List users

List SCIM users in the organization

GET /api/v1/scim/v2/Users

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "itemsPerPage": 1,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "e0dd2003-c291-4e14-b977-7a03b7edc842",
      "userName": "[e-mail]",
      "name": {
        "givenName": "Viewer",
        "familyName": "User"
      },
      "active": true,
      "emails": [
        {
          "value": "[e-mail]",
          "primary": true
        }
      ],
      "roles": [
        {
          "value": "viewer",
          "display": "Viewer",
          "type": "Organization"
        },
        {
          "value": "3675b69e-8324-4110-bdca-059031aa8da3:editor",
          "display": "Jaffle shop - Editor",
          "type": "Project - Jaffle shop",
          "primary": false
        }
      ],
      "meta": {
        "resourceType": "User",
        "created": "2025-11-03T14:22:18.464Z",
        "lastModified": "2025-11-05T15:04:02.687Z",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/Users/e0dd2003-c291-4e14-b977-7a03b7edc842"
      }
    }
  ]
}

Query Parameters

filter · string

SCIM filter string (optional). See: https://bookstack.soffid.com/books/scim/page/scim-query-syntax

startIndex · number<double>

1-based index of the first result to return (optional)

count · number<double>

Maximum number of results to return (optional)

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

Resources. schemas · string[] · required

Resources. id · string · required

Resources. userName · string · required

Resources. meta · object

Show child attributes

Resources.meta. version · string

Resources.meta. location · string

Resources.meta. lastModified · string<date-time>

Resources.meta. created · string<date-time>

Resources.meta. resourceType · string

Resources. name · object

Show child attributes

Resources.name. familyName · string

Resources.name. givenName · string

Resources. active · boolean

Resources. emails · object[]

Show child attributes

Resources.emails. value · string · required

Resources.emails. primary · boolean

Resources. roles · object[]

Show child attributes

Resources.roles. value · string · required

Resources.roles. display · string

Resources.roles. type · string

Resources.roles. primary · boolean

Resources. urn:lightdash:params:scim:schemas:extension:2.0:User · object

Show child attributes

Resources.urn:lightdash:params:scim:schemas:extension:2.0:User. role · string · deprecated