APIAuth
Get role
Get a single role by id.
GET
Get a single role by id.
ApiKeyAuthheader
AuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
view_rolesrole_id*stringFormat
uuidThe request has succeeded.
application/json- response
A role plus what the console derives about it.
id*uuidFormat
uuidname*stringThe role's name as shown in the console.
description*stringWhat the role is for.
permissions*array<>What holding the role lets a person do.
system*booleanBuilt-in roles are maintained by the product and cannot be changed.
created_at*stringFormat
date-timeuser_count*integerHow many people in the organization hold this role.
Format
int32curl -X GET "https://example.com/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "permissions": [ { "permission": "view_agents", "scope": "all" } ], "system": true, "created_at": "2019-08-24T14:15:22Z", "user_count": 0}