@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to create a user pool client.
NOOP| Constructor and Description |
|---|
CreateUserPoolClientRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateUserPoolClientRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAccessTokenValidity()
The access token time limit.
|
List<String> |
getAllowedOAuthFlows()
The allowed OAuth flows.
|
Boolean |
getAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app client. |
List<String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
|
Integer |
getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an authentication flow.
|
List<String> |
getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
|
String |
getClientName()
The client name for the user pool client you would like to create.
|
String |
getDefaultRedirectURI()
The default redirect URI.
|
Boolean |
getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
Boolean |
getEnableTokenRevocation()
Activates or deactivates token revocation.
|
List<String> |
getExplicitAuthFlows()
The authentication flows that you want your user pool client to support.
|
Boolean |
getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
Integer |
getIdTokenValidity()
The ID token time limit.
|
List<String> |
getLogoutURLs()
A list of allowed logout URLs for the IdPs.
|
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.
|
List<String> |
getReadAttributes()
The list of user attributes that you want your app client to have read-only access to.
|
Integer |
getRefreshTokenValidity()
The refresh token time limit.
|
List<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.
|
String |
getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
|
List<String> |
getWriteAttributes()
The list of user attributes that you want your app client to have write access to.
|
int |
hashCode() |
Boolean |
isAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app client. |
Boolean |
isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
Boolean |
isEnableTokenRevocation()
Activates or deactivates token revocation.
|
Boolean |
isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
void |
setAccessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
void |
setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
void |
setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app client. |
void |
setAllowedOAuthScopes(Collection<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(Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an authentication flow.
|
void |
setCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
void |
setClientName(String clientName)
The client name for the user pool client you would like to create.
|
void |
setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
void |
setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
void |
setEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
void |
setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
void |
setGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
void |
setIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
void |
setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
void |
setPreventUserExistenceErrors(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(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
void |
setRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
void |
setSupportedIdentityProviders(Collection<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(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
|
void |
setWriteAttributes(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
String |
toString()
Returns a string representation of this object.
|
CreateUserPoolClientRequest |
withAccessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest |
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app client. |
CreateUserPoolClientRequest |
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
CreateUserPoolClientRequest |
withAllowedOAuthScopes(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(Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an authentication flow.
|
CreateUserPoolClientRequest |
withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest |
withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest |
withClientName(String clientName)
The client name for the user pool client you would like to create.
|
CreateUserPoolClientRequest |
withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
CreateUserPoolClientRequest |
withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
CreateUserPoolClientRequest |
withEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
CreateUserPoolClientRequest |
withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
CreateUserPoolClientRequest |
withGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
CreateUserPoolClientRequest |
withIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
CreateUserPoolClientRequest |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
CreateUserPoolClientRequest |
withLogoutURLs(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(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(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
CreateUserPoolClientRequest |
withReadAttributes(String... readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
CreateUserPoolClientRequest |
withRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers (IdPs) that are supported on this client.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(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(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
|
CreateUserPoolClientRequest |
withWriteAttributes(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
CreateUserPoolClientRequest |
withWriteAttributes(String... writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId - The user pool ID for the user pool where you want to create a user pool client.public String getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
public CreateUserPoolClientRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId - The user pool ID for the user pool where you want to create a user pool client.public void setClientName(String clientName)
The client name for the user pool client you would like to create.
clientName - The client name for the user pool client you would like to create.public String getClientName()
The client name for the user pool client you would like to create.
public CreateUserPoolClientRequest withClientName(String clientName)
The client name for the user pool client you would like to create.
clientName - The client name for the user pool client you would like to create.public void setGenerateSecret(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 Boolean getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public CreateUserPoolClientRequest withGenerateSecret(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 Boolean isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public void setRefreshTokenValidity(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.
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 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.
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(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.
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 void setAccessTokenValidity(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.
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 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.
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(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.
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 void setIdTokenValidity(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.
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 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.
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(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.
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 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 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.
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.
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 List<String> getReadAttributes()
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values of
email_verified, phone_number_verified, and the Standard attributes of your user pool.
When your user pool has read access to these default attributes, ReadAttributes doesn't return any
information. Amazon Cognito only populates ReadAttributes in the API response if you have specified
your own custom set of read attributes.
When you don't specify the ReadAttributes for your app client, your app can read the values
of email_verified, phone_number_verified, and the Standard attributes of your
user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes in the API
response if you have specified your own custom set of read attributes.
public void setReadAttributes(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values of
email_verified, phone_number_verified, and the Standard attributes of your user pool.
When your user pool has read access to these default attributes, ReadAttributes doesn't return any
information. Amazon Cognito only populates ReadAttributes in the API response if you have specified
your own custom set of read attributes.
readAttributes - The list of user attributes that you want your app client to have read-only access to. After your user
authenticates in your app, their access token authorizes them to read their own attribute value for any
attribute in this list. An example of this kind of activity is when your user selects a link to view their
profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values
of email_verified, phone_number_verified, and the Standard attributes of your
user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes in the API
response if you have specified your own custom set of read attributes.
public CreateUserPoolClientRequest withReadAttributes(String... readAttributes)
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values of
email_verified, phone_number_verified, and the Standard attributes of your user pool.
When your user pool has read access to these default attributes, ReadAttributes doesn't return any
information. Amazon Cognito only populates ReadAttributes in the API response if you have specified
your own custom set of read attributes.
NOTE: This method appends the values to the existing list (if any). Use
setReadAttributes(java.util.Collection) or withReadAttributes(java.util.Collection) if you want
to override the existing values.
readAttributes - The list of user attributes that you want your app client to have read-only access to. After your user
authenticates in your app, their access token authorizes them to read their own attribute value for any
attribute in this list. An example of this kind of activity is when your user selects a link to view their
profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values
of email_verified, phone_number_verified, and the Standard attributes of your
user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes in the API
response if you have specified your own custom set of read attributes.
public CreateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to. After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values of
email_verified, phone_number_verified, and the Standard attributes of your user pool.
When your user pool has read access to these default attributes, ReadAttributes doesn't return any
information. Amazon Cognito only populates ReadAttributes in the API response if you have specified
your own custom set of read attributes.
readAttributes - The list of user attributes that you want your app client to have read-only access to. After your user
authenticates in your app, their access token authorizes them to read their own attribute value for any
attribute in this list. An example of this kind of activity is when your user selects a link to view their
profile information. Your app makes a GetUser API request to retrieve and display your user's profile data.
When you don't specify the ReadAttributes for your app client, your app can read the values
of email_verified, phone_number_verified, and the Standard attributes of your
user pool. When your user pool has read access to these default attributes, ReadAttributes
doesn't return any information. Amazon Cognito only populates ReadAttributes in the API
response if you have specified your own custom set of read attributes.
public List<String> getWriteAttributes()
The list of user attributes that you want your app client to have write access to. After your user authenticates
in your app, their access token authorizes them to set or modify their own attribute value for any attribute in
this list. An example of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values of the
Standard attributes of your user pool. When your user pool has write access to these default attributes,
WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write attributes.
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.
family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the
values of the Standard attributes of your user pool. When your user pool has write access to these
default attributes, WriteAttributes doesn't return any information. Amazon Cognito only
populates WriteAttributes in the API response if you have specified your own custom set of
write attributes.
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(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to. After your user authenticates
in your app, their access token authorizes them to set or modify their own attribute value for any attribute in
this list. An example of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values of the
Standard attributes of your user pool. When your user pool has write access to these default attributes,
WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write attributes.
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 list of user attributes that you want your app client to have write access to. After your user
authenticates in your app, their access token authorizes them to set or modify their own attribute value
for any attribute in this list. An example of this kind of activity is when you present your user with a
form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values
of the Standard attributes of your user pool. When your user pool has write access to these default
attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write
attributes.
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(String... writeAttributes)
The list of user attributes that you want your app client to have write access to. After your user authenticates
in your app, their access token authorizes them to set or modify their own attribute value for any attribute in
this list. An example of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values of the
Standard attributes of your user pool. When your user pool has write access to these default attributes,
WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write attributes.
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.
NOTE: This method appends the values to the existing list (if any). Use
setWriteAttributes(java.util.Collection) or withWriteAttributes(java.util.Collection) if you
want to override the existing values.
writeAttributes - The list of user attributes that you want your app client to have write access to. After your user
authenticates in your app, their access token authorizes them to set or modify their own attribute value
for any attribute in this list. An example of this kind of activity is when you present your user with a
form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values
of the Standard attributes of your user pool. When your user pool has write access to these default
attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write
attributes.
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(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to. After your user authenticates
in your app, their access token authorizes them to set or modify their own attribute value for any attribute in
this list. An example of this kind of activity is when you present your user with a form to update their profile
information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values of the
Standard attributes of your user pool. When your user pool has write access to these default attributes,
WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write attributes.
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 list of user attributes that you want your app client to have write access to. After your user
authenticates in your app, their access token authorizes them to set or modify their own attribute value
for any attribute in this list. An example of this kind of activity is when you present your user with a
form to update their profile information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the new value.
When you don't specify the WriteAttributes for your app client, your app can write the values
of the Standard attributes of your user pool. When your user pool has write access to these default
attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates
WriteAttributes in the API response if you have specified your own custom set of write
attributes.
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 List<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.
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.
ExplicitAuthFlowsTypepublic void setExplicitAuthFlows(Collection<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.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(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.
NOTE: This method appends the values to the existing list (if any). Use
setExplicitAuthFlows(java.util.Collection) or withExplicitAuthFlows(java.util.Collection) if
you want to override the existing values.
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.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(Collection<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.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... 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.
ExplicitAuthFlowsTypepublic List<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.
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(Collection<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(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.
NOTE: This method appends the values to the existing list (if any). Use
setSupportedIdentityProviders(java.util.Collection) or
withSupportedIdentityProviders(java.util.Collection) if you want to override the existing values.
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(Collection<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 List<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 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(Collection<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(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.
NOTE: This method appends the values to the existing list (if any). Use
setCallbackURLs(java.util.Collection) or withCallbackURLs(java.util.Collection) if you want to
override the existing values.
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(Collection<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 List<String> getLogoutURLs()
A list of allowed logout URLs for the IdPs.
public void setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.public CreateUserPoolClientRequest withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
NOTE: This method appends the values to the existing list (if any). Use
setLogoutURLs(java.util.Collection) or withLogoutURLs(java.util.Collection) if you want to
override the existing values.
logoutURLs - A list of allowed logout URLs for the IdPs.public CreateUserPoolClientRequest withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.public void setDefaultRedirectURI(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.
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 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.
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(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.
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 List<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.
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.
OAuthFlowTypepublic void setAllowedOAuthFlows(Collection<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.
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(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.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedOAuthFlows(java.util.Collection) or withAllowedOAuthFlows(java.util.Collection) if
you want to override the existing values.
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.
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(Collection<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.
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... 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.
OAuthFlowTypepublic List<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.
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(Collection<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(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.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedOAuthScopes(java.util.Collection) or withAllowedOAuthScopes(java.util.Collection) if
you want to override the existing values.
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(Collection<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 void setAllowedOAuthFlowsUserPoolClient(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 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
.
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(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 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
.
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 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 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.
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.
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 void setPreventUserExistenceErrors(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.
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 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.
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(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.
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.
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 setEnableTokenRevocation(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 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.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public CreateUserPoolClientRequest withEnableTokenRevocation(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 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.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public void setEnablePropagateAdditionalUserContextData(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 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.
EnablePropagateAdditionalUserContextData in an app client that has a client secret.public CreateUserPoolClientRequest withEnablePropagateAdditionalUserContextData(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 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.
EnablePropagateAdditionalUserContextData in an app client that has a client secret.public void setAuthSessionValidity(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.
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 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.
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(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.
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 String toString()
toString in class ObjectObject.toString()public CreateUserPoolClientRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()