Request

POST /pub/v1/scheme/namespaces/{namespace}/groups

Path parameters

Parameter name Value Description Additional
namespace string

Code of the group’s workspace

Required

Request body

The resource sent in the request body is  Create a group’s metadata description — Request. It contains the following writable properties:

{
    "__name": "string",
    "description": "string",
    "isDefault": "boolean",
    "isRole": "boolean"
}

Properties

Name Type Description Additional
__name string

Name

description string

Group description

Optional
isDefault boolean

Assign the group to all new users

Optional
isRole boolean

Role flag

Optional

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned:

Status code Description Resource
200 OK

Response model for creating a metadata description of a group

Response model for creating a metadata description of a group (Create a group’s metadata description)