@Generated(value="software.amazon.awssdk:codegen") public final class UpdateUserPoolClientRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>
Represents the request to update the user pool client.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateUserPoolClientRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
accessTokenValidity()
The time limit after which the access token is no longer valid and can't be used.
|
List<OAuthFlowType> |
allowedOAuthFlows()
The allowed OAuth flows.
|
List<String> |
allowedOAuthFlowsAsStrings()
The allowed OAuth flows.
|
Boolean |
allowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
List<String> |
allowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
analyticsConfiguration()
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
static UpdateUserPoolClientRequest.Builder |
builder() |
List<String> |
callbackURLs()
A list of allowed redirect (callback) URLs for the identity providers.
|
String |
clientId()
The ID of the client associated with the user pool.
|
String |
clientName()
The client name from the update user pool client request.
|
String |
defaultRedirectURI()
The default redirect URI.
|
Boolean |
enableTokenRevocation()
Activates or deactivates token revocation.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<ExplicitAuthFlowsType> |
explicitAuthFlows()
The authentication flows that are supported by the user pool clients.
|
List<String> |
explicitAuthFlowsAsStrings()
The authentication flows that are supported by the user pool clients.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAllowedOAuthFlows()
For responses, this returns true if the service returned a value for the AllowedOAuthFlows property.
|
boolean |
hasAllowedOAuthScopes()
For responses, this returns true if the service returned a value for the AllowedOAuthScopes property.
|
boolean |
hasCallbackURLs()
For responses, this returns true if the service returned a value for the CallbackURLs property.
|
boolean |
hasExplicitAuthFlows()
For responses, this returns true if the service returned a value for the ExplicitAuthFlows property.
|
int |
hashCode() |
boolean |
hasLogoutURLs()
For responses, this returns true if the service returned a value for the LogoutURLs property.
|
boolean |
hasReadAttributes()
For responses, this returns true if the service returned a value for the ReadAttributes property.
|
boolean |
hasSupportedIdentityProviders()
For responses, this returns true if the service returned a value for the SupportedIdentityProviders property.
|
boolean |
hasWriteAttributes()
For responses, this returns true if the service returned a value for the WriteAttributes property.
|
Integer |
idTokenValidity()
The time limit after which the ID token is no longer valid and can't be used.
|
List<String> |
logoutURLs()
A list of allowed logout URLs for the identity providers.
|
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.
|
String |
preventUserExistenceErrorsAsString()
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> |
readAttributes()
The read-only attributes of the user pool.
|
Integer |
refreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and can't be used.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateUserPoolClientRequest.Builder> |
serializableBuilderClass() |
List<String> |
supportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
|
UpdateUserPoolClientRequest.Builder |
toBuilder() |
TokenValidityUnitsType |
tokenValidityUnits()
The units in which the validity times are represented.
|
String |
toString()
Returns a string representation of this object.
|
String |
userPoolId()
The user pool ID for the user pool where you want to update the user pool client.
|
List<String> |
writeAttributes()
The writeable attributes of the user pool.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String userPoolId()
The user pool ID for the user pool where you want to update the user pool client.
public final String clientId()
The ID of the client associated with the user pool.
public final String clientName()
The client name from the update user pool client request.
public final Integer refreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and can't be used.
public final Integer accessTokenValidity()
The time limit after which the access token is no longer valid and can't be used.
public final Integer idTokenValidity()
The time limit after which the ID token is no longer valid and can't be used.
public final TokenValidityUnitsType tokenValidityUnits()
The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens is hours.
public final boolean hasReadAttributes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> readAttributes()
The read-only attributes of the user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReadAttributes() method.
public final boolean hasWriteAttributes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> writeAttributes()
The writeable attributes of the user pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasWriteAttributes() method.
public final List<ExplicitAuthFlowsType> explicitAuthFlows()
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix must be used only along with values with the ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExplicitAuthFlows() method.
ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix must be used only along with values with the
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting.
With this authentication flow, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
public final boolean hasExplicitAuthFlows()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> explicitAuthFlowsAsStrings()
The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
prefix are no longer supported in favor of new names with the ALLOW_ prefix. Note that values with
ALLOW_ prefix must be used only along with values with the ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote
Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExplicitAuthFlows() method.
ALLOW_ prefix are no longer supported in favor of new names with the ALLOW_
prefix. Note that values with ALLOW_ prefix must be used only along with values with the
ALLOW_ prefix.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting.
With this authentication flow, Amazon Cognito receives the password in the request instead of using the
Secure Remote Password (SRP) protocol to verify passwords.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
public final boolean hasSupportedIdentityProviders()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> supportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSupportedIdentityProviders() method.
public final boolean hasCallbackURLs()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCallbackURLs() method.
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 final boolean hasLogoutURLs()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> logoutURLs()
A list of allowed logout URLs for the identity providers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasLogoutURLs() method.
public final 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.
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 final List<OAuthFlowType> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedOAuthFlows() method.
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 final boolean hasAllowedOAuthFlows()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> allowedOAuthFlowsAsStrings()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedOAuthFlows() method.
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 final boolean hasAllowedOAuthScopes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> allowedOAuthScopes()
The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
openid, and profile. Possible values provided by Amazon Web Services are:
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedOAuthScopes() method.
phone, email,
openid, and profile. Possible values provided by Amazon Web Services are:
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.public final Boolean allowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public final AnalyticsConfigurationType analyticsConfiguration()
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public final PreventUserExistenceErrorTypes preventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
aren't prevented.
If the service returns an enum value that is not available in the current SDK version,
preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from preventUserExistenceErrorsAsString().
ENABLED and the user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
a UserNotFoundException exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related
errors aren't prevented.
PreventUserExistenceErrorTypespublic final String preventUserExistenceErrorsAsString()
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
aren't prevented.
If the service returns an enum value that is not available in the current SDK version,
preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION.
The raw value returned by the service is available from preventUserExistenceErrorsAsString().
ENABLED and the user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password recovery return a response
indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
a UserNotFoundException exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon Cognito where user existence related
errors aren't prevented.
PreventUserExistenceErrorTypespublic final Boolean enableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public UpdateUserPoolClientRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>toBuilder in class CognitoIdentityProviderRequestpublic static UpdateUserPoolClientRequest.Builder builder()
public static Class<? extends UpdateUserPoolClientRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.