Passer au contenu

Get application role

Requête

Returns the full details of the specified application role.

Sécurité
Bearer or PersonalAccessToken
Chemin
organizationIdstring, (uuid)obligatoire

Unique identifier of the organization

applicationRoleIdstring, (uuid)obligatoire

Unique identifier of the application role

GET
/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

OK

Corpsapplication/json
idstring, (uuid)obligatoire

The application role ID.

Exemple:"6f2ed3d2-0617-4be4-9445-7e6a4090b260"
namestringobligatoire

The application role name.

Exemple:"Administrator"
descriptionstring or null

The application role description.

Exemple:"Can read envelopes"
isSystemRolebooleanobligatoire

Whether the application role is a built-in system role.

Exemple:false
permissionsArray of objects(Permission)obligatoire

The list of entity/action permission pairs granted by the application role.

Réponse
{ "id": "6f2ed3d2-0617-4be4-9445-7e6a4090b260", "name": "Administrator", "description": "Can read envelopes", "isSystemRole": false, "permissions": [ { … } ] }