APIAdministration

List access roles

GET
/api/v1/roles

Authorization

bearerAuth roles.manage
AuthorizationBearer <token>

Send Authorization: Bearer <credential>. Create API keys in AirTrail Security settings. OAuth clients use authorization code with PKCE S256 and a resource identifier matching /api/v1.

In: header

Scope: roles.manage

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/roles"
{  "data": [    {      "name": "string",      "description": "string",      "permissions": [        "string"      ],      "id": "string",      "userCount": 0,      "oauthMappingCount": 0,      "isDefault": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}