DirectoryService / Client / disable_sso

disable_sso#

DirectoryService.Client.disable_sso(**kwargs)#

Disables single-sign on for a directory.

See also: AWS API Documentation

Request Syntax

response = client.disable_sso(
    DirectoryId='string',
    UserName='string',
    Password='string'
)
Parameters:
  • DirectoryId (string) –

    [REQUIRED]

    The identifier of the directory for which to disable single-sign on.

  • UserName (string) –

    The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

    If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

  • Password (string) – The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Contains the results of the DisableSso operation.

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InsufficientPermissionsException

  • DirectoryService.Client.exceptions.AuthenticationFailedException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException