Retrieve the list of groups associated with a fence policy

returns list of groups associated

Endpoints

get /api/v1/mdm/compliance/{compliance_id}/groups

Copy full URL

Request URL

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

Scope

MDMInventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

compliance_idstringMandatory

Unique identifier of the compliance policy. Obtain from the Add Fence Policy or Get Fence Policies response

- Query Parameters

group_typestringOptional

Filter groups by type. Allowed values: 1=Static, 2=Dynamic, 3=Static Unique

searchstringOptional

Free-text search string applied to the default searchable fields of the resource

select_allbooleanOptional

When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false

group_categorystringOptional

Filter groups by category. Allowed values: 1=Device Group, 2=User Group, 3=Custom Group

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url 'https://appdomain/api/v1/mdm/compliance/{compliance_id}/groups?group_type=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&group_category=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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/compliance/{compliance_id}/groups?group_type=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&group_category=SOME_STRING_VALUE"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

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

conn.request("GET", "/api/v1/mdm/compliance/{compliance_id}/groups?group_type=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&group_category=SOME_STRING_VALUE", headers=headers)

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

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


    parameters = "group_type=value" + "&" + "search=value" + "&" + "select_all=value" + "&" + "group_category=value";

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

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/compliance/{compliance_id}/groups" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/compliance/{compliance_id}/groups?group_type=SOME_STRING_VALUE&search=SOME_STRING_VALUE&select_all=SOME_BOOLEAN_VALUE&group_category=SOME_STRING_VALUE' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

group_listJSON Array

Array of group information objects associated with the compliance policy

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_idlong

Unique identifier of the group

group_namestring

Name of the group

group_typeinteger

Type of the group (numeric code representing group classification)

member_countinteger

Count of members (devices) in the group

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Fence policy associated with multiple groups showing group details and member counts

Copied!

  {
    "group_list": [
      {
        "group_id": 9007199254741084,
        "group_name": "ComplianceGroup",
        "group_type": 6,
        "member_count": 1
      },
      {
        "group_id": 9007199254741086,
        "group_name": "Engineering Devices",
        "group_type": 6,
        "member_count": 12
      }
    ]
  }

▼ Show full

No groups associated with the specified fence policy

Copied!

  {
    "group_list": []
  }

▼ Show full

Duration: 1 minute | Threshold: 120 | 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.