Page Comparison

Page Properties

hidden	true
id	DONErDOC

Product Version
Report Note
Assignee	Martin

Resources & Remarks

Version 2.4 - options" ... "synchronousContentAnalysis": true (OKTO-4309)

Modification History

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.
Antje	15 FEB 2021	2020 Winter	rDOC
Antje	04 JUN 2021	2021 Autumn	groups parameter added to example

Get the data

As of Version product version 2.4 2020 Winter | component version 1.0

Request Method GET

Response Format JSON

Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service

Description

Excerpt
Retrieves a list of all users

for

of the specified tenant. 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

the name.
Required: user with role YUUVIS_TENANT_ADMIN

index equal or larger than the specified value.
`max`	integer	Return only the specified number of users.

Meaning of the response status codes:

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

Request Example

panel

GET /tenant-management/api-tm/system/tenants/myTenant/users HTTP/1.1

GET /tenant-management/api/system/tenants/myTenant/users?first=1

Result Example

&max=5&search=test

Response Example

Code Block

language	yml

[{


  "id": "a69a0eb6-3662-4c00-8096-38fbb2c4a922",


  "email": "

bartonitz@optimal-systems

firstexample@exampleprovider.de"

,
  "

username

userName"

:

: "

bartonitz

mrexample",

,


  "firstName":

:

Martin

Examplename",

,


  "lastName"

:

: "

Bartonitz

Examplesurname",


  "roles": ["role1","role2"],
  "groups": ["group3","group1"],


  "enabled": true,


  "createdTimestamp": 1555069963564

},


  "id": "

63d039b6

a69a0eb6-

71c4

3662-

49dc

4c00-

bf90

8096-

baa19acdbef9

38fbb2c4a933",


  "email": "

bartonitz@optimal-systems

secondexample@exampleprovider.de"

,
"username":: "schulz",
,


  "userName": "msexample",
  "firstName": "Examplename2",
  "lastName"

:

: "

Schulz

Examplesurname2",

,

firstName

roles":

:

["

Andreas

role1","role2"],

"roles


  "groups": ["

role3

group2","

role4

group1"],


  "enabled": true,


  "createdTimestamp":

1555069963564

 1555069963563
},



...]

{

Meaning of the response status codes:

200 OK

The data of all users of the tenant name have been read

401 UNAUTHORIZED

The call was unauthorized

Versions Compared

Old Version 8

New Version Current

Key

200 OK

401 UNAUTHORIZED