You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentity::Types::GetOpenIdTokenForDeveloperIdentityInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentity::Types::GetOpenIdTokenForDeveloperIdentityInput
- Defined in:
- (unknown)
Overview
When passing GetOpenIdTokenForDeveloperIdentityInput as input to an Aws::Client method, you can use a vanilla Hash:
{
identity_pool_id: "IdentityPoolId", # required
identity_id: "IdentityId",
logins: { # required
"IdentityProviderName" => "IdentityProviderToken",
},
token_duration: 1,
}
Input to the GetOpenIdTokenForDeveloperIdentity
action.
Instance Attribute Summary collapse
-
#identity_id ⇒ String
A unique identifier in the format REGION:GUID.
-
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
-
#logins ⇒ Hash<String,String>
A set of optional name-value pairs that map provider names to provider tokens.
-
#token_duration ⇒ Integer
The expiration time of the token, in seconds.
Instance Attribute Details
#identity_id ⇒ String
A unique identifier in the format REGION:GUID.
#identity_pool_id ⇒ String
An identity pool ID in the format REGION:GUID.
#logins ⇒ Hash<String,String>
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.
#token_duration ⇒ Integer
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.