List available admin permissions.

GET

/api/admin/admin-roles/permissions/list

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/admin-roles/permissions/list \
  --header 'Authorization: Bearer <token>'

Returns the built-in Admin permission catalog with permission keys and descriptions that can be used in custom roles.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Available Admin permission catalog.

Media type application/json

object

permissions

required

Array<object>

object

key

required

string

description

required

string

key

additional properties

key

additional properties

Example

{
  "permissions": [
    {
      "key": "*",
      "description": "Full access to all admin functions"
    },
    {
      "key": "admin:admin_users:read",
      "description": "View admin users"
    }
  ]
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}