DirectoryService / Client / register_certificate

register_certificate#

DirectoryService.Client.register_certificate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.register_certificate(
    DirectoryId='string',
    CertificateData='string',
    Type='ClientCertAuth'|'ClientLDAPS',
    ClientCertAuthSettings={
        'OCSPUrl': 'string'
    }
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory.

  • CertificateData (string) –

    [REQUIRED]

    The certificate PEM string that needs to be registered.

  • Type (string) – The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

  • ClientCertAuthSettings (dict) –

    A ClientCertAuthSettings object that contains client certificate authentication settings.

    • OCSPUrl (string) –

      Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.

Return type:

dict

Returns:

Response Syntax

{
    'CertificateId': 'string'
}

Response Structure

  • (dict) –

    • CertificateId (string) –

      The identifier of the certificate.

Exceptions

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.DirectoryDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidCertificateException

  • DirectoryService.Client.exceptions.CertificateLimitExceededException

  • DirectoryService.Client.exceptions.CertificateAlreadyExistsException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException