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

Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

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

data GetOpenIdTokenForDeveloperIdentity Source #

Input to the GetOpenIdTokenForDeveloperIdentity action.

See: newGetOpenIdTokenForDeveloperIdentity smart constructor.

Constructors

GetOpenIdTokenForDeveloperIdentity' 

Fields

  • tokenDuration :: Maybe Natural

    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.

    Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

  • principalTags :: Maybe (HashMap Text Text)

    Use this operation to configure attribute mappings for custom providers.

  • identityId :: Maybe Text

    A unique identifier in the format REGION:GUID.

  • identityPoolId :: Text

    An identity pool ID in the format REGION:GUID.

  • logins :: HashMap Text Text

    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.

Instances

Instances details
Eq GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Read GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Show GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Generic GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Associated Types

type Rep GetOpenIdTokenForDeveloperIdentity :: Type -> Type #

NFData GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Hashable GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

ToJSON GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

AWSRequest GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

ToHeaders GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

ToPath GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

ToQuery GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

type Rep GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

type Rep GetOpenIdTokenForDeveloperIdentity = D1 ('MetaData "GetOpenIdTokenForDeveloperIdentity" "Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "GetOpenIdTokenForDeveloperIdentity'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tokenDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "principalTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "logins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))))
type AWSResponse GetOpenIdTokenForDeveloperIdentity Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

newGetOpenIdTokenForDeveloperIdentity Source #

Create a value of GetOpenIdTokenForDeveloperIdentity 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:tokenDuration:GetOpenIdTokenForDeveloperIdentity', getOpenIdTokenForDeveloperIdentity_tokenDuration - 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.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

$sel:principalTags:GetOpenIdTokenForDeveloperIdentity', getOpenIdTokenForDeveloperIdentity_principalTags - Use this operation to configure attribute mappings for custom providers.

$sel:identityId:GetOpenIdTokenForDeveloperIdentity', getOpenIdTokenForDeveloperIdentity_identityId - A unique identifier in the format REGION:GUID.

$sel:identityPoolId:GetOpenIdTokenForDeveloperIdentity', getOpenIdTokenForDeveloperIdentity_identityPoolId - An identity pool ID in the format REGION:GUID.

$sel:logins:GetOpenIdTokenForDeveloperIdentity', getOpenIdTokenForDeveloperIdentity_logins - 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.

Request Lenses

getOpenIdTokenForDeveloperIdentity_tokenDuration :: 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.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

getOpenIdTokenForDeveloperIdentity_principalTags :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe (HashMap Text Text)) Source #

Use this operation to configure attribute mappings for custom providers.

getOpenIdTokenForDeveloperIdentity_logins :: 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

data GetOpenIdTokenForDeveloperIdentityResponse Source #

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

See: newGetOpenIdTokenForDeveloperIdentityResponse smart constructor.

Constructors

GetOpenIdTokenForDeveloperIdentityResponse' 

Fields

Instances

Instances details
Eq GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Read GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Show GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

Generic GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

NFData GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

type Rep GetOpenIdTokenForDeveloperIdentityResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity

type Rep GetOpenIdTokenForDeveloperIdentityResponse = D1 ('MetaData "GetOpenIdTokenForDeveloperIdentityResponse" "Amazonka.CognitoIdentity.GetOpenIdTokenForDeveloperIdentity" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "GetOpenIdTokenForDeveloperIdentityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

Response Lenses