Get Get 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
list of attributes to return, separated by comma. When specified, the retrieved user(s) will only contain the minimal set of user attributes plus the attributes or sub-attributes explicitly requested
userName,groupswhen specified, only users 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
userName co "j"offset of the first user to return in the list of found users. This is used for pagination
10the number of found users to return starting from the given startIndex. This is used for pagination
50the attribute to use to sort the found user
userNamethe direction the resources returned should be sorted in. Allowed values are "ascending" and "descending".
descendingcustom schema extension types for which user schema attributes need to be included
myCustomSchemasuccessful operation
{
"totalResults": "integer",
"startIndex": "integer",
"itemsPerPage": "integer",
"Resources": [
{
"phoneNumbers": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"value": "string",
"display": "string"
}
],
"addresses": [
{
"locality": "string",
"country": "string",
"region": "string",
"primary": "boolean",
"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": "boolean",
"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": "boolean",
"value": "string",
"display": "string"
}
],
"dataType": "string",
"required": "boolean",
"caseExact": "boolean",
"name": "string",
"readOnly": "boolean",
"multiValuedChildName": "string",
"multiValued": "boolean",
"schema": "string"
}
],
"schema": "string",
"id": "string",
"resourceDescriptor": "ResourceDescriptor Object"
},
"title": "string",
"preferredLanguage": "string",
"scimObject": {
"schemas": [
"string"
]
},
"ims": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"value": "string",
"display": "string"
}
],
"externalId": "string",
"entitlements": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"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": "boolean",
"userPrincipalName": "[email protected]",
"userStatus": "1",
"userStoreUuid": "19175b6d-a656-451a-9d25-b62e12d90a24",
"firstLoginUrl": "string"
},
"photos": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"value": "string",
"display": "string"
}
],
"groups": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"value": "string",
"display": "string"
}
],
"active": "boolean",
"password": "string",
"emails": [
{
"operation": "string",
"type": "string",
"primary": "boolean",
"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": "boolean",
"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 filter operation is invalid or the specified "attributes" are invalid
If the query parameter values are invalid for "sortBy", "count" or "startIndex"