Get scim users

Request

Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all.

Required permissions: apps:read, [appId]:read, users:read, apps:list, [appId]:list, users:list.

Security

ClientAccessToken

Headers

Acceptstringrequired

application/scim+json

Content-Typestringrequired

application/scim+json

Bodyapplication/jsonrequired

startIndexnumber

The 1-based index of the first query result

Default:1

countnumber, <= 5000

Number of users to return in page

Default:1000

sortBystring

The name of the field you wish to sort by

Default:"meta.created"

Enum:"emails""phoneNumbers""meta.created""lastAuth"

sortOrderstring

The order of the sort

Default:"asc"

Enum:"asc""desc"

filterstring

Search expression based on the SCIM protocol. For syntax and searchable fields, see Search query syntax

attributesArray of strings

The names of the user's attributes to return in the response, overriding the set of attributes that would be returned by default

excludedAttributesArray of strings

The names of the user's attributes to be removed from the default set of attributes to return

schemasArray of stringsrequired

Schemas should be always set to ["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]

Items Value:"urn:ietf:params:scim:api:messages:2.0:SearchRequest"

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/scim/Users/.search \
  -H 'Accept: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "startIndex": 1,
    "count": 1000,
    "sortBy": "emails",
    "sortOrder": "asc",
    "filter": "string",
    "attributes": [
      "string"
    ],
    "excludedAttributes": [
      "string"
    ],
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
    ]
  }'

Responses

Bodyapplication/json

schemasArray of stringsrequired

Schema uri

totalResultsnumber

Number of total user results

ResourcesArray of objectsrequired

The returned users

startIndexnumber

The 1-based index of the first result in the current set of list results

itemsPerPagenumber

The number of resources returned in a list response page

Response

{
  "schemas": [
    "string"
  ],
  "totalResults": 0,
  "Resources": [
    { … }
  ],
  "startIndex": 0,
  "itemsPerPage": 0
}