public class UserPoolClientType extends Object implements Serializable
Contains information about a user pool client.
| Constructor and Description |
|---|
UserPoolClientType() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
List<String> |
getAllowedOAuthFlows()
The allowed OAuth flows.
|
Boolean |
getAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
|
List<String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration for the user pool client.
|
List<String> |
getCallbackURLs()
A list of allowed redirect (callback) URLs for the identity providers.
|
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 the user pool client was created.
|
String |
getDefaultRedirectURI()
The default redirect URI.
|
List<String> |
getExplicitAuthFlows()
The authentication flows that are supported by the user pool clients.
|
Date |
getLastModifiedDate()
The date the user pool client was last modified.
|
List<String> |
getLogoutURLs()
A list of allowed logout URLs for the identity providers.
|
String |
getPreventUserExistenceErrors()
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool.
|
List<String> |
getReadAttributes()
The Read-only attributes.
|
Integer |
getRefreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid
and cannot be used.
|
List<String> |
getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on
this client.
|
String |
getUserPoolId()
The user pool ID for the user pool client.
|
List<String> |
getWriteAttributes()
The writeable attributes.
|
int |
hashCode() |
Boolean |
isAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
|
void |
setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
void |
setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
|
void |
setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
void |
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
|
void |
setCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
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 the user pool client was created.
|
void |
setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
void |
setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
void |
setLastModifiedDate(Date lastModifiedDate)
The date the user pool client was last modified.
|
void |
setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
void |
setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool.
|
void |
setPreventUserExistenceErrors(String preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool.
|
void |
setReadAttributes(Collection<String> readAttributes)
The Read-only attributes.
|
void |
setRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid
and cannot be used.
|
void |
setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on
this client.
|
void |
setUserPoolId(String userPoolId)
The user pool ID for the user pool client.
|
void |
setWriteAttributes(Collection<String> writeAttributes)
The writeable attributes.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UserPoolClientType |
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
|
UserPoolClientType |
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when
interacting with Cognito user pools.
|
UserPoolClientType |
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
UserPoolClientType |
withAllowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes.
|
UserPoolClientType |
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
|
UserPoolClientType |
withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
UserPoolClientType |
withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
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 the user pool client was created.
|
UserPoolClientType |
withDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UserPoolClientType |
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UserPoolClientType |
withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UserPoolClientType |
withLastModifiedDate(Date lastModifiedDate)
The date the user pool client was last modified.
|
UserPoolClientType |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UserPoolClientType |
withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UserPoolClientType |
withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool.
|
UserPoolClientType |
withPreventUserExistenceErrors(String preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool.
|
UserPoolClientType |
withReadAttributes(Collection<String> readAttributes)
The Read-only attributes.
|
UserPoolClientType |
withReadAttributes(String... readAttributes)
The Read-only attributes.
|
UserPoolClientType |
withRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid
and cannot be used.
|
UserPoolClientType |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on
this client.
|
UserPoolClientType |
withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on
this client.
|
UserPoolClientType |
withUserPoolId(String userPoolId)
The user pool ID for the user pool client.
|
UserPoolClientType |
withWriteAttributes(Collection<String> writeAttributes)
The writeable attributes.
|
UserPoolClientType |
withWriteAttributes(String... writeAttributes)
The writeable attributes.
|
public String getUserPoolId()
The user pool ID for the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool client.
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool client.
public UserPoolClientType withUserPoolId(String userPoolId)
The user pool ID for the user pool client.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool client.
public String getClientName()
The client name from the user pool request of the client type.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
The client name from the user pool request of the client type.
public void setClientName(String clientName)
The client name from the user pool request of the client type.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - The client name from the user pool request of the client type.
public String getClientId()
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
The ID of the client associated with the user pool.
public void setClientId(String clientId)
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId - 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId - The ID of the client associated with the user pool.
public String getClientSecret()
The client secret from the user pool request of the client type.
Constraints:
Length: 1 - 64
Pattern: [\w+]+
The client secret from the user pool request of the client type.
public void setClientSecret(String clientSecret)
The client secret from the user pool request of the client type.
Constraints:
Length: 1 - 64
Pattern: [\w+]+
clientSecret - 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
Pattern: [\w+]+
clientSecret - The client secret from the user pool request of the client type.
public Date getLastModifiedDate()
The date the user pool client was last modified.
The date the user pool client was last modified.
public void setLastModifiedDate(Date lastModifiedDate)
The date the user pool client was last modified.
lastModifiedDate - The date the user pool client was last modified.
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
The date the user pool client was last modified.
Returns a reference to this object so that method calls can be chained together.
lastModifiedDate - The date the user pool client was last modified.
public Date getCreationDate()
The date the user pool client was created.
The date the user pool client was created.
public void setCreationDate(Date creationDate)
The date the user pool client was created.
creationDate - The date the user pool client was created.
public UserPoolClientType withCreationDate(Date creationDate)
The date the user pool client was created.
Returns a reference to this object so that method calls can be chained together.
creationDate - The date the user pool client was created.
public Integer getRefreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Constraints:
Range: 0 - 3650
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
public void setRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Constraints:
Range: 0 - 3650
refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
public UserPoolClientType withRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 3650
refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
public List<String> getReadAttributes()
The Read-only attributes.
The Read-only attributes.
public void setReadAttributes(Collection<String> readAttributes)
The Read-only attributes.
readAttributes - The Read-only attributes.
public UserPoolClientType withReadAttributes(String... readAttributes)
The Read-only attributes.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The Read-only attributes.
public UserPoolClientType withReadAttributes(Collection<String> readAttributes)
The Read-only attributes.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The Read-only attributes.
public List<String> getWriteAttributes()
The writeable attributes.
The writeable attributes.
public void setWriteAttributes(Collection<String> writeAttributes)
The writeable attributes.
writeAttributes - The writeable attributes.
public UserPoolClientType withWriteAttributes(String... writeAttributes)
The writeable attributes.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The writeable attributes.
public UserPoolClientType withWriteAttributes(Collection<String> writeAttributes)
The writeable attributes.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The writeable attributes.
public List<String> getExplicitAuthFlows()
The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor
of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the request instead
of using the SRP (Secure Remote Password protocol) protocol to verify
passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, 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.
The authentication flows that are supported by the user pool
clients. Flow names without the ALLOW_ prefix are
deprecated in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix cannot
be used along with values without ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based
user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the
ADMIN_NO_SRP_AUTH setting. With this authentication
flow, Cognito receives the password in the request instead of
using the SRP (Secure Remote Password protocol) protocol to
verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, 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.
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor
of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the request instead
of using the SRP (Secure Remote Password protocol) protocol to verify
passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
explicitAuthFlows -
The authentication flows that are supported by the user pool
clients. Flow names without the ALLOW_ prefix are
deprecated in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_
prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the
request instead of using the SRP (Secure Remote Password
protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, 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.
public UserPoolClientType withExplicitAuthFlows(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor
of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the request instead
of using the SRP (Secure Remote Password protocol) protocol to verify
passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, 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.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows -
The authentication flows that are supported by the user pool
clients. Flow names without the ALLOW_ prefix are
deprecated in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_
prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the
request instead of using the SRP (Secure Remote Password
protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, 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.
public UserPoolClientType withExplicitAuthFlows(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
Flow names without the ALLOW_ prefix are deprecated in favor
of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix cannot be used along with values without
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the request instead
of using the SRP (Secure Remote Password protocol) protocol to verify
passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, 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.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows -
The authentication flows that are supported by the user pool
clients. Flow names without the ALLOW_ prefix are
deprecated in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix
cannot be used along with values without ALLOW_
prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, Cognito receives the password in the
request instead of using the SRP (Secure Remote Password
protocol) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, 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.
public List<String> getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
A list of provider names for the identity providers that are supported on this client.
public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
public UserPoolClientType withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
public UserPoolClientType withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
public List<String> getCallbackURLs()
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
A list of allowed redirect (callback) URLs for the identity providers.
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 identity providers.
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 identity providers.
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 identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.
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 identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the identity providers.
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 identity providers.
A list of allowed logout URLs for the identity providers.
public void setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs - A list of allowed logout URLs for the identity providers.
public UserPoolClientType withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the identity providers.
public UserPoolClientType withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the identity providers.
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.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public void setDefaultRedirectURI(String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public List<String> getAllowedOAuthFlows()
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an
authorization code as the response. This code can be exchanged for access
tokens with the token endpoint.
Set to implicit to specify that the client should get the
access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should
get the access token (and, optionally, ID token, based on scopes) from
the token endpoint using a combination of client and client_secret.
The allowed OAuth flows.
Set to code to initiate a code grant flow, which
provides an authorization code as the response. This code can be
exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should
get the access token (and, optionally, ID token, based on scopes)
directly.
Set to client_credentials to specify that the client
should get the access token (and, optionally, ID token, based on
scopes) from the token endpoint using a combination of client and
client_secret.
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an
authorization code as the response. This code can be exchanged for access
tokens with the token endpoint.
Set to implicit to specify that the client should get the
access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should
get the access token (and, optionally, ID token, based on scopes) from
the token endpoint using a combination of client and client_secret.
allowedOAuthFlows - The allowed OAuth flows.
Set to code to initiate a code grant flow, which
provides an authorization code as the response. This code can
be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should
get the access token (and, optionally, ID token, based on
scopes) directly.
Set to client_credentials to specify that the
client should get the access token (and, optionally, ID token,
based on scopes) from the token endpoint using a combination
of client and client_secret.
public UserPoolClientType withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an
authorization code as the response. This code can be exchanged for access
tokens with the token endpoint.
Set to implicit to specify that the client should get the
access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should
get the access token (and, optionally, ID token, based on scopes) from
the token endpoint using a combination of client and client_secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Set to code to initiate a code grant flow, which
provides an authorization code as the response. This code can
be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should
get the access token (and, optionally, ID token, based on
scopes) directly.
Set to client_credentials to specify that the
client should get the access token (and, optionally, ID token,
based on scopes) from the token endpoint using a combination
of client and client_secret.
public UserPoolClientType withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
Set to code to initiate a code grant flow, which provides an
authorization code as the response. This code can be exchanged for access
tokens with the token endpoint.
Set to implicit to specify that the client should get the
access token (and, optionally, ID token, based on scopes) directly.
Set to client_credentials to specify that the client should
get the access token (and, optionally, ID token, based on scopes) from
the token endpoint using a combination of client and client_secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Set to code to initiate a code grant flow, which
provides an authorization code as the response. This code can
be exchanged for access tokens with the token endpoint.
Set to implicit to specify that the client should
get the access token (and, optionally, ID token, based on
scopes) directly.
Set to client_credentials to specify that the
client should get the access token (and, optionally, ID token,
based on scopes) from the token endpoint using a combination
of client and client_secret.
public List<String> getAllowedOAuthScopes()
The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and
profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and
profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created
in Resource Servers are also supported.
public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and
profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are: phone, email,
openid, and profile. Possible values
provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public UserPoolClientType withAllowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and
profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are: phone, email,
openid, and profile. Possible values
provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public UserPoolClientType withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are:
phone, email, openid, and
profile. Possible values provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are: phone, email,
openid, and profile. Possible values
provided by AWS are:
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public Boolean isAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
public Boolean getAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
public UserPoolClientType withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
public AnalyticsConfigurationType getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
public UserPoolClientType withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
Returns a reference to this object so that method calls can be chained together.
analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
public String getPreventUserExistenceErrors()
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns
an error indicating either the username or password was incorrect, and
account confirmation and password recovery return a response indicating a
code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException exception
if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where
user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is
provided.
Constraints:
Allowed Values: LEGACY, ENABLED
Use this setting to choose which errors and responses are
returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not exist
in the user pool. When set to ENABLED and the user
does not exist, authentication returns an error indicating either
the username or password was incorrect, and account confirmation
and password recovery return a response indicating a code was
sent to a simulated destination. When set to LEGACY,
those APIs will return a UserNotFoundException
exception if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the old behavior of Cognito
where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no
value is provided.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(String preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns
an error indicating either the username or password was incorrect, and
account confirmation and password recovery return a response indicating a
code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException exception
if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where
user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is
provided.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Use this setting to choose which errors and responses are
returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not
exist in the user pool. When set to ENABLED and
the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and
account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does
not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the old behavior of
Cognito where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no
value is provided.
PreventUserExistenceErrorTypespublic UserPoolClientType withPreventUserExistenceErrors(String preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns
an error indicating either the username or password was incorrect, and
account confirmation and password recovery return a response indicating a
code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException exception
if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where
user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is
provided.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Use this setting to choose which errors and responses are
returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not
exist in the user pool. When set to ENABLED and
the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and
account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does
not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the old behavior of
Cognito where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no
value is provided.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns
an error indicating either the username or password was incorrect, and
account confirmation and password recovery return a response indicating a
code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException exception
if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where
user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is
provided.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Use this setting to choose which errors and responses are
returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not
exist in the user pool. When set to ENABLED and
the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and
account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does
not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the old behavior of
Cognito where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no
value is provided.
PreventUserExistenceErrorTypespublic UserPoolClientType withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Use this setting to choose which errors and responses are returned by
Cognito APIs during authentication, account confirmation, and password
recovery when the user does not exist in the user pool. When set to
ENABLED and the user does not exist, authentication returns
an error indicating either the username or password was incorrect, and
account confirmation and password recovery return a response indicating a
code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException exception
if the user does not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the old behavior of Cognito where
user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no value is
provided.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Use this setting to choose which errors and responses are
returned by Cognito APIs during authentication, account
confirmation, and password recovery when the user does not
exist in the user pool. When set to ENABLED and
the user does not exist, authentication returns an error
indicating either the username or password was incorrect, and
account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs will return a
UserNotFoundException exception if the user does
not exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the old behavior of
Cognito where user existence related errors are not prevented.
This setting affects the behavior of following APIs:
After February 15th 2020, the value of
PreventUserExistenceErrors will default to
ENABLED for newly created user pool clients if no
value is provided.
PreventUserExistenceErrorTypespublic String toString()
toString in class ObjectObject.toString()Copyright © 2020. All rights reserved.