Retrieve list of roles. | Grist Octri Preview

3 parameters

startIndexintegeroptional

The starting index for pagination.

countintegeroptional

The number of resources to retrieve.

filterstringoptional

Filter resources based on specific criteria.

4 status codes

200Successfully retrieved list of roles.

Resourcesarray<object>optional

itemsPerPageintegeroptional

Number of roles returned per page.

schemasarray<string>optional

startIndexintegeroptional

Starting index.

totalResultsintegeroptional

Total number of roles.

401Unauthenticated

403Unauthorized

500Internal server error.

Error handling

A 401 is returned: Unauthenticated. A 403 is returned: Unauthorized. A 500 is returned: Internal server error.

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.scim.getRoles();

{
  "Resources": [
    {
      "displayName": "owners",
      "id": "1",
      "members": [
        {
          "$ref": null,
          "display": null,
          "type": null,
          "value": null
        }
      ],
      "meta": {
        "location": "/api/scim/v2/Roles/1",
        "resourceType": "Role"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:Grist:1.0:Role"
      ],
      "orgId": 1
    }
  ],
  "itemsPerPage": 20,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 1
}

Request

Response

Errors