Settings for multi-factor authentication (MFA) with passkey, or webauthN, biometric * and security-key devices in a user pool. Configures the following:
*Configuration at the user-pool level for whether you want to require passkey * configuration as an MFA factor, or include it as a choice.
*The user pool relying-party ID. This is the user pool domain that user's * passkey providers should trust as a receiver of passkey authentication.
*The providers that you want to allow as origins for passkey * authentication.
*This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.
* @public */ export interface WebAuthnConfigurationType { /** *Sets or displays the authentication domain, typically your user pool domain, that * passkey providers must use as a relying party (RP) in their configuration.
*Under the following conditions, the passkey relying party ID must be the * fully-qualified domain name of your custom domain:
*The user pool is configured for passkey authentication.
*The user pool has a custom domain, whether or not it also has a prefix * domain.
*Your application performs authentication with managed login or the classic * hosted UI.
*Sets or displays your user-pool treatment for MFA with a passkey. You can override * other MFA options and require passkey MFA, or you can set it as preferred. When passkey * MFA is preferred, the hosted UI encourages users to register a passkey at * sign-in.
* @public */ UserVerification?: UserVerificationType | undefined; } /** * @public */ export interface GetUserPoolMfaConfigResponse { /** *Shows user pool SMS message configuration for MFA. Includes the message template and * the SMS message sending configuration for Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes * TOTP enabled or disabled state.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Shows user pool email message configuration for MFA. Includes the subject and body of * the email message template for MFA messages. To activate this setting, * advanced security features must be active in your user pool.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *The multi-factor authentication (MFA) configuration. Valid values include:
*
* OFF MFA won't be used for any users.
* ON MFA is required for all users to sign in.
* OPTIONAL MFA will be required only for individual users who have
* an MFA factor activated.
Shows user pool configuration for MFA with passkeys from biometric devices and * security keys.
* @public */ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined; } /** *Represents the request to sign out all devices.
* @public */ export interface GlobalSignOutRequest { /** *A valid access token that Amazon Cognito issued to the user who you want to sign out.
* @public */ AccessToken: string | undefined; } /** *The response to the request to sign out all devices.
* @public */ export interface GlobalSignOutResponse { } /** *Initiates the authentication request.
* @public */ export interface InitiateAuthRequest { /** *The authentication flow that you want to initiate. The AuthParameters
* that you must submit are linked to the flow that you submit. For example:
* USER_AUTH: Request a preferred authentication type or review
* available authentication types. From the offered authentication types, select
* one in a challenge response and then authenticate with that method in an
* additional challenge response.
* REFRESH_TOKEN_AUTH: Receive new ID and access tokens when you
* pass a REFRESH_TOKEN parameter with a valid refresh token as the
* value.
* USER_SRP_AUTH: Receive secure remote password (SRP) variables for
* the next challenge, PASSWORD_VERIFIER, when you pass
* USERNAME and SRP_A parameters.
* USER_PASSWORD_AUTH: Receive new tokens or the next challenge, for
* example SOFTWARE_TOKEN_MFA, when you pass USERNAME and
* PASSWORD parameters.
Valid values include the following:
*The entry point for sign-in with passwords, one-time passwords, biometric * devices, and security keys.
*Username-password authentication with the Secure Remote Password (SRP) * protocol. For more information, see Use SRP password verification in custom * authentication flow.
*Provide a valid refresh token and receive new ID and access tokens. For * more information, see Using the refresh token.
*Custom authentication with Lambda triggers. For more information, see * Custom authentication challenge Lambda * triggers.
*Username-password authentication with the password sent directly in the * request. For more information, see Admin authentication flow.
*
* ADMIN_USER_PASSWORD_AUTH is a flow type of AdminInitiateAuth and isn't valid for InitiateAuth.
* ADMIN_NO_SRP_AUTH is a legacy server-side username-password flow and
* isn't valid for InitiateAuth.
The authentication parameters. These are inputs corresponding to the
* AuthFlow that you're invoking. The required values depend on the value
* of AuthFlow:
For USER_AUTH: USERNAME (required),
* PREFERRED_CHALLENGE. If you don't provide a value for
* PREFERRED_CHALLENGE, Amazon Cognito responds with the
* AvailableChallenges parameter that specifies the available
* sign-in methods.
For USER_SRP_AUTH: USERNAME (required),
* SRP_A (required), SECRET_HASH (required if the app
* client is configured with a client secret), DEVICE_KEY.
For USER_PASSWORD_AUTH: USERNAME (required),
* PASSWORD (required), SECRET_HASH (required if the
* app client is configured with a client secret), DEVICE_KEY.
For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN
* (required), SECRET_HASH (required if the app client is configured
* with a client secret), DEVICE_KEY.
For CUSTOM_AUTH: USERNAME (required),
* SECRET_HASH (if app client is configured with client secret),
* DEVICE_KEY. To start the authentication flow with password
* verification, include ChallengeName: SRP_A and SRP_A: (The
* SRP_A Value).
For more information about SECRET_HASH, see Computing secret hash values. For information about
* DEVICE_KEY, see Working with user devices in your user pool.
A map of custom key-value pairs that you can provide as input for certain custom * workflows that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers. * When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda functions that are * specified for various triggers. The ClientMetadata value is passed as input to the * functions for only the following triggers:
*Pre signup
*Pre authentication
*User migration
*When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which
* the function receives as input. This payload contains a validationData
* attribute, which provides the data that you assigned to the ClientMetadata parameter in
* your InitiateAuth request. In your function code in Lambda, you can process the
* validationData value to enhance your workflow for your specific
* needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the * following triggers, but it doesn't provide the ClientMetadata value as input:
*Post authentication
*Custom message
*Pre token generation
*Create auth challenge
*Define auth challenge
*Custom email sender
*Custom SMS sender
*For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The app client ID.
* @public */ ClientId: string | undefined; /** *The Amazon Pinpoint analytics metadata that contributes to your metrics for
* InitiateAuth calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *The optional session ID from a ConfirmSignUp API request. You can sign in
* a user directly from the sign-up process with the USER_AUTH authentication
* flow.
Initiates the authentication response.
* @public */ export interface InitiateAuthResponse { /** *The name of the challenge that you're responding to with this call. This name is
* returned in the InitiateAuth response if you must pass another
* challenge.
Valid values include the following:
*All of the following challenges require USERNAME and
* SECRET_HASH (if applicable) in the parameters.
* WEB_AUTHN: Respond to the challenge with the results of a
* successful authentication with a passkey, or webauthN, factor. These are
* typically biometric devices or security keys.
* PASSWORD: Respond with USER_PASSWORD_AUTH
* parameters: USERNAME (required), PASSWORD (required),
* SECRET_HASH (required if the app client is configured with a
* client secret), DEVICE_KEY.
* PASSWORD_SRP: Respond with USER_SRP_AUTH parameters:
* USERNAME (required), SRP_A (required),
* SECRET_HASH (required if the app client is configured with a
* client secret), DEVICE_KEY.
* SELECT_CHALLENGE: Respond to the challenge with
* USERNAME and an ANSWER that matches one of the
* challenge types in the AvailableChallenges response
* parameter.
* SMS_MFA: Next challenge is to supply an
* SMS_MFA_CODEthat your user pool delivered in an SMS message.
* EMAIL_OTP: Next challenge is to supply an
* EMAIL_OTP_CODE that your user pool delivered in an email
* message.
* PASSWORD_VERIFIER: Next challenge is to supply
* PASSWORD_CLAIM_SIGNATURE,
* PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after
* the client-side SRP calculations.
* CUSTOM_CHALLENGE: This is returned if your custom authentication
* flow determines that the user should pass another challenge before tokens are
* issued.
* DEVICE_SRP_AUTH: If device tracking was activated on your user
* pool and the previous challenges were passed, this challenge is returned so that
* Amazon Cognito can start tracking this device.
* DEVICE_PASSWORD_VERIFIER: Similar to
* PASSWORD_VERIFIER, but for devices only.
* NEW_PASSWORD_REQUIRED: For users who are required to change their
* passwords after successful first login.
Respond to this challenge with NEW_PASSWORD and any required
* attributes that Amazon Cognito returned in the requiredAttributes parameter.
* You can also set values for attributes that aren't required by your user pool
* and that your app client can write. For more information, see RespondToAuthChallenge.
Amazon Cognito only returns this challenge for users who have temporary passwords.
* Because of this, and because in some cases you can create users who don't have
* values for required attributes, take care to collect and submit
* required-attribute values for all users who don't have passwords. You can create
* a user in the Amazon Cognito console without, for example, a required
* birthdate attribute. The API response from Amazon Cognito won't prompt
* you to submit a birthdate for the user if they don't have a password.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter,
* then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
* MFA_SETUP: For users who are required to setup an MFA factor
* before they can sign in. The MFA types activated for the user pool will be
* listed in the challenge parameters MFAS_CAN_SETUP value.
To set up software token MFA, use the session returned here from
* InitiateAuth as an input to
* AssociateSoftwareToken. Use the session returned by
* VerifySoftwareToken as an input to
* RespondToAuthChallenge with challenge name
* MFA_SETUP to complete sign-in. To set up SMS MFA, an
* administrator should help the user to add a phone number to their account, and
* then the user should call InitiateAuth again to restart
* sign-in.
The session that should pass both ways in challenge-response calls to the service. If
* the caller must pass another challenge, they return a session with other challenge
* parameters. Include this session identifier in a RespondToAuthChallenge API
* request.
The challenge parameters. These are returned in the InitiateAuth response
* if you must pass another challenge. The responses in this parameter should be used to
* compute inputs to the next call (RespondToAuthChallenge).
All challenges require USERNAME. They also require
* SECRET_HASH if your app client has a client secret.
The result of the authentication response. This result is only returned if the caller
* doesn't need to pass another challenge. If the caller does need to pass another
* challenge before it gets tokens, ChallengeName,
* ChallengeParameters, and Session are returned.
This response parameter prompts a user to select from multiple available challenges * that they can complete authentication with. For example, they might be able to continue * with passwordless authentication or with a one-time password from an SMS message.
* @public */ AvailableChallenges?: ChallengeNameType[] | undefined; } /** *Represents the request to list the devices.
* @public */ export interface ListDevicesRequest { /** *A valid access token that Amazon Cognito issued to the user whose list of devices you want to * view.
* @public */ AccessToken: string | undefined; /** *The limit of the device request.
* @public */ Limit?: number | undefined; /** *This API operation returns a limited number of results. The pagination token is * an identifier that you can present in an additional API request with the same parameters. When * you include the pagination token, Amazon Cognito returns the next set of items after the current list. * Subsequent requests return a new pagination token. By use of this token, you can paginate * through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** *Represents the response to list devices.
* @public */ export interface ListDevicesResponse { /** *The devices returned in the list devices response.
* @public */ Devices?: DeviceType[] | undefined; /** *The identifier that Amazon Cognito returned with the previous request to this operation. When * you include a pagination token in your request, Amazon Cognito returns the next set of items in * the list. By use of this token, you can paginate through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** * @public */ export interface ListGroupsRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The limit of the request to list groups.
* @public */ Limit?: number | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListGroupsResponse { /** *The group objects for the groups.
* @public */ Groups?: GroupType[] | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListIdentityProvidersRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The maximum number of IdPs to return.
* @public */ MaxResults?: number | undefined; /** *A pagination token.
* @public */ NextToken?: string | undefined; } /** *The details of a user pool identity provider (IdP), including name and type.
*This data type is a response parameter of ListIdentityProviders.
* @public */ export interface ProviderDescription { /** *The name of the IdP, for example MySAMLProvider.
The type of the provider, for example SAML. Amazon Cognito supports SAML 2.0,
* OIDC, and social IdPs. User pools list supported social IdPs by name in this response
* parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
A list of IdP objects.
* @public */ Providers: ProviderDescription[] | undefined; /** *A pagination token.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListResourceServersRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The maximum number of resource servers to return.
* @public */ MaxResults?: number | undefined; /** *A pagination token.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListResourceServersResponse { /** *The resource servers.
* @public */ ResourceServers: ResourceServerType[] | undefined; /** *A pagination token.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *The tags that are assigned to the user pool.
* @public */ Tags?: RecordRepresents the request to list the user import jobs.
* @public */ export interface ListUserImportJobsRequest { /** *The user pool ID for the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; /** *The maximum number of import jobs you want the request to return.
* @public */ MaxResults: number | undefined; /** *This API operation returns a limited number of results. The pagination token is * an identifier that you can present in an additional API request with the same parameters. When * you include the pagination token, Amazon Cognito returns the next set of items after the current list. * Subsequent requests return a new pagination token. By use of this token, you can paginate * through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** *Represents the response from the server to the request to list the user import * jobs.
* @public */ export interface ListUserImportJobsResponse { /** *The user import jobs.
* @public */ UserImportJobs?: UserImportJobType[] | undefined; /** *The identifier that Amazon Cognito returned with the previous request to this operation. When * you include a pagination token in your request, Amazon Cognito returns the next set of items in * the list. By use of this token, you can paginate through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** *Represents the request to list the user pool clients.
* @public */ export interface ListUserPoolClientsRequest { /** *The user pool ID for the user pool where you want to list user pool clients.
* @public */ UserPoolId: string | undefined; /** *The maximum number of results you want the request to return when listing the user * pool clients.
* @public */ MaxResults?: number | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** *A short description of a user pool app client.
*This data type is a response parameter of ListUserPoolClients.
* @public */ export interface UserPoolClientDescription { /** *The app client ID.
* @public */ ClientId?: string | undefined; /** *The ID of the user pool that's associated with the app client.
* @public */ UserPoolId?: string | undefined; /** *The app client name.
* @public */ ClientName?: string | undefined; } /** *Represents the response from the server that lists user pool clients.
* @public */ export interface ListUserPoolClientsResponse { /** *The user pool clients in the response that lists user pool clients.
* @public */ UserPoolClients?: UserPoolClientDescription[] | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** *Represents the request to list user pools.
* @public */ export interface ListUserPoolsRequest { /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; /** *The maximum number of results you want the request to return when listing the user * pools.
* @public */ MaxResults: number | undefined; } /** *A short description of a user pool.
*This data type is a response parameter of ListUserPools.
* @public */ export interface UserPoolDescriptionType { /** *The user pool ID.
* @public */ Id?: string | undefined; /** *The user pool name.
* @public */ Name?: string | undefined; /** *A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible * stages of user pool operations. Triggers can modify the outcome of the operations that * invoked them.
* @public */ LambdaConfig?: LambdaConfigType | undefined; /** * @deprecated * *The user pool status.
* @public */ Status?: StatusType | undefined; /** *The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
Represents the response to list user pools.
* @public */ export interface ListUserPoolsResponse { /** *The user pools from the response to list users.
* @public */ UserPools?: UserPoolDescriptionType[] | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** *Represents the request to list users.
* @public */ export interface ListUsersRequest { /** *The user pool ID for the user pool on which the search should be performed.
* @public */ UserPoolId: string | undefined; /** *A JSON array of user attribute names, for example given_name, that you
* want Amazon Cognito to include in the response for each user. When you don't provide an
* AttributesToGet parameter, Amazon Cognito returns all attributes for each
* user.
Use AttributesToGet with required attributes in your user pool, or in
* conjunction with Filter. Amazon Cognito returns an error if not all users in the
* results have set a value for the attribute you request. Attributes that you can't
* filter on, including custom attributes, must have a value set in every user profile
* before an AttributesToGet parameter returns results.
Maximum number of users to be returned.
* @public */ Limit?: number | undefined; /** *This API operation returns a limited number of results. The pagination token is * an identifier that you can present in an additional API request with the same parameters. When * you include the pagination token, Amazon Cognito returns the next set of items after the current list. * Subsequent requests return a new pagination token. By use of this token, you can paginate * through the full list of items.
* @public */ PaginationToken?: string | undefined; /** *A filter string of the form "AttributeName Filter-Type "AttributeValue".
* Quotation marks within the filter string must be escaped using the backslash
* (\) character. For example, "family_name =
* \"Reddy\"".
* AttributeName: The name of the attribute to search for. * You can only search for one attribute at a time.
*
* Filter-Type: For an exact match, use =, for
* example, "given_name = \"Jon\"". For a prefix ("starts with")
* match, use ^=, for example, "given_name ^= \"Jon\"".
*
* AttributeValue: The attribute value that must be matched * for each user.
*If the filter string is empty, ListUsers returns all users in the user
* pool.
You can only search for the following standard attributes:
*
* username (case-sensitive)
* email
*
* phone_number
*
* name
*
* given_name
*
* family_name
*
* preferred_username
*
* cognito:user_status (called Status in the Console) (case-insensitive)
* status (called Enabled in the Console)
* (case-sensitive)
*
* sub
*
Custom attributes aren't searchable.
*You can also list users with a client-side filter. The server-side filter matches
* no more than one attribute. For an advanced search, use a client-side filter with
* the --query parameter of the list-users action in the
* CLI. When you use a client-side filter, ListUsers returns a paginated list of zero
* or more users. You can receive multiple pages in a row with zero results. Repeat the
* query with each pagination token that is returned until you receive a null
* pagination token value, and then review the combined result.
For more information about server-side and client-side filtering, see FilteringCLI output in the Command Line Interface * User Guide.
*For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer * Guide.
* @public */ Filter?: string | undefined; } /** *The response from the request to list users.
* @public */ export interface ListUsersResponse { /** *A list of the user pool users, and their attributes, that match your query.
*Amazon Cognito creates a profile in your user pool for each native user in your user pool,
* and each unique user ID from your third-party identity providers (IdPs). When you
* link users with the AdminLinkProviderForUser API operation, the output of
* ListUsers displays both the IdP user and the native user that you
* linked. You can identify IdP users in the Users object of this API
* response by the IdP prefix that Amazon Cognito appends to Username.
The identifier that Amazon Cognito returned with the previous request to this operation. When * you include a pagination token in your request, Amazon Cognito returns the next set of items in * the list. By use of this token, you can paginate through the full list of items.
* @public */ PaginationToken?: string | undefined; } /** * @public */ export interface ListUsersInGroupRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The name of the group.
* @public */ GroupName: string | undefined; /** *The maximum number of users that you want to retrieve before pagination.
* @public */ Limit?: number | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUsersInGroupResponse { /** *A list of users in the group, and their attributes.
* @public */ Users?: UserType[] | undefined; /** *An identifier that you can use in a later request to return the next set of items in * the list.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListWebAuthnCredentialsRequest { /** *A valid access token that Amazon Cognito issued to the user whose registered passkeys you want * to list.
* @public */ AccessToken: string | undefined; /** *An identifier that was returned from the previous call to this operation, which can be * used to return the next set of items in the list.
* @public */ NextToken?: string | undefined; /** *The maximum number of the user's passkey credentials that you want to * return.
* @public */ MaxResults?: number | undefined; } /** *The details of a passkey, or webauthN, biometric or security-key authentication factor * for a user.
*This data type is a response parameter of ListWebAuthnCredentials.
* @public */ export interface WebAuthnCredentialDescription { /** *The unique identifier of the passkey credential.
* @public */ CredentialId: string | undefined; /** *An automatically-generated friendly name for the passkey credential.
* @public */ FriendlyCredentialName: string | undefined; /** *The relying-party ID of the provider for the passkey credential.
* @public */ RelyingPartyId: string | undefined; /** *The general category of the passkey authenticator. Can be a platform, or on-device * authenticator like a built-in fingerprint scanner, or a cross-platform device that's not * attached to the device like a Bluetooth security key.
* @public */ AuthenticatorAttachment?: string | undefined; /** *Information about the transport methods of the passkey credential, for example USB or * Bluetooth Low Energy.
* @public */ AuthenticatorTransports: string[] | undefined; /** *The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
* human-readable format like ISO 8601 or a Java Date object.
A list of registered passkeys for a user.
* @public */ Credentials: WebAuthnCredentialDescription[] | undefined; /** *An identifier that you can use in a later request to return the next set of items in * the list.
* @public */ NextToken?: string | undefined; } /** *Represents the request to resend the confirmation code.
* @public */ export interface ResendConfirmationCodeRequest { /** *The ID of the client associated with the user pool.
* @public */ ClientId: string | undefined; /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a * user pool client and username plus the client ID in the message.
* @public */ SecretHash?: string | undefined; /** *Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The Amazon Pinpoint analytics metadata that contributes to your metrics for
* ResendConfirmationCode calls.
A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is
* assigned to the custom message trigger. When Amazon Cognito invokes this
* function, it passes a JSON payload, which the function receives as input. This payload
* contains a clientMetadata attribute, which provides the data that you
* assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your
* function code in Lambda, you can process the clientMetadata value to enhance
* your workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The response from the server when Amazon Cognito makes the request to resend a confirmation * code.
* @public */ export interface ResendConfirmationCodeResponse { /** *The code delivery details returned by the server in response to the request to resend * the confirmation code.
* @public */ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined; } /** *The request to respond to an authentication challenge.
* @public */ export interface RespondToAuthChallengeRequest { /** *The app client ID.
* @public */ ClientId: string | undefined; /** *The challenge name. For more information, see InitiateAuth.
*
* ADMIN_NO_SRP_AUTH isn't a valid value.
The session that should be passed both ways in challenge-response calls to the
* service. If InitiateAuth or RespondToAuthChallenge API call
* determines that the caller must pass another challenge, they return a session with other
* challenge parameters. This session should be passed as it is to the next
* RespondToAuthChallenge API call.
The responses to the challenge that you received in the previous request. Each * challenge has its own required response parameters. The following examples are partial * JSON request bodies that highlight challenge-response parameters.
*You must provide a SECRET_HASH parameter in all challenge responses to an app
* client that has a client secret. Include a DEVICE_KEY for device
* authentication.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "USERNAME": "[username]",
* "ANSWER": "[Challenge name]"\}
*
Available challenges are PASSWORD, PASSWORD_SRP,
* EMAIL_OTP, SMS_OTP, and WEB_AUTHN.
Complete authentication in the SELECT_CHALLENGE response for
* PASSWORD, PASSWORD_SRP, and WEB_AUTHN:
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "WEB_AUTHN",
* "USERNAME": "[username]",
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD",
* "USERNAME": "[username]",
* "PASSWORD": "[password]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "PASSWORD_SRP",
* "USERNAME": "[username]",
* "SRP_A": "[SRP_A]"\}
*
For SMS_OTP and EMAIL_OTP, respond with the
* username and answer. Your user pool will send a code for the user to submit in
* the next challenge response.
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "SMS_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SELECT_CHALLENGE", "ChallengeResponses": \{
* "ANSWER": "EMAIL_OTP",
* "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_OTP", "ChallengeResponses":
* \{"SMS_OTP_CODE": "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "EMAIL_OTP", "ChallengeResponses": \{"EMAIL_OTP_CODE":
* "[code]", "USERNAME": "[username]"\}
*
* "ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
* "[code]", "USERNAME": "[username]"\}
*
This challenge response is part of the SRP flow. Amazon Cognito requires
* that your application respond to this challenge within a few seconds. When
* the response time exceeds this period, your user pool returns a
* NotAuthorizedException error.
* "ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
* [timestamp], "USERNAME": "[username]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}
*
Add "DEVICE_KEY" when you sign in with a remembered
* device.
* "ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
* "[username]"\}
*
To set any required attributes that InitiateAuth returned in
* an requiredAttributes parameter, add
* "userAttributes.[attribute_name]": "[attribute_value]".
* This parameter can also set values for writable attributes that aren't
* required by your user pool.
In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required attribute that already has a value.
* In RespondToAuthChallenge, set a value for any keys that Amazon Cognito returned in the requiredAttributes parameter,
* then use the UpdateUserAttributes API operation to modify the value of any additional attributes.
* "ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
* [authenticator_code]\}
*
* "ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
* "[srp_a]"\}
*
* "ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}
*
* "ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
* "[username]"\}, "SESSION": "[Session ID from
* VerifySoftwareToken]"
*
* "ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}
*
For more information about SECRET_HASH, see Computing secret hash values. For information about
* DEVICE_KEY, see Working with user devices in your user pool.
The Amazon Pinpoint analytics metadata that contributes to your metrics for
* RespondToAuthChallenge calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool
* triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any
* functions that are assigned to the following triggers: post
* authentication, pre token generation,
* define auth challenge, create auth
* challenge, and verify auth challenge. When Amazon Cognito
* invokes any of these functions, it passes a JSON payload, which the function receives as
* input. This payload contains a clientMetadata attribute, which provides the
* data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge
* request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The response to respond to the authentication challenge.
* @public */ export interface RespondToAuthChallengeResponse { /** *The challenge name. For more information, see InitiateAuth.
* @public */ ChallengeName?: ChallengeNameType | undefined; /** *The session that should be passed both ways in challenge-response calls to the
* service. If the caller must pass another challenge, they return a session with other
* challenge parameters. This session should be passed as it is to the next
* RespondToAuthChallenge API call.
The challenge parameters. For more information, see InitiateAuth.
* @public */ ChallengeParameters?: RecordThe result returned by the server in response to the request to respond to the * authentication challenge.
* @public */ AuthenticationResult?: AuthenticationResultType | undefined; } /** * @public */ export interface RevokeTokenRequest { /** *The refresh token that you want to revoke.
* @public */ Token: string | undefined; /** *The client ID for the token that you want to revoke.
* @public */ ClientId: string | undefined; /** *The secret for the client ID. This is required only if the client ID has a * secret.
* @public */ ClientSecret?: string | undefined; } /** * @public */ export interface RevokeTokenResponse { } /** *Exception that is thrown when the request isn't authorized. This can happen due to an * invalid access token in the request.
* @public */ export declare class UnauthorizedException extends __BaseException { readonly name: "UnauthorizedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeException that is thrown when you attempt to perform an operation that isn't enabled * for the user pool client.
* @public */ export declare class UnsupportedOperationException extends __BaseException { readonly name: "UnsupportedOperationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeException that is thrown when an unsupported token is passed to an operation.
* @public */ export declare class UnsupportedTokenTypeException extends __BaseException { readonly name: "UnsupportedTokenTypeException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe ID of the user pool where you want to configure logging.
* @public */ UserPoolId: string | undefined; /** *A collection of the logging configurations for a user pool.
* @public */ LogConfigurations: LogConfigurationType[] | undefined; } /** * @public */ export interface SetLogDeliveryConfigurationResponse { /** *The detailed activity logging configuration that you applied to the requested user * pool.
* @public */ LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined; } /** * @public */ export interface SetRiskConfigurationRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The app client ID. If ClientId is null, then the risk configuration is
* mapped to userPoolId. When the client ID is null, the same risk
* configuration is applied to all the clients in the userPool.
Otherwise, ClientId is mapped to the client. When the client ID isn't
* null, the user pool configuration is overridden and the risk configuration for the
* client is used instead.
The compromised credentials risk configuration.
* @public */ CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined; /** *The account takeover risk configuration.
* @public */ AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined; /** *The configuration to override the risk decision.
* @public */ RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined; } /** * @public */ export interface SetRiskConfigurationResponse { /** *The risk configuration.
* @public */ RiskConfiguration: RiskConfigurationType | undefined; } /** * @public */ export interface SetUICustomizationRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *The client ID for the client app.
* @public */ ClientId?: string | undefined; /** *The CSS values in the UI customization.
* @public */ CSS?: string | undefined; /** *The uploaded logo image for the UI customization.
* @public */ ImageFile?: Uint8Array | undefined; } /** * @public */ export interface SetUICustomizationResponse { /** *The UI customization information.
* @public */ UICustomization: UICustomizationType | undefined; } /** * @public */ export interface SetUserMFAPreferenceRequest { /** *User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as * the preferred MFA method when multiple methods are available.
* @public */ SMSMfaSettings?: SMSMfaSettingsType | undefined; /** *User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates * TOTP MFA and sets it as the preferred MFA method when multiple methods are * available.
* @public */ SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined; /** *User preferences for email message MFA. Activates or deactivates email MFA and sets it * as the preferred MFA method when multiple methods are available. To activate this setting, * advanced security features must be active in your user pool.
* @public */ EmailMfaSettings?: EmailMfaSettingsType | undefined; /** *A valid access token that Amazon Cognito issued to the user whose MFA preference you want to * set.
* @public */ AccessToken: string | undefined; } /** * @public */ export interface SetUserMFAPreferenceResponse { } /** * @public */ export interface SetUserPoolMfaConfigRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *Configures user pool SMS messages for MFA. Sets the message template and the SMS * message sending configuration for Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Configures a user pool for time-based one-time password (TOTP) MFA. Enables or * disables TOTP.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Configures user pool email messages for MFA. Sets the subject and body of the email * message template for MFA messages. To activate this setting, * advanced security features must be active in your user pool.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who * have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor * Authentication (MFA) to a user pool. Valid values include:
*
* OFF MFA won't be used for any users.
* ON MFA is required for all users to sign in.
* OPTIONAL MFA will be required only for individual users who have
* an MFA factor activated.
The configuration of your user pool for passkey, or webauthN, authentication and * registration. You can set this configuration independent of the MFA configuration * options in this operation.
* @public */ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined; } /** * @public */ export interface SetUserPoolMfaConfigResponse { /** *Shows user pool SMS message configuration for MFA. Includes the message template and * the SMS message sending configuration for Amazon SNS.
* @public */ SmsMfaConfiguration?: SmsMfaConfigType | undefined; /** *Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes * TOTP enabled or disabled state.
* @public */ SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined; /** *Shows user pool email message configuration for MFA. Includes the subject and body of * the email message template for MFA messages. To activate this setting, * advanced security features must be active in your user pool.
* @public */ EmailMfaConfiguration?: EmailMfaConfigType | undefined; /** *The MFA configuration. Valid values include:
*
* OFF MFA won't be used for any users.
* ON MFA is required for all users to sign in.
* OPTIONAL MFA will be required only for individual users who have
* an MFA factor enabled.
The configuration of your user pool for passkey, or webauthN, biometric and * security-key devices.
* @public */ WebAuthnConfiguration?: WebAuthnConfigurationType | undefined; } /** *Represents the request to set user settings.
* @public */ export interface SetUserSettingsRequest { /** *A valid access token that Amazon Cognito issued to the user whose user settings you want to * configure.
* @public */ AccessToken: string | undefined; /** *You can use this parameter only to set an SMS configuration that uses SMS for * delivery.
* @public */ MFAOptions: MFAOptionType[] | undefined; } /** *The response from the server for a set user settings request.
* @public */ export interface SetUserSettingsResponse { } /** *Represents the request to register a user.
* @public */ export interface SignUpRequest { /** *The ID of the client associated with the user pool.
* @public */ ClientId: string | undefined; /** *A keyed-hash message authentication code (HMAC) calculated using the secret key of a * user pool client and username plus the client ID in the message.
* @public */ SecretHash?: string | undefined; /** *The username of the user that you want to sign up. The value of this parameter is * typically a username, but can be any alias attribute in your user pool.
* @public */ Username: string | undefined; /** *The password of the user you want to register.
*Users can sign up without a password when your user pool supports passwordless sign-in * with email or SMS OTPs. To create a user with no password, omit this parameter or submit * a blank value. You can only create a passwordless user when passwordless sign-in is * available. See the SignInPolicyType property of CreateUserPool and UpdateUserPool.
* @public */ Password?: string | undefined; /** *An array of name-value pairs representing user attributes.
*For custom attributes, you must prepend the custom: prefix to the
* attribute name.
Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda * trigger. This set of key-value pairs are for custom validation of information that you * collect from your users but don't need to retain.
*Your Lambda function can analyze this additional data and act on it. Your function * might perform external API operations like logging user attributes and validation data * to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns * to Amazon Cognito, like automatically confirming the user if they sign up from within your * network.
*For more information about the pre sign-up Lambda trigger, see Pre sign-up Lambda trigger.
* @public */ ValidationData?: AttributeType[] | undefined; /** *The Amazon Pinpoint analytics metadata that contributes to your metrics for
* SignUp calls.
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced * security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito * when it makes API requests.
* @public */ UserContextData?: UserContextDataType | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the
* following triggers: pre sign-up, custom
* message, and post confirmation. When Amazon Cognito invokes
* any of these functions, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your SignUp request. In your
* function code in Lambda, you can process the clientMetadata value to enhance
* your workflow for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*The response from the server for a registration request.
* @public */ export interface SignUpResponse { /** *A response from the server indicating that a user registration has been * confirmed.
* @public */ UserConfirmed: boolean | undefined; /** *The code delivery details returned by the server response to the user registration * request.
* @public */ CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined; /** *The 128-bit ID of the authenticated user. This isn't the same as
* username.
A session Id that you can pass to ConfirmSignUp when you want to
* immediately sign in your user with the USER_AUTH flow after they complete
* sign-up.
Represents the request to start the user import job.
* @public */ export interface StartUserImportJobRequest { /** *The user pool ID for the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; /** *The job ID for the user import job.
* @public */ JobId: string | undefined; } /** *Represents the response from the server to the request to start the user import * job.
* @public */ export interface StartUserImportJobResponse { /** *The job object that represents the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** * @public */ export interface StartWebAuthnRegistrationRequest { /** *A valid access token that Amazon Cognito issued to the user whose passkey metadata you want to * generate.
* @public */ AccessToken: string | undefined; } /** * @public */ export interface StartWebAuthnRegistrationResponse { /** *The information that a user can provide in their request to register with their * passkey provider.
* @public */ CredentialCreationOptions: __DocumentType | undefined; } /** *This exception is thrown when a user pool doesn't have a configured relying party * id or a user pool domain.
* @public */ export declare class WebAuthnConfigurationMissingException extends __BaseException { readonly name: "WebAuthnConfigurationMissingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeRepresents the request to stop the user import job.
* @public */ export interface StopUserImportJobRequest { /** *The user pool ID for the user pool that the users are being imported into.
* @public */ UserPoolId: string | undefined; /** *The job ID for the user import job.
* @public */ JobId: string | undefined; } /** *Represents the response from the server to the request to stop the user import * job.
* @public */ export interface StopUserImportJobResponse { /** *The job object that represents the user import job.
* @public */ UserImportJob?: UserImportJobType | undefined; } /** * @public */ export interface TagResourceRequest { /** *The Amazon Resource Name (ARN) of the user pool to assign the tags to.
* @public */ ResourceArn: string | undefined; /** *The tags to assign to the user pool.
* @public */ Tags: RecordThe Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
* @public */ ResourceArn: string | undefined; /** *The keys of the tags to remove from the user pool.
* @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagResourceResponse { } /** * @public */ export interface UpdateAuthEventFeedbackRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The username of the user that you want to query or modify. The value of this parameter
* is typically your user's username, but it can be any of their alias attributes. If
* username isn't an alias attribute in your user pool, this value
* must be the sub of a local user or the username of a user from a
* third-party IdP.
The event ID.
* @public */ EventId: string | undefined; /** *The feedback token.
* @public */ FeedbackToken: string | undefined; /** *The authentication event feedback value. When you provide a FeedbackValue
* value of valid, you tell Amazon Cognito that you trust a user session where Amazon Cognito
* has evaluated some level of risk. When you provide a FeedbackValue value of
* invalid, you tell Amazon Cognito that you don't trust a user session, or you
* don't believe that Amazon Cognito evaluated a high-enough risk level.
Represents the request to update the device status.
* @public */ export interface UpdateDeviceStatusRequest { /** *A valid access token that Amazon Cognito issued to the user whose device status you want to * update.
* @public */ AccessToken: string | undefined; /** *The device key.
* @public */ DeviceKey: string | undefined; /** *The status of whether a device is remembered.
* @public */ DeviceRememberedStatus?: DeviceRememberedStatusType | undefined; } /** *The response to the request to update the device status.
* @public */ export interface UpdateDeviceStatusResponse { } /** * @public */ export interface UpdateGroupRequest { /** *The name of the group.
* @public */ GroupName: string | undefined; /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *A string containing the new description of the group.
* @public */ Description?: string | undefined; /** *The new role Amazon Resource Name (ARN) for the group. This is used for setting the
* cognito:roles and cognito:preferred_role claims in the
* token.
The new precedence value for the group. For more information about this parameter, see * CreateGroup.
* @public */ Precedence?: number | undefined; } /** * @public */ export interface UpdateGroupResponse { /** *The group object for the group.
* @public */ Group?: GroupType | undefined; } /** * @public */ export interface UpdateIdentityProviderRequest { /** *The user pool ID.
* @public */ UserPoolId: string | undefined; /** *The IdP name.
* @public */ ProviderName: string | undefined; /** *The scopes, URLs, and identifiers for your external identity provider. The following
* examples describe the provider detail keys for each IdP type. These values and their
* schema are subject to change. Social IdP authorize_scopes values must match
* the values listed here.
Amazon Cognito accepts the following elements when it can't discover endpoint
* URLs from oidc_issuer: attributes_url,
* authorize_url, jwks_uri,
* token_url.
Create or update request: "ProviderDetails": \{
* "attributes_request_method": "GET", "attributes_url":
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
* email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Describe response: "ProviderDetails": \{ "attributes_request_method":
* "GET", "attributes_url": "https://auth.example.com/userInfo",
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
* profile email", "authorize_url": "https://auth.example.com/authorize",
* "client_id": "1example23456789", "client_secret":
* "provider-app-client-secret", "jwks_uri":
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
* "https://auth.example.com", "token_url": "https://example.com/token"
* \}
*
Create or update request with Metadata URL: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
Create or update request with Metadata file: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true",
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
* "rsa-sha256" \}
*
The value of MetadataFile must be the plaintext metadata document with all
* quote (") characters escaped by backslashes.
Describe response: "ProviderDetails": \{ "IDPInit": "true",
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
* "rsa-sha256", "SLORedirectBindingURI":
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
* "https://auth.example.com/sso/saml" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "profile postal_code", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret"
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
* "https://www.amazon.com/ap/oa", "client_id":
* "amzn1.application-oa2-client.1example23456789", "client_secret":
* "provider-app-client-secret", "token_request_method": "POST",
* "token_url": "https://api.amazon.com/auth/o2/token" \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email profile openid", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret" \}
*
Describe response: "ProviderDetails": \{ "attributes_url":
* "https://people.googleapis.com/v1/people/me?personFields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
* profile openid", "authorize_url":
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
* "1example23456789.apps.googleusercontent.com", "client_secret":
* "provider-app-client-secret", "oidc_issuer":
* "https://accounts.google.com", "token_request_method": "POST",
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
* \}
*
Create or update request: "ProviderDetails": \{ "authorize_scopes":
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}
*
Describe response: "ProviderDetails": \{
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
* "token_request_method": "POST", "token_url":
* "https://appleid.apple.com/auth/token" \}
*
Create or update request: "ProviderDetails": \{ "api_version": "v17.0",
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
* "client_secret": "provider-app-client-secret" \}
*
Describe response: "ProviderDetails":
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}
*
The IdP attribute mapping to be changed.
* @public */ AttributeMapping?: RecordA list of IdP identifiers.
* @public */ IdpIdentifiers?: string[] | undefined; } /** * @public */ export interface UpdateIdentityProviderResponse { /** *The identity provider details.
* @public */ IdentityProvider: IdentityProviderType | undefined; } /** * @public */ export interface UpdateManagedLoginBrandingRequest { /** *The ID of the user pool that contains the managed login branding style that you want * to update.
* @public */ UserPoolId?: string | undefined; /** *The ID of the managed login branding style that you want to update.
* @public */ ManagedLoginBrandingId?: string | undefined; /** *When true, applies the default branding style options. This option reverts to default * style options that are managed by Amazon Cognito. You can modify them later in the branding * designer.
*When you specify true for this option, you must also omit values for
* Settings and Assets in the request.
A JSON file, encoded as a Document type, with the the settings that you
* want to apply to your style.
An array of image files that you want to apply to roles like backgrounds, logos, and * icons. Each object must also indicate whether it is for dark mode, light mode, or * browser-adaptive mode.
* @public */ Assets?: AssetType[] | undefined; } /** * @public */ export interface UpdateManagedLoginBrandingResponse { /** *The details of the branding style that you updated.
* @public */ ManagedLoginBranding?: ManagedLoginBrandingType | undefined; } /** * @public */ export interface UpdateResourceServerRequest { /** *The user pool ID for the user pool.
* @public */ UserPoolId: string | undefined; /** *A unique resource server identifier for the resource server. The identifier can be an
* API friendly name like solar-system-data. You can also set an API URL like
* https://solar-system-data-api.example.com as your identifier.
Amazon Cognito represents scopes in the access token in the format
* $resource-server-identifier/$scope. Longer scope-identifier strings
* increase the size of your access tokens.
The name of the resource server.
* @public */ Name: string | undefined; /** *The scope values to be set for the resource server.
* @public */ Scopes?: ResourceServerScopeType[] | undefined; } /** * @public */ export interface UpdateResourceServerResponse { /** *The resource server.
* @public */ ResourceServer: ResourceServerType | undefined; } /** *Represents the request to update user attributes.
* @public */ export interface UpdateUserAttributesRequest { /** *An array of name-value pairs representing user attributes.
*For custom attributes, you must prepend the custom: prefix to the
* attribute name.
If you have set an attribute to require verification before Amazon Cognito updates its value, * this request doesn’t immediately update the value of that attribute. After your user * receives and responds to a verification message to verify the new value, Amazon Cognito updates * the attribute value. Your user can sign in and receive messages with the original * attribute value until they verify the new value.
* @public */ UserAttributes: AttributeType[] | undefined; /** *A valid access token that Amazon Cognito issued to the user whose user attributes you want to * update.
* @public */ AccessToken: string | undefined; /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action initiates.
*You create custom workflows by assigning Lambda functions to user pool triggers. When
* you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned
* to the custom message trigger. When Amazon Cognito invokes this function, it
* passes a JSON payload, which the function receives as input. This payload contains a
* clientMetadata attribute, which provides the data that you assigned to
* the ClientMetadata parameter in your UpdateUserAttributes request. In your function code
* in Lambda, you can process the clientMetadata value to enhance your workflow
* for your specific needs.
For more information, see * Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
*When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the * following:
*Store the ClientMetadata value. This data is available only to Lambda * triggers that are assigned to a user pool to support custom workflows. If * your user pool configuration doesn't include triggers, the ClientMetadata * parameter serves no purpose.
*Validate the ClientMetadata value.
*Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive * information.
*Represents the response from the server for the request to update user * attributes.
* @public */ export interface UpdateUserAttributesResponse { /** *The code delivery details list from the server for the request to update user * attributes.
* @public */ CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined; } /** *Represents the request to update the user pool.
* @public */ export interface UpdateUserPoolRequest { /** *The user pool ID for the user pool you want to update.
* @public */ UserPoolId: string | undefined; /** *A container with the policies you want to update in a user pool.
* @public */ Policies?: UserPoolPolicyType | undefined; /** *When active, DeletionProtection prevents accidental deletion of your user
* pool. Before you can delete a user pool that you have protected against deletion, you
* must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool API request,
* Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool,
* send a new DeleteUserPool request after you deactivate deletion protection in an
* UpdateUserPool API request.
The Lambda configuration information from the request to update the user pool.
* @public */ LambdaConfig?: LambdaConfigType | undefined; /** *The attributes that are automatically verified when Amazon Cognito requests to update user * pools.
* @public */ AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ SmsVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationMessage?: string | undefined; /** *This parameter is no longer used. See VerificationMessageTemplateType.
* @public */ EmailVerificationSubject?: string | undefined; /** *The template for verification messages.
* @public */ VerificationMessageTemplate?: VerificationMessageTemplateType | undefined; /** *The contents of the SMS authentication message.
* @public */ SmsAuthenticationMessage?: string | undefined; /** *The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate,
* a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For
* more information, see
* Verifying updates to email addresses and phone numbers.
Possible values include:
*
* OFF - MFA tokens aren't required and can't be specified during user
* registration.
* ON - MFA tokens are required for all user registrations. You can
* only specify ON when you're initially creating a user pool. You can use the
* SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
* user pools.
* OPTIONAL - Users have the option when registering to create an MFA
* token.
The device-remembering configuration for a user pool. A null value indicates that you * have deactivated device remembering in your user pool.
*When you provide a value for any DeviceConfiguration field, you
* activate the Amazon Cognito device-remembering feature.
The email configuration of your user pool. The email configuration type sets your * preferred sending method, Amazon Web Services Region, and sender for email invitation and verification * messages from your user pool.
* @public */ EmailConfiguration?: EmailConfigurationType | undefined; /** *The SMS configuration with the settings that your Amazon Cognito user pool must use to send an * SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages * with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management * (IAM) role in your Amazon Web Services account.
* @public */ SmsConfiguration?: SmsConfigurationType | undefined; /** *The tag keys and values to assign to the user pool. A tag is a label that you can use * to categorize and manage user pools in different ways, such as by purpose, owner, * environment, or other criteria.
* @public */ UserPoolTags?: RecordThe configuration for AdminCreateUser requests.
User pool add-ons. Contains settings for activation of advanced security features. To
* log user security information but take no action, set to AUDIT. To
* configure automatic security responses to risky traffic to your user pool, set to
* ENFORCED.
For more information, see Adding advanced security to a user pool.
* @public */ UserPoolAddOns?: UserPoolAddOnsType | undefined; /** *The available verified method a user can use to recover their password when they call
* ForgotPassword. You can use this setting to define a preferred method
* when a user has more than one method available. With this setting, SMS doesn't qualify
* for a valid password recovery mechanism if the user also has SMS multi-factor
* authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy
* behavior to determine the recovery method where SMS is preferred through email.
The updated name of your user pool.
* @public */ PoolName?: string | undefined; /** *The user pool feature plan, or tier. This parameter determines the
* eligibility of the user pool for features like managed login, access-token
* customization, and threat protection. Defaults to ESSENTIALS.
Represents the response from the server when you make a request to update the user * pool.
* @public */ export interface UpdateUserPoolResponse { } /** *Represents the request to update the user pool client.
* @public */ export interface UpdateUserPoolClientRequest { /** *The user pool ID for the user pool where you want to update the user pool * client.
* @public */ UserPoolId: string | undefined; /** *The ID of the client associated with the user pool.
* @public */ ClientId: string | undefined; /** *The client name from the update user pool client request.
* @public */ ClientName?: string | undefined; /** *The refresh token time limit. After this limit expires, your user can't use
* their refresh token. To specify the time unit for RefreshTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as 10 and
* TokenValidityUnits as days, your user can refresh their session
* and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an API request is days.
* You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the
* value with the default value of 30 days. Valid range is displayed below
* in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh * tokens are valid for 30 days.
* @public */ RefreshTokenValidity?: number | undefined; /** *The access token time limit. After this limit expires, your user can't use
* their access token. To specify the time unit for AccessTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to 10 and
* TokenValidityUnits to hours, your user can authorize access with
* their access token for 10 hours.
The default time unit for AccessTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access * tokens are valid for one hour.
* @public */ AccessTokenValidity?: number | undefined; /** *The ID token time limit. After this limit expires, your user can't use
* their ID token. To specify the time unit for IdTokenValidity as
* seconds, minutes, hours, or days,
* set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as 10 and
* TokenValidityUnits as hours, your user can authenticate their
* session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request is hours.
* Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID * tokens are valid for one hour.
* @public */ IdTokenValidity?: number | undefined; /** *The time units you use when you set the duration of ID, access, and refresh tokens. * The default unit for RefreshToken is days, and the default for ID and access tokens is * hours.
* @public */ TokenValidityUnits?: TokenValidityUnitsType | undefined; /** *The list of user attributes that you want your app client to have read access to. * After your user authenticates in your app, their access token authorizes them to read * their own attribute value for any attribute in this list. An example of this kind of * activity is when your user selects a link to view their profile information. Your app * makes a GetUser API request to retrieve and display your user's profile * data.
*When you don't specify the ReadAttributes for your app client, your
* app can read the values of email_verified,
* phone_number_verified, and the Standard attributes of your user pool.
* When your user pool app client has read access to these default attributes,
* ReadAttributes doesn't return any information. Amazon Cognito only
* populates ReadAttributes in the API response if you have specified your own
* custom set of read attributes.
The list of user attributes that you want your app client to have write access to.
* After your user authenticates in your app, their access token authorizes them to set or
* modify their own attribute value for any attribute in this list. An example of this kind
* of activity is when you present your user with a form to update their profile
* information and they change their last name. Your app then makes an UpdateUserAttributes API request and sets family_name to the
* new value.
When you don't specify the WriteAttributes for your app client, your
* app can write the values of the Standard attributes of your user pool. When your user
* pool has write access to these default attributes, WriteAttributes
* doesn't return any information. Amazon Cognito only populates
* WriteAttributes in the API response if you have specified your own
* custom set of write attributes.
If your app client allows users to sign in through an IdP, this array must include all * attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when * users sign in to your application through an IdP. If your app client does not have write * access to a mapped attribute, Amazon Cognito throws an error when it tries to update the * attribute. For more information, see Specifying IdP Attribute Mappings for Your user * pool.
* @public */ WriteAttributes?: string[] | undefined; /** *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_USER_AUTH: Enable selection-based sign-in
* with USER_AUTH. This setting covers username-password,
* secure remote password (SRP), passwordless, and passkey authentication.
* This authentiation flow can do username-password and SRP authentication
* without other ExplicitAuthFlows permitting them. For example
* users can complete an SRP challenge through USER_AUTH
* without the flow USER_SRP_AUTH being active for the app
* client. This flow doesn't include CUSTOM_AUTH.
*
* ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password
* authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces
* the ADMIN_NO_SRP_AUTH setting. With this authentication flow, your app
* passes a user name and password to Amazon Cognito in the request, instead of using the Secure
* Remote Password (SRP) protocol to securely transmit the password.
* ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
* authentication.
* ALLOW_USER_PASSWORD_AUTH: Enable user password-based
* authentication. In this flow, Amazon Cognito receives the password in the request instead
* of using the SRP protocol to verify passwords.
* ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
* ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh
* tokens.
In some environments, you will see the values ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or USER_PASSWORD_AUTH.
* You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_,
* like ALLOW_USER_SRP_AUTH.
A list of provider names for the identity providers (IdPs) that are supported on this
* client. The following are supported: COGNITO, Facebook,
* Google, SignInWithApple, and LoginWithAmazon.
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
* user pool, for example MySAMLIdP or MyOIDCIdP.
This setting applies to providers that you can access with the hosted
* UI and OAuth 2.0 authorization server. The removal of COGNITO
* from this list doesn't prevent authentication operations for local users with the
* user pools API in an Amazon Web Services SDK. The only way to prevent API-based authentication is to
* block access with a WAF rule.
A list of allowed redirect (callback) URLs for the IdPs.
*A redirect URI must:
*Be an absolute URI.
*Be registered with the authorization server.
*Not include a fragment component.
*See OAuth 2.0 - * Redirection Endpoint.
*Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes * only.
*App callback URLs such as myapp://example are also supported.
A list of allowed logout URLs for the IdPs.
* @public */ LogoutURLs?: string[] | undefined; /** *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.
The allowed OAuth flows.
*Use a code grant flow, which provides an authorization code as the
* response. This code can be exchanged for access tokens with the
* /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) * directly to your user.
*Issue the access token from the /oauth2/token endpoint
* directly to a non-person user using a combination of the client ID and
* client secret.
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.
Set to true to use OAuth 2.0 features in your user pool app client.
* AllowedOAuthFlowsUserPoolClient must be true before you can configure
* the following features in your app client.
* CallBackURLs: Callback URLs.
* LogoutURLs: Sign-out redirect URLs.
* AllowedOAuthScopes: OAuth 2.0 scopes.
* AllowedOAuthFlows: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
* AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or
* UpdateUserPoolClient API request. If you don't set a value for
* AllowedOAuthFlowsUserPoolClient in a request with the CLI or SDKs, it defaults
* to false.
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.
*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.
Defaults to LEGACY when you don't provide a value.
Activates or deactivates token revocation. For more information about revoking tokens, * see RevokeToken.
* @public */ EnableTokenRevocation?: boolean | undefined; /** *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.
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.
Represents the response from the server to the request to update the user pool * client.
* @public */ export interface UpdateUserPoolClientResponse { /** *The user pool client value from the response from the server when you request to * update the user pool client.
* @public */ UserPoolClient?: UserPoolClientType | undefined; } /** *The UpdateUserPoolDomain request input.
* @public */ export interface UpdateUserPoolDomainRequest { /** *The domain name for the custom domain that hosts the sign-up and sign-in pages for
* your application. One example might be auth.example.com.
This string can include only lowercase letters, numbers, and hyphens. Don't use a * hyphen for the first or last character. Use periods to separate subdomain names.
* @public */ Domain: string | undefined; /** *The ID of the user pool that is associated with the custom domain whose certificate * you're updating.
* @public */ UserPoolId: string | undefined; /** *A version number that indicates the state of managed login for your domain. Version
* 1 is hosted UI (classic). Version 2 is the newer managed
* login with the branding designer. For more information, see Managed login.
The configuration for a custom domain that hosts the sign-up and sign-in pages for * your application. Use this object to specify an SSL certificate that is managed by * ACM.
*When you create a custom domain, the passkey RP ID defaults to the custom domain. If * you had a prefix domain active, this will cause passkey integration for your prefix * domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey * integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID * in a SetUserPoolMfaConfig request.
* @public */ CustomDomainConfig: CustomDomainConfigType | undefined; } /** *The UpdateUserPoolDomain response output.
* @public */ export interface UpdateUserPoolDomainResponse { /** *A version number that indicates the state of managed login for your domain. Version
* 1 is hosted UI (classic). Version 2 is the newer managed
* login with the branding designer. For more information, see Managed login.
The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user * pool.
* @public */ CloudFrontDomain?: string | undefined; } /** *This exception is thrown when there is a code mismatch and the service fails to * configure the software token TOTP multi-factor authentication (MFA).
* @public */ export declare class EnableSoftwareTokenMFAException extends __BaseException { readonly name: "EnableSoftwareTokenMFAException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeA valid access token that Amazon Cognito issued to the user whose software token you want to * verify.
* @public */ AccessToken?: string | undefined; /** *The session that should be passed both ways in challenge-response calls to the * service.
* @public */ Session?: string | undefined; /** *The one- time password computed using the secret code returned by AssociateSoftwareToken.
* @public */ UserCode: string | undefined; /** *The friendly device name.
* @public */ FriendlyDeviceName?: string | undefined; } /** * @public * @enum */ export declare const VerifySoftwareTokenResponseType: { readonly ERROR: "ERROR"; readonly SUCCESS: "SUCCESS"; }; /** * @public */ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenResponseType)[keyof typeof VerifySoftwareTokenResponseType]; /** * @public */ export interface VerifySoftwareTokenResponse { /** *The status of the verify software token.
* @public */ Status?: VerifySoftwareTokenResponseType | undefined; /** *The session that should be passed both ways in challenge-response calls to the * service.
* @public */ Session?: string | undefined; } /** *Represents the request to verify user attributes.
* @public */ export interface VerifyUserAttributeRequest { /** *A valid access token that Amazon Cognito issued to the user whose user attributes you want to * verify.
* @public */ AccessToken: string | undefined; /** *The attribute name in the request to verify user attributes.
* @public */ AttributeName: string | undefined; /** *The verification code in the request to verify user attributes.
* @public */ Code: string | undefined; } /** *A container representing the response from the server from the request to verify user * attributes.
* @public */ export interface VerifyUserAttributeResponse { } /** * @internal */ export declare const GlobalSignOutRequestFilterSensitiveLog: (obj: GlobalSignOutRequest) => any; /** * @internal */ export declare const InitiateAuthRequestFilterSensitiveLog: (obj: InitiateAuthRequest) => any; /** * @internal */ export declare const InitiateAuthResponseFilterSensitiveLog: (obj: InitiateAuthResponse) => any; /** * @internal */ export declare const ListDevicesRequestFilterSensitiveLog: (obj: ListDevicesRequest) => any; /** * @internal */ export declare const ListDevicesResponseFilterSensitiveLog: (obj: ListDevicesResponse) => any; /** * @internal */ export declare const UserPoolClientDescriptionFilterSensitiveLog: (obj: UserPoolClientDescription) => any; /** * @internal */ export declare const ListUserPoolClientsResponseFilterSensitiveLog: (obj: ListUserPoolClientsResponse) => any; /** * @internal */ export declare const ListUsersResponseFilterSensitiveLog: (obj: ListUsersResponse) => any; /** * @internal */ export declare const ListUsersInGroupResponseFilterSensitiveLog: (obj: ListUsersInGroupResponse) => any; /** * @internal */ export declare const ListWebAuthnCredentialsRequestFilterSensitiveLog: (obj: ListWebAuthnCredentialsRequest) => any; /** * @internal */ export declare const ResendConfirmationCodeRequestFilterSensitiveLog: (obj: ResendConfirmationCodeRequest) => any; /** * @internal */ export declare const RespondToAuthChallengeRequestFilterSensitiveLog: (obj: RespondToAuthChallengeRequest) => any; /** * @internal */ export declare const RespondToAuthChallengeResponseFilterSensitiveLog: (obj: RespondToAuthChallengeResponse) => any; /** * @internal */ export declare const RevokeTokenRequestFilterSensitiveLog: (obj: RevokeTokenRequest) => any; /** * @internal */ export declare const SetRiskConfigurationRequestFilterSensitiveLog: (obj: SetRiskConfigurationRequest) => any; /** * @internal */ export declare const SetRiskConfigurationResponseFilterSensitiveLog: (obj: SetRiskConfigurationResponse) => any; /** * @internal */ export declare const SetUICustomizationRequestFilterSensitiveLog: (obj: SetUICustomizationRequest) => any; /** * @internal */ export declare const SetUICustomizationResponseFilterSensitiveLog: (obj: SetUICustomizationResponse) => any; /** * @internal */ export declare const SetUserMFAPreferenceRequestFilterSensitiveLog: (obj: SetUserMFAPreferenceRequest) => any; /** * @internal */ export declare const SetUserSettingsRequestFilterSensitiveLog: (obj: SetUserSettingsRequest) => any; /** * @internal */ export declare const SignUpRequestFilterSensitiveLog: (obj: SignUpRequest) => any; /** * @internal */ export declare const SignUpResponseFilterSensitiveLog: (obj: SignUpResponse) => any; /** * @internal */ export declare const StartWebAuthnRegistrationRequestFilterSensitiveLog: (obj: StartWebAuthnRegistrationRequest) => any; /** * @internal */ export declare const UpdateAuthEventFeedbackRequestFilterSensitiveLog: (obj: UpdateAuthEventFeedbackRequest) => any; /** * @internal */ export declare const UpdateDeviceStatusRequestFilterSensitiveLog: (obj: UpdateDeviceStatusRequest) => any; /** * @internal */ export declare const UpdateUserAttributesRequestFilterSensitiveLog: (obj: UpdateUserAttributesRequest) => any; /** * @internal */ export declare const UpdateUserPoolClientRequestFilterSensitiveLog: (obj: UpdateUserPoolClientRequest) => any; /** * @internal */ export declare const UpdateUserPoolClientResponseFilterSensitiveLog: (obj: UpdateUserPoolClientResponse) => any; /** * @internal */ export declare const VerifySoftwareTokenRequestFilterSensitiveLog: (obj: VerifySoftwareTokenRequest) => any; /** * @internal */ export declare const VerifySoftwareTokenResponseFilterSensitiveLog: (obj: VerifySoftwareTokenResponse) => any; /** * @internal */ export declare const VerifyUserAttributeRequestFilterSensitiveLog: (obj: VerifyUserAttributeRequest) => any;