Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Roles

List Roles

Lists all tenant roles.

get/v2/schema/{proj_id}/{env_id}/roles

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Query parameters

include_total_countboolean

Include total count in response

Include total count in response

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

searchstring

Text search for the object name or key

Text search for the object name or key

Response

Successful Response

OR

Example response

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "key": "editor",
      "name": "Editor",
      "description": "the editor role can read and write to documents",
      "permissions": [
        "document:write"
      ],
      "extends": [
        "viewer"
      ],
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}