OMomni
Users

List embed users

Changed on

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

get/scim/v2/embed/users

Request

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

Query parameters

filterstring

Filter embed users using the userName or embedExternalId fields with SCIM operators.

OperatorDescriptionExample
eqExact matchuserName eq "blob.ross@blobsrus.co"
coContains substringembedExternalId co "sales"

Case sensitivity:

  • Attribute names (userName, embedExternalId) are case-insensitive
  • Operator names (eq, EQ, co, CO) are case-insensitive
  • Email comparisons are case-insensitive
  • External ID (embedExternalId) comparisons are case-sensitive, per SCIM spec

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

startIndexinteger

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

Response

of embed users

schemasstring[]

SCIM schema information for the response

itemsPerPageinteger

The number of embed users returned in the current page

totalResultsinteger

The total number of embed 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
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable 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