Retrieve All Users with SCIM
GET https://{{vaultDNS}}/api/{{version}}/scim/v2/Users
https://developer.veevavault.com/api/22.2/#retrieve-all-users-with-scim
Retrieve all users with SCIM.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | null | Optional: Filter for a specific attribute value. Must be in the format {attribute} eq "{value}". For example, to filter for a particular user name, userName eq "john". Complex expressions are not supported, and eq is the only supported operator. | |
attributes | null | Optional: Include specified attributes only. Enter multiple values in a comma separated list. For example, to include only user name and email in the response, attributes=userName,emails. Note that the schemas and id attributes are always returned. | |
excludedAttributes | null | Optional: Exclude specific attributes from the response. Enter multiple values in a comma separated list. For example, to exclude user name and email from the response, excludedAttributes=userName,emails. Note that the schemas and id attributes are always returned and cannot be excluded. | |
sortBy | null | Optional: Specify an attribute or sub-attribute to order the response. For example, you can sort by the displayName attribute, or the name.familyName sub-attribute. If omitted, the response is sorted by id. Note that the following attributes are not supported: | |
securityPolicy | |||
securityProfile | |||
locale | |||
preferredLanguage | |||
sortOrder | null | Optional: Specify the order in which the sortBy parameter is applied. Allowed values are ascending or descending. If omitted, defaults to ascending. | |
count | null | Optional: Specify the number of query results per page, for example, 10. Negative values are treated as 0, and 0 returns no results except for totalResults. If omitted, defaults to 1000. | |
startIndex | null | Optional: Specify the index of the first result. For example, 10 would omit the first 9 results and begin on result 10. Omission, negative values, and 0 is treated as 1. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Accept | string |