public class CreateUserPoolClientRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
Creates the user pool client.
When you create a new user pool client, token revocation is automatically activated. For more information about revoking tokens, see RevokeToken.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
| Constructor and Description |
|---|
CreateUserPoolClientRequest() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getAccessTokenValidity()
The access token time limit.
|
java.util.List<java.lang.String> |
getAllowedOAuthFlows()
The allowed OAuth flows.
|
java.lang.Boolean |
getAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app
client. |
java.util.List<java.lang.String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The user pool analytics configuration for collecting metrics and sending
them to your Amazon Pinpoint campaign.
|
java.lang.Integer |
getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
java.util.List<java.lang.String> |
getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
|
java.lang.String |
getClientName()
The client name for the user pool client you would like to create.
|
java.lang.String |
getDefaultRedirectURI()
The default redirect URI.
|
java.lang.Boolean |
getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
java.lang.Boolean |
getEnableTokenRevocation()
Activates or deactivates token revocation.
|
java.util.List<java.lang.String> |
getExplicitAuthFlows()
The authentication flows that you want your user pool client to support.
|
java.lang.Boolean |
getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user
pool client being created.
|
java.lang.Integer |
getIdTokenValidity()
The ID token time limit.
|
java.util.List<java.lang.String> |
getLogoutURLs()
A list of allowed logout URLs for the IdPs.
|
java.lang.String |
getPreventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
java.util.List<java.lang.String> |
getReadAttributes()
The read attributes.
|
java.lang.Integer |
getRefreshTokenValidity()
The refresh token time limit.
|
java.util.List<java.lang.String> |
getSupportedIdentityProviders()
A list of provider names for the identity providers (IdPs) that are
supported on this client.
|
TokenValidityUnitsType |
getTokenValidityUnits()
The units in which the validity times are represented.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool where you want to create a user pool
client.
|
java.util.List<java.lang.String> |
getWriteAttributes()
The user pool attributes that the app client can write to.
|
int |
hashCode() |
java.lang.Boolean |
isAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app
client. |
java.lang.Boolean |
isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
java.lang.Boolean |
isEnableTokenRevocation()
Activates or deactivates token revocation.
|
java.lang.Boolean |
isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user
pool client being created.
|
void |
setAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit.
|
void |
setAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
|
void |
setAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app
client. |
void |
setAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes.
|
void |
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending
them to your Amazon Pinpoint campaign.
|
void |
setAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
void |
setCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
void |
setClientName(java.lang.String clientName)
The client name for the user pool client you would like to create.
|
void |
setDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI.
|
void |
setEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
void |
setEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
void |
setExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
void |
setGenerateSecret(java.lang.Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user
pool client being created.
|
void |
setIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit.
|
void |
setLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
void |
setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
void |
setPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
void |
setReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read attributes.
|
void |
setRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit.
|
void |
setSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client.
|
void |
setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to create a user pool
client.
|
void |
setWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The user pool attributes that the app client can write to.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateUserPoolClientRequest |
withAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlows(java.lang.String... allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app
client. |
CreateUserPoolClientRequest |
withAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes.
|
CreateUserPoolClientRequest |
withAllowedOAuthScopes(java.lang.String... allowedOAuthScopes)
The allowed OAuth scopes.
|
CreateUserPoolClientRequest |
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending
them to your Amazon Pinpoint campaign.
|
CreateUserPoolClientRequest |
withAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
CreateUserPoolClientRequest |
withCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest |
withCallbackURLs(java.lang.String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest |
withClientName(java.lang.String clientName)
The client name for the user pool client you would like to create.
|
CreateUserPoolClientRequest |
withDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI.
|
CreateUserPoolClientRequest |
withEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
CreateUserPoolClientRequest |
withEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(java.lang.String... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
CreateUserPoolClientRequest |
withGenerateSecret(java.lang.Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user
pool client being created.
|
CreateUserPoolClientRequest |
withIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit.
|
CreateUserPoolClientRequest |
withLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
CreateUserPoolClientRequest |
withLogoutURLs(java.lang.String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
CreateUserPoolClientRequest |
withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
CreateUserPoolClientRequest |
withPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
CreateUserPoolClientRequest |
withReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read attributes.
|
CreateUserPoolClientRequest |
withReadAttributes(java.lang.String... readAttributes)
The read attributes.
|
CreateUserPoolClientRequest |
withRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(java.lang.String... supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client.
|
CreateUserPoolClientRequest |
withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented.
|
CreateUserPoolClientRequest |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to create a user pool
client.
|
CreateUserPoolClientRequest |
withWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The user pool attributes that the app client can write to.
|
CreateUserPoolClientRequest |
withWriteAttributes(java.lang.String... writeAttributes)
The user pool attributes that the app client can write to.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool where you want to create a user pool client.
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where you want to create a user pool client.
public CreateUserPoolClientRequest withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where you want to create a user pool client.
public java.lang.String getClientName()
The client name for the user pool client you would like to create.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
The client name for the user pool client you would like to create.
public void setClientName(java.lang.String clientName)
The client name for the user pool client you would like to create.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - The client name for the user pool client you would like to create.
public CreateUserPoolClientRequest withClientName(java.lang.String clientName)
The client name for the user pool client you would like to create.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - The client name for the user pool client you would like to create.
public java.lang.Boolean isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
Boolean to specify whether you want to generate a secret for the user pool client being created.
public java.lang.Boolean getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
Boolean to specify whether you want to generate a secret for the user pool client being created.
public void setGenerateSecret(java.lang.Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.
public CreateUserPoolClientRequest withGenerateSecret(java.lang.Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
Returns a reference to this object so that method calls can be chained together.
generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.
public java.lang.Integer getRefreshTokenValidity()
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Constraints:
Range: 0 - 315360000
The refresh token time limit. After this limit expires, your user
can't use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an
API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito
overrides the value with the default value of 30 days. Valid
range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public void setRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Constraints:
Range: 0 - 315360000
refreshTokenValidity -
The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit
for RefreshTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in
an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon
Cognito overrides the value with the default value of 30 days.
Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public CreateUserPoolClientRequest withRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 315360000
refreshTokenValidity -
The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit
for RefreshTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in
an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon
Cognito overrides the value with the default value of 30 days.
Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public java.lang.Integer getAccessTokenValidity()
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Constraints:
Range: 1 - 86400
The access token time limit. After this limit expires, your user
can't use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public void setAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Constraints:
Range: 1 - 86400
accessTokenValidity -
The access token time limit. After this limit expires, your
user can't use their access token. To specify the time unit
for AccessTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in
an API request is hours. Valid range is displayed below
in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public CreateUserPoolClientRequest withAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 86400
accessTokenValidity -
The access token time limit. After this limit expires, your
user can't use their access token. To specify the time unit
for AccessTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in
an API request is hours. Valid range is displayed below
in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public java.lang.Integer getIdTokenValidity()
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Constraints:
Range: 1 - 86400
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session with
their ID token for 10 hours.
The default time unit for IdTokenValidity in an API
request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public void setIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Constraints:
Range: 1 - 86400
idTokenValidity -
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session
with their ID token for 10 hours.
The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public CreateUserPoolClientRequest withIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 86400
idTokenValidity -
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session
with their ID token for 10 hours.
The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public TokenValidityUnitsType getTokenValidityUnits()
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
public CreateUserPoolClientRequest withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
Returns a reference to this object so that method calls can be chained together.
tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
public java.util.List<java.lang.String> getReadAttributes()
The read attributes.
The read attributes.
public void setReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read attributes.
readAttributes - The read attributes.
public CreateUserPoolClientRequest withReadAttributes(java.lang.String... readAttributes)
The read attributes.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The read attributes.
public CreateUserPoolClientRequest withReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read attributes.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The read attributes.
public java.util.List<java.lang.String> getWriteAttributes()
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public void setWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public CreateUserPoolClientRequest withWriteAttributes(java.lang.String... writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public CreateUserPoolClientRequest withWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public java.util.List<java.lang.String> getExplicitAuthFlows()
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows,
your user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based
user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the
ADMIN_NO_SRP_AUTH setting. With this authentication
flow, your app passes a user name and password to Amazon Cognito
in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the
password in the request instead of using the SRP protocol to
verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh
tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the
same time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
public void setExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public CreateUserPoolClientRequest withExplicitAuthFlows(java.lang.String... explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public CreateUserPoolClientRequest withExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public java.util.List<java.lang.String> getSupportedIdentityProviders()
A list of provider names for the identity providers (IdPs) that are
supported on this client. The following are supported:
COGNITO, Facebook, Google,
SignInWithApple, and LoginWithAmazon. You can
also specify the names that you configured for the SAML and OIDC IdPs in
your user pool, for example MySAMLIdP or
MyOIDCIdP.
A list of provider names for the identity providers (IdPs) that
are supported on this client. The following are supported:
COGNITO, Facebook, Google,
SignInWithApple, and LoginWithAmazon.
You can also specify the names that you configured for the SAML
and OIDC IdPs in your user pool, for example
MySAMLIdP or MyOIDCIdP.
public void setSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client. The following are supported:
COGNITO, Facebook, Google,
SignInWithApple, and LoginWithAmazon. You can
also specify the names that you configured for the SAML and OIDC IdPs in
your user pool, for example MySAMLIdP or
MyOIDCIdP.
supportedIdentityProviders -
A list of provider names for the identity providers (IdPs)
that are supported on this client. The following are
supported: COGNITO, Facebook,
Google, SignInWithApple, and
LoginWithAmazon. You can also specify the names
that you configured for the SAML and OIDC IdPs in your user
pool, for example MySAMLIdP or
MyOIDCIdP.
public CreateUserPoolClientRequest withSupportedIdentityProviders(java.lang.String... supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client. The following are supported:
COGNITO, Facebook, Google,
SignInWithApple, and LoginWithAmazon. You can
also specify the names that you configured for the SAML and OIDC IdPs in
your user pool, for example MySAMLIdP or
MyOIDCIdP.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders -
A list of provider names for the identity providers (IdPs)
that are supported on this client. The following are
supported: COGNITO, Facebook,
Google, SignInWithApple, and
LoginWithAmazon. You can also specify the names
that you configured for the SAML and OIDC IdPs in your user
pool, for example MySAMLIdP or
MyOIDCIdP.
public CreateUserPoolClientRequest withSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are
supported on this client. The following are supported:
COGNITO, Facebook, Google,
SignInWithApple, and LoginWithAmazon. You can
also specify the names that you configured for the SAML and OIDC IdPs in
your user pool, for example MySAMLIdP or
MyOIDCIdP.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders -
A list of provider names for the identity providers (IdPs)
that are supported on this client. The following are
supported: COGNITO, Facebook,
Google, SignInWithApple, and
LoginWithAmazon. You can also specify the names
that you configured for the SAML and OIDC IdPs in your user
pool, for example MySAMLIdP or
MyOIDCIdP.
public java.util.List<java.lang.String> getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public void setCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest withCallbackURLs(java.lang.String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest withCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public java.util.List<java.lang.String> getLogoutURLs()
A list of allowed logout URLs for the IdPs.
A list of allowed logout URLs for the IdPs.
public void setLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.
public CreateUserPoolClientRequest withLogoutURLs(java.lang.String... logoutURLs)
A list of allowed logout URLs for the IdPs.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the IdPs.
public CreateUserPoolClientRequest withLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the IdPs.
public java.lang.String getDefaultRedirectURI()
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public void setDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest withDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public java.util.List<java.lang.String> getAllowedOAuthFlows()
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens with
the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of the
client ID and client secret.
public void setAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public CreateUserPoolClientRequest withAllowedOAuthFlows(java.lang.String... allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public CreateUserPoolClientRequest withAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public java.util.List<java.lang.String> getAllowedOAuthScopes()
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web
Services are aws.cognito.signin.user.admin. Custom
scopes created in Resource Servers are also supported.
public void setAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public CreateUserPoolClientRequest withAllowedOAuthScopes(java.lang.String... allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public CreateUserPoolClientRequest withAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public java.lang.Boolean isAllowedOAuthFlowsUserPoolClient()
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user
pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following features
in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code,
implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the
Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true
in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a
value for AllowedOAuthFlowsUserPoolClient in a
request with the CLI or SDKs, it defaults to false.
public java.lang.Boolean getAllowedOAuthFlowsUserPoolClient()
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user
pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following features
in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code,
implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the
Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true
in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a
value for AllowedOAuthFlowsUserPoolClient in a
request with the CLI or SDKs, it defaults to false.
public void setAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
allowedOAuthFlowsUserPoolClient -
Set to true to use OAuth 2.0 features in your
user pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following
features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization
code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in
the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't
set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to
false.
public CreateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlowsUserPoolClient -
Set to true to use OAuth 2.0 features in your
user pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following
features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization
code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in
the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't
set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to
false.
public AnalyticsConfigurationType getAnalyticsConfiguration()
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public CreateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Returns a reference to this object so that method calls can be chained together.
analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public java.lang.String getPreventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
Errors and responses that you want Amazon Cognito APIs to return
during authentication, account confirmation, and password
recovery when the user doesn't exist in the user pool. When set
to ENABLED and the user doesn't exist,
authentication returns an error indicating either the username or
password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a
simulated destination. When set to LEGACY, those
APIs return a UserNotFoundException exception if the
user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic CreateUserPoolClientRequest withPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic CreateUserPoolClientRequest withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic java.lang.Boolean isEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public java.lang.Boolean getEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public void setEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public CreateUserPoolClientRequest withEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
Returns a reference to this object so that method calls can be chained together.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public java.lang.Boolean isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Activates the propagation of additional user context data. For
more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
public java.lang.Boolean getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Activates the propagation of additional user context data. For
more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
public void setEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
enablePropagateAdditionalUserContextData -
Activates the propagation of additional user context data. For
more information about propagation of user context data, see
Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an
app client that has a client secret.
public CreateUserPoolClientRequest withEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Returns a reference to this object so that method calls can be chained together.
enablePropagateAdditionalUserContextData -
Activates the propagation of additional user context data. For
more information about propagation of user context data, see
Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an
app client that has a client secret.
public java.lang.Integer getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Constraints:
Range: 3 - 15
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the
duration, in minutes, of that session token. Your user pool
native user must respond to each authentication challenge before
the session expires.
public void setAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Constraints:
Range: 3 - 15
authSessionValidity -
Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is
the duration, in minutes, of that session token. Your user
pool native user must respond to each authentication challenge
before the session expires.
public CreateUserPoolClientRequest withAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 3 - 15
authSessionValidity -
Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is
the duration, in minutes, of that session token. Your user
pool native user must respond to each authentication challenge
before the session expires.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object