scim.users.readUsers
External DocumentationTo learn more, visit the Ironclad documentation.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
scim.users.readUsers
| Parameter | Description |
|---|---|
| Count | The maximum number of users to return per page. Maximum is 1000. |
| Excluded Attributes | A comma-separated list of attributes to exclude from the users in the response. |
| Filter | A SCIM filter expression to return only the users that match it. For Example: userName eq "alex.doe@example.com"For all the supported search operators, refer to SCIM RFC 7644. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Start Index | The one-based index of the first user to return. Users are indexed by the order in which they were added to Ironclad. |
{
"schemas": [
"string"
],
"totalResults": 0,
"Resources": [
{
"schemas": [
"string"
],
"id": "string",
"userName": "string",
"name": {
"givenName": "string",
"familyName": "string"
},
"title": "string",
"active": false,
"emails": [
{
"value": "string",
"type": "string",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "string"
},
"urn:ietf:params:scim:schemas:extension:ironclad:2.0:User": {
"departmentHead": "string",
"provider": "string",
"allowProviderConversion": false
},
"meta": {
"resourceType": "string",
"created": "string",
"lastModified": "string",
"location": "string"
}
}
],
"startIndex": 0,
"itemsPerPage": 0
}
Was this page helpful?