Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CognitoIdentity.GetOpenIdToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 10 minutes.

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

Creating a Request

data GetOpenIdToken Source #

Input to the GetOpenIdToken action.

See: newGetOpenIdToken smart constructor.

Constructors

GetOpenIdToken'

Fields

logins :: Maybe (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, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.
identityId :: Text
A unique identifier in the format REGION:GUID.

Instances

Instances details

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

newGetOpenIdToken Source #

Arguments

:: Text	`GetOpenIdToken`
-> GetOpenIdToken

Create a value of GetOpenIdToken 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:

GetOpenIdToken, getOpenIdToken_logins - 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, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.

GetOpenIdToken, getOpenIdToken_identityId - A unique identifier in the format REGION:GUID.

Request Lenses

getOpenIdToken_logins :: Lens' GetOpenIdToken (Maybe (HashMap Text Text)) Source #

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, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.

getOpenIdToken_identityId :: Lens' GetOpenIdToken Text Source #

A unique identifier in the format REGION:GUID.

Destructuring the Response

data GetOpenIdTokenResponse Source #

Returned in response to a successful GetOpenIdToken request.

See: newGetOpenIdTokenResponse smart constructor.

Constructors

GetOpenIdTokenResponse'
Fields identityId :: Maybe Text A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. token :: Maybe Text An OpenID token, valid for 10 minutes. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken Associated Types type Rep GetOpenIdTokenResponse :: Type -> Type # Methods from :: GetOpenIdTokenResponse -> Rep GetOpenIdTokenResponse x # to :: Rep GetOpenIdTokenResponse x -> GetOpenIdTokenResponse #
Read GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken Methods readsPrec :: Int -> ReadS GetOpenIdTokenResponse # readList :: ReadS [GetOpenIdTokenResponse] # readPrec :: ReadPrec GetOpenIdTokenResponse # readListPrec :: ReadPrec [GetOpenIdTokenResponse] #
Show GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken Methods showsPrec :: Int -> GetOpenIdTokenResponse -> ShowS # show :: GetOpenIdTokenResponse -> String # showList :: [GetOpenIdTokenResponse] -> ShowS #
NFData GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken Methods rnf :: GetOpenIdTokenResponse -> () #
Eq GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken Methods (==) :: GetOpenIdTokenResponse -> GetOpenIdTokenResponse -> Bool # (/=) :: GetOpenIdTokenResponse -> GetOpenIdTokenResponse -> Bool #
type Rep GetOpenIdTokenResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.GetOpenIdToken type Rep GetOpenIdTokenResponse = D1 ('MetaData "GetOpenIdTokenResponse" "Amazonka.CognitoIdentity.GetOpenIdToken" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "GetOpenIdTokenResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetOpenIdTokenResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetOpenIdTokenResponse'`
-> GetOpenIdTokenResponse

Create a value of GetOpenIdTokenResponse 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:

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

$sel:token:GetOpenIdTokenResponse', getOpenIdTokenResponse_token - An OpenID token, valid for 10 minutes.

$sel:httpStatus:GetOpenIdTokenResponse', getOpenIdTokenResponse_httpStatus - The response's http status code.

Response Lenses

getOpenIdTokenResponse_identityId :: Lens' GetOpenIdTokenResponse (Maybe Text) Source #

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

getOpenIdTokenResponse_token :: Lens' GetOpenIdTokenResponse (Maybe Text) Source #

An OpenID token, valid for 10 minutes.

getOpenIdTokenResponse_httpStatus :: Lens' GetOpenIdTokenResponse Int Source #

The response's http status code.