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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.

Synopsis

data RevokeToken = RevokeToken' {
- clientSecret :: Maybe (Sensitive Text)
- token :: Sensitive Text
- clientId :: Sensitive Text
}
newRevokeToken :: Text -> Text -> RevokeToken
revokeToken_clientSecret :: Lens' RevokeToken (Maybe Text)
revokeToken_token :: Lens' RevokeToken Text
revokeToken_clientId :: Lens' RevokeToken Text
data RevokeTokenResponse = RevokeTokenResponse' {
- httpStatus :: Int
}
newRevokeTokenResponse :: Int -> RevokeTokenResponse
revokeTokenResponse_httpStatus :: Lens' RevokeTokenResponse Int

Creating a Request

data RevokeToken Source #

See: newRevokeToken smart constructor.

Constructors

RevokeToken'
Fields clientSecret :: Maybe (Sensitive Text) The secret for the client ID. This is required only if the client ID has a secret. token :: Sensitive Text The refresh token that you want to revoke. clientId :: Sensitive Text The client ID for the token that you want to revoke.

Instances

Instances details

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

newRevokeToken Source #

Arguments

:: Text	`$sel:token:RevokeToken'`
-> Text	`RevokeToken`
-> RevokeToken

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

RevokeToken, revokeToken_clientSecret - The secret for the client ID. This is required only if the client ID has a secret.

$sel:token:RevokeToken', revokeToken_token - The refresh token that you want to revoke.

RevokeToken, revokeToken_clientId - The client ID for the token that you want to revoke.

Request Lenses

revokeToken_clientSecret :: Lens' RevokeToken (Maybe Text) Source #

The secret for the client ID. This is required only if the client ID has a secret.

revokeToken_token :: Lens' RevokeToken Text Source #

The refresh token that you want to revoke.

revokeToken_clientId :: Lens' RevokeToken Text Source #

The client ID for the token that you want to revoke.

Destructuring the Response

data RevokeTokenResponse Source #

See: newRevokeTokenResponse smart constructor.

Constructors

RevokeTokenResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRevokeTokenResponse Source #

Arguments

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

Create a value of RevokeTokenResponse 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:RevokeTokenResponse', revokeTokenResponse_httpStatus - The response's http status code.

Response Lenses

revokeTokenResponse_httpStatus :: Lens' RevokeTokenResponse Int Source #

The response's http status code.