API Actions: ActivateActiveDirectory

Supported in product version 12.37 and above

This method allows system-wide activation of Active Directory (OS level activation is required prior to this application level activation), in order to create/alter replications with Activation Directory authentication against source and destination/replica database servers. Also see /api/ActivateDirectoryStatus & /api/DectivateActiveDirectory

XML

POST /api/ActivateActiveDirectory 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

<?xml version="1.0" encoding="utf-8"?>
<ActivateActiveDirectoryRequest>
	<Username>your-username</Username>
	<Password>your-password</Password>
</ActivateActiveDirectoryRequest>

JSON

POST /api/ActivateActiveDirectory HTTP/1.1
Host: use.your.host.name:82
X-Amz-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Content-Type: application/json
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

{
	"username": "your-username",
	"password": "your-password"
}

Request Parameters

Parameter	Description	Required
Username	A character string that represents a valid user name.	Yes
Username	Type: String Default: None	Yes
Password	The default password that will be used when trying to login to the CloudBasic console.	Yes
Password	Type: String Default: None	Yes

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

JSON

HTTP/1.1 200
status: 200
{
}

Response Parameters

None

Error Response Syntax:

XML

HTTP/1.1 400
status: 400

<?xml version="1.0" encoding="utf-8"?>
<ErrorResponse> 
  <RequestId>request-id</RequestId> 
  <Errors> 
    <Error> Failed to activate Active Directory. Please check Username/Password. </Error> 
  </Errors> 
</ErrorResponse>

JSON

HTTP/1.1 400
status: 400

{
    "errors": [
        "Failed to activate Active Directory. Please check Username/Password."
    ],
    "requestId": "21"
}