AD Integration

Get

Retrieve AD Integration Settings.

GET/api/ADIntegrationSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

siteIdinteger (int32)

The site ID to which the AD integration settings refer to.

certificateAuthoritynullable string

Certificate authority

enrollmentAgentUsernamenullable string

Principal name in UPN format that will enroll certificates on behalf of other users.

nlaUsernamenullable string

Username of the network level authentication

Request

JavaScriptCurlPython

const response = await fetch('/api/ADIntegrationSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "certificateAuthority": "text",
  "enrollmentAgentUsername": "text",
  "nlaUsername": "text"
}

Update

Modify AD Integration Settings.

PUT/api/ADIntegrationSettings

Query parameters

Body

application/json; api-version=1.0

AD Integration Settings.

certificateAuthoritynullable string

Certificate authority

enrollmentAgentUsernamenullable string

Username of the enrollment agent

enrollmentAgentPasswordnullable string

Password of the account specified in the EnrollmentAgentUsername parameter.

nlaUsernamenullable string

Principal name in UPN format used to initialize the RDP session.

nlaPasswordnullable string

Password of the account specified in the NLAUsername parameter.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ADIntegrationSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}