Skip to main content
Returns one role — built-in or custom — with every permission it grants and where each comes from: the built-in definition, the base role it was copied from, or this role’s own permission rules. Any member may read the role; permissions is returned only to callers holding policy:manage on tenant:policy (the permission that lists permission rules) and is omitted for everyone else. The effective permissions of a member or an access group (Get Member Effective Permissions, Get Access Group Effective Permissions) also show what their role grants. To see your own permissions, use List My Permissions.
Permission required: none — any member’s key can call this

Path Parameters

string
required
Role key (key)

Response

object

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.