Modify an existing ADCS server configuration

Update the individual AD Certificate server details

Endpoints

put /api/v1/mdm/adcs/servers/{ad_config_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/adcs/servers/{ad_config_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

ad_config_idstringMandatory

Unique identifier of the ADCS configuration to modify. Use the ad_config_id from the Add ADCS Server API response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

ad_config_namestringMandatory

Name of the ADCS configuration. Must be unique across the organization

cert_server_addressstringMandatory

URL of the ADCS server (e.g., http://adcs.zylker.com/certsrv/)

cert_authoritystringMandatory

Common Name (CN) of the Certificate Authority (e.g., CN=ZylkerCA-SERVER-CA)

cert_template_namestringMandatory

Template name of the certificate configured in the ADCS server

descriptionstringOptional

Description of the ADCS server configuration. Defaults to '--' if not provided

cert_exp_notify_threadintegerOptional

Number of days before certificate expiry to notify. Defaults to 14 if not provided

rsa_key_sizeintegerOptional

RSA key size for the certificate. Allowed values: 0 (1024), 1 (2048), 2 (4096). Defaults to 1 (2048) if not provided

auto_renew_enabledbooleanOptional

Whether auto-renewal is enabled for the certificate. Defaults to false if not provided

allow_all_apps_to_accessbooleanOptional

Whether all apps can access the certificate. Defaults to false if not provided

is_key_extractablebooleanOptional

Whether the private key is extractable. Defaults to false if not provided

redistribute_profilesbooleanOptional

Whether to redistribute associated profiles after modification. Defaults to false if not provided

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/adcs/servers/{ad_config_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"ad_config_name":"computer_1_updated","cert_authority":"CN=zylker-SERVER-CA2","auto_renew_enabled":true,"cert_exp_notify_thread":14,"is_key_extractable":false,"allow_all_apps_to_access":true,"description":"Updated ADCS server configuration","cert_template_name":"computer_1","cert_server_address":"http://cert.zylker.com/certsrv/","rsa_key_size":1,"redistribute_profiles":false}'

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/adcs/servers/{ad_config_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"ad_config_name\":\"computer_1_updated\",\"cert_authority\":\"CN=zylker-SERVER-CA2\",\"auto_renew_enabled\":true,\"cert_exp_notify_thread\":14,\"is_key_extractable\":false,\"allow_all_apps_to_access\":true,\"description\":\"Updated ADCS server configuration\",\"cert_template_name\":\"computer_1\",\"cert_server_address\":\"http://cert.zylker.com/certsrv/\",\"rsa_key_size\":1,\"redistribute_profiles\":false}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"ad_config_name\":\"computer_1_updated\",\"cert_authority\":\"CN=zylker-SERVER-CA2\",\"auto_renew_enabled\":true,\"cert_exp_notify_thread\":14,\"is_key_extractable\":false,\"allow_all_apps_to_access\":true,\"description\":\"Updated ADCS server configuration\",\"cert_template_name\":\"computer_1\",\"cert_server_address\":\"http://cert.zylker.com/certsrv/\",\"rsa_key_size\":1,\"redistribute_profiles\":false}"

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

conn.request("PUT", "/api/v1/mdm/adcs/servers/{ad_config_id}", 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("ad_config_name","value");
    data.put("cert_server_address","value");
    data.put("cert_authority","value");
    data.put("cert_template_name","value");
    data.put("description","value");
    data.put("cert_exp_notify_thread","1");
    data.put("rsa_key_size","1");
    data.put("auto_renew_enabled",true);
    data.put("allow_all_apps_to_access",true);
    data.put("is_key_extractable",true);
    data.put("redistribute_profiles",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/adcs/servers/{ad_config_id}"
        type: PUT
        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/adcs/servers/{ad_config_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"ad_config_name":"computer_1_updated","cert_authority":"CN=zylker-SERVER-CA2","auto_renew_enabled":true,"cert_exp_notify_thread":14,"is_key_extractable":false,"allow_all_apps_to_access":true,"description":"Updated ADCS server configuration","cert_template_name":"computer_1","cert_server_address":"http://cert.zylker.com/certsrv/","rsa_key_size":1,"redistribute_profiles":false}'

Sample Request Body

Modify an existing ADCS server configuration

Copied!

  {
    "ad_config_name": "computer_1_updated",
    "cert_authority": "CN=zylker-SERVER-CA2",
    "auto_renew_enabled": true,
    "cert_exp_notify_thread": 14,
    "is_key_extractable": false,
    "allow_all_apps_to_access": true,
    "description": "Updated ADCS server configuration",
    "cert_template_name": "computer_1",
    "cert_server_address": "http://cert.zylker.com/certsrv/",
    "rsa_key_size": 1,
    "redistribute_profiles": false
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

ad_config_idlong

Unique identifier of the modified ADCS configuration

- HTTP code 400

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

Error code: ADCS0001 — ADCS configuration name already exists

error_descriptionstring

Human-readable error description

localized_error_descriptionstring

Localized error description for display

Possible Response Codes

200HTTP code

400HTTP code

Sample Response: HTTP 200

ADCS server configuration successfully modified

Copied!

  {
    "ad_config_id": 9007199254740996
  }

▼ Show full

Sample Response: HTTP 400

ADCS configuration name already exists

Copied!

  {
    "error_description": "ADCS configuration name already exists.",
    "error_code": "ADCS0001",
    "localized_error_description": "ADCS configuration name already exists."
  }

▼ Show full

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