Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.GlobalSignOut

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.

Synopsis

Creating a Request

data GlobalSignOut Source #

Represents the request to sign out all devices.

See: newGlobalSignOut smart constructor.

Constructors

GlobalSignOut'
Fields accessToken :: Sensitive Text The access token.

Instances

Instances details

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

newGlobalSignOut Source #

Arguments

:: Text	`$sel:accessToken:GlobalSignOut'`
-> GlobalSignOut

Create a value of GlobalSignOut 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:accessToken:GlobalSignOut', globalSignOut_accessToken - The access token.

Request Lenses

globalSignOut_accessToken :: Lens' GlobalSignOut Text Source #

The access token.

Destructuring the Response

data GlobalSignOutResponse Source #

The response to the request to sign out all devices.

See: newGlobalSignOutResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGlobalSignOutResponse Source #

Arguments

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

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

Response Lenses

globalSignOutResponse_httpStatus :: Lens' GlobalSignOutResponse Int Source #

The response's http status code.