RegisterCertificate - Amazon Directory Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Registers a certificate for a secure LDAP or client certificate authentication.

Request Syntax

{ "CertificateData": "string", "ClientCertAuthSettings": { "OCSPUrl": "string" }, "DirectoryId": "string", "Type": "string" }

Request Parameters

The request accepts the following data in JSON format.


The certificate PEM string that needs to be registered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Required: Yes


A ClientCertAuthSettings object that contains client certificate authentication settings.

Type: ClientCertAuthSettings object

Required: No


The identifier of the directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes


The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

Type: String

Valid Values: ClientCertAuth | ClientLDAPS

Required: No

Response Syntax

{ "CertificateId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The identifier of the certificate.

Type: String

Pattern: ^c-[0-9a-f]{10}$


For information about the errors that are common to all actions, see Common Errors.


The certificate has already been registered into the system.

HTTP Status Code: 400


The certificate could not be added because the certificate limit has been reached.

HTTP Status Code: 400


A client exception has occurred.

HTTP Status Code: 400


The specified directory does not exist in the system.

HTTP Status Code: 400


The specified directory is unavailable or could not be found.

HTTP Status Code: 400


The certificate PEM that was provided has incorrect encoding.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in Amazon Directory Service.

HTTP Status Code: 500


The operation is not supported.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: