Page Comparison

Page Properties

hidden	true
id	DONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

2021 Summer

Name	Date	Product Version	Action
Antje	19 MAY 2021	02 MAR 2023	2023 Spring	Page created.

As of Version

product version 2021 Summer | component version 2023 Spring

Request Method GET

Response Format JSON

Description

Excerpt
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:

Parameter	Type	Description
`excludeMe`	boolean	If `true`, the currently logged-in user is excluded from the result list. (default: `true`)
`page`	integer($int32)	Result page you want to retrieve (0…N). Default is `0` which means the first page.
`search`	string	Retrieve only users for which the specified string is contained in user name, first name, last name or e-mail.
`size`	integer($int32)	Limit the number of users per page. (default: 20)
`sort`	string	Sorting of results either ascending (`asc`) or descending (`desc`). Default sort order is ascending.
`roles`	array[string]	Retrieve only users that have at least one of the provided roles.
`onlyActive`	boolean	If `true`, the disabled users are excluded from the result list. (default: `true`)

Response HTTP status codes:

HTTP Status Code	Meaning
`200 OK`	Successful.
`401 Unauthorized`	Not successful.

Request Example

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

no request body

Response Example

200 OK

Code Block

language	yml

[
  {
    "accountNonExpiredusername": true"string",
    "accountNonLockedid": true"string",
    "authoritiesforeignid": [       "string"
    ],
    "credentialsNonExpiredtype": true"string",
    "domaintitle": "string",
    "email": "string",
    "enabledfirstname": true"string",
    "firstnamelastname": "string",
    "foreigniddomain": "string",
    "idtenant": "string",
    "lastnameauthorities": [
      "string"
    ],
    "substituteOf": [
      "string"
    ],
    "tenantaccountNonExpired": true,
    "stringaccountNonLocked": true,
    "titlecredentialsNonExpired": "string"true,
    "typeenabled": "string"true,
    "usernamedisplayName": "string"
  }
]

Versions Compared

Old Version 1

New Version Current

Key