Skip to main content
GET
/
scim
/
v2
/
Users
List SCIM Users
curl --request GET \
  --url https://paradigm.lighton.ai/scim/v2/Users \
  --header 'Authorization: Bearer <token>'
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 50,
  "Resources": [
    {
      "id": "2819c223-7f76-453a-919d-413861904646",
      "userName": "alice",
      "name": {
        "givenName": "Alice",
        "familyName": "Durand"
      },
      "emails": [
        {
          "value": "alice@example.com",
          "primary": true
        }
      ],
      "active": true,
      "meta": {
        "resourceType": "User",
        "location": "/scim/v2/Users/2819c223-7f76-453a-919d-413861904646",
        "version": "W/\"a330bc54f0671c9\""
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Query Parameters

​
filter
string

SCIM filter expression (RFC 7644 §3.4.2.2), e.g. userName eq "alice", emails.value co "example.com". Operators: eq, ne, co, sw, ew, gt, ge, lt, le, pr. Group with and/or/not. Use parentheses to control precedence.

​
startIndex
integer
default:1

1-based index of first result (default 1).

Required range: x >= 1
​
count
integer
default:50

Page size / number of results to return (server may cap).

Required range: 0 <= x <= 200
​
sortBy
string

Attribute name to sort by (e.g., userName, displayName).

​
sortOrder
enum<string>
default:ascending

Sort order direction.

Available options:
ascending,
descending
​
attributes
string

Comma-separated attribute paths to include in the response.

​
excludedAttributes
string

Comma-separated attribute paths to exclude from the response.

Response

SCIM ListResponse of Users

​
schemas
string[]
required
Example:
[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
​
totalResults
integer
required
Example:

1

​
startIndex
integer
required
Example:

1

​
itemsPerPage
integer
required
Example:

50

​
Resources
object[]
required
  • Option 1
  • Option 2
⌘I