Skip to main content
GET
/
api
/
v1
/
scim
/
v2
/
Users
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 123,
  "itemsPerPage": 123,
  "startIndex": 123,
  "Resources": [
    {
      "schemas": [
        "<string>"
      ],
      "id": "<string>",
      "meta": {
        "version": "<string>",
        "location": "<string>",
        "lastModified": "2023-11-07T05:31:56Z",
        "created": "2023-11-07T05:31:56Z",
        "resourceType": "<string>"
      },
      "userName": "<string>",
      "name": {
        "familyName": "<string>",
        "givenName": "<string>"
      },
      "active": true,
      "emails": [
        {
          "primary": true,
          "value": "<string>"
        }
      ],
      "roles": [
        {
          "value": "<string>",
          "display": "<string>",
          "type": "ORG_SYSTEM",
          "primary": true
        }
      ],
      "urn:lightdash:params:scim:schemas:extension:2.0:User": {
        "role": "<string>"
      }
    }
  ]
}

Query Parameters

filter
string
startIndex
number

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

count
number

Maximum number of results to return (optional)

Response

200 - application/json

Ok

schemas
enum<string>[]
required
totalResults
number
required
itemsPerPage
number
required
startIndex
number
required
Resources
object[]
required