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.SSO.Logout

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Removes the client- and server-side session that is associated with the user.

Synopsis

data Logout = Logout' {
- accessToken :: Sensitive Text
}
newLogout :: Text -> Logout
logout_accessToken :: Lens' Logout Text
data LogoutResponse = LogoutResponse' {
}
newLogoutResponse :: LogoutResponse

Creating a Request

data Logout Source #

See: newLogout smart constructor.

Constructors

Logout'
Fields accessToken :: Sensitive Text The token issued by the `CreateToken` API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

Instances

Instances details

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

newLogout Source #

Arguments

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

Create a value of Logout 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:Logout', logout_accessToken - The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

Request Lenses

logout_accessToken :: Lens' Logout Text Source #

The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

Destructuring the Response

data LogoutResponse Source #

See: newLogoutResponse smart constructor.

Constructors

LogoutResponse'

Instances

Instances details

Eq LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods (==) :: LogoutResponse -> LogoutResponse -> Bool # (/=) :: LogoutResponse -> LogoutResponse -> Bool #
Read LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods readsPrec :: Int -> ReadS LogoutResponse # readList :: ReadS [LogoutResponse] # readPrec :: ReadPrec LogoutResponse # readListPrec :: ReadPrec [LogoutResponse] #
Show LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods showsPrec :: Int -> LogoutResponse -> ShowS # show :: LogoutResponse -> String # showList :: [LogoutResponse] -> ShowS #
Generic LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Associated Types type Rep LogoutResponse :: Type -> Type # Methods from :: LogoutResponse -> Rep LogoutResponse x # to :: Rep LogoutResponse x -> LogoutResponse #
NFData LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout Methods rnf :: LogoutResponse -> () #
type Rep LogoutResponse Source #
Instance details Defined in Amazonka.SSO.Logout type Rep LogoutResponse = D1 ('MetaData "LogoutResponse" "Amazonka.SSO.Logout" "libZSservicesZSamazonka-ssoZSamazonka-sso" 'False) (C1 ('MetaCons "LogoutResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newLogoutResponse :: LogoutResponse Source #

Create a value of LogoutResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.