Modifies the privilege elevation application group by adding or removing rules

Updates the privilege application group by adding new rules or removing existing ones. Prefetch vendorID or productVendorID from Get App Rule Types for new rules, and prefetch appRuleID from Get Privilege Application Group for rules to remove.

Endpoints

post /dcapi/appctrl/privilegeAppGroup

Copy full URL

Request URL

https://{serverurl}/dcapi/appctrl/privilegeAppGroup

Scope

DesktopCentralCloud.AppControl.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/addUpdatePrivilegeAppGroup.v1+jsonCopied!

AcceptstringMandatory

application/addUpdatePrivilegeAppGroup.v1+jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

jitRequestModestringMandatory

JIT request mode (0=Disabled, 1=Enabled, 2=Approval Required)

configSpecificAppEnabledbooleanMandatory

Whether config-specific app elevation is enabled

appGroupTypeintegerMandatory

Type of application group (3=Privilege)

addedRulesJSON ArrayMandatory

Rules to add

Show Sub-Attributes

JSON Object

Show Sub-Attributes

appRuleTypelongMandatory

Rule type (1=Vendor, 2=Product, 3=Executable, 4=FileHash)

verifiedAppRepoIDsarrayOptional

Verified repository IDs (vendorID or productVendorID) — prefetch from Get Child Process Types (Omit this parameter if you are not adding any verified IDs.)

unVerifiedAppRepoIDsarrayOptional

Unverified repository IDs - prefetch from Get Child Process Types (Omit this parameter if you are not adding any unverified IDs.)

removedRulesJSON ArrayMandatory

Rules to remove

Show Sub-Attributes

JSON Object

Show Sub-Attributes

appRuleTypelongMandatory

Rule type (1=Vendor, 2=Product, 3=Executable, 4=FileHash)

appRuleIDsarrayMandatory

App Rule IDs Prefetch from Get Privileage App Group

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/dcapi/appctrl/privilegeAppGroup \
  --header 'Accept: application/addUpdatePrivilegeAppGroup.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/addUpdatePrivilegeAppGroup.v1+json' \
  --data '{"removedRules":[{"appRuleType":1,"appRuleIDs":[610]}],"appGroupType":3,"configSpecificAppEnabled":true,"jitRequestMode":"2","addedRules":[{"appRuleType":2}]}'

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://appdomains/dcapi/appctrl/privilegeAppGroup"))
        .header("Content-Type", "application/addUpdatePrivilegeAppGroup.v1+json")
        .header("Accept", "application/addUpdatePrivilegeAppGroup.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"removedRules\":[{\"appRuleType\":1,\"appRuleIDs\":[610]}],\"appGroupType\":3,\"configSpecificAppEnabled\":true,\"jitRequestMode\":\"2\",\"addedRules\":[{\"appRuleType\":2}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"removedRules\":[{\"appRuleType\":1,\"appRuleIDs\":[610]}],\"appGroupType\":3,\"configSpecificAppEnabled\":true,\"jitRequestMode\":\"2\",\"addedRules\":[{\"appRuleType\":2}]}"

headers = {
    'Content-Type': "application/addUpdatePrivilegeAppGroup.v1+json",
    'Accept': "application/addUpdatePrivilegeAppGroup.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/appctrl/privilegeAppGroup", payload, headers)

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

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


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

    data=Map();
    data_removedRules=List();
    data_removedRules_item1=Map();
    data_removedRules_item1.put("appRuleType","1");
    data_removedRules_item1_appRuleIDs=List();
    data_removedRules_item1.put("appRuleIDs",data_removedRules_item1_appRuleIDs);
    data_removedRules.add(data_removedRules_item1);
    data.put("removedRules",data_removedRules);
    data.put("appGroupType","1");
    data.put("configSpecificAppEnabled",true);
    data.put("jitRequestMode","value");
    data_addedRules=List();
    data_addedRules_item1=Map();
    data_addedRules_item1.put("appRuleType","1");
    data_addedRules.add(data_addedRules_item1);
    data.put("addedRules",data_addedRules);

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/appctrl/privilegeAppGroup"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/addUpdatePrivilegeAppGroup.v1+json")
$headers.Add("Accept", "application/addUpdatePrivilegeAppGroup.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/appctrl/privilegeAppGroup' -Method POST -Headers $headers -ContentType 'application/addUpdatePrivilegeAppGroup.v1+json' -Body '{"removedRules":[{"appRuleType":1,"appRuleIDs":[610]}],"appGroupType":3,"configSpecificAppEnabled":true,"jitRequestMode":"2","addedRules":[{"appRuleType":2}]}'

Sample Request Body

Update privilege group — add product rules and remove existing vendor rules

Copied!

  {
    "removedRules": [
      {
        "appRuleType": 1,
        "appRuleIDs": [
          610
        ]
      }
    ],
    "appGroupType": 3,
    "configSpecificAppEnabled": true,
    "jitRequestMode": "2",
    "addedRules": [
      {
        "appRuleType": 2,
        "verifiedAppRepoIDs": [
          700
        ]
      }
    ]
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusboolean

Whether the operation completed successfully (true=success, false=failure)

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodestring

Internal error code: INTERNAL_ERROR when exception occurs updating privilege app group

errorMessagestring

Detailed message: Error Occurred while add or update privilege app group

Possible Response Codes

200HTTP code

401HTTP code

500HTTP code

Sample Response: HTTP 200

Privilege application group updated successfully

Copied!

  {
    "status": true
  }

▼ Show full

Sample Response: HTTP 401

Authentication credentials missing or invalid

Copied!

  {
    "errorMessage": "Authentication credentials are missing or invalid",
    "errorCode": "UNAUTHORIZED"
  }

▼ Show full

Sample Response: HTTP 500

Internal error while updating privilege app group

Copied!

  {
    "errorMessage": "Error Occurred while add or update privilege app group",
    "errorCode": "INTERNAL_ERROR"
  }

▼ Show full

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