com.amazonaws.services.cognitoidentity.model

Class GetOpenIdTokenForDeveloperIdentityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetOpenIdTokenForDeveloperIdentityRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetOpenIdTokenForDeveloperIdentityRequest()

Method Summary

Modifier and Type	Method and Description
GetOpenIdTokenForDeveloperIdentityRequest	addLoginsEntry(java.lang.String key, java.lang.String value) A set of optional name-value pairs that map provider names to provider tokens.
GetOpenIdTokenForDeveloperIdentityRequest	addPrincipalTagsEntry(java.lang.String key, java.lang.String value) Use this operation to configure attribute mappings for custom providers.
GetOpenIdTokenForDeveloperIdentityRequest	clearLoginsEntries() Removes all the entries added into Logins.
GetOpenIdTokenForDeveloperIdentityRequest	clearPrincipalTagsEntries() Removes all the entries added into PrincipalTags.
boolean	equals(java.lang.Object obj)
java.lang.String	getIdentityId() A unique identifier in the format REGION:GUID.
java.lang.String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
java.util.Map<java.lang.String,java.lang.String>	getLogins() A set of optional name-value pairs that map provider names to provider tokens.
java.util.Map<java.lang.String,java.lang.String>	getPrincipalTags() Use this operation to configure attribute mappings for custom providers.
java.lang.Long	getTokenDuration() The expiration time of the token, in seconds.
int	hashCode()
void	setIdentityId(java.lang.String identityId) A unique identifier in the format REGION:GUID.
void	setIdentityPoolId(java.lang.String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setLogins(java.util.Map<java.lang.String,java.lang.String> logins) A set of optional name-value pairs that map provider names to provider tokens.
void	setPrincipalTags(java.util.Map<java.lang.String,java.lang.String> principalTags) Use this operation to configure attribute mappings for custom providers.
void	setTokenDuration(java.lang.Long tokenDuration) The expiration time of the token, in seconds.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetOpenIdTokenForDeveloperIdentityRequest	withIdentityId(java.lang.String identityId) A unique identifier in the format REGION:GUID.
GetOpenIdTokenForDeveloperIdentityRequest	withIdentityPoolId(java.lang.String identityPoolId) An identity pool ID in the format REGION:GUID.
GetOpenIdTokenForDeveloperIdentityRequest	withLogins(java.util.Map<java.lang.String,java.lang.String> logins) A set of optional name-value pairs that map provider names to provider tokens.
GetOpenIdTokenForDeveloperIdentityRequest	withPrincipalTags(java.util.Map<java.lang.String,java.lang.String> principalTags) Use this operation to configure attribute mappings for custom providers.
GetOpenIdTokenForDeveloperIdentityRequest	withTokenDuration(java.lang.Long tokenDuration) The expiration time of the token, in seconds.

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

GetOpenIdTokenForDeveloperIdentityRequest

public GetOpenIdTokenForDeveloperIdentityRequest()

Method Detail

getIdentityPoolId

public java.lang.String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

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

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(java.lang.String identityPoolId)

An identity pool ID in the format REGION:GUID.

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

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public GetOpenIdTokenForDeveloperIdentityRequest withIdentityPoolId(java.lang.String identityPoolId)

An identity pool ID 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:

identityPoolId -

An identity pool ID in the format REGION:GUID.

Returns:

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

getIdentityId

public java.lang.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(java.lang.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 GetOpenIdTokenForDeveloperIdentityRequest withIdentityId(java.lang.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 java.util.Map<java.lang.String,java.lang.String> getLogins()

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.

Returns:

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.

setLogins

public void setLogins(java.util.Map<java.lang.String,java.lang.String> 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.

Parameters:

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.

withLogins

public GetOpenIdTokenForDeveloperIdentityRequest withLogins(java.util.Map<java.lang.String,java.lang.String> 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.

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

Returns:

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

addLoginsEntry

public GetOpenIdTokenForDeveloperIdentityRequest addLoginsEntry(java.lang.String key,
                                                                java.lang.String value)

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.

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 GetOpenIdTokenForDeveloperIdentityRequest clearLoginsEntries()

Removes all the entries added into Logins.

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

getPrincipalTags

public java.util.Map<java.lang.String,java.lang.String> getPrincipalTags()

Use this operation to configure attribute mappings for custom providers.

Returns:

Use this operation to configure attribute mappings for custom providers.

setPrincipalTags

public void setPrincipalTags(java.util.Map<java.lang.String,java.lang.String> principalTags)

Use this operation to configure attribute mappings for custom providers.

Parameters:

principalTags -

Use this operation to configure attribute mappings for custom providers.

withPrincipalTags

public GetOpenIdTokenForDeveloperIdentityRequest withPrincipalTags(java.util.Map<java.lang.String,java.lang.String> principalTags)

Use this operation to configure attribute mappings for custom providers.

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

Parameters:

principalTags -

Use this operation to configure attribute mappings for custom providers.

Returns:

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

addPrincipalTagsEntry

public GetOpenIdTokenForDeveloperIdentityRequest addPrincipalTagsEntry(java.lang.String key,
                                                                       java.lang.String value)

Use this operation to configure attribute mappings for custom providers.

The method adds a new key-value pair into PrincipalTags 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 PrincipalTags.

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

Returns:

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

clearPrincipalTagsEntries

public GetOpenIdTokenForDeveloperIdentityRequest clearPrincipalTagsEntries()

Removes all the entries added into PrincipalTags.

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

getTokenDuration

public java.lang.Long getTokenDuration()

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.

Constraints:
Range: 1 - 86400

Returns:

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.

setTokenDuration

public void setTokenDuration(java.lang.Long 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.

Constraints:
Range: 1 - 86400

Parameters:

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.

withTokenDuration

public GetOpenIdTokenForDeveloperIdentityRequest withTokenDuration(java.lang.Long 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.

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

Constraints:
Range: 1 - 86400

Parameters:

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.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object