create_workgroup

The create_workgroup method creates a new workgroup in a specified domain.

Syntax

{
    <credentials object>, 
    "domain": <domain name>, 
    "workgroup": <workgroup name>
}

Request fields for create_workgroup

The following fields can be used in the create_workgroup method:

Field name

Obligation

Definition/Value

domain

Required

The domain under which you want to create the workgroup.

workgroup

Required

The name of the new workgroup.

Response fields for create_workgroup

The following fields may be returned in response to the create_workgroup method:

Field name

Obligation

Description/Value

error

Returned if success = false

A text string that explains the error.

error_number

Returned if success = false

A number that represents the error.

success

Always returned

Indicates whether the request was successful or not. Allowed values are true and false.

Examples for create_workgroup

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "pencil75"
  },
  "domain": "example.com",
  "workgroup": "finance"
}

Response

{
   "success": true
}