AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the ConfirmSignUp operation. This public API operation provides a code that Amazon Cognito sent to your user when they signed up in your user pool via the SignUp API operation. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message.
Local users who signed up in your user pool are the only type of user who can confirm sign-up with a code. Users who federate through an external identity provider (IdP) have already been confirmed by their IdP. Administrator-created users, users created with the AdminCreateUser API operation, confirm their accounts when they respond to their invitation email message and choose a password. They do not receive a confirmation code. Instead, they receive a temporary password.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class ConfirmSignUpRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The ConfirmSignUpRequest type exposes the following members
Name | Description | |
---|---|---|
ConfirmSignUpRequest() |
Name | Type | Description | |
---|---|---|---|
AnalyticsMetadata | Amazon.CognitoIdentityProvider.Model.AnalyticsMetadataType |
Gets and sets the property AnalyticsMetadata.
The Amazon Pinpoint analytics metadata for collecting metrics for |
|
ClientId | System.String |
Gets and sets the property ClientId. The ID of the app client associated with the user pool. |
|
ClientMetadata | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property ClientMetadata. 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 ConfirmSignUp API action, Amazon Cognito invokes the function that is
assigned to the post confirmation trigger. When Amazon Cognito invokes this
function, it passes a JSON payload, which the function receives as input. This payload
contains a 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:
|
|
ConfirmationCode | System.String |
Gets and sets the property ConfirmationCode. The confirmation code sent by a user's request to confirm registration. |
|
ForceAliasCreation | System.Boolean |
Gets and sets the property ForceAliasCreation.
Boolean to be specified to force user confirmation irrespective of existing alias.
By default set to |
|
SecretHash | System.String |
Gets and sets the property SecretHash. 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. |
|
UserContextData | Amazon.CognitoIdentityProvider.Model.UserContextDataType |
Gets and sets the property UserContextData. 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. |
|
Username | System.String |
Gets and sets the property Username.
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
|
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5