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.CognitoIdentity.UnlinkIdentity

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

Synopsis

Creating a Request

data UnlinkIdentity Source #

Input to the UnlinkIdentity action.

See: newUnlinkIdentity smart constructor.

Constructors

UnlinkIdentity'
Fields identityId :: Text A unique identifier in the format REGION:GUID. logins :: HashMap Text Text A set of optional name-value pairs that map provider names to provider tokens. loginsToRemove :: [Text] Provider names to unlink from this identity.

Instances

Instances details

Eq UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods (==) :: UnlinkIdentity -> UnlinkIdentity -> Bool # (/=) :: UnlinkIdentity -> UnlinkIdentity -> Bool #
Read UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods readsPrec :: Int -> ReadS UnlinkIdentity # readList :: ReadS [UnlinkIdentity] # readPrec :: ReadPrec UnlinkIdentity # readListPrec :: ReadPrec [UnlinkIdentity] #
Show UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods showsPrec :: Int -> UnlinkIdentity -> ShowS # show :: UnlinkIdentity -> String # showList :: [UnlinkIdentity] -> ShowS #
Generic UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Associated Types type Rep UnlinkIdentity :: Type -> Type # Methods from :: UnlinkIdentity -> Rep UnlinkIdentity x # to :: Rep UnlinkIdentity x -> UnlinkIdentity #
NFData UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods rnf :: UnlinkIdentity -> () #
Hashable UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods hashWithSalt :: Int -> UnlinkIdentity -> Int # hash :: UnlinkIdentity -> Int #
ToJSON UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods toJSON :: UnlinkIdentity -> Value # toEncoding :: UnlinkIdentity -> Encoding # toJSONList :: [UnlinkIdentity] -> Value # toEncodingList :: [UnlinkIdentity] -> Encoding #
AWSRequest UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Associated Types type AWSResponse UnlinkIdentity # Methods request :: UnlinkIdentity -> Request UnlinkIdentity # response :: MonadResource m => Logger -> Service -> Proxy UnlinkIdentity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UnlinkIdentity))) #
ToHeaders UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods toHeaders :: UnlinkIdentity -> [Header] #
ToPath UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods toPath :: UnlinkIdentity -> ByteString #
ToQuery UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity Methods toQuery :: UnlinkIdentity -> QueryString #
type Rep UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity type Rep UnlinkIdentity = D1 ('MetaData "UnlinkIdentity" "Amazonka.CognitoIdentity.UnlinkIdentity" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "UnlinkIdentity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "logins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)) :: S1 ('MetaSel ('Just "loginsToRemove") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))
type AWSResponse UnlinkIdentity Source #
Instance details Defined in Amazonka.CognitoIdentity.UnlinkIdentity type AWSResponse UnlinkIdentity = UnlinkIdentityResponse

newUnlinkIdentity Source #

Arguments

:: Text	`$sel:identityId:UnlinkIdentity'`
-> UnlinkIdentity

Create a value of UnlinkIdentity 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:identityId:UnlinkIdentity', unlinkIdentity_identityId - A unique identifier in the format REGION:GUID.

$sel:logins:UnlinkIdentity', unlinkIdentity_logins - A set of optional name-value pairs that map provider names to provider tokens.

$sel:loginsToRemove:UnlinkIdentity', unlinkIdentity_loginsToRemove - Provider names to unlink from this identity.

Request Lenses

unlinkIdentity_identityId :: Lens' UnlinkIdentity Text Source #

A unique identifier in the format REGION:GUID.

unlinkIdentity_logins :: Lens' UnlinkIdentity (HashMap Text Text) Source #

A set of optional name-value pairs that map provider names to provider tokens.

unlinkIdentity_loginsToRemove :: Lens' UnlinkIdentity [Text] Source #

Provider names to unlink from this identity.

Destructuring the Response

data UnlinkIdentityResponse Source #

See: newUnlinkIdentityResponse smart constructor.

Constructors

UnlinkIdentityResponse'

Instances

Instances details

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

newUnlinkIdentityResponse :: UnlinkIdentityResponse Source #

Create a value of UnlinkIdentityResponse with all optional fields omitted.

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