Skip to Content
kosemdocs
ReferenceAPIRoles

List roles

Lists the predefined roles: the basic roles, then each service's.

GET
/v1/roles

Lists the predefined roles: the basic roles, then each service's.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Query Parameters

pageSize?integer

Maximum number of roles to return. Defaults to 50; values above 500 are treated as 500.

Formatint32
Range0 <= value
pageToken?string

Page token from a previous response.

Response Body

OK

application/json
  1. response
nextPageToken*string

Token for the next page; empty on the last page.

roles*array<>

Roles, the basic ones first, then by service.

Example Request
curl -X GET 'https://api.kosem.ai/v1/roles'
Example Response
{
  "nextPageToken": "string",
  "roles": [
    {
      "description": "string",
      "grantableOn": [
        "string"
      ],
      "includedPermissions": [
        "string"
      ],
      "name": "string",
      "title": "string"
    }
  ]
}