Skip to content

create-group.md

Latest commit

 

History

History
87 lines (64 loc) · 1.27 KB

create-group.md

File metadata and controls

87 lines (64 loc) · 1.27 KB
sidebar_position 18

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
Parameter Description/Comments
Name (string) Group name.
Description (string) Group description.
GroupRole Group'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