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

As of Version product version 2021 Autumn | component version 1.0

Request Method POST

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

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

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 Code	Meaning
`201 CREATED`	Successful, the user has been created with the specified properties.
`401 UNAUTHORIZED`	The 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"
}

yuuvis® Momentum

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

Analytics

Related content