Create a new group for managing devices

Creation of group

Endpoints

post /api/v1/mdm/groups

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/groups

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

namestringMandatory

Name of the group. Must be unique within the customer

group_typeintegerMandatory

Type of group: 6 — Device Group, 7 — User Group/AD Group

domainstringOptional

Domain in which the group exists (applicable if Active Directory is synced)

descriptionstringOptional

Description of the group

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/groups \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"domain":"ZYLKERCORP","name":"MDM","description":"Group for MDM","group_type":1}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/groups"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"domain\":\"ZYLKERCORP\",\"name\":\"MDM\",\"description\":\"Group for MDM\",\"group_type\":1}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"domain\":\"ZYLKERCORP\",\"name\":\"MDM\",\"description\":\"Group for MDM\",\"group_type\":1}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/groups", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("name","value");
    data.put("group_type","1");
    data.put("domain","value");
    data.put("description","value");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/groups"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"domain":"ZYLKERCORP","name":"MDM","description":"Group for MDM","group_type":1}'

Sample Request Body

Create a group with domain and description

Copied!

  {
    "domain": "ZYLKERCORP",
    "name": "MDM",
    "description": "Group for MDM",
    "group_type": 1
  }

▼ Show full

Create a group with only required fields

Copied!

  {
    "domain": "",
    "name": "Sales Devices",
    "description": "",
    "group_type": 1
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

group_idlong

Unique identifier for the newly created group

namestring

Name of the created group

group_typeinteger

Type of group

domainstring

Domain in which the group exists

descriptionstring

Description of the group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Group successfully created

Copied!

  {
    "group_id": 99731238129,
    "domain": "ZYLKERCORP",
    "name": "MDM",
    "description": "Group for MDM",
    "group_type": 1
  }

▼ Show full

Duration: 1 minute | Threshold: 300 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.