GET /tenant-management/api/system/tenants/{tenant}/groups

As of Version product version 2021 Autumn | 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

Retrieves all groups of the specified tenant with the assigned roles and members.

Meaning of the response status codes:

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

Request Example

GET /tenant-management/api/system/tenants/myTenant/groups HTTP/1.1

Result Example

[
  {
    "id": "fa854da5-004a-5187-9cc6-3b5c5bc2c728",
    "name": "HR-Manager",
    "realmRoles": [
      "EMAIL_WITHOUT_ACL"
    ],
    "members": [
      "gustav"
    ]
  },
  {
    "id": "dab12224-4e4a-5e23-06e8-ffd3ed17cff7",
    "name": "QA-Manager",
    "realmRoles": [
      "QA_MANAGER"
    ],
   "members": [
     "susanne",
     "gustav"
   ]
  }
...
]

{