List roles

Get a list of roles within an organization

GET /api/v1/scim/v2/Roles

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "itemsPerPage": 3,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:extension:2.0:Role"
      ],
      "id": "member",
      "value": "member",
      "display": "Member",
      "type": "Organization",
      "supported": true,
      "meta": {
        "resourceType": "Role",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Roles/member"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:extension:2.0:Role"
      ],
      "id": "3675b69e-8324-4110-bdca-059031aa8da3:viewer",
      "value": "3675b69e-8324-4110-bdca-059031aa8da3:viewer",
      "display": "Jaffle shop - Viewer",
      "type": "Project - Jaffle shop",
      "supported": true,
      "meta": {
        "resourceType": "Role",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Roles/3675b69e-8324-4110-bdca-059031aa8da3:viewer"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:extension:2.0:Role"
      ],
      "id": "3675b69e-8324-4110-bdca-059031aa8da3:da116e0f-2b96-4af4-93b7-b2636a26853d",
      "value": "3675b69e-8324-4110-bdca-059031aa8da3:da116e0f-2b96-4af4-93b7-b2636a26853d",
      "display": "Jaffle shop - test",
      "type": "Project - Jaffle shop",
      "supported": true,
      "meta": {
        "resourceType": "Role",
        "created": "2025-11-03T17:01:45.447Z",
        "lastModified": "2025-11-03T17:01:45.447Z",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Roles/3675b69e-8324-4110-bdca-059031aa8da3:da116e0f-2b96-4af4-93b7-b2636a26853d"
      }
    }
  ]
}

Query Parameters

filter · string

Filter to apply to the role list (optional)

startIndex · number<double>

SCIM 2.0 startIndex (1-based). Defaults to 1.

count · number<double>

SCIM 2.0 count (page size). Defaults to 100.

Response

200 - application/json

Ok

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:api:messages:2.0:ListResponse

totalResults · number<double> · required

itemsPerPage · number<double> · required

startIndex · number<double> · required

Resources · object[] · required

Show child attributes