DescribeClientAuthenticationSettings - AWS Directory Service

DescribeClientAuthenticationSettings

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

Request Syntax

{ "DirectoryId": "string", "Limit": number, "NextToken": "string", "Type": "string" }

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The identifier of the directory for which to retrieve information.

Type: String

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

Required: Yes

Limit

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings . Pass null if this is the first call.

Type: String

Required: No

Type

The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

Type: String

Valid Values: SmartCard

Required: No

Response Syntax

{ "ClientAuthenticationSettingsInfo": [ { "LastUpdatedDateTime": number, "Status": "string", "Type": "string" } ], "NextToken": "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.

ClientAuthenticationSettingsInfo

Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

Type: Array of ClientAuthenticationSettingInfo objects

NextToken

The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

Type: String

Errors

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

AccessDeniedException

Client authentication is not available in this region at this time.

HTTP Status Code: 400

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400

See Also

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