Network.AWS.CognitoIdentity.GetOpenIdToken

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

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

Creating a Request

getOpenIdToken

Arguments

:: Text

goitIdentityId

-> GetOpenIdToken

Creates a value of GetOpenIdToken with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• goitLogins
• goitIdentityId

data GetOpenIdToken

Input to the GetOpenIdToken action.

See: getOpenIdToken smart constructor.

Instances

Eq GetOpenIdToken

Methods

(==) :: GetOpenIdToken -> GetOpenIdToken -> Bool

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

Data GetOpenIdToken

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetOpenIdToken -> c GetOpenIdToken

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetOpenIdToken

toConstr :: GetOpenIdToken -> Constr

dataTypeOf :: GetOpenIdToken -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetOpenIdToken)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetOpenIdToken)

gmapT :: (forall b. Data b => b -> b) -> GetOpenIdToken -> GetOpenIdToken

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetOpenIdToken -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetOpenIdToken -> r

gmapQ :: (forall d. Data d => d -> u) -> GetOpenIdToken -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetOpenIdToken -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetOpenIdToken -> m GetOpenIdToken

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetOpenIdToken -> m GetOpenIdToken

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetOpenIdToken -> m GetOpenIdToken

Read GetOpenIdToken

Methods

readsPrec :: Int -> ReadS GetOpenIdToken

readList :: ReadS [GetOpenIdToken]

readPrec :: ReadPrec GetOpenIdToken

readListPrec :: ReadPrec [GetOpenIdToken]

Show GetOpenIdToken

Methods

showsPrec :: Int -> GetOpenIdToken -> ShowS

show :: GetOpenIdToken -> String

showList :: [GetOpenIdToken] -> ShowS

Generic GetOpenIdToken

Associated Types

type Rep GetOpenIdToken :: * -> *

Methods

from :: GetOpenIdToken -> Rep GetOpenIdToken x

to :: Rep GetOpenIdToken x -> GetOpenIdToken

Hashable GetOpenIdToken

Methods

hashWithSalt :: Int -> GetOpenIdToken -> Int

hash :: GetOpenIdToken -> Int

NFData GetOpenIdToken

Methods

rnf :: GetOpenIdToken -> ()

AWSRequest GetOpenIdToken

Associated Types

type Rs GetOpenIdToken :: *

Methods

request :: GetOpenIdToken -> Request GetOpenIdToken

response :: MonadResource m => Logger -> Service -> Proxy * GetOpenIdToken -> ClientResponse -> m (Response GetOpenIdToken)

ToPath GetOpenIdToken

Methods

toPath :: GetOpenIdToken -> ByteString

ToHeaders GetOpenIdToken

Methods

toHeaders :: GetOpenIdToken -> [Header]

ToQuery GetOpenIdToken

Methods

toQuery :: GetOpenIdToken -> QueryString

ToJSON GetOpenIdToken

Methods

toJSON :: GetOpenIdToken -> Value

toEncoding :: GetOpenIdToken -> Encoding

type Rep GetOpenIdToken

type Rep GetOpenIdToken = D1 (MetaData "GetOpenIdToken" "Network.AWS.CognitoIdentity.GetOpenIdToken" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "GetOpenIdToken'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_goitLogins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_goitIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetOpenIdToken

type Rs GetOpenIdToken = GetOpenIdTokenResponse

Request Lenses

goitLogins :: Lens' GetOpenIdToken (HashMap Text Text)

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com or any other OpenId Connect provider, always include the id_token.

goitIdentityId :: Lens' GetOpenIdToken Text

A unique identifier in the format REGION:GUID.

Destructuring the Response

getOpenIdTokenResponse

Arguments

:: Int

goitrsResponseStatus

-> GetOpenIdTokenResponse

Creates a value of GetOpenIdTokenResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• goitrsToken
• goitrsIdentityId
• goitrsResponseStatus

data GetOpenIdTokenResponse

Returned in response to a successful GetOpenIdToken request.

See: getOpenIdTokenResponse smart constructor.

Instances

Eq GetOpenIdTokenResponse

Methods

(==) :: GetOpenIdTokenResponse -> GetOpenIdTokenResponse -> Bool

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

Data GetOpenIdTokenResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetOpenIdTokenResponse -> c GetOpenIdTokenResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetOpenIdTokenResponse

toConstr :: GetOpenIdTokenResponse -> Constr

dataTypeOf :: GetOpenIdTokenResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetOpenIdTokenResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetOpenIdTokenResponse)

gmapT :: (forall b. Data b => b -> b) -> GetOpenIdTokenResponse -> GetOpenIdTokenResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetOpenIdTokenResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetOpenIdTokenResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetOpenIdTokenResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetOpenIdTokenResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetOpenIdTokenResponse -> m GetOpenIdTokenResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetOpenIdTokenResponse -> m GetOpenIdTokenResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetOpenIdTokenResponse -> m GetOpenIdTokenResponse

Read GetOpenIdTokenResponse

Methods

readsPrec :: Int -> ReadS GetOpenIdTokenResponse

readList :: ReadS [GetOpenIdTokenResponse]

readPrec :: ReadPrec GetOpenIdTokenResponse

readListPrec :: ReadPrec [GetOpenIdTokenResponse]

Show GetOpenIdTokenResponse

Methods

showsPrec :: Int -> GetOpenIdTokenResponse -> ShowS

show :: GetOpenIdTokenResponse -> String

showList :: [GetOpenIdTokenResponse] -> ShowS

Generic GetOpenIdTokenResponse

Associated Types

type Rep GetOpenIdTokenResponse :: * -> *

Methods

from :: GetOpenIdTokenResponse -> Rep GetOpenIdTokenResponse x

to :: Rep GetOpenIdTokenResponse x -> GetOpenIdTokenResponse

NFData GetOpenIdTokenResponse

Methods

rnf :: GetOpenIdTokenResponse -> ()

type Rep GetOpenIdTokenResponse

type Rep GetOpenIdTokenResponse = D1 (MetaData "GetOpenIdTokenResponse" "Network.AWS.CognitoIdentity.GetOpenIdToken" "amazonka-cognito-identity-1.4.4-HCXYru6jCnl38KjgmeNXOZ" False) (C1 (MetaCons "GetOpenIdTokenResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_goitrsToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_goitrsIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_goitrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

goitrsToken :: Lens' GetOpenIdTokenResponse (Maybe Text)

An OpenID token, valid for 15 minutes.

goitrsIdentityId :: Lens' GetOpenIdTokenResponse (Maybe Text)

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

goitrsResponseStatus :: Lens' GetOpenIdTokenResponse Int

The response status code.