libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
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.CognitoIdentityProvider.GlobalSignOut

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

Instances

Instances details
Eq GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Show GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Generic GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type Rep GlobalSignOut :: Type -> Type #

NFData GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

rnf :: GlobalSignOut -> () #

Hashable GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

ToJSON GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

AWSRequest GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type AWSResponse GlobalSignOut #

ToHeaders GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

ToPath GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

ToQuery GlobalSignOut Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

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

newGlobalSignOut Source #

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

Destructuring the Response

data GlobalSignOutResponse Source #

The response to the request to sign out all devices.

See: newGlobalSignOutResponse smart constructor.

Constructors

GlobalSignOutResponse' 

Fields

Instances

Instances details
Eq GlobalSignOutResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Read GlobalSignOutResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Show GlobalSignOutResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Generic GlobalSignOutResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type Rep GlobalSignOutResponse :: Type -> Type #

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 #

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