DirectoryService / Client / reset_user_password

reset_user_password#

DirectoryService.Client.reset_user_password(**kwargs)#

Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

  • For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.

See also: AWS API Documentation

Request Syntax

response = client.reset_user_password(
    DirectoryId='string',
    UserName='string',
    NewPassword='string'
)
Parameters:

  • DirectoryId (string) –

    [REQUIRED]

    Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.

  • UserName (string) –

    [REQUIRED]

    The user name of the user whose password will be reset.

  • NewPassword (string) –

    [REQUIRED]

    The new password that will be reset.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DirectoryService.Client.exceptions.DirectoryUnavailableException

  • DirectoryService.Client.exceptions.UserDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidPasswordException

  • DirectoryService.Client.exceptions.UnsupportedOperationException

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException