amazonka-cognito-identity-1.5.0: Amazon Cognito Identity SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Contents

Description

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId . This API will create the identity in the specified IdentityPoolId .

You must use AWS Developer credentials to call this API.

Synopsis

Creating a Request

getOpenIdTokenForDeveloperIdentity Source #

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

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

  • goitfdiTokenDuration - The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
  • goitfdiIdentityId - A unique identifier in the format REGION:GUID.
  • goitfdiIdentityPoolId - An identity pool ID in the format REGION:GUID.
  • goitfdiLogins - A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier" . The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

data GetOpenIdTokenForDeveloperIdentity Source #

Input to the GetOpenIdTokenForDeveloperIdentity action.

See: getOpenIdTokenForDeveloperIdentity smart constructor.

Instances

Eq GetOpenIdTokenForDeveloperIdentity Source # 
Data GetOpenIdTokenForDeveloperIdentity Source # 

Methods

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

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

toConstr :: GetOpenIdTokenForDeveloperIdentity -> Constr #

dataTypeOf :: GetOpenIdTokenForDeveloperIdentity -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> GetOpenIdTokenForDeveloperIdentity -> GetOpenIdTokenForDeveloperIdentity #

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

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

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

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

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

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

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

Read GetOpenIdTokenForDeveloperIdentity Source # 
Show GetOpenIdTokenForDeveloperIdentity Source # 
Generic GetOpenIdTokenForDeveloperIdentity Source # 
Hashable GetOpenIdTokenForDeveloperIdentity Source # 
ToJSON GetOpenIdTokenForDeveloperIdentity Source # 
NFData GetOpenIdTokenForDeveloperIdentity Source # 
AWSRequest GetOpenIdTokenForDeveloperIdentity Source # 
ToQuery GetOpenIdTokenForDeveloperIdentity Source # 
ToPath GetOpenIdTokenForDeveloperIdentity Source # 
ToHeaders GetOpenIdTokenForDeveloperIdentity Source # 
type Rep GetOpenIdTokenForDeveloperIdentity Source # 
type Rep GetOpenIdTokenForDeveloperIdentity = D1 (MetaData "GetOpenIdTokenForDeveloperIdentity" "Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity" "amazonka-cognito-identity-1.5.0-2qFYgszJ6M87WvyWvg2D9u" False) (C1 (MetaCons "GetOpenIdTokenForDeveloperIdentity'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_goitfdiTokenDuration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_goitfdiIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_goitfdiIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_goitfdiLogins") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Map Text Text))))))
type Rs GetOpenIdTokenForDeveloperIdentity Source # 

Request Lenses

goitfdiTokenDuration :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe Natural) Source #

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

goitfdiIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe Text) Source #

A unique identifier in the format REGION:GUID.

goitfdiIdentityPoolId :: Lens' GetOpenIdTokenForDeveloperIdentity Text Source #

An identity pool ID in the format REGION:GUID.

goitfdiLogins :: Lens' GetOpenIdTokenForDeveloperIdentity (HashMap Text Text) Source #

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier" . The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

Destructuring the Response

getOpenIdTokenForDeveloperIdentityResponse Source #

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

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

data GetOpenIdTokenForDeveloperIdentityResponse Source #

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

See: getOpenIdTokenForDeveloperIdentityResponse smart constructor.

Instances

Eq GetOpenIdTokenForDeveloperIdentityResponse Source # 
Data GetOpenIdTokenForDeveloperIdentityResponse Source # 

Methods

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

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

toConstr :: GetOpenIdTokenForDeveloperIdentityResponse -> Constr #

dataTypeOf :: GetOpenIdTokenForDeveloperIdentityResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> GetOpenIdTokenForDeveloperIdentityResponse -> GetOpenIdTokenForDeveloperIdentityResponse #

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

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

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

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

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

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

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

Read GetOpenIdTokenForDeveloperIdentityResponse Source # 
Show GetOpenIdTokenForDeveloperIdentityResponse Source # 
Generic GetOpenIdTokenForDeveloperIdentityResponse Source # 
NFData GetOpenIdTokenForDeveloperIdentityResponse Source # 
type Rep GetOpenIdTokenForDeveloperIdentityResponse Source # 
type Rep GetOpenIdTokenForDeveloperIdentityResponse = D1 (MetaData "GetOpenIdTokenForDeveloperIdentityResponse" "Network.AWS.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity" "amazonka-cognito-identity-1.5.0-2qFYgszJ6M87WvyWvg2D9u" False) (C1 (MetaCons "GetOpenIdTokenForDeveloperIdentityResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_goitfdirsToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_goitfdirsIdentityId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_goitfdirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

goitfdirsIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text) Source #

A unique identifier in the format REGION:GUID.