Amazonka.SSO.Logout

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the IAM Identity Center User Guide.

Creating a Request

data Logout

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 IAM Identity Center OIDC API Reference Guide.

Instances

ToJSON Logout

Defined in Amazonka.SSO.Logout

Methods

toJSON :: Logout -> Value

toEncoding :: Logout -> Encoding

toJSONList :: [Logout] -> Value

toEncodingList :: [Logout] -> Encoding

ToHeaders Logout

Defined in Amazonka.SSO.Logout

Methods

toHeaders :: Logout -> [Header]

ToPath Logout

Defined in Amazonka.SSO.Logout

Methods

toPath :: Logout -> ByteString

ToQuery Logout

Defined in Amazonka.SSO.Logout

Methods

toQuery :: Logout -> QueryString

AWSRequest Logout

Defined in Amazonka.SSO.Logout

Associated Types

type AWSResponse Logout

Methods

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

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

Generic Logout

Defined in Amazonka.SSO.Logout

Associated Types

type Rep Logout :: Type -> Type

Methods

from :: Logout -> Rep Logout x

to :: Rep Logout x -> Logout

Show Logout

Defined in Amazonka.SSO.Logout

Methods

showsPrec :: Int -> Logout -> ShowS

show :: Logout -> String

showList :: [Logout] -> ShowS

NFData Logout

Defined in Amazonka.SSO.Logout

Methods

rnf :: Logout -> ()

Eq Logout

Defined in Amazonka.SSO.Logout

Methods

(==) :: Logout -> Logout -> Bool

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

Hashable Logout

Defined in Amazonka.SSO.Logout

Methods

hashWithSalt :: Int -> Logout -> Int

hash :: Logout -> Int

type AWSResponse Logout

Defined in Amazonka.SSO.Logout

type AWSResponse Logout = LogoutResponse

type Rep Logout

Defined in Amazonka.SSO.Logout

type Rep Logout = D1 ('MetaData "Logout" "Amazonka.SSO.Logout" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "Logout'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newLogout

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 IAM Identity Center OIDC API Reference Guide.

Request Lenses

logout_accessToken :: Lens' Logout Text

The token issued by the CreateToken API call. For more information, see CreateToken in the IAM Identity Center OIDC API Reference Guide.

Destructuring the Response

data LogoutResponse

See: newLogoutResponse smart constructor.

Constructors

LogoutResponse'

Instances

Generic LogoutResponse

Defined in Amazonka.SSO.Logout

Associated Types

type Rep LogoutResponse :: Type -> Type

Methods

from :: LogoutResponse -> Rep LogoutResponse x

to :: Rep LogoutResponse x -> LogoutResponse

Read LogoutResponse

Defined in Amazonka.SSO.Logout

Methods

readsPrec :: Int -> ReadS LogoutResponse

readList :: ReadS [LogoutResponse]

readPrec :: ReadPrec LogoutResponse

readListPrec :: ReadPrec [LogoutResponse]

Show LogoutResponse

Defined in Amazonka.SSO.Logout

Methods

showsPrec :: Int -> LogoutResponse -> ShowS

show :: LogoutResponse -> String

showList :: [LogoutResponse] -> ShowS

NFData LogoutResponse

Defined in Amazonka.SSO.Logout

Methods

rnf :: LogoutResponse -> ()

Eq LogoutResponse

Defined in Amazonka.SSO.Logout

Methods

(==) :: LogoutResponse -> LogoutResponse -> Bool

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

type Rep LogoutResponse

Defined in Amazonka.SSO.Logout

type Rep LogoutResponse = D1 ('MetaData "LogoutResponse" "Amazonka.SSO.Logout" "amazonka-sso-2.0-B4gMJoZyEheG3SJYxPhDjE" 'False) (C1 ('MetaCons "LogoutResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newLogoutResponse :: LogoutResponse

Create a value of LogoutResponse with all optional fields omitted.

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