Skip to content
On this page

Authorization API

User

Field nameTypeDescription
idnumber*The unique ID of the user
usernameRoleEnum*
emailstring*Email of the user to whom the account is registered.
rolestring*The role of the user reflects the level of access to change the content.
is_activeboolean*Flag indicating whether the user has confirmed his email
User details
{
    "username": "string",
    "email": "user@example.com",
    "id": number,
    "is_active": boolean,
    "role": "admin" | "moderator" | "viewer"
}

Authorizatrion response

Field nameTypeDescription
userUser*The unique ID of the user
access_tokenstring*A unique access token issued to the user
refresh_tokenstring*Email of the user to whom the account is registered.
User details
{
  "access_token": "string",
  "refresh_token": "string",
  "user": {
    "username": "string",
    "email": "user@example.com",
    "id": number,
    "is_active": boolean,
    "role": "admin" | "moderator" | "viewer"
  }
}

Released under the Mozilla Public License Version 2.0.