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

Owned by Technische Redaktion
Nov 12, 2021
As of Versionproduct version 2021 Autumn | component version 1.0
Request MethodPOST
Response FormatJSON
Description

Creates a new group with the given properties for the specified tenant.

Required user role: YUUVIS_SYSTEM_INTEGRATOR

The properties for the new group are passed in JSON format. In the response body, 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 specified 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/system/tenants/{mytenant}/groups HTTP/1.1

{
  "name": "QA",
  "realmRoles": [
    "QUALITY_MANAGER",
    "CUSTOM_ROLE"
  ]
}

Response Example
{
  "id": "a00a0bb1-1234-5c66-7890-00fbb1c1a222"
}