amazonka-finspace-data-2.0: Amazon FinSpace Public API SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FinSpaceData.ResetUserPassword

Description

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Synopsis

Creating a Request

data ResetUserPassword Source #

See: newResetUserPassword smart constructor.

Constructors

ResetUserPassword' 

Fields

  • clientToken :: Maybe Text

    A token that ensures idempotency. This token expires in 10 minutes.

  • userId :: Text

    The unique identifier of the user that a temporary password is requested for.

Instances

Instances details
ToJSON ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

ToHeaders ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

ToPath ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

ToQuery ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

AWSRequest ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Associated Types

type AWSResponse ResetUserPassword #

Generic ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Associated Types

type Rep ResetUserPassword :: Type -> Type #

Read ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Show ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

NFData ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Methods

rnf :: ResetUserPassword -> () #

Eq ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Hashable ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

type AWSResponse ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

type Rep ResetUserPassword Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

type Rep ResetUserPassword = D1 ('MetaData "ResetUserPassword" "Amazonka.FinSpaceData.ResetUserPassword" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "ResetUserPassword'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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:clientToken:ResetUserPassword', resetUserPassword_clientToken - A token that ensures idempotency. This token expires in 10 minutes.

ResetUserPassword, resetUserPassword_userId - The unique identifier of the user that a temporary password is requested for.

Request Lenses

resetUserPassword_clientToken :: Lens' ResetUserPassword (Maybe Text) Source #

A token that ensures idempotency. This token expires in 10 minutes.

resetUserPassword_userId :: Lens' ResetUserPassword Text Source #

The unique identifier of the user that a temporary password is requested for.

Destructuring the Response

data ResetUserPasswordResponse Source #

See: newResetUserPasswordResponse smart constructor.

Constructors

ResetUserPasswordResponse' 

Fields

Instances

Instances details
Generic ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Associated Types

type Rep ResetUserPasswordResponse :: Type -> Type #

Show ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

NFData ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

Eq ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

type Rep ResetUserPasswordResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.ResetUserPassword

type Rep ResetUserPasswordResponse = D1 ('MetaData "ResetUserPasswordResponse" "Amazonka.FinSpaceData.ResetUserPassword" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "ResetUserPasswordResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "temporaryPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:temporaryPassword:ResetUserPasswordResponse', resetUserPasswordResponse_temporaryPassword - A randomly generated temporary password for the requested user account. This password expires in 7 days.

ResetUserPassword, resetUserPasswordResponse_userId - The unique identifier of the user that a new password is generated for.

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

Response Lenses

resetUserPasswordResponse_temporaryPassword :: Lens' ResetUserPasswordResponse (Maybe Text) Source #

A randomly generated temporary password for the requested user account. This password expires in 7 days.

resetUserPasswordResponse_userId :: Lens' ResetUserPasswordResponse (Maybe Text) Source #

The unique identifier of the user that a new password is generated for.