Sign in

Get API v1 roles

Changed on
get/api/v1/roles/

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

limitinteger

Limit number of roles

Example:20
offsetinteger

Offset for pagination

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total number of roles

Example response

{
  "$schema": "https://example.com/schemas/GetAllRolesResponse.json",
  "roles": [
    {
      "$schema": "https://example.com/schemas/RoleResponse.json",
      "id": "1",
      "name": "admin",
      "permissions": [
        {
          "$schema": "https://example.com/schemas/PermissionResponse.json",
          "action": "create",
          "id": "1",
          "resource": "user"
        }
      ]
    }
  ]
}

Changes