DescribeClientAuthenticationSettingsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DirectoryServiceClient, DescribeClientAuthenticationSettingsCommand } from "@aws-sdk/client-directory-service"; // ES Modules import
// const { DirectoryServiceClient, DescribeClientAuthenticationSettingsCommand } = require("@aws-sdk/client-directory-service"); // CommonJS import
const client = new DirectoryServiceClient(config);
const input = { // DescribeClientAuthenticationSettingsRequest
  DirectoryId: "STRING_VALUE", // required
  Type: "SmartCard" || "SmartCardOrPassword",
  NextToken: "STRING_VALUE",
  Limit: Number("int"),
};
const command = new DescribeClientAuthenticationSettingsCommand(input);
const response = await client.send(command);
// { // DescribeClientAuthenticationSettingsResult
//   ClientAuthenticationSettingsInfo: [ // ClientAuthenticationSettingsInfo
//     { // ClientAuthenticationSettingInfo
//       Type: "SmartCard" || "SmartCardOrPassword",
//       Status: "Enabled" || "Disabled",
//       LastUpdatedDateTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeClientAuthenticationSettingsCommand Input

See DescribeClientAuthenticationSettingsCommandInput for more details

Parameter
Type
Description
DirectoryId
Required
string | undefined

The identifier of the directory for which to retrieve information.

Limit
number | undefined

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.

NextToken
string | undefined

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

Type
ClientAuthenticationType | undefined

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.

DescribeClientAuthenticationSettingsCommand Output

See DescribeClientAuthenticationSettingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ClientAuthenticationSettingsInfo
ClientAuthenticationSettingInfo[] | undefined

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.

NextToken
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ClientException
client

A client exception has occurred.

DirectoryDoesNotExistException
client

The specified directory does not exist in the system.

InvalidParameterException
client

One or more parameters are not valid.

ServiceException
server

An exception has occurred in Directory Service.

UnsupportedOperationException
client

The operation is not supported.

DirectoryServiceServiceException
Base exception class for all service exceptions from DirectoryService service.