Get effective admin role permissions.

GET

/api/admin/admin-roles/{id}/effective-permissions

Code sample: Shell / cURL

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

Returns direct permissions, inherited effective permissions, and the inheritance parent for a tenant or system Admin role.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Admin role id.

Responses

200

Effective permissions for an Admin role.

Media type application/json

object

role_id

required

string

role_name

required

string

direct_permissions

required

Array<string>

effective_permissions

required

Array<string>

inherits_from

string | null

key

additional properties

Example

{
  "role_id": "role_security_admin",
  "role_name": "security_admin",
  "direct_permissions": [
    "admin:admin_roles:read"
  ],
  "effective_permissions": [
    "admin:admin_roles:read",
    "admin:admin_audit:read"
  ],
  "inherits_from": "role_base_admin"
}

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"
}

404

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"
}