Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, it will be set to the default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Synopsis
- data UpdateUserPoolClient = UpdateUserPoolClient' {
- accessTokenValidity :: Maybe Natural
- allowedOAuthFlows :: Maybe [OAuthFlowType]
- allowedOAuthFlowsUserPoolClient :: Maybe Bool
- allowedOAuthScopes :: Maybe [Text]
- analyticsConfiguration :: Maybe AnalyticsConfigurationType
- authSessionValidity :: Maybe Natural
- callbackURLs :: Maybe [Text]
- clientName :: Maybe Text
- defaultRedirectURI :: Maybe Text
- enablePropagateAdditionalUserContextData :: Maybe Bool
- enableTokenRevocation :: Maybe Bool
- explicitAuthFlows :: Maybe [ExplicitAuthFlowsType]
- idTokenValidity :: Maybe Natural
- logoutURLs :: Maybe [Text]
- preventUserExistenceErrors :: Maybe PreventUserExistenceErrorTypes
- readAttributes :: Maybe [Text]
- refreshTokenValidity :: Maybe Natural
- supportedIdentityProviders :: Maybe [Text]
- tokenValidityUnits :: Maybe TokenValidityUnitsType
- writeAttributes :: Maybe [Text]
- userPoolId :: Text
- clientId :: Sensitive Text
- newUpdateUserPoolClient :: Text -> Text -> UpdateUserPoolClient
- updateUserPoolClient_accessTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural)
- updateUserPoolClient_allowedOAuthFlows :: Lens' UpdateUserPoolClient (Maybe [OAuthFlowType])
- updateUserPoolClient_allowedOAuthFlowsUserPoolClient :: Lens' UpdateUserPoolClient (Maybe Bool)
- updateUserPoolClient_allowedOAuthScopes :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_analyticsConfiguration :: Lens' UpdateUserPoolClient (Maybe AnalyticsConfigurationType)
- updateUserPoolClient_authSessionValidity :: Lens' UpdateUserPoolClient (Maybe Natural)
- updateUserPoolClient_callbackURLs :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_clientName :: Lens' UpdateUserPoolClient (Maybe Text)
- updateUserPoolClient_defaultRedirectURI :: Lens' UpdateUserPoolClient (Maybe Text)
- updateUserPoolClient_enablePropagateAdditionalUserContextData :: Lens' UpdateUserPoolClient (Maybe Bool)
- updateUserPoolClient_enableTokenRevocation :: Lens' UpdateUserPoolClient (Maybe Bool)
- updateUserPoolClient_explicitAuthFlows :: Lens' UpdateUserPoolClient (Maybe [ExplicitAuthFlowsType])
- updateUserPoolClient_idTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural)
- updateUserPoolClient_logoutURLs :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_preventUserExistenceErrors :: Lens' UpdateUserPoolClient (Maybe PreventUserExistenceErrorTypes)
- updateUserPoolClient_readAttributes :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_refreshTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural)
- updateUserPoolClient_supportedIdentityProviders :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_tokenValidityUnits :: Lens' UpdateUserPoolClient (Maybe TokenValidityUnitsType)
- updateUserPoolClient_writeAttributes :: Lens' UpdateUserPoolClient (Maybe [Text])
- updateUserPoolClient_userPoolId :: Lens' UpdateUserPoolClient Text
- updateUserPoolClient_clientId :: Lens' UpdateUserPoolClient Text
- data UpdateUserPoolClientResponse = UpdateUserPoolClientResponse' {}
- newUpdateUserPoolClientResponse :: Int -> UpdateUserPoolClientResponse
- updateUserPoolClientResponse_userPoolClient :: Lens' UpdateUserPoolClientResponse (Maybe UserPoolClientType)
- updateUserPoolClientResponse_httpStatus :: Lens' UpdateUserPoolClientResponse Int
Creating a Request
data UpdateUserPoolClient Source #
Represents the request to update the user pool client.
See: newUpdateUserPoolClient
smart constructor.
UpdateUserPoolClient' | |
|
Instances
newUpdateUserPoolClient Source #
Create a value of UpdateUserPoolClient
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_allowedOAuthFlows
- The allowed OAuth flows.
- code
- 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. - implicit
- Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
- 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.
UpdateUserPoolClient
, updateUserPoolClient_allowedOAuthFlowsUserPoolClient
- Set to true if the client is allowed to follow the OAuth protocol when
interacting with Amazon Cognito user pools.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_analyticsConfiguration
- The Amazon Pinpoint analytics configuration necessary to collect metrics
for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_clientName
- The client name from the update user pool client request.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_enablePropagateAdditionalUserContextData
- Activates the propagation of additional user context data. For more
information about propagation of user context data, see
Adding advanced security to a user pool.
If you don’t include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito advanced
security. You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a
client secret.
UpdateUserPoolClient
, updateUserPoolClient_enableTokenRevocation
- Activates or deactivates token revocation. For more information about
revoking tokens, see
RevokeToken.
UpdateUserPoolClient
, updateUserPoolClient_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 flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_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
.
UpdateUserPoolClient
, updateUserPoolClient_idTokenValidity
- The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as
seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and
TokenValidityUnits
as hours
, your user can authenticate their
session with their ID token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is
hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
UpdateUserPoolClient
, updateUserPoolClient_logoutURLs
- A list of allowed logout URLs for the IdPs.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_readAttributes
- The read-only attributes of the user pool.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_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.
UpdateUserPoolClient
, updateUserPoolClient_tokenValidityUnits
- The units in which the validity times are represented. The default unit
for RefreshToken is days, and the default for ID and access tokens is
hours.
UpdateUserPoolClient
, updateUserPoolClient_writeAttributes
- The writeable attributes of the user pool.
UpdateUserPoolClient
, updateUserPoolClient_userPoolId
- The user pool ID for the user pool where you want to update the user
pool client.
UpdateUserPoolClient
, updateUserPoolClient_clientId
- The ID of the client associated with the user pool.
Request Lenses
updateUserPoolClient_accessTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural) Source #
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.
updateUserPoolClient_allowedOAuthFlows :: Lens' UpdateUserPoolClient (Maybe [OAuthFlowType]) Source #
The allowed OAuth flows.
- code
- 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. - implicit
- Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
- client_credentials
- 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.
updateUserPoolClient_allowedOAuthFlowsUserPoolClient :: Lens' UpdateUserPoolClient (Maybe Bool) Source #
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
updateUserPoolClient_allowedOAuthScopes :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
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.
updateUserPoolClient_analyticsConfiguration :: Lens' UpdateUserPoolClient (Maybe AnalyticsConfigurationType) Source #
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
updateUserPoolClient_authSessionValidity :: Lens' UpdateUserPoolClient (Maybe Natural) Source #
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.
updateUserPoolClient_callbackURLs :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
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.
updateUserPoolClient_clientName :: Lens' UpdateUserPoolClient (Maybe Text) Source #
The client name from the update user pool client request.
updateUserPoolClient_defaultRedirectURI :: Lens' UpdateUserPoolClient (Maybe Text) Source #
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.
updateUserPoolClient_enablePropagateAdditionalUserContextData :: Lens' UpdateUserPoolClient (Maybe Bool) Source #
Activates the propagation of additional user context data. For more
information about propagation of user context data, see
Adding advanced security to a user pool.
If you don’t include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito advanced
security. You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a
client secret.
updateUserPoolClient_enableTokenRevocation :: Lens' UpdateUserPoolClient (Maybe Bool) Source #
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
updateUserPoolClient_explicitAuthFlows :: Lens' UpdateUserPoolClient (Maybe [ExplicitAuthFlowsType]) Source #
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 flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_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
.
updateUserPoolClient_idTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural) Source #
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as
seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and
TokenValidityUnits
as hours
, your user can authenticate their
session with their ID token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is
hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
updateUserPoolClient_logoutURLs :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
A list of allowed logout URLs for the IdPs.
updateUserPoolClient_preventUserExistenceErrors :: Lens' UpdateUserPoolClient (Maybe PreventUserExistenceErrorTypes) Source #
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.
updateUserPoolClient_readAttributes :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
The read-only attributes of the user pool.
updateUserPoolClient_refreshTokenValidity :: Lens' UpdateUserPoolClient (Maybe Natural) Source #
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.
updateUserPoolClient_supportedIdentityProviders :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
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.
updateUserPoolClient_tokenValidityUnits :: Lens' UpdateUserPoolClient (Maybe TokenValidityUnitsType) Source #
The units in which the validity times are represented. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
updateUserPoolClient_writeAttributes :: Lens' UpdateUserPoolClient (Maybe [Text]) Source #
The writeable attributes of the user pool.
updateUserPoolClient_userPoolId :: Lens' UpdateUserPoolClient Text Source #
The user pool ID for the user pool where you want to update the user pool client.
updateUserPoolClient_clientId :: Lens' UpdateUserPoolClient Text Source #
The ID of the client associated with the user pool.
Destructuring the Response
data UpdateUserPoolClientResponse Source #
Represents the response from the server to the request to update the user pool client.
See: newUpdateUserPoolClientResponse
smart constructor.
UpdateUserPoolClientResponse' | |
|
Instances
newUpdateUserPoolClientResponse Source #
Create a value of UpdateUserPoolClientResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userPoolClient:UpdateUserPoolClientResponse'
, updateUserPoolClientResponse_userPoolClient
- The user pool client value from the response from the server when you
request to update the user pool client.
$sel:httpStatus:UpdateUserPoolClientResponse'
, updateUserPoolClientResponse_httpStatus
- The response's http status code.
Response Lenses
updateUserPoolClientResponse_userPoolClient :: Lens' UpdateUserPoolClientResponse (Maybe UserPoolClientType) Source #
The user pool client value from the response from the server when you request to update the user pool client.
updateUserPoolClientResponse_httpStatus :: Lens' UpdateUserPoolClientResponse Int Source #
The response's http status code.