1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package cognitoidentityprovider
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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 (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html)
// 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 (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html)
// 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
// native and OIDC APIs (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)
// .
func (c *Client) ConfirmSignUp(ctx context.Context, params *ConfirmSignUpInput, optFns ...func(*Options)) (*ConfirmSignUpOutput, error) {
if params == nil {
params = &ConfirmSignUpInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ConfirmSignUp", params, optFns, c.addOperationConfirmSignUpMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ConfirmSignUpOutput)
out.ResultMetadata = metadata
return out, nil
}
// Represents the request to confirm registration of a user.
type ConfirmSignUpInput struct {
// The ID of the app client associated with the user pool.
//
// This member is required.
ClientId *string
// The confirmation code sent by a user's request to confirm registration.
//
// This member is required.
ConfirmationCode *string
// 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, you can
// also use their sub in this request.
//
// This member is required.
Username *string
// The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
// calls.
AnalyticsMetadata *types.AnalyticsMetadataType
// 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
// clientMetadata attribute, which provides the data that you assigned to the
// ClientMetadata parameter in your ConfirmSignUp 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 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
// 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.
ClientMetadata map[string]string
// Boolean to be specified to force user confirmation irrespective of existing
// alias. By default set to False . If this parameter is set to True and the phone
// number/email used for sign up confirmation already exists as an alias with a
// different user, the API call will migrate the alias from the previous user to
// the newly created user being confirmed. If set to False , the API will throw an
// AliasExistsException error.
ForceAliasCreation bool
// 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.
SecretHash *string
// 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.
UserContextData *types.UserContextDataType
noSmithyDocumentSerde
}
// Represents the response from the server for the registration confirmation.
type ConfirmSignUpOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationConfirmSignUpMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpConfirmSignUp{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpConfirmSignUp{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ConfirmSignUp"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpConfirmSignUpValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opConfirmSignUp(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opConfirmSignUp(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ConfirmSignUp",
}
}
|
