POST /tenant-management/api/admin/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 for the tenant with the properties specified in the JSON request body.

Required user role: YUUVIS_TENANT_ADMIN

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"
}