libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.ResetUserPassword

Description

Resets the password for any user in your Managed Microsoft AD or Simple AD directory.

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.
Synopsis

Creating a Request

data ResetUserPassword Source #

See: newResetUserPassword smart constructor.

Constructors

ResetUserPassword' 

Fields

Instances

Instances details
Eq ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Show ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Generic ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Associated Types

type Rep ResetUserPassword :: Type -> Type #

NFData ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Methods

rnf :: ResetUserPassword -> () #

Hashable ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

ToJSON ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

AWSRequest ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Associated Types

type AWSResponse ResetUserPassword #

ToHeaders ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

ToPath ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

ToQuery ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

type Rep ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

type Rep ResetUserPassword = D1 ('MetaData "ResetUserPassword" "Amazonka.DirectoryService.ResetUserPassword" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "ResetUserPassword'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "newPassword'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))
type AWSResponse ResetUserPassword Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

newResetUserPassword Source #

Create a value of ResetUserPassword with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directoryId:ResetUserPassword', resetUserPassword_directoryId - Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.

$sel:userName:ResetUserPassword', resetUserPassword_userName - The user name of the user whose password will be reset.

$sel:newPassword':ResetUserPassword', resetUserPassword_newPassword - The new password that will be reset.

Request Lenses

resetUserPassword_directoryId :: Lens' ResetUserPassword Text Source #

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

resetUserPassword_userName :: Lens' ResetUserPassword Text Source #

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

resetUserPassword_newPassword :: Lens' ResetUserPassword Text Source #

The new password that will be reset.

Destructuring the Response

data ResetUserPasswordResponse Source #

See: newResetUserPasswordResponse smart constructor.

Constructors

ResetUserPasswordResponse' 

Fields

Instances

Instances details
Eq ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Read ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Show ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Generic ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

Associated Types

type Rep ResetUserPasswordResponse :: Type -> Type #

NFData ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

type Rep ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.DirectoryService.ResetUserPassword

type Rep ResetUserPasswordResponse = D1 ('MetaData "ResetUserPasswordResponse" "Amazonka.DirectoryService.ResetUserPassword" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "ResetUserPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newResetUserPasswordResponse Source #

Create a value of ResetUserPasswordResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ResetUserPasswordResponse', resetUserPasswordResponse_httpStatus - The response's http status code.

Response Lenses