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 AdminConfirmSignUp operation. Confirms user sign-up as an administrator. Unlike ConfirmSignUp, your IAM credentials authorize user account confirmation. No confirmation code is required.
This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
To configure your user pool to require administrative confirmation of users, set AllowAdminCreateUserOnly
to true
in a CreateUserPool
or UpdateUserPool
request.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminConfirmSignUpRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminConfirmSignUpRequest type exposes the following members
Name | Description | |
---|---|---|
AdminConfirmSignUpRequest() |
Name | Type | Description | |
---|---|---|---|
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.
If your user pool configuration includes triggers, the AdminConfirmSignUp API action
invokes the Lambda function that is specified for the post confirmation trigger.
When Amazon Cognito invokes this function, it passes a JSON payload, which the function
receives as input. In this payload, the For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the
|
|
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
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to confirm a user's sign-up request. |
.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