Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentityProvider.VerifySoftwareToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this API to register a user's entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

Synopsis

data VerifySoftwareToken = VerifySoftwareToken' {
- accessToken :: Maybe (Sensitive Text)
- friendlyDeviceName :: Maybe Text
- session :: Maybe Text
- userCode :: Text
}
newVerifySoftwareToken :: Text -> VerifySoftwareToken
verifySoftwareToken_accessToken :: Lens' VerifySoftwareToken (Maybe Text)
verifySoftwareToken_friendlyDeviceName :: Lens' VerifySoftwareToken (Maybe Text)
verifySoftwareToken_session :: Lens' VerifySoftwareToken (Maybe Text)
verifySoftwareToken_userCode :: Lens' VerifySoftwareToken Text
data VerifySoftwareTokenResponse = VerifySoftwareTokenResponse' {
- session :: Maybe Text
- status :: Maybe VerifySoftwareTokenResponseType
- httpStatus :: Int
}
newVerifySoftwareTokenResponse :: Int -> VerifySoftwareTokenResponse
verifySoftwareTokenResponse_session :: Lens' VerifySoftwareTokenResponse (Maybe Text)
verifySoftwareTokenResponse_status :: Lens' VerifySoftwareTokenResponse (Maybe VerifySoftwareTokenResponseType)
verifySoftwareTokenResponse_httpStatus :: Lens' VerifySoftwareTokenResponse Int

Creating a Request

data VerifySoftwareToken Source #

See: newVerifySoftwareToken smart constructor.

Constructors

VerifySoftwareToken'

Fields

accessToken :: Maybe (Sensitive Text)
A valid access token that Amazon Cognito issued to the user whose software token you want to verify.
friendlyDeviceName :: Maybe Text
The friendly device name.
session :: Maybe Text
The session that should be passed both ways in challenge-response calls to the service.
userCode :: Text
The one- time password computed using the secret code returned by AssociateSoftwareToken.

Instances

Instances details

