UpdateUserPoolClientRequest
import type { UpdateUserPoolClientRequest } from "https://aws-api.deno.dev/v0.3/services/cognitoidentityserviceprovider.ts?docs=full";
Represents the request to update the user pool client.
§Properties
The time limit, after which the access token is no longer valid and cannot be used.
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.
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
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.
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
Note: In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
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.
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.
Enables or disables token revocation. For more information about revoking tokens, see RevokeToken.
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 flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_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 time limit, after which the ID token is no longer valid and cannot be used.
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.
Note:
After February 15th 2020, the value of PreventUserExistenceErrors
will default to ENABLED
for newly created user pool clients if no value is provided.
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
A list of provider names for the identity providers that are supported on this client.
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.