List Users

List Users will return a list of user's, along with their details that match the given query parameters.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

GET https://{tenantId}.{hostname}/digitanium/v4/users

HTTP request URL for SHIFT

GET https://{hostname}/auth/realms/{tenantId}/v3_user/getusers/

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

Parameter Name	Type	Description
email	String	Unique email of the user. (query parameter)
firstName	String	firstName of the user. (query parameter)
lastName	String	lastName of the user. (query parameter)
pageNumber	Integer	To indicate from where the data has to be filtered.(defaults to 1) (query parameter)
limit	Integer	Maximum results size (defaults to 20) (query parameter)

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Object	User details
userList	array	list of users matching criteria.
page	Object	Paging (dividing a document into discrete pages) information.

Sample Response

{
 "message": "Users fetched successfully",
 "status": "Success",
 "subSystem": 5,
 "data": {
 "userList": [
            {
                "username": "USER_NAME_1",
                "enabled": true,
                "emailVerified": false,
                "attributes": {
                    "digitaniumUserIdOnboardingType": [
                        "onscreen"
                    ],
                    "digitaniumCreateActivation": [
                        "true"
                    ],
                    "digitaniumRequiredAction": [
                        "kobil-2fa-required-action"
                    ]
                },
                "requiredActions": [],
                "admin": true
            },
            {
                "username": "USER_NAME_2",
                "enabled": true,
                "emailVerified": false,
                "attributes": {
                    "digitaniumUserIdOnboardingType": [
                        "onscreen"
                    ],
                    "digitaniumCreateActivation": [
                        "true"
                    ]
                },
                "requiredActions": [],
                "admin": false
            },
            {
                "username": "USER_NAME_3",
                "enabled": true,
                "emailVerified": false,
                "attributes": {},
                "requiredActions": [],
                "admin": true
            },
            {
                "username": "USER_NAME_4",
                "enabled": true,
                "emailVerified": false,
                "attributes": {
                    "digitaniumUserIdOnboardingType": [
                        "onscreen"
                    ],
                    "digitaniumCreateActivation": [
                        "true"
                    ],
                    "digitaniumRequiredAction": [
                        "kobil-offline-otp-required-action"
                    ]
                },
                "requiredActions": [],
                "admin": false
            },
            {
                "username": "USER_NAME_5",
                "enabled": true,
                "emailVerified": false,
                "attributes": {
                    "digitaniumUserIdOnboardingType": [
                        "onscreen"
                    ],
                    "digitaniumCreateActivation": [
                        "true"
                    ]
                },
                "requiredActions": [],
                "admin": false
            },
            {
                "username": "USER_NAME_6",
                "enabled": true,
                "emailVerified": false,
                "attributes": {
                    "digitaniumUserIdOnboardingType": [
                        "onscreen"
                    ],
                    "digitaniumCreateActivation": [
                        "true"
                    ]
                },
                "requiredActions": [],
                "admin": false
            }
        ],
        "page": {
            "pageSize": 20,
            "totalRecords": 6,
            "totalPages": 1,
            "currentPage": 1
        }
    }
}

Response Status Information

Status Code	Status	Message
200	Success	Users fetched successfully
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist