Post Find Users
Retrieve all users if no filter is specified, otherwise retrieve all the users matching the given filter. This endpoint complies with the SCIM specifications, see https://tools.ietf.org/html/rfc7644#page-15. It serves the same function as the GET /scim/Users API but using a POST to allow an unlimited request size.
the search request
{
"customSchemaExtensionTypes": "string",
"count": 50,
"excludedAttributes": "string",
"filter": "domain co \"test.com\"",
"startIndex": 1,
"sortOrder": "descending",
"attributes": "distinguishedName",
"sortBy": "distinguishedName"
}customSchemaExtensionTypes
The number of found resources to return starting from the given startIndex. This is used for pagination. Default is 20
excludedAttributes
The search filter. When specified, only resources matching the filter expression will be returned. The filter must comply with the SCIM specification. Only 'eq','co','sw','gt','ge','lt' and 'le' are currently supported as operators
Offset of the first resource to return in the list of found resources. This is used for pagination. Default is 0
The direction the resources returned should be sorted in. Allowed values are "ascending" and "descending"
The attributes to be returned. When specified, the returned resource will contain the minimal set of resource attributes plus the attributes or sub-attributes explicitly requested.
The attribute to use to sort the found resource
successful operation
{
"totalResults": 0,
"startIndex": 0,
"itemsPerPage": 0,
"Resources": [
{
"phoneNumbers": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"addresses": [
{
"locality": "string",
"country": "string",
"region": "string",
"primary": false,
"formatted": "string",
"streetAddress": "string",
"postalCode": "string",
"type": "string"
}
],
"locale": "string",
"userType": "string",
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"id": "string",
"resourceDescriptor": {
"endpoint": "string",
"description": "string",
"name": "string",
"attributeSchemas": [
"string"
],
"strictMode": false,
"scimObject": {
"schemas": [
"string"
]
},
"meta": {
"lastModified": "string",
"version": "string",
"location": "string",
"created": "string"
},
"externalId": "string",
"attributes": [
{
"subAttributes": [
"AttributeDescriptor Object"
],
"description": "string",
"canonicalValues": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": false,
"caseExact": false,
"name": "string",
"readOnly": false,
"multiValuedChildName": "string",
"multiValued": false,
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"title": "string",
"preferredLanguage": "string",
"scimObject": {
"schemas": [
"string"
]
},
"ims": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"externalId": "string",
"entitlements": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"nickName": "string",
"urn:scim:schemas:extension:workspace:1.0": {
"distinguishedName": "CN=user1,CN=Users,DC=acme,DC=com",
"domain": "acme.com",
"internalUserType": "PROVISIONED",
"softDeleted": false,
"userPrincipalName": "user1@acme.com",
"userStatus": "1",
"userStoreUuid": "19175b6d-a656-451a-9d25-b62e12d90a24",
"firstLoginUrl": "string"
},
"photos": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"groups": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"active": false,
"password": "string",
"emails": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"userName": "string",
"displayName": "string",
"name": {
"honorificPrefix": "string",
"middleName": "string",
"familyName": "string",
"formatted": "string",
"givenName": "string",
"honorificSuffix": "string"
},
"roles": [
{
"operation": "string",
"type": "string",
"primary": false,
"value": "string",
"display": "string"
}
],
"urn:scim:schemas:extension:enterprise:1.0": {
"manager": {
"displayName": "string",
"managerId": "string"
},
"employeeNumber": "100007"
},
"profileUrl": "string",
"timeZone": "string"
}
]
}totalResults
startIndex
itemsPerPage
The specified search request is invalid