Skip to content

disable_client_authentication

disable_client_authentication(
    directory_id: DirectoryId,
    type: ClientAuthenticationType,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> DisableClientAuthenticationResult

Disables alternative client authentication methods for the specified directory.

Parameters:

  • directory_id (DirectoryId) –

    The identifier of the directory

  • type (ClientAuthenticationType) –

    The type of client authentication to disable. Currently the only parameter "SmartCard" is supported.

Raises:

Source code in docs_src/capo_directory_service/_services/directory_service.py
def disable_client_authentication(
    self,
    directory_id: "capo_directory_service.types.directory_id.DirectoryId",
    type: "capo_directory_service.types.client_authentication_type.ClientAuthenticationType",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.disable_client_authentication_result.DisableClientAuthenticationResult":
    """<p>Disables alternative client authentication methods for the specified directory. </p>

    Args:
        directory_id: <p>The identifier of the directory </p>
        type: <p>The type of client authentication to disable. Currently the only parameter <code>"SmartCard"</code> is supported.</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_client_auth_status_exception.InvalidClientAuthStatusException: <p>Client authentication is already enabled.</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.disable_client_authentication_request.DisableClientAuthenticationRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.disable_client_authentication_result.DisableClientAuthenticationResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.disable_client_authentication

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableClientAuthentication")
    )
    input_: capo_directory_service.types.disable_client_authentication_request.DisableClientAuthenticationRequest = {
        "directory_id": directory_id,
        "type": type,
    }

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