Get Get Users

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

Request
URI
GET
https://{api_host}//SAAS/jersey/manager/api/scim/Users
COPY
Query Parameters
string
attributes
Optional

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

attributes example 
userName,groups
string
filter
Optional

when 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

filter example 
userName co "j"
integer
startIndex
Optional

offset of the first user to return in the list of found users. This is used for pagination

startIndex example 
10
integer
count
Optional

the number of found users to return starting from the given startIndex. This is used for pagination

count example 
50
string
sortBy
Optional

the attribute to use to sort the found user

sortBy example 
userName
string
sortOrder
Optional

the direction the resources returned should be sorted in. Allowed values are "ascending" and "descending".

sortOrder example 
descending
Possible values are : ascending, descending,
string
customSchemaExtensionTypes
Optional

custom schema extension types for which user schema attributes need to be included

customSchemaExtensionTypes example 
myCustomSchema
Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResourcesOfUserResource of type(s) application/json 
{
    "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": "[email protected]",
                "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"
        }
    ]
}
integer As int64 As int64
totalResults
Optional

totalResults

integer As int64 As int64
startIndex
Optional

startIndex

integer As int32 As int32
itemsPerPage
Optional

itemsPerPage

array of SdkUserResource
Resources
Optional

The list of users.


400

The specified filter operation is invalid or the specified "attributes" are invalid

Operation doesn't return any data structure

404

If the query parameter values are invalid for "sortBy", "count" or "startIndex"

Operation doesn't return any data structure

On This Page
Scim Operations
DELETE
Delete Delete Group
DELETE
Delete Delete User
GET
Get Get Group
GET
Get Get Groups
GET
Get Get Role
GET
Get Get Roles
GET
Get Get Schemas
GET
Get Get User
GET
Get Get Users
PATCH
Patch Patch Group
PATCH
Patch Patch Role
PATCH
Patch Patch User
POST
Post Find Groups
POST
Post Find Users
POST
Post Post Group
POST
Post Post User