@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UserPoolClientType extends Object implements Serializable, Cloneable, StructuredPojo
Contains information about a user pool client.
Constructor and Description |
---|
UserPoolClientType() |
Modifier and Type | Method and Description |
---|---|
UserPoolClientType |
clone() |
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 OAuth scopes that your app client supports.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration for the user pool client.
|
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 |
getClientId()
The ID of the client associated with the user pool.
|
String |
getClientName()
The client name from the user pool request of the client type.
|
String |
getClientSecret()
The client secret from the user pool request of the client type.
|
Date |
getCreationDate()
The date and time, in ISO 8601 format, when
the item was created.
|
String |
getDefaultRedirectURI()
The default redirect URI.
|
Boolean |
getEnablePropagateAdditionalUserContextData()
When
EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. |
Boolean |
getEnableTokenRevocation()
Indicates whether token revocation is activated for the user pool client.
|
List<String> |
getExplicitAuthFlows()
The authentication flows that you want your user pool client to support.
|
Integer |
getIdTokenValidity()
The ID token time limit.
|
Date |
getLastModifiedDate()
The date and time, in ISO 8601 format, when
the item was modified.
|
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 IdPs that this client supports.
|
TokenValidityUnitsType |
getTokenValidityUnits()
The time units used to specify the token validity times of each token type: ID, access, and refresh.
|
String |
getUserPoolId()
The user pool ID for the 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()
When
EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. |
Boolean |
isEnableTokenRevocation()
Indicates whether token revocation is activated for the user pool client.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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 OAuth scopes that your app client supports.
|
void |
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
|
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 |
setClientId(String clientId)
The ID of the client associated with the user pool.
|
void |
setClientName(String clientName)
The client name from the user pool request of the client type.
|
void |
setClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
|
void |
setCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when
the item was created.
|
void |
setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
void |
setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
When
EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. |
void |
setEnableTokenRevocation(Boolean enableTokenRevocation)
Indicates whether token revocation is activated for the user pool client.
|
void |
setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
void |
setIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
void |
setLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when
the item was modified.
|
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 IdPs that this client supports.
|
void |
setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units used to specify the token validity times of each token type: ID, access, and refresh.
|
void |
setUserPoolId(String userPoolId)
The user pool ID for the 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.
|
UserPoolClientType |
withAccessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
UserPoolClientType |
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app client. |
UserPoolClientType |
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The OAuth scopes that your app client supports.
|
UserPoolClientType |
withAllowedOAuthScopes(String... allowedOAuthScopes)
The OAuth scopes that your app client supports.
|
UserPoolClientType |
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
|
UserPoolClientType |
withAuthSessionValidity(Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an authentication flow.
|
UserPoolClientType |
withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UserPoolClientType |
withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UserPoolClientType |
withClientId(String clientId)
The ID of the client associated with the user pool.
|
UserPoolClientType |
withClientName(String clientName)
The client name from the user pool request of the client type.
|
UserPoolClientType |
withClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
|
UserPoolClientType |
withCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when
the item was created.
|
UserPoolClientType |
withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UserPoolClientType |
withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
When
EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an
IpAddress value that you send in the UserContextData parameter. |
UserPoolClientType |
withEnableTokenRevocation(Boolean enableTokenRevocation)
Indicates whether token revocation is activated for the user pool client.
|
UserPoolClientType |
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UserPoolClientType |
withIdTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
UserPoolClientType |
withLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when
the item was modified.
|
UserPoolClientType |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UserPoolClientType |
withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UserPoolClientType |
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.
|
UserPoolClientType |
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.
|
UserPoolClientType |
withReadAttributes(Collection<String> readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
UserPoolClientType |
withReadAttributes(String... readAttributes)
The list of user attributes that you want your app client to have read-only access to.
|
UserPoolClientType |
withRefreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
UserPoolClientType |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UserPoolClientType |
withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UserPoolClientType |
withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units used to specify the token validity times of each token type: ID, access, and refresh.
|
UserPoolClientType |
withUserPoolId(String userPoolId)
The user pool ID for the user pool client.
|
UserPoolClientType |
withWriteAttributes(Collection<String> writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
UserPoolClientType |
withWriteAttributes(String... writeAttributes)
The list of user attributes that you want your app client to have write access to.
|
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool client.
userPoolId
- The user pool ID for the user pool client.public String getUserPoolId()
The user pool ID for the user pool client.
public UserPoolClientType withUserPoolId(String userPoolId)
The user pool ID for the user pool client.
userPoolId
- The user pool ID for the user pool client.public void setClientName(String clientName)
The client name from the user pool request of the client type.
clientName
- The client name from the user pool request of the client type.public String getClientName()
The client name from the user pool request of the client type.
public UserPoolClientType withClientName(String clientName)
The client name from the user pool request of the client type.
clientName
- The client name from the user pool request of the client type.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 UserPoolClientType 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 setClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
clientSecret
- The client secret from the user pool request of the client type.public String getClientSecret()
The client secret from the user pool request of the client type.
public UserPoolClientType withClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
clientSecret
- The client secret from the user pool request of the client type.public void setLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
lastModifiedDate
- The date and time, in ISO 8601
format, when the item was modified.public Date getLastModifiedDate()
The date and time, in ISO 8601 format, when the item was modified.
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
lastModifiedDate
- The date and time, in ISO 8601
format, when the item was modified.public void setCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate
- The date and time, in ISO 8601
format, when the item was created.public Date getCreationDate()
The date and time, in ISO 8601 format, when the item was created.
public UserPoolClientType withCreationDate(Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate
- The date and time, in ISO 8601
format, when the item was 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 time units used to specify the token validity times of each token type: ID, access, and refresh.
tokenValidityUnits
- The time units used to specify the token validity times of each token type: ID, access, and refresh.public TokenValidityUnitsType getTokenValidityUnits()
The time units used to specify the token validity times of each token type: ID, access, and refresh.
public UserPoolClientType withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units used to specify the token validity times of each token type: ID, access, and refresh.
tokenValidityUnits
- The time units used to specify the token validity times of each token type: ID, access, and refresh.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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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
.
ExplicitAuthFlowsType
public 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
.
ExplicitAuthFlowsType
public UserPoolClientType 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
.
ExplicitAuthFlowsType
public UserPoolClientType 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
.
ExplicitAuthFlowsType
public UserPoolClientType 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
.
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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 OAuth scopes that your app client supports. Possible values that OAuth provides are phone
,
email
, openid
, and profile
. Possible values that Amazon Web Services
provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you
create in Resource Servers.
phone
, email
, openid
, and profile
. Possible values
that Amazon Web Services provides are aws.cognito.signin.user.admin
. Amazon Cognito also
supports custom scopes that you create in Resource Servers.public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone
,
email
, openid
, and profile
. Possible values that Amazon Web Services
provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you
create in Resource Servers.
allowedOAuthScopes
- The OAuth scopes that your app client supports. Possible values that OAuth provides are phone
, email
, openid
, and profile
. Possible values that Amazon Web
Services provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom
scopes that you create in Resource Servers.public UserPoolClientType withAllowedOAuthScopes(String... allowedOAuthScopes)
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone
,
email
, openid
, and profile
. Possible values that Amazon Web Services
provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you
create in Resource Servers.
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 OAuth scopes that your app client supports. Possible values that OAuth provides are phone
, email
, openid
, and profile
. Possible values that Amazon Web
Services provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom
scopes that you create in Resource Servers.public UserPoolClientType withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The OAuth scopes that your app client supports. Possible values that OAuth provides are phone
,
email
, openid
, and profile
. Possible values that Amazon Web Services
provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you
create in Resource Servers.
allowedOAuthScopes
- The OAuth scopes that your app client supports. Possible values that OAuth provides are phone
, email
, openid
, and profile
. Possible values that Amazon Web
Services provides are aws.cognito.signin.user.admin
. Amazon Cognito also supports custom
scopes that you create in Resource Servers.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 UserPoolClientType 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 Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
analyticsConfiguration
- The Amazon Pinpoint analytics configuration for the user pool client. Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
public AnalyticsConfigurationType getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
public UserPoolClientType withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
analyticsConfiguration
- The Amazon Pinpoint analytics configuration for the user pool client. Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
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 old 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 old 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 old 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 old behavior of Amazon Cognito where user existence related
errors aren't prevented.
PreventUserExistenceErrorTypes
public UserPoolClientType 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 old 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 old behavior of Amazon Cognito where user existence related
errors aren't prevented.
PreventUserExistenceErrorTypes
public UserPoolClientType 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 old 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 old behavior of Amazon Cognito where user existence related
errors aren't prevented.
PreventUserExistenceErrorTypes
public void setEnableTokenRevocation(Boolean enableTokenRevocation)
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
enableTokenRevocation
- Indicates whether token revocation is activated for the user pool client. When you create a new user pool
client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.public Boolean getEnableTokenRevocation()
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
public UserPoolClientType withEnableTokenRevocation(Boolean enableTokenRevocation)
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
enableTokenRevocation
- Indicates whether token revocation is activated for the user pool client. When you create a new user pool
client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.public Boolean isEnableTokenRevocation()
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
public void setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis.
You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address
to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in
a ContextData
parameter with the authenticated API operations AdminInitiateAuth
and
AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client
secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
enablePropagateAdditionalUserContextData
- When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk
analysis. You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP
address to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP
address in a ContextData
parameter with the authenticated API operations
AdminInitiateAuth
and AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a
client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
public Boolean getEnablePropagateAdditionalUserContextData()
When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis.
You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address
to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in
a ContextData
parameter with the authenticated API operations AdminInitiateAuth
and
AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client
secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk
analysis. You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP
address to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP
address in a ContextData
parameter with the authenticated API operations
AdminInitiateAuth
and AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a
client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
public UserPoolClientType withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis.
You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address
to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in
a ContextData
parameter with the authenticated API operations AdminInitiateAuth
and
AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client
secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
enablePropagateAdditionalUserContextData
- When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk
analysis. You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP
address to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP
address in a ContextData
parameter with the authenticated API operations
AdminInitiateAuth
and AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a
client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
public Boolean isEnablePropagateAdditionalUserContextData()
When EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis.
You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP address
to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP address in
a ContextData
parameter with the authenticated API operations AdminInitiateAuth
and
AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client
secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts an
IpAddress
value that you send in the UserContextData
parameter. The
UserContextData
parameter sends information to Amazon Cognito advanced security for risk
analysis. You can send UserContextData
when you sign in Amazon Cognito native users with the
InitiateAuth
and RespondToAuthChallenge
API operations.
When EnablePropagateAdditionalUserContextData
is false, you can't send your user's source IP
address to Amazon Cognito advanced security with unauthenticated API operations.
EnablePropagateAdditionalUserContextData
doesn't affect whether you can send a source IP
address in a ContextData
parameter with the authenticated API operations
AdminInitiateAuth
and AdminRespondToAuthChallenge
.
You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a
client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
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 UserPoolClientType 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 Object
Object.toString()
public UserPoolClientType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.