GET /api-web/api/idm/users

As of Version

product version 2023 Spring

Request MethodGET
Response FormatJSON
Description

Retrieves a list of all users. The result list can be filtered by applying conditions that have to be matched.

The conditions are specified via the following optional query parameters:

ParameterTypeDescription
excludeMebooleanIf true, the currently logged-in user is excluded from the result list. (default: true)
pageinteger($int32)Result page you want to retrieve (0…N). Default is 0 which means the first page.
searchstringRetrieve only users for which the specified string is contained in user name, first name, last name or e-mail.
sizeinteger($int32)Limit the number of users per page. (default: 20)
sortstringSorting of results either ascending (asc) or descending (desc). Default sort order is ascending.
rolesarray[string]Retrieve only users that have at least one of the provided roles.
onlyActivebooleanIf true, the disabled users are excluded from the result list. (default: true)

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
401 UnauthorizedNot successful.
Request Example

https://<host>/api-web/api/idm/users

no request body

Response Example

200 OK

[
  {
    "username": "string",
    "id": "string",
    "foreignid": "string",
    "type": "string",
    "title": "string",
    "email": "string",
    "firstname": "string",
    "lastname": "string",
    "domain": "string",
    "tenant": "string",
    "authorities": [
      "string"
    ],
    "substituteOf": [
      "string"
    ],
    "accountNonExpired": true,
    "accountNonLocked": true,
    "credentialsNonExpired": true,
    "enabled": true,
    "displayName": "string"
  }
]