API Actions: ActiveDirectoryStatus

API Actions: ActiveDirectoryStatus

Supported in product version 12.37 and above

This method  allows to confirm application level activation/deactivation of Active Directory (OS level activation is required prior to application level Active Directory activation). Also see /api/ActivateActiveDirectory & /api/DeactivateActiveDirectory.


Request Syntax:

POST /api/ActiveDirectoryStatus HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/xml
X-Amz-Date: 20171115T202130Z
Authorization: AWS4-HMAC-SHA256 Credential= UQOPWUVNBALABCABCABC/20171115/us-east-1/cloudbasic/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date, Signature=995374189c189e8e68ed3de82c1764ca11971711fb5179eeab2b19edd883dd74

 

Request Parameters

None

 

Request Headers

This implementation uses only request headers that are common to all operations. For more information please see the section Common Request Headers

Response Syntax:

XML

HTTP/1.1 200
status: 200

<?xml version="1.0" encoding="utf-8"?>

<ActiveDirectoryStatusResponse>
    <RequestTimestamp>Friday, August 16, 2019 10:25:43 PM</RequestTimestamp>
    <Status>Activated</Status>
    <RemoteStatus>Activated</RemoteStatus>
</ActiveDirectoryStatusResponse>

JSON

HTTP/1.1 200
status: 200
{
    "requestTimestamp": "Friday, August 16, 2019 10:25:43 PM",
    "status": "Activated",
    "remoteStatus": "Activated"
}

Response Parameters

Parameter Description Optional
RequestTimestamp ???????? No
Status The current status of the Active Directory. Possible values include:

  • Activated
  • ????????
 No
RemoteStatus The remote status of the Active Directory. Possible values include:

  • Activated
  • ????????
 No

 

Error Response Syntax:

HTTP/1.1 400
status: 400