PHphrase
SCIM

List users

Returns a paginated list of users belonging to the authenticated organization.

Supports SCIM filtering using the eq comparator on the following attributes:

  • id
  • externalId
  • userName
  • name.givenName
  • name.familyName
  • emails.value

Only a single filter condition is supported — compound expressions (e.g. AND) return 400. Filter attribute names are case-insensitive.

get/scim/Users

Request

Query parameters

filterstring

SCIM filter expression (RFC 7644 Section 3.4.2.2). Only the eq comparator is supported.

startIndexinteger

1-based index of the first result. Defaults to 1.

countinteger

Maximum number of results per page. Must be between 0 and 100.

Response

Users returned successfully

schemasstring[]
totalResultsinteger

Total number of matching results across all pages

startIndexinteger

1-based index of the first result in this response

itemsPerPageinteger

Number of results returned in this response

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "roles": [
        {
          "type": "phrase__platform",
          "value": "MEMBER"
        }
      ],
      "meta": {
        "resourceType": "User"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.