Create group

Description

Creates one or more new CloudShell groups.

HTTP method

POST

Request

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

Example header format:

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

Content-Type: application/json

Parameter Description/Comments
Name (string) Group name.
Description (string) Group description.

ViewOnly

(bool)

groupType

 

groupRole

Group's role. Possible values are: External, Regular, DomainAdmin, SystemAdmin

Id

 

 
{
  "Groups": [
    {
      "Name": "my group",
      "Description": "my test group",
      "ViewOnly": false,
      "groupType": 0,
      "groupRole": "Regular",
      "Id": 0
    }
  ]
}

Response

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

201 Created