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

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 role for the specified tenant with the properties specified in JSON format in the request body.

The properties for the new role are passed in JSON format.

The only required parameters are name for the role and its description.

Meaning of the response status codes:

HTTP Status Code	Meaning
`201 CREATED`	Successful, the role has been created with the specified properties.
`401 UNAUTHORIZED`	The call was unauthorized.

Request Example

POST /tenant-management/api/system/tenants/mytenant/roles HTTP/1.1

{
  "description": "This is a new role",
  "name": "MY_NEW_ROLE"
}

Response Example

{
  "errors": [],
  "valid": true
}

yuuvis® Momentum

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

Analytics

Related content