Core - Roles

Module dedicated to the user roles. Different roles define what parts of the system are accessible to the user

The base url for the APIs in this page is at:

/api/admin

A JSON file with OpenAPI data about all core-related admin APIs can be downloaded here.

Get roles

Gets the list of roles (it’s a Paged List APIs, as explained in the introduction):

GET /v1/roles/list

Gets the list of roles

Status Codes

200 OK – Success

Returns the list of available roles for user accounts:

[
  {
    ID: 1234,                               // Int
    LastUpdated: "2001-01-01T01:01:01Z",    // DateTime
    Name: "Administrator",                  // String
    Slug: "Admin",                          // String
    IsBackend: false,                       // Boolean
    IsFrontend: false,                      // Boolean
    IsOperator: true                        // Boolean
  },
  ...
]