Version 2.20 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Roles

A role is a group of permissions that can be granted. Permissions are a set of actions that can be applied to entities. For more information, see Roles.

Get a list of roles.

get

Use to retrieve a list of roles.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
200

Executed successfully.

application/json

May contain additional creation fields that are not updatable

namestringRequiredExample: admin
descriptionstringRequiredExample: can manage all resources
idinteger · int32RequiredExample: 32
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
deletedAtstring · date-time · nullableOptional
tenantIdinteger · int32Optional

The id of the tenant.

Example: 1001
createdBystringRequiredExample: user@run.ai
get/api/v1/authorization/roles
GET /api/v1/authorization/roles HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "admin",
    "description": "can manage all resources",
    "permissions": [
      {
        "resourceType": "department",
        "displayName": "Projects",
        "groupId": "organization",
        "actions": [
          "create"
        ]
      }
    ],
    "id": 32,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "deletedAt": "2026-01-01T00:00:00.000Z",
    "tenantId": 1001,
    "createdBy": "user@run.ai"
  }
]

Get a role by id.

get

Retrieve the details of a role by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
roleIdPathinteger · int32Required

The id of the role to retrieve

Example: 32
Responses
200

Executed successfully.

application/json

May contain additional creation fields that are not updatable

namestringRequiredExample: admin
descriptionstringRequiredExample: can manage all resources
idinteger · int32RequiredExample: 32
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
deletedAtstring · date-time · nullableOptional
tenantIdinteger · int32Optional

The id of the tenant.

Example: 1001
createdBystringRequiredExample: user@run.ai
get/api/v1/authorization/roles/{roleIdPath}
GET /api/v1/authorization/roles/{roleIdPath} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "admin",
  "description": "can manage all resources",
  "permissions": [
    {
      "resourceType": "department",
      "displayName": "Projects",
      "groupId": "organization",
      "actions": [
        "create"
      ]
    }
  ],
  "id": 32,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "deletedAt": "2026-01-01T00:00:00.000Z",
  "tenantId": 1001,
  "createdBy": "user@run.ai"
}
PreviousApplications
NextTokens

Last updated