Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for GetOpenIdTokenForDeveloperIdentity.
- getOpenIdTokenForDeveloperIdentity :: Text -> GetOpenIdTokenForDeveloperIdentity
- data GetOpenIdTokenForDeveloperIdentity
- goitfdiTokenDuration :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe Natural)
- goitfdiIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentity (Maybe Text)
- goitfdiIdentityPoolId :: Lens' GetOpenIdTokenForDeveloperIdentity Text
- goitfdiLogins :: Lens' GetOpenIdTokenForDeveloperIdentity (HashMap Text Text)
- getOpenIdTokenForDeveloperIdentityResponse :: Int -> GetOpenIdTokenForDeveloperIdentityResponse
- data GetOpenIdTokenForDeveloperIdentityResponse
- goitfdirsToken :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text)
- goitfdirsIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text)
- goitfdirsStatus :: Lens' GetOpenIdTokenForDeveloperIdentityResponse Int
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:
data GetOpenIdTokenForDeveloperIdentity Source
Input to the GetOpenIdTokenForDeveloperIdentity
action.
See: getOpenIdTokenForDeveloperIdentity
smart constructor.
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.
Response Lenses
goitfdirsToken :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text) Source
An OpenID token.
goitfdirsIdentityId :: Lens' GetOpenIdTokenForDeveloperIdentityResponse (Maybe Text) Source
A unique identifier in the format REGION:GUID.
goitfdirsStatus :: Lens' GetOpenIdTokenForDeveloperIdentityResponse Int Source
The response status code.