ToJSON VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods toJSON :: VerifySoftwareToken -> Value # toEncoding :: VerifySoftwareToken -> Encoding # toJSONList :: [VerifySoftwareToken] -> Value # toEncodingList :: [VerifySoftwareToken] -> Encoding #
ToHeaders VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods toHeaders :: VerifySoftwareToken -> [Header] #
ToPath VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods toPath :: VerifySoftwareToken -> ByteString #
ToQuery VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods toQuery :: VerifySoftwareToken -> QueryString #
AWSRequest VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Associated Types type AWSResponse VerifySoftwareToken # Methods request :: (Service -> Service) -> VerifySoftwareToken -> Request VerifySoftwareToken # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy VerifySoftwareToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse VerifySoftwareToken))) #
Generic VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Associated Types type Rep VerifySoftwareToken :: Type -> Type # Methods from :: VerifySoftwareToken -> Rep VerifySoftwareToken x # to :: Rep VerifySoftwareToken x -> VerifySoftwareToken #
Show VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods showsPrec :: Int -> VerifySoftwareToken -> ShowS # show :: VerifySoftwareToken -> String # showList :: [VerifySoftwareToken] -> ShowS #
NFData VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods rnf :: VerifySoftwareToken -> () #
Eq VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods (==) :: VerifySoftwareToken -> VerifySoftwareToken -> Bool # (/=) :: VerifySoftwareToken -> VerifySoftwareToken -> Bool #
Hashable VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods hashWithSalt :: Int -> VerifySoftwareToken -> Int # hash :: VerifySoftwareToken -> Int #
type AWSResponse VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken type AWSResponse VerifySoftwareToken = VerifySoftwareTokenResponse
type Rep VerifySoftwareToken Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken type Rep VerifySoftwareToken = D1 ('MetaData "VerifySoftwareToken" "Amazonka.CognitoIdentityProvider.VerifySoftwareToken" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "VerifySoftwareToken'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "friendlyDeviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newVerifySoftwareToken Source #

Arguments

:: Text	`$sel:userCode:VerifySoftwareToken'`
-> VerifySoftwareToken

Create a value of VerifySoftwareToken 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:

VerifySoftwareToken, verifySoftwareToken_accessToken - A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

$sel:friendlyDeviceName:VerifySoftwareToken', verifySoftwareToken_friendlyDeviceName - The friendly device name.

VerifySoftwareToken, verifySoftwareToken_session - The session that should be passed both ways in challenge-response calls to the service.

$sel:userCode:VerifySoftwareToken', verifySoftwareToken_userCode - The one- time password computed using the secret code returned by AssociateSoftwareToken.

Request Lenses

verifySoftwareToken_accessToken :: Lens' VerifySoftwareToken (Maybe Text) Source #

A valid access token that Amazon Cognito issued to the user whose software token you want to verify.

verifySoftwareToken_friendlyDeviceName :: Lens' VerifySoftwareToken (Maybe Text) Source #

The friendly device name.

verifySoftwareToken_session :: Lens' VerifySoftwareToken (Maybe Text) Source #

The session that should be passed both ways in challenge-response calls to the service.

verifySoftwareToken_userCode :: Lens' VerifySoftwareToken Text Source #

The one- time password computed using the secret code returned by AssociateSoftwareToken.

Destructuring the Response

data VerifySoftwareTokenResponse Source #

See: newVerifySoftwareTokenResponse smart constructor.

Constructors

VerifySoftwareTokenResponse'
Fields session :: Maybe Text The session that should be passed both ways in challenge-response calls to the service. status :: Maybe VerifySoftwareTokenResponseType The status of the verify software token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Associated Types type Rep VerifySoftwareTokenResponse :: Type -> Type # Methods from :: VerifySoftwareTokenResponse -> Rep VerifySoftwareTokenResponse x # to :: Rep VerifySoftwareTokenResponse x -> VerifySoftwareTokenResponse #
Read VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods readsPrec :: Int -> ReadS VerifySoftwareTokenResponse # readList :: ReadS [VerifySoftwareTokenResponse] # readPrec :: ReadPrec VerifySoftwareTokenResponse # readListPrec :: ReadPrec [VerifySoftwareTokenResponse] #
Show VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods showsPrec :: Int -> VerifySoftwareTokenResponse -> ShowS # show :: VerifySoftwareTokenResponse -> String # showList :: [VerifySoftwareTokenResponse] -> ShowS #
NFData VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods rnf :: VerifySoftwareTokenResponse -> () #
Eq VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken Methods (==) :: VerifySoftwareTokenResponse -> VerifySoftwareTokenResponse -> Bool # (/=) :: VerifySoftwareTokenResponse -> VerifySoftwareTokenResponse -> Bool #
type Rep VerifySoftwareTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.VerifySoftwareToken type Rep VerifySoftwareTokenResponse = D1 ('MetaData "VerifySoftwareTokenResponse" "Amazonka.CognitoIdentityProvider.VerifySoftwareToken" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "VerifySoftwareTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VerifySoftwareTokenResponseType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newVerifySoftwareTokenResponse Source #

Arguments

:: Int	`$sel:httpStatus:VerifySoftwareTokenResponse'`
-> VerifySoftwareTokenResponse

Create a value of VerifySoftwareTokenResponse 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:

VerifySoftwareToken, verifySoftwareTokenResponse_session - The session that should be passed both ways in challenge-response calls to the service.

VerifySoftwareTokenResponse, verifySoftwareTokenResponse_status - The status of the verify software token.

$sel:httpStatus:VerifySoftwareTokenResponse', verifySoftwareTokenResponse_httpStatus - The response's http status code.

Response Lenses

verifySoftwareTokenResponse_session :: Lens' VerifySoftwareTokenResponse (Maybe Text) Source #

The session that should be passed both ways in challenge-response calls to the service.

verifySoftwareTokenResponse_status :: Lens' VerifySoftwareTokenResponse (Maybe VerifySoftwareTokenResponseType) Source #

The status of the verify software token.

verifySoftwareTokenResponse_httpStatus :: Lens' VerifySoftwareTokenResponse Int Source #

The response's http status code.