DirectoryService / Client / describe_client_authentication_settings

describe_client_authentication_settings#

DirectoryService.Client.describe_client_authentication_settings(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_client_authentication_settings(
    DirectoryId='string',
    Type='SmartCard'|'SmartCardOrPassword',
    NextToken='string',
    Limit=123
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory for which to retrieve information.

  • Type (string) – 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 (string) – The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.

  • Limit (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ClientAuthenticationSettingsInfo': [
        {
            'Type': 'SmartCard'|'SmartCardOrPassword',
            'Status': 'Enabled'|'Disabled',
            'LastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ClientAuthenticationSettingsInfo (list) –

      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.

      • (dict) –

        Contains information about a client authentication method for a directory.

        • Type (string) –

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

        • Status (string) –

          Whether the client authentication type is enabled or disabled for the specified directory.

        • LastUpdatedDateTime (datetime) –

          The date and time when the status of the client authentication type was last updated.

    • NextToken (string) –

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

Exceptions

  • DirectoryService.Client.exceptions.DirectoryDoesNotExistException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.AccessDeniedException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException