UserRole

The UserRole enum defines the access levels available for users in the system.

Enum Values

ADMIN

enum value

Administrator role with full system accessUsers with the ADMIN role have elevated privileges and can perform administrative operations such as managing all users in the system.

USER

enum value

Standard user role with regular accessThe USER role is the default role for most users, providing standard access to user management features.

GUEST

enum value

Guest role with limited accessUsers with the GUEST role have restricted access to the system, typically with read-only or limited permissions.

Usage in API Requests

The UserRole is used in both registration and update operations:

Register User Example

{
  "username": "jdoe",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "role": "USER"
}

Update User Example

{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "role": "ADMIN",
  "active": true
}

Validation

When provided in API requests:

The role field is required and cannot be null
Must be one of the three valid values: ADMIN, USER, or GUEST
Case-sensitive (must be uppercase)
Invalid values will result in a validation error

Error Example

{
  "type": "about:blank",
  "title": "Validation Failed",
  "status": 400,
  "detail": "role: role is required and must be one of: ADMIN, USER, GUEST",
  "timestamp": "2024-01-15T10:30:00"
}

Endpoints

Models

Enum Values

Usage in API Requests

Register User Example

Update User Example

Validation

Error Example

Build docs developers (and LLMs) love

Endpoints

Models

​Enum Values

​Usage in API Requests

​Register User Example

​Update User Example

​Validation

​Error Example

Build docs developers (and LLMs) love

Enum Values

Usage in API Requests

Register User Example

Update User Example

Validation

Error Example