latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Users

Returns users matching the given search criteria

Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored.<p>The returned users satisfy all constraints that are specified in this search criteria.</p><p>By default a result containing 1000 users is returned.</p>

get/users

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

userIdstring[]

The list of user IDs to look for. The query parameter must be passed for each user ID.

namestring

The name of the user. The search will take place in the fields specified by the 'nameSearchFields' parameter.

titlestring

The organizational title of the user.

departmentstring

The organization department to which the user belongs.

userSourcestring[]

Filter users by source (e.g. INTERNAL, LDAP, SSO, SCIM). Repeat the query parameter for each value. Unknown values are ignored; if none are valid the filter is not applied.

nameSearchFieldsstring[]

The user fields that will be searched for occurrences of the 'name' parameter. It defaults to USERNAME, FIRSTNAME, LASTNAME, FIRSTNAME_LASTNAME and LASTNAME_FIRSTNAME.

groupIdstring uuid

The ID of the group the searched users should belong to.

onlyLoggedInboolean

Whether only currently logged in users should be returned.

includeDisabledboolean

Whether disabled users should be included in the search results.

sortOrder'ASC' | 'DESC'

The order of sorting.

sortField'USERNAME' | 'FIRSTNAME' | 'LASTNAME' | 'LASTNAME_FIRSTNAME' | 'FIRSTNAME_LASTNAME' | 'EMAIL'

The field for sorting.

Response

Users successfully retrieved

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.