user-controller
Get Users (getUsers)
Returns a page of users owned by tenant or customer. The scope depends on authority of the user that performs the request.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.
Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.
get/api/users
Query parameters
userIdsstring[] required
A list of user ids, separated by comma ','
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
textSearchstring
The case insensitive 'substring' filter based on the user email.
sortProperty'createdTime' | 'firstName' | 'lastName' | 'email'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
Response
OK
Example response
{
"data": [
{
"id": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "USER"
},
"createdTime": 1609459200000,
"tenantId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT"
},
"customerId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "CUSTOMER"
},
"email": "user@example.com",
"authority": "SYS_ADMIN, TENANT_ADMIN or CUSTOMER_USER",
"firstName": "John",
"lastName": "Doe",
"name": "user@example.com",
"additionalInfo": {}
}
]
}