Amazonka.CognitoIdentityProvider.GlobalSignOut

Signs out users from all devices. It also invalidates all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

Creating a Request

data GlobalSignOut

Represents the request to sign out all devices.

See: newGlobalSignOut smart constructor.

Constructors

GlobalSignOut'

Fields

• accessToken :: Sensitive Text

  A valid access token that Amazon Cognito issued to the user who you want to sign out.

Instances

ToJSON GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

toJSON :: GlobalSignOut -> Value

toEncoding :: GlobalSignOut -> Encoding

toJSONList :: [GlobalSignOut] -> Value

toEncodingList :: [GlobalSignOut] -> Encoding

ToHeaders GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

toHeaders :: GlobalSignOut -> [Header]

ToPath GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

toPath :: GlobalSignOut -> ByteString

ToQuery GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

toQuery :: GlobalSignOut -> QueryString

AWSRequest GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type AWSResponse GlobalSignOut

Methods

request :: (Service -> Service) -> GlobalSignOut -> Request GlobalSignOut

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GlobalSignOut -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GlobalSignOut)))

Generic GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type Rep GlobalSignOut :: Type -> Type

Methods

from :: GlobalSignOut -> Rep GlobalSignOut x

to :: Rep GlobalSignOut x -> GlobalSignOut

Show GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

showsPrec :: Int -> GlobalSignOut -> ShowS

show :: GlobalSignOut -> String

showList :: [GlobalSignOut] -> ShowS

NFData GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

rnf :: GlobalSignOut -> ()

Eq GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

(==) :: GlobalSignOut -> GlobalSignOut -> Bool

(/=) :: GlobalSignOut -> GlobalSignOut -> Bool

Hashable GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

hashWithSalt :: Int -> GlobalSignOut -> Int

hash :: GlobalSignOut -> Int

type AWSResponse GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

type AWSResponse GlobalSignOut = GlobalSignOutResponse

type Rep GlobalSignOut

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

type Rep GlobalSignOut = D1 ('MetaData "GlobalSignOut" "Amazonka.CognitoIdentityProvider.GlobalSignOut" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GlobalSignOut'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newGlobalSignOut

Arguments

:: Text

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:

GlobalSignOut, globalSignOut_accessToken - A valid access token that Amazon Cognito issued to the user who you want to sign out.

Request Lenses

globalSignOut_accessToken :: Lens' GlobalSignOut Text

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Destructuring the Response

data GlobalSignOutResponse

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

Generic GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Associated Types

type Rep GlobalSignOutResponse :: Type -> Type

Methods

from :: GlobalSignOutResponse -> Rep GlobalSignOutResponse x

to :: Rep GlobalSignOutResponse x -> GlobalSignOutResponse

Read GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

readsPrec :: Int -> ReadS GlobalSignOutResponse

readList :: ReadS [GlobalSignOutResponse]

readPrec :: ReadPrec GlobalSignOutResponse

readListPrec :: ReadPrec [GlobalSignOutResponse]

Show GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

showsPrec :: Int -> GlobalSignOutResponse -> ShowS

show :: GlobalSignOutResponse -> String

showList :: [GlobalSignOutResponse] -> ShowS

NFData GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

rnf :: GlobalSignOutResponse -> ()

Eq GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

Methods

(==) :: GlobalSignOutResponse -> GlobalSignOutResponse -> Bool

(/=) :: GlobalSignOutResponse -> GlobalSignOutResponse -> Bool

type Rep GlobalSignOutResponse

Defined in Amazonka.CognitoIdentityProvider.GlobalSignOut

type Rep GlobalSignOutResponse = D1 ('MetaData "GlobalSignOutResponse" "Amazonka.CognitoIdentityProvider.GlobalSignOut" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "GlobalSignOutResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGlobalSignOutResponse

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

The response's http status code.