Skip to content

describe_client_authentication_settings

describe_client_authentication_settings(
    directory_id: DirectoryId,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
    type: Optional[ClientAuthenticationType] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[PageLimit] = None,
) -> DescribeClientAuthenticationSettingsResult

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.

Parameters:

  • directory_id (DirectoryId) –

    The identifier of the directory for which to retrieve information.

  • type (Optional[ClientAuthenticationType], default: None ) –

    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.

  • next_token (Optional[NextToken], default: None ) –

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

  • limit (Optional[PageLimit], default: None ) –

    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.

Raises:

Source code in docs_src/capo_directory_service/_services/directory_service.py
def describe_client_authentication_settings(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
    type: Optional[
        "capo_directory_service.types.client_authentication_type.ClientAuthenticationType"
    ] = None,
    next_token: Optional[
        "capo_directory_service.types.next_token.NextToken"
    ] = None,
    limit: Optional["capo_directory_service.types.page_limit.PageLimit"] = None,
) -> "capo_directory_service.types.describe_client_authentication_settings_result.DescribeClientAuthenticationSettingsResult":
    """<p>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 <code>SmartCard</code> is supported. </p>

    Args:
        directory_id: <p>The identifier of the directory for which to retrieve information.</p>
        type: <p>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.</p>
        next_token: <p>The <i>DescribeClientAuthenticationSettingsResult.NextToken</i> value from a previous call to <a>DescribeClientAuthenticationSettings</a>. Pass null if this is the first call.</p>
        limit: <p>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. </p>

    Raises:
        capo_directory_service.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.directory_does_not_exist_exception.DirectoryDoesNotExistException: <p>The specified directory does not exist in the system.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.describe_client_authentication_settings_request.DescribeClientAuthenticationSettingsRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.describe_client_authentication_settings_result.DescribeClientAuthenticationSettingsResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.describe_client_authentication_settings

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.describe_client_authentication_settings.describe_client_authentication_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClientAuthenticationSettings")
    )
    input_: capo_directory_service.types.describe_client_authentication_settings_request.DescribeClientAuthenticationSettingsRequest = {
        "directory_id": directory_id
    }
    if type is not None:
        input_["type"] = type
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output