v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

User Roles

Get User roles

Get Roles

This endpoint retrieves a list of roles.

Response

The response is a JSON object with a roles array containing objects with the following properties:

id (string): The ID of the role.
name (string): The name of the role.
level (string): The level of the role.
twofa_type (string): The type of two-factor authentication associated with the role.
userIds (array of strings): An array of user IDs associated with the role.

get/roles

Response

Successful operation

Example response

{
  "roles": [
    {
      "id": "1",
      "level": "1000",
      "name": "Admins",
      "twofa_type": "default",
      "userIds": [
        "1",
        "2"
      ]
    },
    {
      "id": "3",
      "level": "1050",
      "name": "Other",
      "twofa_type": "default",
      "userIds": [
        "1",
        "16",
        "19",
        "21"
      ]
    }
  ]
}