Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE".

Everything contained within the table is displayed in the (INTERNAL) Reports page.

Product Version
Report Note
Assignee

Resources & Remarks

Links, Pictures, whatever

Modification History

Add a new line to this table and fill it whenever you edit the page.

NameDateProduct VersionAction
Antje7 OCT 20212021 WinterPage created.
Antje18 AUG 20222022 Autumnadd 'briefRepresentation' query parameter



As of Version

product version 2021 Winter | component version a.b

Request MethodGET
Response FormatJSON
Required PermissionThe endpoint is available for every logged-in user.
Description


Retrieves a list of all users within the same tenant as the currently logged-in user.


Each user in the result list will be represented with all user account parameters available via Tenant Management API.
>> User Management via Endpoints

Optionally, the following query parameters can be specified in order to modify the result list:

ParameterTypeDescription
pageinteger($int32)Results the page you want to retrieve (0…N)
sizeinteger($int32)Limit the number of users per page
searchstringRetrieve only users for which the specified string is contained in user name, first name, last name or e-mail.
briefRepresentation
(as of 2022 Autumn)		boolean

If true (default) the response will contain only a reduced data set for each listed user in order to reduce the processing time. The following parameters will be returned: id, email, firstName, lastName, username, enabled, createdTimestamp.

If false, the following parameters will be additionally included: roles, groups.



Request Example
https://<host>/tenant-management/api/idm/users?max=3&briefRepresentation=false
Response Example


{
  "objects": [
    {
      "id": "406b5a28-7a8b-4c36-a569-df7bff480375",
      "firstName": "Heinrich",
      "lastName": "Schuetzel",
      "roles": [
        "YUUVIS_SYSTEM_INTEGRATOR",
        "YUUVIS_DEFAULT",
        "YUUVIS_TENANT_ADMIN",
        "HR_MANAGER",
        "YUUVIS_CREATE_OBJECT",
        "YUUVIS_MANAGE_SETTINGS"
      ],
      "username": "newuser5",
      "enabled": true,
      "createdTimestamp": 1622122631393
    },
    {
      "id": "320c67d0-b88b-4e99-852a-b938f4b38cd7",
      "email": "kammer@segelreisen.de",
      "firstName": "Hannes",
      "lastName": "Kammer",
      "roles": [
        "YUUVIS_SYSTEM_INTEGRATOR",
        "YUUVIS_DEFAULT",
        "YUUVIS_TENANT_ADMIN",
        "YUUVIS_CREATE_OBJECT",
        "YUUVIS_MANAGE_SETTINGS",
        "YUUVIS_AI_PIPELINE",
        "COMPLIANCE_MANAGER",
        "YUUVIS_AI_PREDICT"
      ],
      "groups": [
        "onlyoffice"
      ],
      "username": "kammer",
      "enabled": true,
      "createdTimestamp": 1591957723730
    },
    {
      "id": "a6f5e1aa-ff42-4140-b9ec-5de4cc61f1a9",
      "email": "schwimmer@segelreisen.de",
      "firstName": "Klaus",
      "lastName": "Schwimmer",
      "roles": [
        "YUUVIS_SYSTEM_INTEGRATOR",
        "YUUVIS_DEFAULT",
        "INVOICE_MANAGER",
        "YUUVIS_TENANT_ADMIN",
        "HR_MANAGER",
        "YUUVIS_AIINVOICE",
        "EMAIL_WITHOUT_ACL",
        "QA_MEMBER_AREA2",
        "uma_authorization",
        "YUUVIS_CREATE_OBJECT",
        "TEAMS_MANAGER",
        "PHOTOARCHIVE_MANAGER",
        "YUUVIS_MANAGE_SETTINGS",
        "QA_MANAGER",
        "ACL_ALL_USERS",
        "YUUVIS_AI_PIPELINE",
        "QA_MEMBER_AREA1",
        "COMPLIANCE_MANAGER",
        "YUUVIS_AI_PREDICT",
        "offline_access"
      ],
      "username": "klaus",
      "enabled": true,
      "createdTimestamp": 1606820894094
    }
  ],
  "numItems": 3,
  "totalNumItems": 89,
  "hasMoreItems": true
}