Validate AWS

Verify

post

Validate the AD Integration Settings for AWS Private Certificate Authority.

Query parameters

enrollmentServerIdinteger · int32Optional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID in which to modify the specified server.

Body

application/json; api-version=1.0

To invoke validate AD Integration Settings for AWS Private Certificate Authority

certificateAuthoritystring · min: 1 · max: 255 · nullableOptional

Certificate authority

enrollmentAgentUsernamestring · min: 1 · max: 255 · nullableOptional

Username of the enrollment agent

enrollmentAgentPasswordstring · nullableOptional

Password of the account specified in the EnrollmentAgentUsername parameter.

nlaUsernamestring · min: 1 · max: 255 · nullableOptional

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

accessKeyIdstring · min: 1 · max: 255 · nullableOptional

Access Key ID (AWS Private CA)

secretAccessKeystring · nullableOptional

Secret Access Key (AWS Private CA)

regionstring · min: 1 · max: 255 · nullableOptional

Region (AWS Private CA).

Responses

200

Success

application/json; api-version=1.0

AD Integration Settings

siteIdinteger · int32Optional

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

certificateAuthoritystring · nullableOptionalDeprecated

Certificate authority

enrollmentAgentUsernamestring · nullableOptional

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

nlaUsernamestring · nullableOptional

Username of the network level authentication

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post/api/ADIntegrationSettings/ValidateAWS

HTTPcURLJavaScriptPython

POST /api/ADIntegrationSettings/ValidateAWS HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 180

{
  "certificateAuthority": "text",
  "enrollmentAgentUsername": "text",
  "enrollmentAgentPassword": "text",
  "nlaUsername": "text",
  "accessKeyId": "text",
  "secretAccessKey": "text",
  "region": "text"
}

{
  "siteId": 1,
  "enrollmentAgentUsername": "text",
  "nlaUsername": "text",
  "caSettings": {
    "caType": [
      "0 = MicrosoftADCS",
      "1 = AWSPrivateCA"
    ],
    "certificateAuthority": "text",
    "region": "text",
    "useSameAccessKeyAsProvider": true,
    "providerId": 1,
    "accessKeyId": "text"
  }
}