Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- getOpenIdToken :: Text -> GetOpenIdToken
- data GetOpenIdToken
- goitLogins :: Lens' GetOpenIdToken (HashMap Text Text)
- goitIdentityId :: Lens' GetOpenIdToken Text
- getOpenIdTokenResponse :: Int -> GetOpenIdTokenResponse
- data GetOpenIdTokenResponse
- goitrsToken :: Lens' GetOpenIdTokenResponse (Maybe Text)
- goitrsIdentityId :: Lens' GetOpenIdTokenResponse (Maybe Text)
- goitrsResponseStatus :: Lens' GetOpenIdTokenResponse Int
Creating a Request
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
- 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 Identity Provider, or any other OpenId Connect provider, always include theid_token
.goitIdentityId
- A unique identifier in the format REGION:GUID.
data GetOpenIdToken Source #
Input to the GetOpenIdToken action.
See: getOpenIdToken
smart constructor.
Request Lenses
goitLogins :: Lens' GetOpenIdToken (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 Identity Provider, or any other OpenId Connect provider, always include the id_token
.
goitIdentityId :: Lens' GetOpenIdToken Text Source #
A unique identifier in the format REGION:GUID.
Destructuring the Response
getOpenIdTokenResponse Source #
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
- An OpenID token, valid for 15 minutes.goitrsIdentityId
- A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.goitrsResponseStatus
- -- | The response status code.
data GetOpenIdTokenResponse Source #
Returned in response to a successful GetOpenIdToken request.
See: getOpenIdTokenResponse
smart constructor.
Response Lenses
goitrsToken :: Lens' GetOpenIdTokenResponse (Maybe Text) Source #
An OpenID token, valid for 15 minutes.
goitrsIdentityId :: 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.
goitrsResponseStatus :: Lens' GetOpenIdTokenResponse Int Source #
- - | The response status code.