Sign in
roles

Get a role by name

Get a role from the provided role name.

Permissions

Requires an active session but no other permissions.

get/api/v4/roles/name/{role_name}

Path parameters

role_namestring required

Role Name

Response

Role retrieval successful

idstring

The unique identifier of the role.

namestring

The unique name of the role, used when assigning roles to users/groups in contexts.

display_namestring

The human readable name for the role.

descriptionstring

A human readable description of the role.

permissionsstring[]

A list of the unique names of the permissions this role grants.

scheme_managedboolean

indicates if this role is managed by a scheme (true), or is a custom stand-alone role (false).

Changes