Describe Client Authentication Settings

directoryservice_describe_client_authentication_settings

R Documentation

Retrieves information about the type of client authentication for the specified directory, if the type is specified¶

Description¶

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.

Usage¶

directoryservice_describe_client_authentication_settings(DirectoryId,
  Type, NextToken, Limit)

Arguments¶

DirectoryId: [required] The identifier of the directory for which to retrieve information.
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.
NextToken: The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to describe_client_authentication_settings. Pass null if this is the first call.
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.

Value¶

A list with the following syntax:

list(
  ClientAuthenticationSettingsInfo = list(
    list(
      Type = "SmartCard"|"SmartCardOrPassword",
      Status = "Enabled"|"Disabled",
      LastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_client_authentication_settings(
  DirectoryId = "string",
  Type = "SmartCard"|"SmartCardOrPassword",
  NextToken = "string",
  Limit = 123
)