OMomni
Users

List users

Changed on

List users in the organization, sorted by creation time. Use the embed users endpoint to retrieve embed users.

get/scim/v2/users

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/scim/v2/users
  • Auth
    HTTP bearer

Query parameters

filterstring

Filter users using the userName field with SCIM operators:

OperatorDescriptionExample
eqExact matchuserName eq "blob.ross@blobsrus.co"
coContains substringuserName co "smith"

Case sensitivity:

  • Attribute names (userName, USERNAME) are case-insensitive
  • Operator names (eq, EQ, co, CO) are case-insensitive
  • Email comparisons are case-insensitive

Usernames should be URL-encoded when passed as filters. For example, userName eq "user@example.com" will become userName%20eq%20%22user%40example.com%22 when encoded.

countinteger

The number of users to return per page

startIndexinteger

An integer index that determines the starting point of the sorted result list

Response

List of users

schemasstring[]

SCIM schema information for the response

itemsPerPageinteger

The number of users returned in the current page

totalResultsinteger

The total number of users matching the query

startIndexinteger

The starting index of the current page in the result set

Example response

{
  "Resources": [
    {
      "meta": {
        "resourceType": "User"
      }
    }
  ]
}

Changes

  • 43290040f88fRevision changes
    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status