POST /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 MethodPOST
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

Creates a new group for the tenant with the properties specified in the JSON request body.

In the response, the group ID is returned again in JSON format.

The only required parameter is name for the group name. If roles should be assigned the given realmRoles must exist.

Meaning of the response status codes:
HTTP Status CodeMeaning
201 CREATEDSuccessful, the user has been created with the specified properties.
401 UNAUTHORIZEDThe call was unauthorized.
Request Example

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

{
  "name": "QA",
  "realmRoles": [
    "QUALITY_MANAGER",
    "CUSTOM_ROLE"
  ]
}
Response Example
{
  "id": "a00a0bb1-1234-5c66-7890-00fbb1c1a222"
}