List all Users

get https://ironcladapp.com/scim/v2/Users

Documentation on listing Users via SCIM.

OAuth Scope required: scim.users.readUsers

time	status	user agent
Retrieving recent requests…

Loading…

📘
Paging (Start Index)
The startIndex parameter corresponds to the index of the user that should be the first response result. It is not a page number.
You can page through users by incrementing the startIndex with the count during successive calls. For example, if count=10, then startIndex=1 would return the first 10 users and startIndex=11 would return the next ten users.
See SCIM RFC 7644 3.4.2.4 for background.

Query Params

startIndex

int32

≥ 1

Defaults to 1

The starting index for retrieving this resource. Resources are indexed based on when they were first added to Ironclad.

count

int32

0 to 1000

Defaults to 25

Specifies the maximum number of resources to return in a single page of results.

filter

string

Filters for identifying subsets of users. Filters must comply with the SCIM protocol's convention. For more details, see SCIM RFC 7644 Section 3.4.2.2.

excludedAttributes

string

A comma-separated list of attributes to exclude from the resources in the response.

Headers

x-as-user-email

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-id

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://ironcladapp.com/scim/v2/Users?startIndex=1&count=25' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘Paging (Start Index)

200200

400400

403403

500500

📘
Paging (Start Index)