Skip to main content
Version: 2023.3

Create group

Description

Creates one or more new CloudShell groups.

URL

http://{Admin API IP}:{port#}/api/v1/groups

HTTP method

POST

Request

Headers

Example header format:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Request body
ParameterDescription/Comments
Name(string) Group name.
Description(string) Group description.
GroupRoleGroup's role. Possible values are: External, Regular, DomainAdmin
Request example
{
"Groups": [
{
"Name": "my group",
"Description": "my test group",
"groupRole": "Regular"
}
]
}

Response

Response example
{
"Groups": [
{
"Name": "mygroup",
"Description": "my test group",
"ViewOnly": false,
"groupType": "UserDefined",
"groupRole": "Regular",
"Id": 7
}
],
"Errors": []
}
Response code
201 Created