AD Integration | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieve AD Integration Settings.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to retrieve the AD Integration Settings. (optional)

Responses

application/json; api-version=1.0

objectOptional

AD Integration Settings

application/json; api-version=1.0

get

GET /api/ADIntegrationSettings HTTP/1.1
Host: 
Accept: */*

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

Update

put

Modify AD Integration Settings.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to modify the AD Integration Settings. (optional)

Body

Update the AD integration settings

certificateAuthoritystring | nullableOptional

Certificate authority

enrollmentAgentUsernamestring | nullableOptional

Username of the enrollment agent

enrollmentAgentPasswordstring | nullableOptional

Password of the account specified in the EnrollmentAgentUsername parameter.

nlaUsernamestring | nullableOptional

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

nlaPasswordstring | nullableOptional

Password of the account specified in the NLAUsername parameter.

Responses

application/json; api-version=1.0

put

PUT /api/ADIntegrationSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 139

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

No content