GET /tenant-management/api/admin/users

As of Version product version 2020 Winter | component version 1.0

Request Method GET

Response Format JSON

Description

Retrieves a list of all users. As 2021 Autumn, the list can be filtered by applying query parameters.

As of version 2021 Autumn, the following query parameters can be specified optionally:

Parameter	Type	Description
`search`	string	Return only users where at least one of the properties `userName`, `email`, `firstName` or `lastName` contains the specified value.
`first`	integer	Skip the first users in the result list. Return only users with index equal or larger than the specified value.
`max`	integer	Return only the specified number of users.

Required user role: YUUVIS_TENANT_ADMIN

Meaning of the response status codes:

HTTP Status Code	Meaning
`200 OK`	Successful, the data of all users have been read.
`401 UNAUTHORIZED`	The call was unauthorized.

Request Example

GET /tenant-management/api/admin/users HTTP/1.1

GET /tenant-management/api/admin/users?first=1&max=5&search=test

Response Example

[{
  "id": "a69a0eb6-3662-4c00-8096-38fbb2c4a922",
  "email": "firstexample@exampleprovider.de",
  "userName": "mrexample",
  "firstName": "Examplename",
  "lastName": "Examplesurname",
  "roles": ["role1","role2"],
  "groups": ["group3","group1"],
  "enabled": true,
  "createdTimestamp": 1555069963564
},
{
  "id": "a69a0eb6-3662-4c00-8096-38fbb2c4a933",
  "email": "secondexample@exampleprovider.de"
  "userName": "msexample",
  "firstName": "Examplename2",
  "lastName": "Examplesurname2",
  "roles": ["group2","group7"],
  "enabled": true,
  "createdTimestamp": 1555069963563
},

...]

{