com.amazonaws.services.cognitoidentity.model

Class GetOpenIdTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenRequest

All Implemented Interfaces:

Serializable, Cloneable

public class GetOpenIdTokenRequest
extends AmazonWebServiceRequest
implements Serializable

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 10 minutes.

This is a public API. You do not need any credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetOpenIdTokenRequest()

Method Summary

Modifier and Type	Method and Description
GetOpenIdTokenRequest	addLoginsEntry(String key, String value) A set of optional name-value pairs that map provider names to provider tokens.
GetOpenIdTokenRequest	clearLoginsEntries() Removes all the entries added into Logins.
boolean	equals(Object obj)
String	getIdentityId() A unique identifier in the format REGION:GUID.
Map<String,String>	getLogins() A set of optional name-value pairs that map provider names to provider tokens.
int	hashCode()
void	setIdentityId(String identityId) A unique identifier in the format REGION:GUID.
void	setLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetOpenIdTokenRequest	withIdentityId(String identityId) A unique identifier in the format REGION:GUID.
GetOpenIdTokenRequest	withLogins(Map<String,String> logins) A set of optional name-value pairs that map provider names to provider tokens.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetOpenIdTokenRequest

public GetOpenIdTokenRequest()

Method Detail

getIdentityId

public String getIdentityId()

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A unique identifier in the format REGION:GUID.

setIdentityId

public void setIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId -

A unique identifier in the format REGION:GUID.

withIdentityId

public GetOpenIdTokenRequest withIdentityId(String identityId)

A unique identifier in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityId -

A unique identifier in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogins

public Map<String,String> getLogins()

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

Returns:

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

setLogins

public void setLogins(Map<String,String> logins)

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

Parameters:

logins -

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

withLogins

public GetOpenIdTokenRequest withLogins(Map<String,String> logins)

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

Returns a reference to this object so that method calls can be chained together.

Parameters:

logins -

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

Returns:

A reference to this updated object so that method calls can be chained together.

addLoginsEntry

public GetOpenIdTokenRequest addLoginsEntry(String key,
                                            String value)

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 user pool provider, or any other OpenId Connect provider, always include the id_token.

The method adds a new key-value pair into Logins parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Logins.

value - The corresponding value of the entry to be added into Logins.

Returns:

A reference to this updated object so that method calls can be chained together.

clearLoginsEntries

public GetOpenIdTokenRequest clearLoginsEntries()

Removes all the entries added into Logins.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object