List provisioned users

The members of the organization the token belongs to, as SCIM users. Two filter expressions are understood: userName eq "[e-mail]", matched against the member’s email without regard to case, and externalId eq "...", matched against the identifier the presented token’s own directory connection pushed. Any other filter is refused.

GET /api/scim/v2/Users

List provisioned users

Python

import requests

url = "https://app.langwatch.ai/api/scim/v2/Users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 0,
  "startIndex": 0,
  "itemsPerPage": 0,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "<string>",
      "userName": "<string>",
      "name": {
        "givenName": "<string>",
        "familyName": "<string>"
      },
      "emails": [
        {
          "primary": true,
          "value": "<string>",
          "type": "<string>"
        }
      ],
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "<string>",
        "lastModified": "<string>"
      },
      "externalId": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

SCIM token for one organization's directory connection, created with POST /api/scim-tokens or in Settings > SCIM. It authenticates provisioning calls only, and stops working if the organization's Enterprise plan lapses.

Query Parameters

filter · string

A SCIM filter. Only attribute eq "..." is understood; any other expression is refused.

startIndex · integer

1-based index of the first resource to return. Anything that does not parse as a positive integer is read as 1.

Required range: -9007199254740991 <= x <= 9007199254740991

count · integer

How many resources to return, capped at 100 (the filter.maxResults ServiceProviderConfig publishes). Anything that does not parse as a positive integer is read as 100, and anything above 100 is served as 100.

Required range: -9007199254740991 <= x <= 100

Response

200

application/scim+json

A page of provisioned users.

schemas · string[] · required

Allowed value: "urn:ietf:params:scim:api:messages:2.0:ListResponse"

totalResults · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

startIndex · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

itemsPerPage · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

Resources · object[] · required

Show child attributes