GET /tenant-management/api/idm/roles/{role}/users

Owned by Technische Redaktion
Last updated: Feb 13, 2023
3 min read
As of Version

product version 2021 Winter | component version 

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

Retrieves a list of users that have the specified role assigned to them.

Optionally, a boolean value for the query parameter briefRepresentation can be specified:

  • If true (default), the following parameters will be returned for each user: id, email, firstName, lastName, username, enabled, createdTimestamp.
  • If false, the following parameters will be additionally included: roles, groups.

>> User Management via Endpoints


Request Example
https://<host>/tenant-management/api/idm/roles/YUUVIS_TENANT_ADMIN/users?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
}