Versions Compared

Old Version 1

changes.mady.by.user Team Kolibri

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Statusstatus
Page Properties
hiddentrue
id
rDOC

colourYellow
titleDraft
Priority1
Product Version
Report Note
AssigneeMartin
Bartonitz

Ressources

Resources & Remarks

History

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

Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Antje15 FEB 20212020 WinterrDOC
Antje04 JUN 20212021 Autumngroups parameter added to example



Get the data

{

  "ID":

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

As of Versionproduct version 2020 Winter | component version 1.0
Request MethodGET
Response FormatJSON
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:

ParameterTypeDescription
searchstringReturn only users where at least one of the properties userName, email, firstName or lastName contains the specified value.
firstintegerSkip 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.
maxintegerReturn only the specified number of users.
Meaning of the response status codes:


HTTP Status CodeMeaning
200 OKSuccessful, the data of all users of the specified tenant have been read.
401 UNAUTHORIZEDThe call was unauthorized.


Request Example
Panel
Result Example

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

Response Example


Code Block
languageyml
[{
  "id": "a69a0eb6-3662-4c00-8096-38fbb2c4a922",


  "
Created At
email":
"3/25/19 6:04:39 PM",
  "Email": "bartonitz@optimal-systems.de"
  "Username"::"bartonitz",
, "First name":: "Martin",
, "Last name"::"Bartonitz",
  "User Enabled": true

{

  "ID": "63d039b6-71c4-49dc-bf90-baa19acdbef9",
  "Created At": "4/25/19 6:04:39 PM",
  "Email": "bartonitz@optimal-systems.de",
  "Username"::"schulz",
, "Last name"::"Schulz",
, "First name":: "Andreas"

},

...

{
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
 "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": ["role1","role2"],
  "groups": ["group2","group1"],
  "enabled": true,
  "createdTimestamp": 1555069963563
},

...]

{