GET /tenant-management/api/admin/groups

Owned by Team Kolibri (Unlicensed)
Last updated: May 10, 2022 by Technische Redaktion
1 min read
As of Versionproduct version 2021 Autumn | 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_TENANT_ADMIN role.

>> AUTHENTICATION Service
Description

Retrieves all groups with the assigned roles and members for the tenant.

Meaning of the response status codes:
HTTP Status CodeMeaning
200 OKSuccessful, all roles have been read.
401 UNAUTHORIZEDThe call was unauthorized.
Request Example

GET /tenant-management/api/admin/groups HTTP/1.1

Response 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"
   ]
  }
...
]