@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to update the user pool client.
NOOP
Constructor and Description |
---|
UpdateUserPoolClientRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateUserPoolClientRequest |
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 if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
List<String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
|
List<String> |
getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
|
String |
getClientId()
The ID of the client associated with the user pool.
|
String |
getClientName()
The client name from the update user pool client request.
|
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 are supported by the user pool clients.
|
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 read-only attributes of the user pool.
|
Integer |
getRefreshTokenValidity()
The refresh token time limit.
|
List<String> |
getSupportedIdentityProviders()
A list of provider names for the IdPs that this client supports.
|
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 update the user pool client.
|
List<String> |
getWriteAttributes()
The writeable attributes of the user pool.
|
int |
hashCode() |
Boolean |
isAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
Boolean |
isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
Boolean |
isEnableTokenRevocation()
Activates or deactivates token revocation.
|
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 if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
void |
setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
void |
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
|
void |
setCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
void |
setClientId(String clientId)
The ID of the client associated with the user pool.
|
void |
setClientName(String clientName)
The client name from the update user pool client request.
|
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 are supported by the user pool clients.
|
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 read-only attributes of the user pool.
|
void |
setRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
void |
setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
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 update the user pool client.
|
void |
setWriteAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
|
String |
toString()
Returns a string representation of this object.
|
UpdateUserPoolClientRequest |
withAccessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
UpdateUserPoolClientRequest |
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest |
withAllowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest |
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
|
UpdateUserPoolClientRequest |
withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withClientId(String clientId)
The ID of the client associated with the user pool.
|
UpdateUserPoolClientRequest |
withClientName(String clientName)
The client name from the update user pool client request.
|
UpdateUserPoolClientRequest |
withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UpdateUserPoolClientRequest |
withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
UpdateUserPoolClientRequest |
withEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
UpdateUserPoolClientRequest |
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest |
withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest |
withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest |
withIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
UpdateUserPoolClientRequest |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UpdateUserPoolClientRequest |
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.
|
UpdateUserPoolClientRequest |
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.
|
UpdateUserPoolClientRequest |
withReadAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest |
withReadAttributes(String... readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest |
withRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
UpdateUserPoolClientRequest |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UpdateUserPoolClientRequest |
withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UpdateUserPoolClientRequest |
withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented.
|
UpdateUserPoolClientRequest |
withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
|
UpdateUserPoolClientRequest |
withWriteAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
|
UpdateUserPoolClientRequest |
withWriteAttributes(String... writeAttributes)
The writeable attributes of the user pool.
|
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, withSdkRequestTimeout
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
userPoolId
- The user pool ID for the user pool where you want to update the user pool client.public String getUserPoolId()
The user pool ID for the user pool where you want to update the user pool client.
public UpdateUserPoolClientRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
userPoolId
- The user pool ID for the user pool where you want to update the user pool client.public void setClientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public String getClientId()
The ID of the client associated with the user pool.
public UpdateUserPoolClientRequest withClientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.public void setClientName(String clientName)
The client name from the update user pool client request.
clientName
- The client name from the update user pool client request.public String getClientName()
The client name from the update user pool client request.
public UpdateUserPoolClientRequest withClientName(String clientName)
The client name from the update user pool client request.
clientName
- The client name from the update user pool client request.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.
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.
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.
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.
public UpdateUserPoolClientRequest 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.
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.
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.
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.
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.
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.
public UpdateUserPoolClientRequest 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.
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.
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 AccessTokenValidity
in an API request is hours. Valid range is
displayed below in seconds.
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 AccessTokenValidity
in an API request is hours. Valid range
is displayed below in seconds.
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 AccessTokenValidity
in an API request is hours. Valid range is
displayed below in seconds.
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 AccessTokenValidity
in an API request is hours. Valid range
is displayed below in seconds.
public UpdateUserPoolClientRequest 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 AccessTokenValidity
in an API request is hours. Valid range is
displayed below in seconds.
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 AccessTokenValidity
in an API request is hours. Valid range
is displayed below in seconds.
public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
tokenValidityUnits
- The units in which the validity times are represented. The default unit for RefreshToken is days, and the
default for ID and access tokens is hours.public TokenValidityUnitsType getTokenValidityUnits()
The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
public UpdateUserPoolClientRequest withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
tokenValidityUnits
- The units in which the validity times are represented. The default unit for RefreshToken is days, and the
default for ID and access tokens is hours.public List<String> getReadAttributes()
The read-only attributes of the user pool.
public void setReadAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
readAttributes
- The read-only attributes of the user pool.public UpdateUserPoolClientRequest withReadAttributes(String... readAttributes)
The read-only attributes of the user pool.
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 read-only attributes of the user pool.public UpdateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
readAttributes
- The read-only attributes of the user pool.public List<String> getWriteAttributes()
The writeable attributes of the user pool.
public void setWriteAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
writeAttributes
- The writeable attributes of the user pool.public UpdateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
The writeable attributes of the 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 writeable attributes of the user pool.public UpdateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
writeAttributes
- The writeable attributes of the user pool.public List<String> getExplicitAuthFlows()
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with
ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
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.
ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the
ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
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.
ExplicitAuthFlowsType
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with
ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
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.
explicitAuthFlows
- The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the
ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
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.
ExplicitAuthFlowsType
public UpdateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with
ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
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.
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 are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the
ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
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.
ExplicitAuthFlowsType
public UpdateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with
ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
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.
explicitAuthFlows
- The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the
ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
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.
ExplicitAuthFlowsType
public UpdateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with
ALLOW_
prefix must be used only along with values with the ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
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.
explicitAuthFlows
- The authentication flows that are supported by the user pool clients. Flow names without the
ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_
prefix must be used only along with values with the
ALLOW_
prefix.
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, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
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.
ExplicitAuthFlowsType
public List<String> getSupportedIdentityProviders()
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.
supportedIdentityProviders
- A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.public UpdateUserPoolClientRequest withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.
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 IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.public UpdateUserPoolClientRequest withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.
supportedIdentityProviders
- A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
, Facebook
, Google
, SignInWithApple
,
LoginWithAmazon
, and the names of your own SAML and OIDC providers.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 UpdateUserPoolClientRequest 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 UpdateUserPoolClientRequest 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 UpdateUserPoolClientRequest 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 UpdateUserPoolClientRequest 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 UpdateUserPoolClientRequest 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.
OAuthFlowType
public 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.
OAuthFlowType
public UpdateUserPoolClientRequest 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.
OAuthFlowType
public UpdateUserPoolClientRequest 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.
OAuthFlowType
public UpdateUserPoolClientRequest 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.
OAuthFlowType
public 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 UpdateUserPoolClientRequest 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 UpdateUserPoolClientRequest 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 if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
allowedOAuthFlowsUserPoolClient
- Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito
user pools.public Boolean getAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public UpdateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
allowedOAuthFlowsUserPoolClient
- Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito
user pools.public Boolean isAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in 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 Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in 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 Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in 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 us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public UpdateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in 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 Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in 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.
PreventUserExistenceErrorTypes
public 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.
PreventUserExistenceErrorTypes
public UpdateUserPoolClientRequest 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.
PreventUserExistenceErrorTypes
public UpdateUserPoolClientRequest 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.
PreventUserExistenceErrorTypes
public void setEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
enableTokenRevocation
- Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.public Boolean getEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public UpdateUserPoolClientRequest withEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
enableTokenRevocation
- Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.public Boolean isEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
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 UpdateUserPoolClientRequest 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 String toString()
toString
in class Object
Object.toString()
public UpdateUserPoolClientRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()