@aws-sdk/client-cognito-identity-provider 3.758.0 → 3.760.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -61
- package/dist-cjs/index.js +39 -6
- package/dist-es/models/models_0.js +13 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +13 -1
- package/dist-types/CognitoIdentityProvider.d.ts +5 -62
- package/dist-types/CognitoIdentityProviderClient.d.ts +5 -62
- package/dist-types/commands/AddCustomAttributesCommand.d.ts +0 -3
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +1 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +12 -12
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +10 -13
- package/dist-types/commands/AdminEnableUserCommand.d.ts +1 -1
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +1 -1
- package/dist-types/commands/AdminGetUserCommand.d.ts +4 -3
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +3 -0
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +11 -12
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +1 -1
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +2 -12
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +0 -3
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +10 -7
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +20 -20
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +0 -12
- package/dist-types/commands/ChangePasswordCommand.d.ts +1 -1
- package/dist-types/commands/CompleteWebAuthnRegistrationCommand.d.ts +2 -3
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +4 -0
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +7 -10
- package/dist-types/commands/CreateGroupCommand.d.ts +1 -1
- package/dist-types/commands/CreateManagedLoginBrandingCommand.d.ts +0 -3
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +1 -3
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +4 -5
- package/dist-types/commands/CreateUserPoolCommand.d.ts +8 -10
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserPoolCommand.d.ts +7 -1
- package/dist-types/commands/DeleteWebAuthnCredentialCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +1 -1
- package/dist-types/commands/ForgetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/ForgotPasswordCommand.d.ts +6 -11
- package/dist-types/commands/GetCSVHeaderCommand.d.ts +26 -2
- package/dist-types/commands/GetDeviceCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupCommand.d.ts +23 -2
- package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +3 -1
- package/dist-types/commands/GetLogDeliveryConfigurationCommand.d.ts +22 -1
- package/dist-types/commands/GetSigningCertificateCommand.d.ts +26 -5
- package/dist-types/commands/GetUICustomizationCommand.d.ts +5 -5
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +2 -3
- package/dist-types/commands/GetUserAuthFactorsCommand.d.ts +9 -3
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/GetUserPoolMfaConfigCommand.d.ts +39 -1
- package/dist-types/commands/InitiateAuthCommand.d.ts +5 -2
- package/dist-types/commands/ListDevicesCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -1
- package/dist-types/commands/ListResourceServersCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +3 -1
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -1
- package/dist-types/commands/ListUserPoolsCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersCommand.d.ts +2 -1
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -1
- package/dist-types/commands/ListWebAuthnCredentialsCommand.d.ts +9 -2
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +5 -2
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +3 -1
- package/dist-types/commands/SetRiskConfigurationCommand.d.ts +24 -5
- package/dist-types/commands/SetUICustomizationCommand.d.ts +23 -10
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +0 -3
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +2 -1
- package/dist-types/commands/SetUserSettingsCommand.d.ts +1 -1
- package/dist-types/commands/SignUpCommand.d.ts +3 -5
- package/dist-types/commands/StartUserImportJobCommand.d.ts +3 -1
- package/dist-types/commands/StartWebAuthnRegistrationCommand.d.ts +4 -6
- package/dist-types/commands/StopUserImportJobCommand.d.ts +3 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +13 -3
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -2
- package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +4 -1
- package/dist-types/commands/UpdateManagedLoginBrandingCommand.d.ts +1 -5
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -1
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +4 -5
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +7 -4
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +8 -7
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +4 -3
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +5 -3
- package/dist-types/index.d.ts +5 -62
- package/dist-types/models/models_0.d.ts +730 -642
- package/dist-types/models/models_1.d.ts +834 -558
- package/dist-types/ts3.4/models/models_0.d.ts +9 -6
- package/dist-types/ts3.4/models/models_1.d.ts +6 -1
- package/package.json +1 -1
|
@@ -23,7 +23,6 @@ export type RecoveryOptionNameType = (typeof RecoveryOptionNameType)[keyof typeo
|
|
|
23
23
|
* sends account-recovery messages to a verified email address but falls back to an SMS
|
|
24
24
|
* message if the user has a verified phone number. The <code>admin_only</code> option
|
|
25
25
|
* prevents self-service account recovery.</p>
|
|
26
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
27
26
|
* @public
|
|
28
27
|
*/
|
|
29
28
|
export interface RecoveryOptionType {
|
|
@@ -43,7 +42,6 @@ export interface RecoveryOptionType {
|
|
|
43
42
|
* <p>The settings for user message delivery in forgot-password operations. Contains
|
|
44
43
|
* preference for email or SMS message delivery of password reset codes, or for admin-only
|
|
45
44
|
* password reset.</p>
|
|
46
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
47
45
|
* @public
|
|
48
46
|
*/
|
|
49
47
|
export interface AccountRecoverySettingType {
|
|
@@ -73,8 +71,7 @@ export type AccountTakeoverEventActionType = (typeof AccountTakeoverEventActionT
|
|
|
73
71
|
/**
|
|
74
72
|
* <p>The automated response to a risk level for adaptive authentication in full-function,
|
|
75
73
|
* or <code>ENFORCED</code>, mode. You can assign an action to each risk level that
|
|
76
|
-
*
|
|
77
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
74
|
+
* threat protection evaluates.</p>
|
|
78
75
|
* @public
|
|
79
76
|
*/
|
|
80
77
|
export interface AccountTakeoverActionType {
|
|
@@ -118,35 +115,30 @@ export interface AccountTakeoverActionType {
|
|
|
118
115
|
}
|
|
119
116
|
/**
|
|
120
117
|
* <p>A list of account-takeover actions for each level of risk that Amazon Cognito might assess with
|
|
121
|
-
*
|
|
122
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
118
|
+
* threat protection features.</p>
|
|
123
119
|
* @public
|
|
124
120
|
*/
|
|
125
121
|
export interface AccountTakeoverActionsType {
|
|
126
122
|
/**
|
|
127
|
-
* <p>The action that you assign to a low-risk assessment by
|
|
128
|
-
* features.</p>
|
|
123
|
+
* <p>The action that you assign to a low-risk assessment by threat protection.</p>
|
|
129
124
|
* @public
|
|
130
125
|
*/
|
|
131
126
|
LowAction?: AccountTakeoverActionType | undefined;
|
|
132
127
|
/**
|
|
133
|
-
* <p>The action that you assign to a medium-risk assessment by
|
|
134
|
-
* features.</p>
|
|
128
|
+
* <p>The action that you assign to a medium-risk assessment by threat protection.</p>
|
|
135
129
|
* @public
|
|
136
130
|
*/
|
|
137
131
|
MediumAction?: AccountTakeoverActionType | undefined;
|
|
138
132
|
/**
|
|
139
|
-
* <p>The action that you assign to a high-risk assessment by
|
|
140
|
-
* features.</p>
|
|
133
|
+
* <p>The action that you assign to a high-risk assessment by threat protection.</p>
|
|
141
134
|
* @public
|
|
142
135
|
*/
|
|
143
136
|
HighAction?: AccountTakeoverActionType | undefined;
|
|
144
137
|
}
|
|
145
138
|
/**
|
|
146
|
-
* <p>The template for email messages that
|
|
139
|
+
* <p>The template for email messages that threat protection sends to a user when
|
|
147
140
|
* your threat protection automated response has a <i>Notify</i>
|
|
148
141
|
* action.</p>
|
|
149
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
150
142
|
* @public
|
|
151
143
|
*/
|
|
152
144
|
export interface NotifyEmailType {
|
|
@@ -171,10 +163,9 @@ export interface NotifyEmailType {
|
|
|
171
163
|
TextBody?: string | undefined;
|
|
172
164
|
}
|
|
173
165
|
/**
|
|
174
|
-
* <p>The configuration for Amazon SES email messages that
|
|
166
|
+
* <p>The configuration for Amazon SES email messages that threat protection sends to a
|
|
175
167
|
* user when your adaptive authentication automated response has a
|
|
176
168
|
* <i>Notify</i> action.</p>
|
|
177
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
178
169
|
* @public
|
|
179
170
|
*/
|
|
180
171
|
export interface NotifyConfigurationType {
|
|
@@ -218,14 +209,12 @@ export interface NotifyConfigurationType {
|
|
|
218
209
|
}
|
|
219
210
|
/**
|
|
220
211
|
* <p>The settings for automated responses and notification templates for adaptive
|
|
221
|
-
* authentication with
|
|
222
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
212
|
+
* authentication with threat protection features.</p>
|
|
223
213
|
* @public
|
|
224
214
|
*/
|
|
225
215
|
export interface AccountTakeoverRiskConfigurationType {
|
|
226
216
|
/**
|
|
227
|
-
* <p>The settings for composing and sending an email message when
|
|
228
|
-
* features assesses a risk level with adaptive authentication. When you choose to notify
|
|
217
|
+
* <p>The settings for composing and sending an email message when threat protection assesses a risk level with adaptive authentication. When you choose to notify
|
|
229
218
|
* users in <code>AccountTakeoverRiskConfiguration</code>, Amazon Cognito sends an email message
|
|
230
219
|
* using the method and template that you set with this data type.</p>
|
|
231
220
|
* @public
|
|
@@ -233,7 +222,7 @@ export interface AccountTakeoverRiskConfigurationType {
|
|
|
233
222
|
NotifyConfiguration?: NotifyConfigurationType | undefined;
|
|
234
223
|
/**
|
|
235
224
|
* <p>A list of account-takeover actions for each level of risk that Amazon Cognito might assess with
|
|
236
|
-
*
|
|
225
|
+
* threat protection.</p>
|
|
237
226
|
* @public
|
|
238
227
|
*/
|
|
239
228
|
Actions: AccountTakeoverActionsType | undefined;
|
|
@@ -255,10 +244,6 @@ export type AttributeDataType = (typeof AttributeDataType)[keyof typeof Attribut
|
|
|
255
244
|
/**
|
|
256
245
|
* <p>The minimum and maximum values of an attribute that is of the number type, for example
|
|
257
246
|
* <code>custom:age</code>.</p>
|
|
258
|
-
* <p>This data type is part of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html">SchemaAttributeType</a>. It defines the length constraints
|
|
259
|
-
* on number-type attributes that you configure in <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and displays the length constraints of
|
|
260
|
-
* all number-type attributes in the response to <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>
|
|
261
|
-
* </p>
|
|
262
247
|
* @public
|
|
263
248
|
*/
|
|
264
249
|
export interface NumberAttributeConstraintsType {
|
|
@@ -278,10 +263,6 @@ export interface NumberAttributeConstraintsType {
|
|
|
278
263
|
/**
|
|
279
264
|
* <p>The minimum and maximum length values of an attribute that is of the string type, for
|
|
280
265
|
* example <code>custom:department</code>.</p>
|
|
281
|
-
* <p>This data type is part of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html">SchemaAttributeType</a>. It defines the length constraints
|
|
282
|
-
* on string-type attributes that you configure in <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and displays the length constraints of
|
|
283
|
-
* all string-type attributes in the response to <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>
|
|
284
|
-
* </p>
|
|
285
266
|
* @public
|
|
286
267
|
*/
|
|
287
268
|
export interface StringAttributeConstraintsType {
|
|
@@ -308,7 +289,6 @@ export interface StringAttributeConstraintsType {
|
|
|
308
289
|
* are read-only to all app clients. You can create and update developer-only attributes
|
|
309
290
|
* only with IAM-authenticated API operations. Use app client read/write permissions
|
|
310
291
|
* instead.</p>
|
|
311
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
312
292
|
* @public
|
|
313
293
|
*/
|
|
314
294
|
export interface SchemaAttributeType {
|
|
@@ -528,7 +508,7 @@ export interface AdminAddUserToGroupRequest {
|
|
|
528
508
|
*/
|
|
529
509
|
UserPoolId: string | undefined;
|
|
530
510
|
/**
|
|
531
|
-
* <p>The
|
|
511
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
532
512
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
533
513
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
534
514
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -566,7 +546,7 @@ export interface AdminConfirmSignUpRequest {
|
|
|
566
546
|
*/
|
|
567
547
|
UserPoolId: string | undefined;
|
|
568
548
|
/**
|
|
569
|
-
* <p>The
|
|
549
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
570
550
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
571
551
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
572
552
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -586,7 +566,7 @@ export interface AdminConfirmSignUpRequest {
|
|
|
586
566
|
* Lambda, you can process the ClientMetadata value to enhance your workflow for your
|
|
587
567
|
* specific needs.</p>
|
|
588
568
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
589
|
-
*
|
|
569
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
590
570
|
* <note>
|
|
591
571
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
592
572
|
* following:</p>
|
|
@@ -707,7 +687,6 @@ export declare const MessageActionType: {
|
|
|
707
687
|
export type MessageActionType = (typeof MessageActionType)[keyof typeof MessageActionType];
|
|
708
688
|
/**
|
|
709
689
|
* <p>The name and value of a user attribute.</p>
|
|
710
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a>.</p>
|
|
711
690
|
* @public
|
|
712
691
|
*/
|
|
713
692
|
export interface AttributeType {
|
|
@@ -770,28 +749,27 @@ export interface AdminCreateUserRequest {
|
|
|
770
749
|
* passwordless sign-in with an email or SMS OTP. These attributes must be provided when
|
|
771
750
|
* passwordless options are the only available, or when you don't submit a
|
|
772
751
|
* <code>TemporaryPassword</code>.</p>
|
|
773
|
-
* <p>In your
|
|
774
|
-
* <code>email_verified</code>
|
|
775
|
-
* <code>
|
|
776
|
-
*
|
|
777
|
-
*
|
|
778
|
-
* <
|
|
779
|
-
* <p>
|
|
780
|
-
*
|
|
781
|
-
*
|
|
782
|
-
* <code>
|
|
783
|
-
*
|
|
784
|
-
*
|
|
785
|
-
* </
|
|
786
|
-
* <
|
|
787
|
-
* <p>
|
|
788
|
-
*
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
* </ul>
|
|
752
|
+
* <p>In your <code>AdminCreateUser</code> request, you can set the
|
|
753
|
+
* <code>email_verified</code> and <code>phone_number_verified</code> attributes to
|
|
754
|
+
* <code>true</code>. The following conditions apply:</p>
|
|
755
|
+
* <dl>
|
|
756
|
+
* <dt>email</dt>
|
|
757
|
+
* <dd>
|
|
758
|
+
* <p>The email address where you want the user to receive their confirmation
|
|
759
|
+
* code and username. You must provide a value for the <code>email</code> when
|
|
760
|
+
* you want to set <code>email_verified</code> to <code>true</code>, or if you
|
|
761
|
+
* set <code>EMAIL</code> in the <code>DesiredDeliveryMediums</code>
|
|
762
|
+
* parameter.</p>
|
|
763
|
+
* </dd>
|
|
764
|
+
* <dt>phone_number</dt>
|
|
765
|
+
* <dd>
|
|
766
|
+
* <p>The phone number where you want the user to receive their confirmation
|
|
767
|
+
* code and username. You must provide a value for the <code>email</code> when
|
|
768
|
+
* you want to set <code>phone_number</code> to <code>true</code>, or if you
|
|
769
|
+
* set <code>SMS</code> in the <code>DesiredDeliveryMediums</code>
|
|
770
|
+
* parameter.</p>
|
|
771
|
+
* </dd>
|
|
772
|
+
* </dl>
|
|
795
773
|
* @public
|
|
796
774
|
*/
|
|
797
775
|
UserAttributes?: AttributeType[] | undefined;
|
|
@@ -800,10 +778,8 @@ export interface AdminCreateUserRequest {
|
|
|
800
778
|
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
801
779
|
* collect from your users but don't need to retain.</p>
|
|
802
780
|
* <p>Your Lambda function can analyze this additional data and act on it. Your function
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
* to Amazon Cognito, like automatically confirming the user if they sign up from within your
|
|
806
|
-
* network.</p>
|
|
781
|
+
* can automatically confirm and verify select users or perform external API operations
|
|
782
|
+
* like logging user attributes and validation data to Amazon CloudWatch Logs.</p>
|
|
807
783
|
* <p>For more information about the pre sign-up Lambda trigger, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">Pre sign-up Lambda trigger</a>.</p>
|
|
808
784
|
* @public
|
|
809
785
|
*/
|
|
@@ -814,7 +790,7 @@ export interface AdminCreateUserRequest {
|
|
|
814
790
|
* <p>The exception to the requirement for a password is when your user pool supports
|
|
815
791
|
* passwordless sign-in with email or SMS OTPs. To create a user with no password, omit
|
|
816
792
|
* this parameter or submit a blank value. You can only create a passwordless user when
|
|
817
|
-
* passwordless sign-in is available
|
|
793
|
+
* passwordless sign-in is available.</p>
|
|
818
794
|
* <p>The temporary password is valid only once. To complete the Admin Create User flow, the
|
|
819
795
|
* user must enter the temporary password in the sign-in page, along with a new password to
|
|
820
796
|
* be used in all future sign-ins.</p>
|
|
@@ -869,7 +845,7 @@ export interface AdminCreateUserRequest {
|
|
|
869
845
|
* Lambda, you can process the <code>clientMetadata</code> value to enhance your
|
|
870
846
|
* workflow for your specific needs.</p>
|
|
871
847
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
872
|
-
*
|
|
848
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
873
849
|
* <note>
|
|
874
850
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
875
851
|
* following:</p>
|
|
@@ -934,7 +910,6 @@ export declare const UserStatusType: {
|
|
|
934
910
|
export type UserStatusType = (typeof UserStatusType)[keyof typeof UserStatusType];
|
|
935
911
|
/**
|
|
936
912
|
* <p>A user profile in a Amazon Cognito user pool.</p>
|
|
937
|
-
* <p>This data type is a response parameter to <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html">AdminCreateUser</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsers.html">ListUsers</a>. </p>
|
|
938
913
|
* @public
|
|
939
914
|
*/
|
|
940
915
|
export interface UserType {
|
|
@@ -1125,22 +1100,18 @@ export interface MessageTemplateType {
|
|
|
1125
1100
|
* <p>The settings for administrator creation of users in a user pool. Contains settings for
|
|
1126
1101
|
* allowing user sign-up, customizing invitation messages to new users, and the amount of
|
|
1127
1102
|
* time before temporary passwords expire.</p>
|
|
1128
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
1129
1103
|
* @public
|
|
1130
1104
|
*/
|
|
1131
1105
|
export interface AdminCreateUserConfigType {
|
|
1132
1106
|
/**
|
|
1133
1107
|
* <p>The setting for allowing self-service sign-up. When <code>true</code>, only
|
|
1134
1108
|
* administrators can create new user profiles. When <code>false</code>, users can register
|
|
1135
|
-
* themselves and create a new user profile with the <
|
|
1109
|
+
* themselves and create a new user profile with the <code>SignUp</code> operation.</p>
|
|
1136
1110
|
* @public
|
|
1137
1111
|
*/
|
|
1138
1112
|
AllowAdminCreateUserOnly?: boolean | undefined;
|
|
1139
1113
|
/**
|
|
1140
|
-
* <p>This parameter is no longer in use
|
|
1141
|
-
* the <code>TemporaryPasswordValidityDays</code> parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_PasswordPolicyType.html">PasswordPolicyType</a>. For older user pools that have a
|
|
1142
|
-
* <code>UnusedAccountValidityDays</code> configuration, that value is effective until
|
|
1143
|
-
* you set a value for <code>TemporaryPasswordValidityDays</code>.</p>
|
|
1114
|
+
* <p>This parameter is no longer in use.</p>
|
|
1144
1115
|
* <p>The password expiration limit in days for administrator-created users. When this time
|
|
1145
1116
|
* expires, the user can't sign in with their temporary password. To reset the account
|
|
1146
1117
|
* after that time limit, you must call <code>AdminCreateUser</code> again, specifying
|
|
@@ -1169,7 +1140,7 @@ export interface AdminDeleteUserRequest {
|
|
|
1169
1140
|
*/
|
|
1170
1141
|
UserPoolId: string | undefined;
|
|
1171
1142
|
/**
|
|
1172
|
-
* <p>The
|
|
1143
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1173
1144
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1174
1145
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1175
1146
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1189,7 +1160,7 @@ export interface AdminDeleteUserAttributesRequest {
|
|
|
1189
1160
|
*/
|
|
1190
1161
|
UserPoolId: string | undefined;
|
|
1191
1162
|
/**
|
|
1192
|
-
* <p>The
|
|
1163
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1193
1164
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1194
1165
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1195
1166
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1215,7 +1186,6 @@ export interface AdminDeleteUserAttributesResponse {
|
|
|
1215
1186
|
/**
|
|
1216
1187
|
* <p>The characteristics of a source or destination user for linking a federated user
|
|
1217
1188
|
* profile to a local user profile.</p>
|
|
1218
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDisableProviderForUser.html">AdminDisableProviderForUser</a>.</p>
|
|
1219
1189
|
* @public
|
|
1220
1190
|
*/
|
|
1221
1191
|
export interface ProviderUserIdentifierType {
|
|
@@ -1284,7 +1254,7 @@ export interface AdminDisableUserRequest {
|
|
|
1284
1254
|
*/
|
|
1285
1255
|
UserPoolId: string | undefined;
|
|
1286
1256
|
/**
|
|
1287
|
-
* <p>The
|
|
1257
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1288
1258
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1289
1259
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1290
1260
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1311,7 +1281,7 @@ export interface AdminEnableUserRequest {
|
|
|
1311
1281
|
*/
|
|
1312
1282
|
UserPoolId: string | undefined;
|
|
1313
1283
|
/**
|
|
1314
|
-
* <p>The
|
|
1284
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1315
1285
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1316
1286
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1317
1287
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1338,7 +1308,7 @@ export interface AdminForgetDeviceRequest {
|
|
|
1338
1308
|
*/
|
|
1339
1309
|
UserPoolId: string | undefined;
|
|
1340
1310
|
/**
|
|
1341
|
-
* <p>The
|
|
1311
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1342
1312
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1343
1313
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1344
1314
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1347,8 +1317,7 @@ export interface AdminForgetDeviceRequest {
|
|
|
1347
1317
|
*/
|
|
1348
1318
|
Username: string | undefined;
|
|
1349
1319
|
/**
|
|
1350
|
-
* <p>The key ID of the device that you want to delete
|
|
1351
|
-
* response to an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html">AdminListDevices</a> request.</p>
|
|
1320
|
+
* <p>The key ID of the device that you want to delete.</p>
|
|
1352
1321
|
* @public
|
|
1353
1322
|
*/
|
|
1354
1323
|
DeviceKey: string | undefined;
|
|
@@ -1371,8 +1340,7 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
|
|
|
1371
1340
|
*/
|
|
1372
1341
|
export interface AdminGetDeviceRequest {
|
|
1373
1342
|
/**
|
|
1374
|
-
* <p>The key of the device that you want to delete
|
|
1375
|
-
* to an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html">AdminListDevices</a> request.</p>
|
|
1343
|
+
* <p>The key of the device that you want to delete.</p>
|
|
1376
1344
|
* @public
|
|
1377
1345
|
*/
|
|
1378
1346
|
DeviceKey: string | undefined;
|
|
@@ -1382,7 +1350,7 @@ export interface AdminGetDeviceRequest {
|
|
|
1382
1350
|
*/
|
|
1383
1351
|
UserPoolId: string | undefined;
|
|
1384
1352
|
/**
|
|
1385
|
-
* <p>The
|
|
1353
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1386
1354
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1387
1355
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1388
1356
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1394,7 +1362,6 @@ export interface AdminGetDeviceRequest {
|
|
|
1394
1362
|
/**
|
|
1395
1363
|
* <p>Information about a user's device that they've registered for device SRP
|
|
1396
1364
|
* authentication in your application. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
1397
|
-
* <p>The data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminGetDevice.html">AdminGetDevice</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html">AdminListDevices</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetDevice.html">GetDevice</a>.</p>
|
|
1398
1365
|
* @public
|
|
1399
1366
|
*/
|
|
1400
1367
|
export interface DeviceType {
|
|
@@ -1450,7 +1417,7 @@ export interface AdminGetUserRequest {
|
|
|
1450
1417
|
*/
|
|
1451
1418
|
UserPoolId: string | undefined;
|
|
1452
1419
|
/**
|
|
1453
|
-
* <p>The
|
|
1420
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1454
1421
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1455
1422
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1456
1423
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1489,8 +1456,7 @@ export interface AdminGetUserResponse {
|
|
|
1489
1456
|
*/
|
|
1490
1457
|
UserLastModifiedDate?: Date | undefined;
|
|
1491
1458
|
/**
|
|
1492
|
-
* <p>Indicates whether the user is activated for sign-in
|
|
1493
|
-
* user sign-in, respectively.</p>
|
|
1459
|
+
* <p>Indicates whether the user is activated for sign-in.</p>
|
|
1494
1460
|
* @public
|
|
1495
1461
|
*/
|
|
1496
1462
|
Enabled?: boolean | undefined;
|
|
@@ -1541,9 +1507,8 @@ export interface AdminGetUserResponse {
|
|
|
1541
1507
|
PreferredMfaSetting?: string | undefined;
|
|
1542
1508
|
/**
|
|
1543
1509
|
* <p>The MFA options that are activated for the user. The possible values in this list are
|
|
1544
|
-
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and
|
|
1545
|
-
*
|
|
1546
|
-
* with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a>.</p>
|
|
1510
|
+
* <code>SMS_MFA</code>, <code>EMAIL_OTP</code>, and
|
|
1511
|
+
* <code>SOFTWARE_TOKEN_MFA</code>.</p>
|
|
1547
1512
|
* @public
|
|
1548
1513
|
*/
|
|
1549
1514
|
UserMFASettingList?: string[] | undefined;
|
|
@@ -1554,7 +1519,6 @@ export interface AdminGetUserResponse {
|
|
|
1554
1519
|
* <p>An endpoint ID uniquely identifies a mobile device, email address or phone number that
|
|
1555
1520
|
* can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that
|
|
1556
1521
|
* can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics with Amazon Cognito user pools</a>.</p>
|
|
1557
|
-
* <p>This data type is a request parameter of authentication operations like <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
1558
1522
|
* @public
|
|
1559
1523
|
*/
|
|
1560
1524
|
export interface AnalyticsMetadataType {
|
|
@@ -1585,8 +1549,6 @@ export declare const AuthFlowType: {
|
|
|
1585
1549
|
export type AuthFlowType = (typeof AuthFlowType)[keyof typeof AuthFlowType];
|
|
1586
1550
|
/**
|
|
1587
1551
|
* <p>The HTTP header in the <code>ContextData</code> parameter.</p>
|
|
1588
|
-
* <p>This data type is a request parameter of server-side authentication operations like
|
|
1589
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
1590
1552
|
* @public
|
|
1591
1553
|
*/
|
|
1592
1554
|
export interface HttpHeader {
|
|
@@ -1604,8 +1566,6 @@ export interface HttpHeader {
|
|
|
1604
1566
|
/**
|
|
1605
1567
|
* <p>Contextual user data used for evaluating the risk of an authentication event by user
|
|
1606
1568
|
* pool threat protection.</p>
|
|
1607
|
-
* <p>This data type is a request parameter of server-side authentication operations like
|
|
1608
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
1609
1569
|
* @public
|
|
1610
1570
|
*/
|
|
1611
1571
|
export interface ContextDataType {
|
|
@@ -1654,42 +1614,17 @@ export interface AdminInitiateAuthRequest {
|
|
|
1654
1614
|
/**
|
|
1655
1615
|
* <p>The authentication flow that you want to initiate. Each <code>AuthFlow</code> has
|
|
1656
1616
|
* linked <code>AuthParameters</code> that you must submit. The following are some example
|
|
1657
|
-
* flows
|
|
1658
|
-
* <ul>
|
|
1659
|
-
* <li>
|
|
1660
|
-
* <p>
|
|
1661
|
-
* <code>USER_AUTH</code>: Request a preferred authentication type or review
|
|
1662
|
-
* available authentication types. From the offered authentication types, select
|
|
1663
|
-
* one in a challenge response and then authenticate with that method in an
|
|
1664
|
-
* additional challenge response.</p>
|
|
1665
|
-
* </li>
|
|
1666
|
-
* <li>
|
|
1667
|
-
* <p>
|
|
1668
|
-
* <code>REFRESH_TOKEN_AUTH</code>: Receive new ID and access tokens when you
|
|
1669
|
-
* pass a <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
|
|
1670
|
-
* value.</p>
|
|
1671
|
-
* </li>
|
|
1672
|
-
* <li>
|
|
1673
|
-
* <p>
|
|
1674
|
-
* <code>USER_SRP_AUTH</code>: Receive secure remote password (SRP) variables for
|
|
1675
|
-
* the next challenge, <code>PASSWORD_VERIFIER</code>, when you pass
|
|
1676
|
-
* <code>USERNAME</code> and <code>SRP_A</code> parameters..</p>
|
|
1677
|
-
* </li>
|
|
1678
|
-
* <li>
|
|
1679
|
-
* <p>
|
|
1680
|
-
* <code>ADMIN_USER_PASSWORD_AUTH</code>: Receive new tokens or the next
|
|
1681
|
-
* challenge, for example <code>SOFTWARE_TOKEN_MFA</code>, when you pass
|
|
1682
|
-
* <code>USERNAME</code> and <code>PASSWORD</code> parameters.</p>
|
|
1683
|
-
* </li>
|
|
1684
|
-
* </ul>
|
|
1685
|
-
* <p>
|
|
1686
|
-
* <i>All flows</i>
|
|
1687
|
-
* </p>
|
|
1617
|
+
* flows.</p>
|
|
1688
1618
|
* <dl>
|
|
1689
1619
|
* <dt>USER_AUTH</dt>
|
|
1690
1620
|
* <dd>
|
|
1691
|
-
* <p>The entry point for
|
|
1692
|
-
*
|
|
1621
|
+
* <p>The entry point for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a> with passwords,
|
|
1622
|
+
* one-time passwords, and WebAuthn authenticators. Request a preferred
|
|
1623
|
+
* authentication type or review available authentication types. From the
|
|
1624
|
+
* offered authentication types, select one in a challenge response and then
|
|
1625
|
+
* authenticate with that method in an additional challenge response.
|
|
1626
|
+
* To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
1627
|
+
* Essentials tier</a> or higher.</p>
|
|
1693
1628
|
* </dd>
|
|
1694
1629
|
* <dt>USER_SRP_AUTH</dt>
|
|
1695
1630
|
* <dd>
|
|
@@ -1699,8 +1634,9 @@ export interface AdminInitiateAuthRequest {
|
|
|
1699
1634
|
* </dd>
|
|
1700
1635
|
* <dt>REFRESH_TOKEN_AUTH and REFRESH_TOKEN</dt>
|
|
1701
1636
|
* <dd>
|
|
1702
|
-
* <p>
|
|
1703
|
-
*
|
|
1637
|
+
* <p>Receive new ID and access tokens when you pass a
|
|
1638
|
+
* <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
|
|
1639
|
+
* value. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html">Using the refresh token</a>.</p>
|
|
1704
1640
|
* </dd>
|
|
1705
1641
|
* <dt>CUSTOM_AUTH</dt>
|
|
1706
1642
|
* <dd>
|
|
@@ -1710,20 +1646,18 @@ export interface AdminInitiateAuthRequest {
|
|
|
1710
1646
|
* </dd>
|
|
1711
1647
|
* <dt>ADMIN_USER_PASSWORD_AUTH</dt>
|
|
1712
1648
|
* <dd>
|
|
1713
|
-
* <p>
|
|
1714
|
-
* request. For more information
|
|
1649
|
+
* <p>Server-side username-password authentication with the password sent
|
|
1650
|
+
* directly in the request. For more information about client-side and
|
|
1651
|
+
* server-side authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-public-server-side.html">SDK authorization models</a>.</p>
|
|
1715
1652
|
* </dd>
|
|
1716
1653
|
* </dl>
|
|
1717
|
-
* <p>
|
|
1718
|
-
* <code>USER_PASSWORD_AUTH</code> is a flow type of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a> and isn't valid for
|
|
1719
|
-
* AdminInitiateAuth.</p>
|
|
1720
1654
|
* @public
|
|
1721
1655
|
*/
|
|
1722
1656
|
AuthFlow: AuthFlowType | undefined;
|
|
1723
1657
|
/**
|
|
1724
1658
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|
1725
1659
|
* <code>AuthFlow</code> that you're invoking. The required values depend on the value
|
|
1726
|
-
* of <code>AuthFlow</code
|
|
1660
|
+
* of <code>AuthFlow</code> for example:</p>
|
|
1727
1661
|
* <ul>
|
|
1728
1662
|
* <li>
|
|
1729
1663
|
* <p>For <code>USER_AUTH</code>: <code>USERNAME</code> (required),
|
|
@@ -1810,7 +1744,7 @@ export interface AdminInitiateAuthRequest {
|
|
|
1810
1744
|
* </li>
|
|
1811
1745
|
* </ul>
|
|
1812
1746
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
1813
|
-
*
|
|
1747
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1814
1748
|
* <note>
|
|
1815
1749
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1816
1750
|
* following:</p>
|
|
@@ -1834,13 +1768,15 @@ export interface AdminInitiateAuthRequest {
|
|
|
1834
1768
|
*/
|
|
1835
1769
|
ClientMetadata?: Record<string, string> | undefined;
|
|
1836
1770
|
/**
|
|
1837
|
-
* <p>
|
|
1771
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
1772
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
1773
|
+
* email address, or phone number.</p>
|
|
1838
1774
|
* @public
|
|
1839
1775
|
*/
|
|
1840
1776
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
1841
1777
|
/**
|
|
1842
|
-
* <p>Contextual data about your user session
|
|
1843
|
-
*
|
|
1778
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
1779
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1844
1780
|
* when it makes API requests.</p>
|
|
1845
1781
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
1846
1782
|
* applications</a>.</p>
|
|
@@ -1862,7 +1798,6 @@ export interface AdminInitiateAuthRequest {
|
|
|
1862
1798
|
* you configure it to remember devices and a user signs in with an unrecognized device.
|
|
1863
1799
|
* Amazon Cognito presents a new device key that you can use to set up <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">device authentication</a> in a "Remember me on this device"
|
|
1864
1800
|
* authentication model.</p>
|
|
1865
|
-
* <p>This data type is a response parameter of authentication operations like <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
1866
1801
|
* @public
|
|
1867
1802
|
*/
|
|
1868
1803
|
export interface NewDeviceMetadataType {
|
|
@@ -1882,7 +1817,6 @@ export interface NewDeviceMetadataType {
|
|
|
1882
1817
|
/**
|
|
1883
1818
|
* <p>The object that your application receives after authentication. Contains tokens and
|
|
1884
1819
|
* information for device authentication.</p>
|
|
1885
|
-
* <p>This data type is a response parameter of authentication operations like <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
1886
1820
|
* @public
|
|
1887
1821
|
*/
|
|
1888
1822
|
export interface AuthenticationResultType {
|
|
@@ -1952,12 +1886,17 @@ export interface AdminInitiateAuthResponse {
|
|
|
1952
1886
|
* <p>The name of the challenge that you're responding to with this call. This is returned
|
|
1953
1887
|
* in the <code>AdminInitiateAuth</code> response if you must pass another
|
|
1954
1888
|
* challenge.</p>
|
|
1889
|
+
* <p>Possible challenges include the following:</p>
|
|
1890
|
+
* <note>
|
|
1891
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
1892
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
1893
|
+
* </note>
|
|
1955
1894
|
* <ul>
|
|
1956
1895
|
* <li>
|
|
1957
1896
|
* <p>
|
|
1958
1897
|
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
1959
|
-
* successful authentication with a
|
|
1960
|
-
*
|
|
1898
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
1899
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
1961
1900
|
* </li>
|
|
1962
1901
|
* <li>
|
|
1963
1902
|
* <p>
|
|
@@ -1982,93 +1921,74 @@ export interface AdminInitiateAuthResponse {
|
|
|
1982
1921
|
* </li>
|
|
1983
1922
|
* <li>
|
|
1984
1923
|
* <p>
|
|
1985
|
-
* <code>
|
|
1986
|
-
*
|
|
1987
|
-
* challenge. The user must set up at least one MFA type to continue to
|
|
1988
|
-
* authenticate.</p>
|
|
1989
|
-
* </li>
|
|
1990
|
-
* <li>
|
|
1991
|
-
* <p>
|
|
1992
|
-
* <code>SELECT_MFA_TYPE</code>: Selects the MFA type. Valid MFA options are
|
|
1993
|
-
* <code>SMS_MFA</code> for SMS message MFA, <code>EMAIL_OTP</code> for email
|
|
1994
|
-
* message MFA, and <code>SOFTWARE_TOKEN_MFA</code> for time-based one-time
|
|
1995
|
-
* password (TOTP) software token MFA.</p>
|
|
1996
|
-
* </li>
|
|
1997
|
-
* <li>
|
|
1998
|
-
* <p>
|
|
1999
|
-
* <code>SMS_MFA</code>: Next challenge is to supply an
|
|
2000
|
-
* <code>SMS_MFA_CODE</code>that your user pool delivered in an SMS message.</p>
|
|
1924
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
1925
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
2001
1926
|
* </li>
|
|
2002
1927
|
* <li>
|
|
2003
1928
|
* <p>
|
|
2004
|
-
* <code>EMAIL_OTP</code>:
|
|
1929
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
2005
1930
|
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
2006
1931
|
* message.</p>
|
|
2007
1932
|
* </li>
|
|
2008
1933
|
* <li>
|
|
2009
1934
|
* <p>
|
|
2010
|
-
* <code>PASSWORD_VERIFIER</code>:
|
|
1935
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
2011
1936
|
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
2012
1937
|
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
2013
|
-
*
|
|
1938
|
+
* client-side SRP calculations.</p>
|
|
2014
1939
|
* </li>
|
|
2015
1940
|
* <li>
|
|
2016
1941
|
* <p>
|
|
2017
1942
|
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
2018
1943
|
* flow determines that the user should pass another challenge before tokens are
|
|
2019
|
-
* issued.</p>
|
|
1944
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
2020
1945
|
* </li>
|
|
2021
1946
|
* <li>
|
|
2022
1947
|
* <p>
|
|
2023
|
-
* <code>DEVICE_SRP_AUTH</code>:
|
|
2024
|
-
*
|
|
2025
|
-
* Amazon Cognito can start tracking this device.</p>
|
|
1948
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
1949
|
+
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2026
1950
|
* </li>
|
|
2027
1951
|
* <li>
|
|
2028
1952
|
* <p>
|
|
2029
|
-
* <code>DEVICE_PASSWORD_VERIFIER</code>:
|
|
2030
|
-
* <code>
|
|
2031
|
-
*
|
|
2032
|
-
*
|
|
2033
|
-
* <p>
|
|
2034
|
-
* <code>ADMIN_NO_SRP_AUTH</code>: This is returned if you must authenticate with
|
|
2035
|
-
* <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must
|
|
2036
|
-
* be enabled to use this flow.</p>
|
|
1953
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
1954
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1955
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1956
|
+
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2037
1957
|
* </li>
|
|
2038
1958
|
* <li>
|
|
2039
1959
|
* <p>
|
|
2040
1960
|
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
2041
1961
|
* passwords after successful first login. Respond to this challenge with
|
|
2042
|
-
*
|
|
1962
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
2043
1963
|
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
2044
|
-
* attributes that aren't required by your user pool and that your app client
|
|
2045
|
-
* write
|
|
1964
|
+
* attributes that aren't required by your user pool and that your app client
|
|
1965
|
+
* can write.</p>
|
|
2046
1966
|
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
2047
|
-
*
|
|
2048
|
-
*
|
|
2049
|
-
* required-attribute values for all users who don't have passwords. You can create
|
|
2050
|
-
* a user in the Amazon Cognito console without, for example, a required
|
|
2051
|
-
* <code>birthdate</code> attribute. The API response from Amazon Cognito won't prompt
|
|
2052
|
-
* you to submit a birthdate for the user if they don't have a password.</p>
|
|
1967
|
+
* When you create passwordless users, you must provide values for all required
|
|
1968
|
+
* attributes.</p>
|
|
2053
1969
|
* <note>
|
|
2054
1970
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2055
|
-
* In <code>AdminRespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
2056
|
-
* then use the <code>AdminUpdateUserAttributes</code>
|
|
1971
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1972
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
1973
|
+
* operation to modify the value of any additional attributes.</p>
|
|
2057
1974
|
* </note>
|
|
2058
1975
|
* </li>
|
|
2059
1976
|
* <li>
|
|
2060
1977
|
* <p>
|
|
2061
|
-
* <code>MFA_SETUP</code>: For users who are required to
|
|
1978
|
+
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
2062
1979
|
* before they can sign in. The MFA types activated for the user pool will be
|
|
2063
1980
|
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
2064
|
-
* <p>
|
|
2065
|
-
*
|
|
2066
|
-
* <code>AssociateSoftwareToken</code
|
|
2067
|
-
*
|
|
2068
|
-
*
|
|
2069
|
-
*
|
|
2070
|
-
*
|
|
2071
|
-
*
|
|
1981
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
1982
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
1983
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
1984
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
1985
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
1986
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
1987
|
+
* </p>
|
|
1988
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
1989
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
1990
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
1991
|
+
* </p>
|
|
2072
1992
|
* </li>
|
|
2073
1993
|
* </ul>
|
|
2074
1994
|
* @public
|
|
@@ -2077,24 +1997,25 @@ export interface AdminInitiateAuthResponse {
|
|
|
2077
1997
|
/**
|
|
2078
1998
|
* <p>The session that must be passed to challenge-response requests. If an
|
|
2079
1999
|
* <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code> API
|
|
2080
|
-
* request
|
|
2081
|
-
*
|
|
2082
|
-
*
|
|
2000
|
+
* request results in another authentication challenge, Amazon Cognito returns a session ID and the
|
|
2001
|
+
* parameters of the next challenge. Pass this session ID in the <code>Session</code>
|
|
2002
|
+
* parameter of <code>AdminRespondToAuthChallenge</code>.</p>
|
|
2083
2003
|
* @public
|
|
2084
2004
|
*/
|
|
2085
2005
|
Session?: string | undefined;
|
|
2086
2006
|
/**
|
|
2087
|
-
* <p>The challenge
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2090
|
-
*
|
|
2091
|
-
*
|
|
2092
|
-
*
|
|
2093
|
-
*
|
|
2094
|
-
*
|
|
2095
|
-
*
|
|
2096
|
-
*
|
|
2097
|
-
*
|
|
2007
|
+
* <p>The parameters of an authentication challenge. Amazon Cognito returns challenge parameters as a
|
|
2008
|
+
* guide to the responses your user or application must provide for the returned
|
|
2009
|
+
* <code>ChallengeName</code>. Calculate responses to the challenge parameters and pass
|
|
2010
|
+
* them in the <code>ChallengeParameters</code> of
|
|
2011
|
+
* <code>AdminRespondToAuthChallenge</code>.</p>
|
|
2012
|
+
* <p>All challenges require <code>USERNAME</code> and, when the app client has a client
|
|
2013
|
+
* secret, <code>SECRET_HASH</code>.</p>
|
|
2014
|
+
* <p>In SRP challenges, Amazon Cognito returns the <code>username</code> attribute in
|
|
2015
|
+
* <code>USER_ID_FOR_SRP</code> instead of any email address, preferred username, or
|
|
2016
|
+
* phone number alias that you might have specified in your <code>AdminInitiateAuth</code>
|
|
2017
|
+
* request. You must use the username and not an alias in the
|
|
2018
|
+
* <code>ChallengeResponses</code> of your challenge response.</p>
|
|
2098
2019
|
* @public
|
|
2099
2020
|
*/
|
|
2100
2021
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
@@ -2106,6 +2027,14 @@ export interface AdminInitiateAuthResponse {
|
|
|
2106
2027
|
* @public
|
|
2107
2028
|
*/
|
|
2108
2029
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
2030
|
+
/**
|
|
2031
|
+
* <p>This response parameter lists the available authentication challenges that users can
|
|
2032
|
+
* select from in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>. For example, they might be
|
|
2033
|
+
* able to choose between passkey authentication, a one-time password from an SMS message,
|
|
2034
|
+
* and a traditional password.</p>
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
AvailableChallenges?: ChallengeNameType[] | undefined;
|
|
2109
2038
|
}
|
|
2110
2039
|
/**
|
|
2111
2040
|
* <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
|
|
@@ -2240,7 +2169,7 @@ export interface AdminListDevicesRequest {
|
|
|
2240
2169
|
*/
|
|
2241
2170
|
UserPoolId: string | undefined;
|
|
2242
2171
|
/**
|
|
2243
|
-
* <p>The
|
|
2172
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2244
2173
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2245
2174
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2246
2175
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2287,7 +2216,7 @@ export interface AdminListDevicesResponse {
|
|
|
2287
2216
|
*/
|
|
2288
2217
|
export interface AdminListGroupsForUserRequest {
|
|
2289
2218
|
/**
|
|
2290
|
-
* <p>The
|
|
2219
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2291
2220
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2292
2221
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2293
2222
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2320,7 +2249,6 @@ export interface AdminListGroupsForUserRequest {
|
|
|
2320
2249
|
* IAM role decisions with identity pools. Identity pools can make decisions about the
|
|
2321
2250
|
* IAM role to assign based on groups: users get credentials for the role associated with
|
|
2322
2251
|
* their highest-priority group.</p>
|
|
2323
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListGroupsForUser.html">AdminListGroupsForUser</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetGroup.html">GetGroup</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListGroups.html">ListGroups</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateGroup.html">UpdateGroup</a>.</p>
|
|
2324
2252
|
* @public
|
|
2325
2253
|
*/
|
|
2326
2254
|
export interface GroupType {
|
|
@@ -2404,7 +2332,7 @@ export interface AdminListUserAuthEventsRequest {
|
|
|
2404
2332
|
*/
|
|
2405
2333
|
UserPoolId: string | undefined;
|
|
2406
2334
|
/**
|
|
2407
|
-
* <p>The
|
|
2335
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2408
2336
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2409
2337
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2410
2338
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2482,7 +2410,7 @@ export type ChallengeResponse = (typeof ChallengeResponse)[keyof typeof Challeng
|
|
|
2482
2410
|
* "USERNAME": "[username]",
|
|
2483
2411
|
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
|
|
2484
2412
|
* </p>
|
|
2485
|
-
* <p>See <a href="https://www.w3.org/TR/
|
|
2413
|
+
* <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
|
|
2486
2414
|
* AuthenticationResponseJSON</a>.</p>
|
|
2487
2415
|
* </li>
|
|
2488
2416
|
* <li>
|
|
@@ -2581,8 +2509,9 @@ export type ChallengeResponse = (typeof ChallengeResponse)[keyof typeof Challeng
|
|
|
2581
2509
|
* required by your user pool.</p>
|
|
2582
2510
|
* <note>
|
|
2583
2511
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2584
|
-
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
2585
|
-
* then use the <code>UpdateUserAttributes</code> API
|
|
2512
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
2513
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
2514
|
+
* operation to modify the value of any additional attributes.</p>
|
|
2586
2515
|
* </note>
|
|
2587
2516
|
* </dd>
|
|
2588
2517
|
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
@@ -2628,7 +2557,6 @@ export type ChallengeResponse = (typeof ChallengeResponse)[keyof typeof Challeng
|
|
|
2628
2557
|
* </dl>
|
|
2629
2558
|
* <p>For more information about <code>SECRET_HASH</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash">Computing secret hash values</a>. For information about
|
|
2630
2559
|
* <code>DEVICE_KEY</code>, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with user devices in your user pool</a>.</p>
|
|
2631
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html">AdminRespondToAuthChallenge</a>.</p>
|
|
2632
2560
|
* @public
|
|
2633
2561
|
*/
|
|
2634
2562
|
export interface ChallengeResponseType {
|
|
@@ -2646,7 +2574,8 @@ export interface ChallengeResponseType {
|
|
|
2646
2574
|
}
|
|
2647
2575
|
/**
|
|
2648
2576
|
* <p>The context data that your application submitted in an authentication request with
|
|
2649
|
-
*
|
|
2577
|
+
* threat protection, as displayed in an <code>AdminListUserAuthEvents</code>
|
|
2578
|
+
* response.</p>
|
|
2650
2579
|
* @public
|
|
2651
2580
|
*/
|
|
2652
2581
|
export interface EventContextDataType {
|
|
@@ -2689,13 +2618,13 @@ export declare const FeedbackValueType: {
|
|
|
2689
2618
|
*/
|
|
2690
2619
|
export type FeedbackValueType = (typeof FeedbackValueType)[keyof typeof FeedbackValueType];
|
|
2691
2620
|
/**
|
|
2692
|
-
* <p>The feedback that your application submitted to
|
|
2693
|
-
* log, as displayed in an <
|
|
2621
|
+
* <p>The feedback that your application submitted to a threat protection event
|
|
2622
|
+
* log, as displayed in an <code>AdminListUserAuthEvents</code> response.</p>
|
|
2694
2623
|
* @public
|
|
2695
2624
|
*/
|
|
2696
2625
|
export interface EventFeedbackType {
|
|
2697
2626
|
/**
|
|
2698
|
-
* <p>
|
|
2627
|
+
* <p>Your feedback to the authentication event. When you provide a <code>FeedbackValue</code>
|
|
2699
2628
|
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2700
2629
|
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2701
2630
|
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
@@ -2755,9 +2684,10 @@ export declare const RiskLevelType: {
|
|
|
2755
2684
|
*/
|
|
2756
2685
|
export type RiskLevelType = (typeof RiskLevelType)[keyof typeof RiskLevelType];
|
|
2757
2686
|
/**
|
|
2758
|
-
* <p>The risk evaluation by adaptive authentication, as displayed in an
|
|
2759
|
-
*
|
|
2760
|
-
* adaptive
|
|
2687
|
+
* <p>The risk evaluation by adaptive authentication, as displayed in an
|
|
2688
|
+
* <code>AdminListUserAuthEvents</code> response. Contains evaluations of
|
|
2689
|
+
* compromised-credentials detection and assessed risk level and action taken by adaptive
|
|
2690
|
+
* authentication.</p>
|
|
2761
2691
|
* @public
|
|
2762
2692
|
*/
|
|
2763
2693
|
export interface EventRiskType {
|
|
@@ -2798,10 +2728,8 @@ export declare const EventType: {
|
|
|
2798
2728
|
*/
|
|
2799
2729
|
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
2800
2730
|
/**
|
|
2801
|
-
* <p>One authentication event that Amazon Cognito logged in a user pool with
|
|
2802
|
-
* features active. Contains user and device metadata and a risk assessment from your user
|
|
2731
|
+
* <p>One authentication event that Amazon Cognito logged in a user pool with threat protection active. Contains user and device metadata and a risk assessment from your user
|
|
2803
2732
|
* pool.</p>
|
|
2804
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html">AdminListUserAuthEvents</a>.</p>
|
|
2805
2733
|
* @public
|
|
2806
2734
|
*/
|
|
2807
2735
|
export interface AuthEventType {
|
|
@@ -2846,12 +2774,12 @@ export interface AuthEventType {
|
|
|
2846
2774
|
*/
|
|
2847
2775
|
EventContextData?: EventContextDataType | undefined;
|
|
2848
2776
|
/**
|
|
2849
|
-
* <p>The <
|
|
2850
|
-
* user provided in response to the event. A value of
|
|
2851
|
-
*
|
|
2852
|
-
* to be valid, or likely safe. A value of
|
|
2853
|
-
*
|
|
2854
|
-
* malicious.</p>
|
|
2777
|
+
* <p>The <code>UpdateAuthEventFeedback</code> or <code>AdminUpdateAuthEventFeedback</code>
|
|
2778
|
+
* feedback that you or your user provided in response to the event. A value of
|
|
2779
|
+
* <code>Valid</code> indicates that you disagreed with the level of risk that your
|
|
2780
|
+
* user pool assigned, and evaluated a session to be valid, or likely safe. A value of
|
|
2781
|
+
* <code>Invalid</code> indicates that you agreed with the user pool risk level and
|
|
2782
|
+
* evaluated a session to be invalid, or likely malicious.</p>
|
|
2855
2783
|
* @public
|
|
2856
2784
|
*/
|
|
2857
2785
|
EventFeedback?: EventFeedbackType | undefined;
|
|
@@ -2898,7 +2826,7 @@ export interface AdminRemoveUserFromGroupRequest {
|
|
|
2898
2826
|
*/
|
|
2899
2827
|
UserPoolId: string | undefined;
|
|
2900
2828
|
/**
|
|
2901
|
-
* <p>The
|
|
2829
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2902
2830
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2903
2831
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2904
2832
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2924,7 +2852,7 @@ export interface AdminResetUserPasswordRequest {
|
|
|
2924
2852
|
*/
|
|
2925
2853
|
UserPoolId: string | undefined;
|
|
2926
2854
|
/**
|
|
2927
|
-
* <p>The
|
|
2855
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2928
2856
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2929
2857
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2930
2858
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2944,7 +2872,7 @@ export interface AdminResetUserPasswordRequest {
|
|
|
2944
2872
|
* your function code in Lambda, you can process the
|
|
2945
2873
|
* <code>clientMetadata</code> value to enhance your workflow for your specific needs. </p>
|
|
2946
2874
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
2947
|
-
*
|
|
2875
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
2948
2876
|
* <note>
|
|
2949
2877
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
2950
2878
|
* following:</p>
|
|
@@ -2992,8 +2920,112 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
2992
2920
|
*/
|
|
2993
2921
|
ClientId: string | undefined;
|
|
2994
2922
|
/**
|
|
2995
|
-
* <p>The name of the challenge that you are responding to
|
|
2996
|
-
*
|
|
2923
|
+
* <p>The name of the challenge that you are responding to.</p>
|
|
2924
|
+
* <p>Possible challenges include the following:</p>
|
|
2925
|
+
* <note>
|
|
2926
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
2927
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
2928
|
+
* </note>
|
|
2929
|
+
* <ul>
|
|
2930
|
+
* <li>
|
|
2931
|
+
* <p>
|
|
2932
|
+
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
2933
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
2934
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
2935
|
+
* </li>
|
|
2936
|
+
* <li>
|
|
2937
|
+
* <p>
|
|
2938
|
+
* <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
|
|
2939
|
+
* parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
|
|
2940
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
2941
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
2942
|
+
* </li>
|
|
2943
|
+
* <li>
|
|
2944
|
+
* <p>
|
|
2945
|
+
* <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
|
|
2946
|
+
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|
2947
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
2948
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
2949
|
+
* </li>
|
|
2950
|
+
* <li>
|
|
2951
|
+
* <p>
|
|
2952
|
+
* <code>SELECT_CHALLENGE</code>: Respond to the challenge with
|
|
2953
|
+
* <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
|
|
2954
|
+
* challenge types in the <code>AvailableChallenges</code> response
|
|
2955
|
+
* parameter.</p>
|
|
2956
|
+
* </li>
|
|
2957
|
+
* <li>
|
|
2958
|
+
* <p>
|
|
2959
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
2960
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
2961
|
+
* </li>
|
|
2962
|
+
* <li>
|
|
2963
|
+
* <p>
|
|
2964
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
2965
|
+
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
2966
|
+
* message.</p>
|
|
2967
|
+
* </li>
|
|
2968
|
+
* <li>
|
|
2969
|
+
* <p>
|
|
2970
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
2971
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
2972
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
2973
|
+
* client-side SRP calculations.</p>
|
|
2974
|
+
* </li>
|
|
2975
|
+
* <li>
|
|
2976
|
+
* <p>
|
|
2977
|
+
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
2978
|
+
* flow determines that the user should pass another challenge before tokens are
|
|
2979
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
2980
|
+
* </li>
|
|
2981
|
+
* <li>
|
|
2982
|
+
* <p>
|
|
2983
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
2984
|
+
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2985
|
+
* </li>
|
|
2986
|
+
* <li>
|
|
2987
|
+
* <p>
|
|
2988
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
2989
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
2990
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
2991
|
+
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
2992
|
+
* </li>
|
|
2993
|
+
* <li>
|
|
2994
|
+
* <p>
|
|
2995
|
+
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
2996
|
+
* passwords after successful first login. Respond to this challenge with
|
|
2997
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
2998
|
+
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
2999
|
+
* attributes that aren't required by your user pool and that your app client
|
|
3000
|
+
* can write.</p>
|
|
3001
|
+
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
3002
|
+
* When you create passwordless users, you must provide values for all required
|
|
3003
|
+
* attributes.</p>
|
|
3004
|
+
* <note>
|
|
3005
|
+
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
3006
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
3007
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
3008
|
+
* operation to modify the value of any additional attributes.</p>
|
|
3009
|
+
* </note>
|
|
3010
|
+
* </li>
|
|
3011
|
+
* <li>
|
|
3012
|
+
* <p>
|
|
3013
|
+
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
3014
|
+
* before they can sign in. The MFA types activated for the user pool will be
|
|
3015
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
3016
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
3017
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
3018
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
3019
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
3020
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
3021
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
3022
|
+
* </p>
|
|
3023
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
3024
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
3025
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
3026
|
+
* </p>
|
|
3027
|
+
* </li>
|
|
3028
|
+
* </ul>
|
|
2997
3029
|
* @public
|
|
2998
3030
|
*/
|
|
2999
3031
|
ChallengeName: ChallengeNameType | undefined;
|
|
@@ -3026,7 +3058,7 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3026
3058
|
* "USERNAME": "[username]",
|
|
3027
3059
|
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
|
|
3028
3060
|
* </p>
|
|
3029
|
-
* <p>See <a href="https://www.w3.org/TR/
|
|
3061
|
+
* <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
|
|
3030
3062
|
* AuthenticationResponseJSON</a>.</p>
|
|
3031
3063
|
* </li>
|
|
3032
3064
|
* <li>
|
|
@@ -3125,8 +3157,9 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3125
3157
|
* required by your user pool.</p>
|
|
3126
3158
|
* <note>
|
|
3127
3159
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
3128
|
-
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
3129
|
-
* then use the <code>UpdateUserAttributes</code> API
|
|
3160
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
3161
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
3162
|
+
* operation to modify the value of any additional attributes.</p>
|
|
3130
3163
|
* </note>
|
|
3131
3164
|
* </dd>
|
|
3132
3165
|
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
@@ -3186,14 +3219,15 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3186
3219
|
*/
|
|
3187
3220
|
Session?: string | undefined;
|
|
3188
3221
|
/**
|
|
3189
|
-
* <p>
|
|
3190
|
-
*
|
|
3222
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
3223
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
3224
|
+
* email address, or phone number.</p>
|
|
3191
3225
|
* @public
|
|
3192
3226
|
*/
|
|
3193
3227
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
3194
3228
|
/**
|
|
3195
|
-
* <p>Contextual data about your user session
|
|
3196
|
-
*
|
|
3229
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
3230
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
3197
3231
|
* when it makes API requests.</p>
|
|
3198
3232
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
3199
3233
|
* applications</a>.</p>
|
|
@@ -3239,7 +3273,7 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3239
3273
|
* process the <code>clientMetadata</code> value to enhance your workflow for your specific
|
|
3240
3274
|
* needs.</p>
|
|
3241
3275
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
3242
|
-
*
|
|
3276
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
3243
3277
|
* <note>
|
|
3244
3278
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
3245
3279
|
* following:</p>
|
|
@@ -3269,8 +3303,112 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
3269
3303
|
*/
|
|
3270
3304
|
export interface AdminRespondToAuthChallengeResponse {
|
|
3271
3305
|
/**
|
|
3272
|
-
* <p>The name of the challenge that you must
|
|
3273
|
-
*
|
|
3306
|
+
* <p>The name of the next challenge that you must respond to.</p>
|
|
3307
|
+
* <p>Possible challenges include the following:</p>
|
|
3308
|
+
* <note>
|
|
3309
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
3310
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
3311
|
+
* </note>
|
|
3312
|
+
* <ul>
|
|
3313
|
+
* <li>
|
|
3314
|
+
* <p>
|
|
3315
|
+
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
3316
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
3317
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
3318
|
+
* </li>
|
|
3319
|
+
* <li>
|
|
3320
|
+
* <p>
|
|
3321
|
+
* <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
|
|
3322
|
+
* parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
|
|
3323
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
3324
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
3325
|
+
* </li>
|
|
3326
|
+
* <li>
|
|
3327
|
+
* <p>
|
|
3328
|
+
* <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
|
|
3329
|
+
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|
3330
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
3331
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
3332
|
+
* </li>
|
|
3333
|
+
* <li>
|
|
3334
|
+
* <p>
|
|
3335
|
+
* <code>SELECT_CHALLENGE</code>: Respond to the challenge with
|
|
3336
|
+
* <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
|
|
3337
|
+
* challenge types in the <code>AvailableChallenges</code> response
|
|
3338
|
+
* parameter.</p>
|
|
3339
|
+
* </li>
|
|
3340
|
+
* <li>
|
|
3341
|
+
* <p>
|
|
3342
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
3343
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
3344
|
+
* </li>
|
|
3345
|
+
* <li>
|
|
3346
|
+
* <p>
|
|
3347
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
3348
|
+
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
3349
|
+
* message.</p>
|
|
3350
|
+
* </li>
|
|
3351
|
+
* <li>
|
|
3352
|
+
* <p>
|
|
3353
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
3354
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
3355
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
3356
|
+
* client-side SRP calculations.</p>
|
|
3357
|
+
* </li>
|
|
3358
|
+
* <li>
|
|
3359
|
+
* <p>
|
|
3360
|
+
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
3361
|
+
* flow determines that the user should pass another challenge before tokens are
|
|
3362
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
3363
|
+
* </li>
|
|
3364
|
+
* <li>
|
|
3365
|
+
* <p>
|
|
3366
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
3367
|
+
* authentication. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
3368
|
+
* </li>
|
|
3369
|
+
* <li>
|
|
3370
|
+
* <p>
|
|
3371
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
3372
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
3373
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
3374
|
+
* client-side SRP calculations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-signing-in-with-a-device">Signing in with a device</a>.</p>
|
|
3375
|
+
* </li>
|
|
3376
|
+
* <li>
|
|
3377
|
+
* <p>
|
|
3378
|
+
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
3379
|
+
* passwords after successful first login. Respond to this challenge with
|
|
3380
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
3381
|
+
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
3382
|
+
* attributes that aren't required by your user pool and that your app client
|
|
3383
|
+
* can write.</p>
|
|
3384
|
+
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
3385
|
+
* When you create passwordless users, you must provide values for all required
|
|
3386
|
+
* attributes.</p>
|
|
3387
|
+
* <note>
|
|
3388
|
+
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
3389
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
3390
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
3391
|
+
* operation to modify the value of any additional attributes.</p>
|
|
3392
|
+
* </note>
|
|
3393
|
+
* </li>
|
|
3394
|
+
* <li>
|
|
3395
|
+
* <p>
|
|
3396
|
+
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
3397
|
+
* before they can sign in. The MFA types activated for the user pool will be
|
|
3398
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
3399
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
3400
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
3401
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
3402
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
3403
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
3404
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
3405
|
+
* </p>
|
|
3406
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
3407
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
3408
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
3409
|
+
* </p>
|
|
3410
|
+
* </li>
|
|
3411
|
+
* </ul>
|
|
3274
3412
|
* @public
|
|
3275
3413
|
*/
|
|
3276
3414
|
ChallengeName?: ChallengeNameType | undefined;
|
|
@@ -3285,9 +3423,7 @@ export interface AdminRespondToAuthChallengeResponse {
|
|
|
3285
3423
|
*/
|
|
3286
3424
|
Session?: string | undefined;
|
|
3287
3425
|
/**
|
|
3288
|
-
* <p>The parameters that define your response to the next challenge
|
|
3289
|
-
* <code>ChallengeParameters</code> and provide values for them in the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html#CognitoUserPools-AdminRespondToAuthChallenge-request-ChallengeResponses">ChallengeResponses</a> of the next <code>AdminRespondToAuthChallenge</code>
|
|
3290
|
-
* request.</p>
|
|
3426
|
+
* <p>The parameters that define your response to the next challenge.</p>
|
|
3291
3427
|
* @public
|
|
3292
3428
|
*/
|
|
3293
3429
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
@@ -3353,9 +3489,8 @@ export declare class SoftwareTokenMFANotFoundException extends __BaseException {
|
|
|
3353
3489
|
/**
|
|
3354
3490
|
* <p>User preferences for multi-factor authentication with email messages. Activates or
|
|
3355
3491
|
* deactivates email MFA and sets it as the preferred MFA method when multiple methods are
|
|
3356
|
-
* available. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/
|
|
3357
|
-
*
|
|
3358
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a>. </p>
|
|
3492
|
+
* available. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
3493
|
+
* Essentials tier</a> or higher.</p>
|
|
3359
3494
|
* @public
|
|
3360
3495
|
*/
|
|
3361
3496
|
export interface EmailMfaSettingsType {
|
|
@@ -3377,7 +3512,6 @@ export interface EmailMfaSettingsType {
|
|
|
3377
3512
|
* MFA on and off, and can set SMS as preferred when other MFA options are available. You
|
|
3378
3513
|
* can't turn off SMS MFA for any of your users when MFA is required in your user pool; you
|
|
3379
3514
|
* can only set the type that your user prefers. </p>
|
|
3380
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a>. </p>
|
|
3381
3515
|
* @public
|
|
3382
3516
|
*/
|
|
3383
3517
|
export interface SMSMfaSettingsType {
|
|
@@ -3401,7 +3535,6 @@ export interface SMSMfaSettingsType {
|
|
|
3401
3535
|
* authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when
|
|
3402
3536
|
* other MFA options are available. You can't turn off TOTP MFA for any of your users when
|
|
3403
3537
|
* MFA is required in your user pool; you can only set the type that your user prefers. </p>
|
|
3404
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserMFAPreference.html">SetUserMFAPreference</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html">AdminSetUserMFAPreference</a>. </p>
|
|
3405
3538
|
* @public
|
|
3406
3539
|
*/
|
|
3407
3540
|
export interface SoftwareTokenMfaSettingsType {
|
|
@@ -3437,13 +3570,14 @@ export interface AdminSetUserMFAPreferenceRequest {
|
|
|
3437
3570
|
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
|
|
3438
3571
|
/**
|
|
3439
3572
|
* <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
|
|
3440
|
-
* as the preferred MFA method when multiple methods are available.
|
|
3441
|
-
*
|
|
3573
|
+
* as the preferred MFA method when multiple methods are available.
|
|
3574
|
+
* To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
3575
|
+
* Essentials tier</a> or higher.</p>
|
|
3442
3576
|
* @public
|
|
3443
3577
|
*/
|
|
3444
3578
|
EmailMfaSettings?: EmailMfaSettingsType | undefined;
|
|
3445
3579
|
/**
|
|
3446
|
-
* <p>The
|
|
3580
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3447
3581
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3448
3582
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3449
3583
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3472,7 +3606,7 @@ export interface AdminSetUserPasswordRequest {
|
|
|
3472
3606
|
*/
|
|
3473
3607
|
UserPoolId: string | undefined;
|
|
3474
3608
|
/**
|
|
3475
|
-
* <p>The
|
|
3609
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3476
3610
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3477
3611
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3478
3612
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3513,7 +3647,7 @@ export interface AdminSetUserSettingsRequest {
|
|
|
3513
3647
|
*/
|
|
3514
3648
|
UserPoolId: string | undefined;
|
|
3515
3649
|
/**
|
|
3516
|
-
* <p>The
|
|
3650
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3517
3651
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3518
3652
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3519
3653
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3545,7 +3679,7 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
3545
3679
|
*/
|
|
3546
3680
|
UserPoolId: string | undefined;
|
|
3547
3681
|
/**
|
|
3548
|
-
* <p>The
|
|
3682
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3549
3683
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3550
3684
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3551
3685
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3554,12 +3688,12 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
3554
3688
|
*/
|
|
3555
3689
|
Username: string | undefined;
|
|
3556
3690
|
/**
|
|
3557
|
-
* <p>The
|
|
3691
|
+
* <p>The ID of the threat protection authentication event that you want to update.</p>
|
|
3558
3692
|
* @public
|
|
3559
3693
|
*/
|
|
3560
3694
|
EventId: string | undefined;
|
|
3561
3695
|
/**
|
|
3562
|
-
* <p>
|
|
3696
|
+
* <p>Your feedback to the authentication event. When you provide a <code>FeedbackValue</code>
|
|
3563
3697
|
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
3564
3698
|
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
3565
3699
|
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
@@ -3596,7 +3730,7 @@ export interface AdminUpdateDeviceStatusRequest {
|
|
|
3596
3730
|
*/
|
|
3597
3731
|
UserPoolId: string | undefined;
|
|
3598
3732
|
/**
|
|
3599
|
-
* <p>The
|
|
3733
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3600
3734
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3601
3735
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3602
3736
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3634,7 +3768,7 @@ export interface AdminUpdateUserAttributesRequest {
|
|
|
3634
3768
|
*/
|
|
3635
3769
|
UserPoolId: string | undefined;
|
|
3636
3770
|
/**
|
|
3637
|
-
* <p>The
|
|
3771
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3638
3772
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3639
3773
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3640
3774
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3673,7 +3807,7 @@ export interface AdminUpdateUserAttributesRequest {
|
|
|
3673
3807
|
* <code>clientMetadata</code> value to enhance your workflow for your specific
|
|
3674
3808
|
* needs.</p>
|
|
3675
3809
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
3676
|
-
*
|
|
3810
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
3677
3811
|
* <note>
|
|
3678
3812
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
3679
3813
|
* following:</p>
|
|
@@ -3715,7 +3849,7 @@ export interface AdminUserGlobalSignOutRequest {
|
|
|
3715
3849
|
*/
|
|
3716
3850
|
UserPoolId: string | undefined;
|
|
3717
3851
|
/**
|
|
3718
|
-
* <p>The
|
|
3852
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
3719
3853
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
3720
3854
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
3721
3855
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -3743,14 +3877,14 @@ export declare const AdvancedSecurityEnabledModeType: {
|
|
|
3743
3877
|
*/
|
|
3744
3878
|
export type AdvancedSecurityEnabledModeType = (typeof AdvancedSecurityEnabledModeType)[keyof typeof AdvancedSecurityEnabledModeType];
|
|
3745
3879
|
/**
|
|
3746
|
-
* <p>
|
|
3880
|
+
* <p>Threat protection configuration options for additional authentication types in your
|
|
3747
3881
|
* user pool, including custom
|
|
3748
3882
|
* authentication. </p>
|
|
3749
3883
|
* @public
|
|
3750
3884
|
*/
|
|
3751
3885
|
export interface AdvancedSecurityAdditionalFlowsType {
|
|
3752
3886
|
/**
|
|
3753
|
-
* <p>The operating mode of
|
|
3887
|
+
* <p>The operating mode of threat protection in custom authentication with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html"> Custom
|
|
3754
3888
|
* authentication challenge Lambda triggers</a>. </p>
|
|
3755
3889
|
* @public
|
|
3756
3890
|
*/
|
|
@@ -3802,8 +3936,6 @@ export type AuthFactorType = (typeof AuthFactorType)[keyof typeof AuthFactorType
|
|
|
3802
3936
|
* campaign.</p>
|
|
3803
3937
|
* <p>Amazon Pinpoint isn't available in all Amazon Web Services Regions. For a list of available Regions, see
|
|
3804
3938
|
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html#cognito-user-pools-find-region-mappings">Amazon Cognito and Amazon Pinpoint Region availability</a>.</p>
|
|
3805
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html">CreateUserPoolClient</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html">UpdateUserPoolClient</a>, and a response parameter of
|
|
3806
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
3807
3939
|
* @public
|
|
3808
3940
|
*/
|
|
3809
3941
|
export interface AnalyticsConfigurationType {
|
|
@@ -3896,8 +4028,6 @@ export declare const ColorSchemeModeType: {
|
|
|
3896
4028
|
export type ColorSchemeModeType = (typeof ColorSchemeModeType)[keyof typeof ColorSchemeModeType];
|
|
3897
4029
|
/**
|
|
3898
4030
|
* <p>An image file from a managed login branding style in a user pool.</p>
|
|
3899
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html">CreateManagedLoginBranding</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html">UpdateManagedLoginBranding</a>, and a response parameter of
|
|
3900
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html">DescribeManagedLoginBranding</a>.</p>
|
|
3901
4031
|
* @public
|
|
3902
4032
|
*/
|
|
3903
4033
|
export interface AssetType {
|
|
@@ -3936,8 +4066,9 @@ export interface AssetType {
|
|
|
3936
4066
|
*/
|
|
3937
4067
|
export interface AssociateSoftwareTokenRequest {
|
|
3938
4068
|
/**
|
|
3939
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
3940
|
-
*
|
|
4069
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
4070
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
4071
|
+
* <p>You can provide either an access token or a session ID in the request.</p>
|
|
3941
4072
|
* @public
|
|
3942
4073
|
*/
|
|
3943
4074
|
AccessToken?: string | undefined;
|
|
@@ -3962,7 +4093,7 @@ export interface AssociateSoftwareTokenResponse {
|
|
|
3962
4093
|
SecretCode?: string | undefined;
|
|
3963
4094
|
/**
|
|
3964
4095
|
* <p>The session identifier that maintains the state of authentication requests and
|
|
3965
|
-
* challenge responses
|
|
4096
|
+
* challenge responses.</p>
|
|
3966
4097
|
* @public
|
|
3967
4098
|
*/
|
|
3968
4099
|
Session?: string | undefined;
|
|
@@ -4040,13 +4171,13 @@ export interface ChangePasswordResponse {
|
|
|
4040
4171
|
*/
|
|
4041
4172
|
export interface CompleteWebAuthnRegistrationRequest {
|
|
4042
4173
|
/**
|
|
4043
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
4044
|
-
*
|
|
4174
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
4175
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
4045
4176
|
* @public
|
|
4046
4177
|
*/
|
|
4047
4178
|
AccessToken: string | undefined;
|
|
4048
4179
|
/**
|
|
4049
|
-
* <p>A <a href="https://www.w3.org/TR/
|
|
4180
|
+
* <p>A <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-registrationresponsejson">RegistrationResponseJSON</a> public-key credential response from the
|
|
4050
4181
|
* user's passkey provider.</p>
|
|
4051
4182
|
* @public
|
|
4052
4183
|
*/
|
|
@@ -4138,7 +4269,6 @@ export declare class WebAuthnRelyingPartyMismatchException extends __BaseExcepti
|
|
|
4138
4269
|
/**
|
|
4139
4270
|
* <p>A Secure Remote Password (SRP) value that your application generates when you register
|
|
4140
4271
|
* a user's device. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html#user-pools-remembered-devices-getting-a-device-key">Getting a device key</a>.</p>
|
|
4141
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">ConfirmDevice</a>.</p>
|
|
4142
4272
|
* @public
|
|
4143
4273
|
*/
|
|
4144
4274
|
export interface DeviceSecretVerifierConfigType {
|
|
@@ -4159,8 +4289,8 @@ export interface DeviceSecretVerifierConfigType {
|
|
|
4159
4289
|
*/
|
|
4160
4290
|
export interface ConfirmDeviceRequest {
|
|
4161
4291
|
/**
|
|
4162
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
4163
|
-
*
|
|
4292
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
4293
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
4164
4294
|
* @public
|
|
4165
4295
|
*/
|
|
4166
4296
|
AccessToken: string | undefined;
|
|
@@ -4188,24 +4318,33 @@ export interface ConfirmDeviceRequest {
|
|
|
4188
4318
|
export interface ConfirmDeviceResponse {
|
|
4189
4319
|
/**
|
|
4190
4320
|
* <p>When <code>true</code>, your user must confirm that they want to remember the device.
|
|
4191
|
-
* Prompt the user for an answer
|
|
4192
|
-
* <code>remembered</code> or <code>not_remembered</code>.</p>
|
|
4321
|
+
* Prompt the user for an answer.</p>
|
|
4193
4322
|
* <p>When <code>false</code>, immediately sets the device as remembered and eligible for
|
|
4194
4323
|
* device authentication.</p>
|
|
4195
4324
|
* <p>You can configure your user pool to always remember devices, in which case this
|
|
4196
4325
|
* response is <code>false</code>, or to allow users to opt in, in which case this response
|
|
4197
4326
|
* is <code>true</code>. Configure this option under <i>Device tracking</i>
|
|
4198
|
-
* in the <i>Sign-in</i> menu of your user pool
|
|
4199
|
-
* option with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html#CognitoUserPools-CreateUserPool-request-DeviceConfiguration">DeviceConfiguration</a> parameter of a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a> request.</p>
|
|
4327
|
+
* in the <i>Sign-in</i> menu of your user pool.</p>
|
|
4200
4328
|
* @public
|
|
4201
4329
|
*/
|
|
4202
4330
|
UserConfirmationNecessary?: boolean | undefined;
|
|
4203
4331
|
}
|
|
4332
|
+
/**
|
|
4333
|
+
* <p>This exception is thrown when a user attempts to confirm a device with a device key
|
|
4334
|
+
* that already exists.</p>
|
|
4335
|
+
* @public
|
|
4336
|
+
*/
|
|
4337
|
+
export declare class DeviceKeyExistsException extends __BaseException {
|
|
4338
|
+
readonly name: "DeviceKeyExistsException";
|
|
4339
|
+
readonly $fault: "client";
|
|
4340
|
+
/**
|
|
4341
|
+
* @internal
|
|
4342
|
+
*/
|
|
4343
|
+
constructor(opts: __ExceptionOptionType<DeviceKeyExistsException, __BaseException>);
|
|
4344
|
+
}
|
|
4204
4345
|
/**
|
|
4205
4346
|
* <p>Contextual data, such as the user's device fingerprint, IP address, or location, used
|
|
4206
|
-
* for evaluating the risk of an unexpected event by Amazon Cognito
|
|
4207
|
-
* <p>This data type is a request parameter of public-client authentication operations like
|
|
4208
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RespondToAuthChallenge.html">RespondToAuthChallenge</a>.</p>
|
|
4347
|
+
* for evaluating the risk of an unexpected event by Amazon Cognito threat protection.</p>
|
|
4209
4348
|
* @public
|
|
4210
4349
|
*/
|
|
4211
4350
|
export interface UserContextDataType {
|
|
@@ -4229,8 +4368,8 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4229
4368
|
/**
|
|
4230
4369
|
* <p>The ID of the app client where the user wants to reset their password. This parameter
|
|
4231
4370
|
* is an identifier of the client application that users are resetting their password from,
|
|
4232
|
-
* but this operation resets users'
|
|
4233
|
-
*
|
|
4371
|
+
* but this operation resets users' irrespective of the app clients they sign in
|
|
4372
|
+
* to.</p>
|
|
4234
4373
|
* @public
|
|
4235
4374
|
*/
|
|
4236
4375
|
ClientId: string | undefined;
|
|
@@ -4242,7 +4381,7 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4242
4381
|
*/
|
|
4243
4382
|
SecretHash?: string | undefined;
|
|
4244
4383
|
/**
|
|
4245
|
-
* <p>The
|
|
4384
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
4246
4385
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
4247
4386
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
4248
4387
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -4251,7 +4390,8 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4251
4390
|
*/
|
|
4252
4391
|
Username: string | undefined;
|
|
4253
4392
|
/**
|
|
4254
|
-
* <p>The confirmation code that your user pool
|
|
4393
|
+
* <p>The confirmation code that your user pool delivered when your user requested to reset
|
|
4394
|
+
* their password.</p>
|
|
4255
4395
|
* @public
|
|
4256
4396
|
*/
|
|
4257
4397
|
ConfirmationCode: string | undefined;
|
|
@@ -4261,14 +4401,15 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4261
4401
|
*/
|
|
4262
4402
|
Password: string | undefined;
|
|
4263
4403
|
/**
|
|
4264
|
-
* <p>
|
|
4265
|
-
*
|
|
4404
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
4405
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
4406
|
+
* email address, or phone number.</p>
|
|
4266
4407
|
* @public
|
|
4267
4408
|
*/
|
|
4268
4409
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
4269
4410
|
/**
|
|
4270
|
-
* <p>Contextual data about your user session
|
|
4271
|
-
*
|
|
4411
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
4412
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
4272
4413
|
* when it makes API requests.</p>
|
|
4273
4414
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
4274
4415
|
* applications</a>.</p>
|
|
@@ -4287,7 +4428,7 @@ export interface ConfirmForgotPasswordRequest {
|
|
|
4287
4428
|
* function code in Lambda, you can process the <code>clientMetadata</code> value to
|
|
4288
4429
|
* enhance your workflow for your specific needs.</p>
|
|
4289
4430
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
4290
|
-
*
|
|
4431
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
4291
4432
|
* <note>
|
|
4292
4433
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
4293
4434
|
* following:</p>
|
|
@@ -4336,7 +4477,7 @@ export interface ConfirmSignUpRequest {
|
|
|
4336
4477
|
*/
|
|
4337
4478
|
SecretHash?: string | undefined;
|
|
4338
4479
|
/**
|
|
4339
|
-
* <p>The
|
|
4480
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
4340
4481
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
4341
4482
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
4342
4483
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -4368,14 +4509,15 @@ export interface ConfirmSignUpRequest {
|
|
|
4368
4509
|
*/
|
|
4369
4510
|
ForceAliasCreation?: boolean | undefined;
|
|
4370
4511
|
/**
|
|
4371
|
-
* <p>
|
|
4372
|
-
*
|
|
4512
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
4513
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
4514
|
+
* email address, or phone number.</p>
|
|
4373
4515
|
* @public
|
|
4374
4516
|
*/
|
|
4375
4517
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
4376
4518
|
/**
|
|
4377
|
-
* <p>Contextual data about your user session
|
|
4378
|
-
*
|
|
4519
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
4520
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
4379
4521
|
* when it makes API requests.</p>
|
|
4380
4522
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
4381
4523
|
* applications</a>.</p>
|
|
@@ -4394,7 +4536,7 @@ export interface ConfirmSignUpRequest {
|
|
|
4394
4536
|
* code in Lambda, you can process the <code>clientMetadata</code> value to
|
|
4395
4537
|
* enhance your workflow for your specific needs.</p>
|
|
4396
4538
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
4397
|
-
*
|
|
4539
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
4398
4540
|
* <note>
|
|
4399
4541
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
4400
4542
|
* following:</p>
|
|
@@ -4433,8 +4575,7 @@ export interface ConfirmSignUpResponse {
|
|
|
4433
4575
|
/**
|
|
4434
4576
|
* <p>A session identifier that you can use to immediately sign in the confirmed user. You
|
|
4435
4577
|
* can automatically sign users in with the one-time password that they provided in a
|
|
4436
|
-
* successful <code>ConfirmSignUp</code> request
|
|
4437
|
-
* parameter from this response in the <code>Session</code> parameter of an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">InitiateAuth</a> or <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html">AdminInitiateAuth</a> request.</p>
|
|
4578
|
+
* successful <code>ConfirmSignUp</code> request.</p>
|
|
4438
4579
|
* @public
|
|
4439
4580
|
*/
|
|
4440
4581
|
Session?: string | undefined;
|
|
@@ -4692,7 +4833,6 @@ export interface CreateIdentityProviderRequest {
|
|
|
4692
4833
|
* <p>A user pool identity provider (IdP). Contains information about a third-party IdP to a
|
|
4693
4834
|
* user pool, the attributes that it populates to user profiles, and the trust relationship
|
|
4694
4835
|
* between the IdP and your user pool.</p>
|
|
4695
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html">CreateIdentityProvider</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeIdentityProvider.html">DescribeIdentityProvider</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetIdentityProviderByIdentifier.html">GetIdentityProviderByIdentifier</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateIdentityProvider.html">UpdateIdentityProvider</a>.</p>
|
|
4696
4836
|
* @public
|
|
4697
4837
|
*/
|
|
4698
4838
|
export interface IdentityProviderType {
|
|
@@ -4894,9 +5034,8 @@ export interface CreateManagedLoginBrandingRequest {
|
|
|
4894
5034
|
*/
|
|
4895
5035
|
UserPoolId: string | undefined;
|
|
4896
5036
|
/**
|
|
4897
|
-
* <p>The app client that you want to create the branding style for. Each style is
|
|
4898
|
-
*
|
|
4899
|
-
* existing style with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteManagedLoginBranding.html">DeleteManagedLoginBranding</a> and create a new one.</p>
|
|
5037
|
+
* <p>The app client that you want to create the branding style for. Each style is linked to
|
|
5038
|
+
* an app client until you delete it.</p>
|
|
4900
5039
|
* @public
|
|
4901
5040
|
*/
|
|
4902
5041
|
ClientId: string | undefined;
|
|
@@ -4915,8 +5054,8 @@ export interface CreateManagedLoginBrandingRequest {
|
|
|
4915
5054
|
*/
|
|
4916
5055
|
Settings?: __DocumentType | undefined;
|
|
4917
5056
|
/**
|
|
4918
|
-
* <p>An array of image files that you want to apply to
|
|
4919
|
-
* icons. Each object must also indicate whether it is for dark mode, light mode, or
|
|
5057
|
+
* <p>An array of image files that you want to apply to functions like backgrounds, logos,
|
|
5058
|
+
* and icons. Each object must also indicate whether it is for dark mode, light mode, or
|
|
4920
5059
|
* browser-adaptive mode.</p>
|
|
4921
5060
|
* @public
|
|
4922
5061
|
*/
|
|
@@ -4924,7 +5063,6 @@ export interface CreateManagedLoginBrandingRequest {
|
|
|
4924
5063
|
}
|
|
4925
5064
|
/**
|
|
4926
5065
|
* <p>A managed login branding style that's assigned to a user pool app client.</p>
|
|
4927
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateManagedLoginBranding.html">CreateManagedLoginBranding</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateManagedLoginBranding.html">UpdateManagedLoginBranding</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBranding.html">DescribeManagedLoginBranding</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeManagedLoginBrandingByClient.html">DescribeManagedLoginBrandingByClient</a>.</p>
|
|
4928
5066
|
* @public
|
|
4929
5067
|
*/
|
|
4930
5068
|
export interface ManagedLoginBrandingType {
|
|
@@ -5000,7 +5138,6 @@ export declare class ManagedLoginBrandingExistsException extends __BaseException
|
|
|
5000
5138
|
* <p>One custom scope associated with a user pool resource server. This data type is a
|
|
5001
5139
|
* member of <code>ResourceServerScopeType</code>. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html">
|
|
5002
5140
|
* Scopes, M2M, and API authorization with resource servers</a>. </p>
|
|
5003
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html">CreateResourceServer</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html">DescribeResourceServer</a>. </p>
|
|
5004
5141
|
* @public
|
|
5005
5142
|
*/
|
|
5006
5143
|
export interface ResourceServerScopeType {
|
|
@@ -5055,7 +5192,6 @@ export interface CreateResourceServerRequest {
|
|
|
5055
5192
|
/**
|
|
5056
5193
|
* <p>The details of a resource server configuration and associated custom scopes in a user
|
|
5057
5194
|
* pool.</p>
|
|
5058
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html">CreateResourceServer</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html">DescribeResourceServer</a>. </p>
|
|
5059
5195
|
* @public
|
|
5060
5196
|
*/
|
|
5061
5197
|
export interface ResourceServerType {
|
|
@@ -5138,7 +5274,6 @@ export type UserImportJobStatusType = (typeof UserImportJobStatusType)[keyof typ
|
|
|
5138
5274
|
/**
|
|
5139
5275
|
* <p>A user import job in a user pool. Describes the status of user import with a CSV file.
|
|
5140
5276
|
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users into user pools from a CSV file</a>.</p>
|
|
5141
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserImportJob.html">CreateUserImportJob</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserImportJob.html">DescribeUserImportJob</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserImportJobs.html">ListUserImportJobs</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StartUserImportJob.html">StartUserImportJob</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StopUserImportJob.html">StopUserImportJob</a>.</p>
|
|
5142
5277
|
* @public
|
|
5143
5278
|
*/
|
|
5144
5279
|
export interface UserImportJobType {
|
|
@@ -5258,7 +5393,8 @@ export interface UserImportJobType {
|
|
|
5258
5393
|
*/
|
|
5259
5394
|
export interface CreateUserImportJobResponse {
|
|
5260
5395
|
/**
|
|
5261
|
-
* <p>The details of the user import job
|
|
5396
|
+
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
5397
|
+
* pre-signed URL for CSV upload.</p>
|
|
5262
5398
|
* @public
|
|
5263
5399
|
*/
|
|
5264
5400
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -5276,23 +5412,10 @@ export declare const DeletionProtectionType: {
|
|
|
5276
5412
|
*/
|
|
5277
5413
|
export type DeletionProtectionType = (typeof DeletionProtectionType)[keyof typeof DeletionProtectionType];
|
|
5278
5414
|
/**
|
|
5279
|
-
* <p>The device-remembering configuration for a user pool
|
|
5280
|
-
* DescribeUserPool</a> request returns a null value for this object when the user
|
|
5281
|
-
* pool isn't configured to remember devices. When device remembering is active, you can
|
|
5282
|
-
* remember a user's device with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html">ConfirmDevice</a> API request. Additionally. when the property
|
|
5283
|
-
* <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>true</code>, you must follow
|
|
5284
|
-
* <code>ConfirmDevice</code> with an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html">UpdateDeviceStatus</a> API request that sets the user's device to
|
|
5285
|
-
* <code>remembered</code> or <code>not_remembered</code>.</p>
|
|
5286
|
-
* <p>To sign in with a remembered device, include <code>DEVICE_KEY</code> in the
|
|
5287
|
-
* authentication parameters in your user's <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html">
|
|
5288
|
-
* InitiateAuth</a> request. If your app doesn't include a <code>DEVICE_KEY</code>
|
|
5289
|
-
* parameter, the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html#API_InitiateAuth_ResponseSyntax">response</a> from Amazon Cognito includes newly-generated <code>DEVICE_KEY</code> and
|
|
5290
|
-
* <code>DEVICE_GROUP_KEY</code> values under <code>NewDeviceMetadata</code>. Store
|
|
5291
|
-
* these values to use in future device-authentication requests.</p>
|
|
5415
|
+
* <p>The device-remembering configuration for a user pool.</p>
|
|
5292
5416
|
* <note>
|
|
5293
5417
|
* <p>When you provide a value for any property of <code>DeviceConfiguration</code>, you
|
|
5294
5418
|
* activate the device remembering for the user pool.</p>
|
|
5295
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5296
5419
|
* </note>
|
|
5297
5420
|
* @public
|
|
5298
5421
|
*/
|
|
@@ -5311,10 +5434,9 @@ export interface DeviceConfigurationType {
|
|
|
5311
5434
|
ChallengeRequiredOnNewDevice?: boolean | undefined;
|
|
5312
5435
|
/**
|
|
5313
5436
|
* <p>When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
|
|
5314
|
-
* <a
|
|
5315
|
-
*
|
|
5316
|
-
*
|
|
5317
|
-
* UpdateDeviceStatus</a> API request.</p>
|
|
5437
|
+
* <code>ConfirmDevice</code> API request. In your app, create a prompt for your user
|
|
5438
|
+
* to choose whether they want to remember their device. Return the user's choice in an
|
|
5439
|
+
* <code>UpdateDeviceStatus</code> API request.</p>
|
|
5318
5440
|
* <p>When <code>DeviceOnlyRememberedOnUserPrompt</code> is <code>false</code>, Amazon
|
|
5319
5441
|
* Cognito immediately remembers devices that you register in a <code>ConfirmDevice</code>
|
|
5320
5442
|
* API request.</p>
|
|
@@ -5343,8 +5465,6 @@ export type EmailSendingAccountType = (typeof EmailSendingAccountType)[keyof typ
|
|
|
5343
5465
|
* you created your user pool, and in alternate Regions in some cases. For more
|
|
5344
5466
|
* information on the supported Regions, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html">Email settings for Amazon Cognito user pools</a>.</p>
|
|
5345
5467
|
* </note>
|
|
5346
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a>, and a response parameter of
|
|
5347
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>.</p>
|
|
5348
5468
|
* @public
|
|
5349
5469
|
*/
|
|
5350
5470
|
export interface EmailConfigurationType {
|
|
@@ -5465,7 +5585,6 @@ export declare const CustomEmailSenderLambdaVersionType: {
|
|
|
5465
5585
|
export type CustomEmailSenderLambdaVersionType = (typeof CustomEmailSenderLambdaVersionType)[keyof typeof CustomEmailSenderLambdaVersionType];
|
|
5466
5586
|
/**
|
|
5467
5587
|
* <p>The properties of a custom email sender Lambda trigger.</p>
|
|
5468
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5469
5588
|
* @public
|
|
5470
5589
|
*/
|
|
5471
5590
|
export interface CustomEmailLambdaVersionConfigType {
|
|
@@ -5495,7 +5614,6 @@ export declare const CustomSMSSenderLambdaVersionType: {
|
|
|
5495
5614
|
export type CustomSMSSenderLambdaVersionType = (typeof CustomSMSSenderLambdaVersionType)[keyof typeof CustomSMSSenderLambdaVersionType];
|
|
5496
5615
|
/**
|
|
5497
5616
|
* <p>The properties of a custom SMS sender Lambda trigger.</p>
|
|
5498
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5499
5617
|
* @public
|
|
5500
5618
|
*/
|
|
5501
5619
|
export interface CustomSMSLambdaVersionConfigType {
|
|
@@ -5519,6 +5637,7 @@ export interface CustomSMSLambdaVersionConfigType {
|
|
|
5519
5637
|
export declare const PreTokenGenerationLambdaVersionType: {
|
|
5520
5638
|
readonly V1_0: "V1_0";
|
|
5521
5639
|
readonly V2_0: "V2_0";
|
|
5640
|
+
readonly V3_0: "V3_0";
|
|
5522
5641
|
};
|
|
5523
5642
|
/**
|
|
5524
5643
|
* @public
|
|
@@ -5526,7 +5645,6 @@ export declare const PreTokenGenerationLambdaVersionType: {
|
|
|
5526
5645
|
export type PreTokenGenerationLambdaVersionType = (typeof PreTokenGenerationLambdaVersionType)[keyof typeof PreTokenGenerationLambdaVersionType];
|
|
5527
5646
|
/**
|
|
5528
5647
|
* <p>The properties of a pre token generation Lambda trigger.</p>
|
|
5529
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5530
5648
|
* @public
|
|
5531
5649
|
*/
|
|
5532
5650
|
export interface PreTokenGenerationVersionConfigType {
|
|
@@ -5548,7 +5666,6 @@ export interface PreTokenGenerationVersionConfigType {
|
|
|
5548
5666
|
* <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
|
|
5549
5667
|
* stages of user pool operations. Triggers can modify the outcome of the operations that
|
|
5550
5668
|
* invoked them.</p>
|
|
5551
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5552
5669
|
* @public
|
|
5553
5670
|
*/
|
|
5554
5671
|
export interface LambdaConfigType {
|
|
@@ -5665,7 +5782,6 @@ export type UserPoolMfaType = (typeof UserPoolMfaType)[keyof typeof UserPoolMfaT
|
|
|
5665
5782
|
/**
|
|
5666
5783
|
* <p>The password policy settings for a user pool, including complexity, history, and
|
|
5667
5784
|
* length requirements.</p>
|
|
5668
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5669
5785
|
* @public
|
|
5670
5786
|
*/
|
|
5671
5787
|
export interface PasswordPolicyType {
|
|
@@ -5703,9 +5819,6 @@ export interface PasswordPolicyType {
|
|
|
5703
5819
|
* <p>The number of previous passwords that you want Amazon Cognito to restrict each user from
|
|
5704
5820
|
* reusing. Users can't set a password that matches any of <code>n</code> previous
|
|
5705
5821
|
* passwords, where <code>n</code> is the value of <code>PasswordHistorySize</code>.</p>
|
|
5706
|
-
* <p>Password history isn't enforced and isn't displayed in <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a> responses when you set this value to
|
|
5707
|
-
* <code>0</code> or don't provide it. To activate this setting, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">
|
|
5708
|
-
* advanced security features</a> must be active in your user pool.</p>
|
|
5709
5822
|
* @public
|
|
5710
5823
|
*/
|
|
5711
5824
|
PasswordHistorySize?: number | undefined;
|
|
@@ -5724,8 +5837,9 @@ export interface PasswordPolicyType {
|
|
|
5724
5837
|
TemporaryPasswordValidityDays?: number | undefined;
|
|
5725
5838
|
}
|
|
5726
5839
|
/**
|
|
5727
|
-
* <p>The policy for allowed types of authentication in a user pool
|
|
5728
|
-
*
|
|
5840
|
+
* <p>The policy for allowed types of authentication in a user pool.
|
|
5841
|
+
* To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
5842
|
+
* Essentials tier</a> or higher.</p>
|
|
5729
5843
|
* @public
|
|
5730
5844
|
*/
|
|
5731
5845
|
export interface SignInPolicyType {
|
|
@@ -5740,7 +5854,6 @@ export interface SignInPolicyType {
|
|
|
5740
5854
|
/**
|
|
5741
5855
|
* <p>A list of user pool policies. Contains the policy that sets password-complexity
|
|
5742
5856
|
* requirements.</p>
|
|
5743
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5744
5857
|
* @public
|
|
5745
5858
|
*/
|
|
5746
5859
|
export interface UserPoolPolicyType {
|
|
@@ -5760,8 +5873,6 @@ export interface UserPoolPolicyType {
|
|
|
5760
5873
|
* <p>User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS
|
|
5761
5874
|
* messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
|
|
5762
5875
|
* Identity and Access Management (IAM) role in your Amazon Web Services account.</p>
|
|
5763
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a>, and a response parameter of
|
|
5764
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>.</p>
|
|
5765
5876
|
* @public
|
|
5766
5877
|
*/
|
|
5767
5878
|
export interface SmsConfigurationType {
|
|
@@ -5804,7 +5915,6 @@ export interface SmsConfigurationType {
|
|
|
5804
5915
|
* 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
|
|
5805
5916
|
* more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates">
|
|
5806
5917
|
* Verifying updates to email addresses and phone numbers</a>.</p>
|
|
5807
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5808
5918
|
* @public
|
|
5809
5919
|
*/
|
|
5810
5920
|
export interface UserAttributeUpdateSettingsType {
|
|
@@ -5814,8 +5924,6 @@ export interface UserAttributeUpdateSettingsType {
|
|
|
5814
5924
|
* this option activated, Amazon Cognito sends a verification message to the new phone number or
|
|
5815
5925
|
* email address. Amazon Cognito doesn’t change the value of the attribute until your user responds
|
|
5816
5926
|
* to the verification message and confirms the new value.</p>
|
|
5817
|
-
* <p>You can verify an updated email address or phone number with a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifyUserAttribute.html">VerifyUserAttribute</a> API request. You can also call the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html">AdminUpdateUserAttributes</a> API and set <code>email_verified</code> or
|
|
5818
|
-
* <code>phone_number_verified</code> to true.</p>
|
|
5819
5927
|
* <p>When <code>AttributesRequireVerificationBeforeUpdate</code> is false, your user pool
|
|
5820
5928
|
* doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a
|
|
5821
5929
|
* user pool where <code>AttributesRequireVerificationBeforeUpdate</code> is false, API
|
|
@@ -5839,7 +5947,6 @@ export declare const UsernameAttributeType: {
|
|
|
5839
5947
|
export type UsernameAttributeType = (typeof UsernameAttributeType)[keyof typeof UsernameAttributeType];
|
|
5840
5948
|
/**
|
|
5841
5949
|
* <p>The configuration of a user pool for username case sensitivity.</p>
|
|
5842
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5843
5950
|
* @public
|
|
5844
5951
|
*/
|
|
5845
5952
|
export interface UsernameConfigurationType {
|
|
@@ -5872,24 +5979,24 @@ export interface UsernameConfigurationType {
|
|
|
5872
5979
|
CaseSensitive: boolean | undefined;
|
|
5873
5980
|
}
|
|
5874
5981
|
/**
|
|
5875
|
-
* <p>
|
|
5876
|
-
*
|
|
5877
|
-
*
|
|
5878
|
-
*
|
|
5879
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a
|
|
5880
|
-
*
|
|
5982
|
+
* <p>Contains settings for activation of threat protection, including the operating
|
|
5983
|
+
* mode and additional authentication types. To log user security information but take
|
|
5984
|
+
* no action, set to <code>AUDIT</code>. To configure automatic security responses to
|
|
5985
|
+
* potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
|
|
5986
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
5987
|
+
* Plus tier</a>.</p>
|
|
5881
5988
|
* @public
|
|
5882
5989
|
*/
|
|
5883
5990
|
export interface UserPoolAddOnsType {
|
|
5884
5991
|
/**
|
|
5885
|
-
* <p>The operating mode of
|
|
5992
|
+
* <p>The operating mode of threat protection for standard authentication types in
|
|
5886
5993
|
* your user pool, including username-password and secure remote password (SRP)
|
|
5887
5994
|
* authentication. </p>
|
|
5888
5995
|
* @public
|
|
5889
5996
|
*/
|
|
5890
5997
|
AdvancedSecurityMode: AdvancedSecurityModeType | undefined;
|
|
5891
5998
|
/**
|
|
5892
|
-
* <p>
|
|
5999
|
+
* <p>Threat protection configuration options for additional authentication types in your
|
|
5893
6000
|
* user pool, including custom
|
|
5894
6001
|
* authentication. </p>
|
|
5895
6002
|
* @public
|
|
@@ -5924,7 +6031,6 @@ export type DefaultEmailOptionType = (typeof DefaultEmailOptionType)[keyof typeo
|
|
|
5924
6031
|
/**
|
|
5925
6032
|
* <p>The template for the verification message that your user pool delivers to users who
|
|
5926
6033
|
* set an email address or phone number attribute.</p>
|
|
5927
|
-
* <p>This data type is a request and response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
5928
6034
|
* @public
|
|
5929
6035
|
*/
|
|
5930
6036
|
export interface VerificationMessageTemplateType {
|
|
@@ -5978,7 +6084,7 @@ export interface VerificationMessageTemplateType {
|
|
|
5978
6084
|
*/
|
|
5979
6085
|
export interface CreateUserPoolRequest {
|
|
5980
6086
|
/**
|
|
5981
|
-
* <p>A
|
|
6087
|
+
* <p>A friendly name for your user pool.</p>
|
|
5982
6088
|
* @public
|
|
5983
6089
|
*/
|
|
5984
6090
|
PoolName: string | undefined;
|
|
@@ -6008,15 +6114,14 @@ export interface CreateUserPoolRequest {
|
|
|
6008
6114
|
*/
|
|
6009
6115
|
LambdaConfig?: LambdaConfigType | undefined;
|
|
6010
6116
|
/**
|
|
6011
|
-
* <p>The attributes that you want your user pool to automatically verify.
|
|
6012
|
-
*
|
|
6117
|
+
* <p>The attributes that you want your user pool to automatically verify. For more
|
|
6118
|
+
* information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#allowing-users-to-sign-up-and-confirm-themselves">Verifying contact information at sign-up</a>.</p>
|
|
6013
6119
|
* @public
|
|
6014
6120
|
*/
|
|
6015
6121
|
AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
|
|
6016
6122
|
/**
|
|
6017
|
-
* <p>Attributes supported as an alias for this user pool.
|
|
6018
|
-
*
|
|
6019
|
-
* alias attributes, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases">Customizing sign-in attributes</a>.</p>
|
|
6123
|
+
* <p>Attributes supported as an alias for this user pool. For more information about alias
|
|
6124
|
+
* attributes, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases">Customizing sign-in attributes</a>.</p>
|
|
6020
6125
|
* @public
|
|
6021
6126
|
*/
|
|
6022
6127
|
AliasAttributes?: AliasAttributeType[] | undefined;
|
|
@@ -6027,17 +6132,17 @@ export interface CreateUserPoolRequest {
|
|
|
6027
6132
|
*/
|
|
6028
6133
|
UsernameAttributes?: UsernameAttributeType[] | undefined;
|
|
6029
6134
|
/**
|
|
6030
|
-
* <p>This parameter is no longer used
|
|
6135
|
+
* <p>This parameter is no longer used.</p>
|
|
6031
6136
|
* @public
|
|
6032
6137
|
*/
|
|
6033
6138
|
SmsVerificationMessage?: string | undefined;
|
|
6034
6139
|
/**
|
|
6035
|
-
* <p>This parameter is no longer used
|
|
6140
|
+
* <p>This parameter is no longer used.</p>
|
|
6036
6141
|
* @public
|
|
6037
6142
|
*/
|
|
6038
6143
|
EmailVerificationMessage?: string | undefined;
|
|
6039
6144
|
/**
|
|
6040
|
-
* <p>This parameter is no longer used
|
|
6145
|
+
* <p>This parameter is no longer used.</p>
|
|
6041
6146
|
* @public
|
|
6042
6147
|
*/
|
|
6043
6148
|
EmailVerificationSubject?: string | undefined;
|
|
@@ -6054,7 +6159,8 @@ export interface CreateUserPoolRequest {
|
|
|
6054
6159
|
*/
|
|
6055
6160
|
VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
|
|
6056
6161
|
/**
|
|
6057
|
-
* <p>
|
|
6162
|
+
* <p>The contents of the SMS message that your user pool sends to users in SMS OTP and MFA
|
|
6163
|
+
* authentication.</p>
|
|
6058
6164
|
* @public
|
|
6059
6165
|
*/
|
|
6060
6166
|
SmsAuthenticationMessage?: string | undefined;
|
|
@@ -6064,6 +6170,10 @@ export interface CreateUserPoolRequest {
|
|
|
6064
6170
|
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
6065
6171
|
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
6066
6172
|
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
6173
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
6174
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
6175
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
6176
|
+
* MFA factor.</p>
|
|
6067
6177
|
* @public
|
|
6068
6178
|
*/
|
|
6069
6179
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
@@ -6096,10 +6206,10 @@ export interface CreateUserPoolRequest {
|
|
|
6096
6206
|
*/
|
|
6097
6207
|
EmailConfiguration?: EmailConfigurationType | undefined;
|
|
6098
6208
|
/**
|
|
6099
|
-
* <p>The
|
|
6100
|
-
*
|
|
6101
|
-
*
|
|
6102
|
-
*
|
|
6209
|
+
* <p>The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. To send SMS
|
|
6210
|
+
* messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
|
|
6211
|
+
* Identity and Access Management (IAM) role in your Amazon Web Services account. For more information see
|
|
6212
|
+
* <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
|
|
6103
6213
|
* @public
|
|
6104
6214
|
*/
|
|
6105
6215
|
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
@@ -6111,7 +6221,7 @@ export interface CreateUserPoolRequest {
|
|
|
6111
6221
|
*/
|
|
6112
6222
|
UserPoolTags?: Record<string, string> | undefined;
|
|
6113
6223
|
/**
|
|
6114
|
-
* <p>The configuration for
|
|
6224
|
+
* <p>The configuration for administrative creation of users. Includes the template for the
|
|
6115
6225
|
* invitation message for new users, the duration of temporary passwords, and permitting
|
|
6116
6226
|
* self-service sign-up.</p>
|
|
6117
6227
|
* @public
|
|
@@ -6125,11 +6235,12 @@ export interface CreateUserPoolRequest {
|
|
|
6125
6235
|
*/
|
|
6126
6236
|
Schema?: SchemaAttributeType[] | undefined;
|
|
6127
6237
|
/**
|
|
6128
|
-
* <p>
|
|
6129
|
-
*
|
|
6130
|
-
*
|
|
6131
|
-
*
|
|
6132
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a
|
|
6238
|
+
* <p>Contains settings for activation of threat protection, including the operating
|
|
6239
|
+
* mode and additional authentication types. To log user security information but take
|
|
6240
|
+
* no action, set to <code>AUDIT</code>. To configure automatic security responses to
|
|
6241
|
+
* potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
|
|
6242
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
6243
|
+
* Plus tier</a>.</p>
|
|
6133
6244
|
* @public
|
|
6134
6245
|
*/
|
|
6135
6246
|
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
@@ -6154,8 +6265,12 @@ export interface CreateUserPoolRequest {
|
|
|
6154
6265
|
* <code>ForgotPassword</code>. You can use this setting to define a preferred method
|
|
6155
6266
|
* when a user has more than one method available. With this setting, SMS doesn't qualify
|
|
6156
6267
|
* for a valid password recovery mechanism if the user also has SMS multi-factor
|
|
6157
|
-
* authentication (MFA) activated.
|
|
6158
|
-
*
|
|
6268
|
+
* authentication (MFA) activated. Email MFA is also disqualifying for account recovery
|
|
6269
|
+
* with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine
|
|
6270
|
+
* the recovery method where SMS is preferred over email.</p>
|
|
6271
|
+
* <p>As a best practice, configure both <code>verified_email</code> and
|
|
6272
|
+
* <code>verified_phone_number</code>, with one having a higher priority than the
|
|
6273
|
+
* other.</p>
|
|
6159
6274
|
* @public
|
|
6160
6275
|
*/
|
|
6161
6276
|
AccountRecoverySetting?: AccountRecoverySettingType | undefined;
|
|
@@ -6181,7 +6296,6 @@ export declare const StatusType: {
|
|
|
6181
6296
|
export type StatusType = (typeof StatusType)[keyof typeof StatusType];
|
|
6182
6297
|
/**
|
|
6183
6298
|
* <p>The configuration of a user pool.</p>
|
|
6184
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html">CreateUserPool</a>, <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html">UpdateUserPool</a>, and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html">DescribeUserPool</a>.</p>
|
|
6185
6299
|
* @public
|
|
6186
6300
|
*/
|
|
6187
6301
|
export interface UserPoolType {
|
|
@@ -6268,17 +6382,17 @@ export interface UserPoolType {
|
|
|
6268
6382
|
*/
|
|
6269
6383
|
UsernameAttributes?: UsernameAttributeType[] | undefined;
|
|
6270
6384
|
/**
|
|
6271
|
-
* <p>This parameter is no longer used
|
|
6385
|
+
* <p>This parameter is no longer used.</p>
|
|
6272
6386
|
* @public
|
|
6273
6387
|
*/
|
|
6274
6388
|
SmsVerificationMessage?: string | undefined;
|
|
6275
6389
|
/**
|
|
6276
|
-
* <p>This parameter is no longer used
|
|
6390
|
+
* <p>This parameter is no longer used.</p>
|
|
6277
6391
|
* @public
|
|
6278
6392
|
*/
|
|
6279
6393
|
EmailVerificationMessage?: string | undefined;
|
|
6280
6394
|
/**
|
|
6281
|
-
* <p>This parameter is no longer used
|
|
6395
|
+
* <p>This parameter is no longer used.</p>
|
|
6282
6396
|
* @public
|
|
6283
6397
|
*/
|
|
6284
6398
|
EmailVerificationSubject?: string | undefined;
|
|
@@ -6408,11 +6522,12 @@ export interface UserPoolType {
|
|
|
6408
6522
|
*/
|
|
6409
6523
|
AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
|
|
6410
6524
|
/**
|
|
6411
|
-
* <p>
|
|
6412
|
-
*
|
|
6413
|
-
*
|
|
6414
|
-
*
|
|
6415
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a
|
|
6525
|
+
* <p>Contains settings for activation of threat protection, including the operating
|
|
6526
|
+
* mode and additional authentication types. To log user security information but take
|
|
6527
|
+
* no action, set to <code>AUDIT</code>. To configure automatic security responses to
|
|
6528
|
+
* potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
|
|
6529
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html">Adding advanced security to a user pool</a>. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
6530
|
+
* Plus tier</a>.</p>
|
|
6416
6531
|
* @public
|
|
6417
6532
|
*/
|
|
6418
6533
|
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
@@ -6426,7 +6541,6 @@ export interface UserPoolType {
|
|
|
6426
6541
|
* When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in
|
|
6427
6542
|
* case as the same user, and prevents a case variation from being assigned to the same
|
|
6428
6543
|
* attribute for a different user.</p>
|
|
6429
|
-
* <p>This configuration is immutable after you set it. For more information, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UsernameConfigurationType.html">UsernameConfigurationType</a>.</p>
|
|
6430
6544
|
* @public
|
|
6431
6545
|
*/
|
|
6432
6546
|
UsernameConfiguration?: UsernameConfigurationType | undefined;
|
|
@@ -6565,8 +6679,6 @@ export type TimeUnitsType = (typeof TimeUnitsType)[keyof typeof TimeUnitsType];
|
|
|
6565
6679
|
* <code>AccessTokenValidity</code>, and <code>RefreshTokenValidity</code>, set and
|
|
6566
6680
|
* display the duration of ID, access, and refresh tokens for an app client. You can assign
|
|
6567
6681
|
* a separate token validity unit to each type of token. </p>
|
|
6568
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html">CreateUserPoolClient</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html">UpdateUserPoolClient</a>, and a response parameter of
|
|
6569
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
6570
6682
|
* @public
|
|
6571
6683
|
*/
|
|
6572
6684
|
export interface TokenValidityUnitsType {
|
|
@@ -6611,8 +6723,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
6611
6723
|
ClientName: string | undefined;
|
|
6612
6724
|
/**
|
|
6613
6725
|
* <p>When <code>true</code>, generates a client secret for the app client. Client secrets
|
|
6614
|
-
* are used with server-side and machine-to-machine applications.
|
|
6615
|
-
*
|
|
6726
|
+
* are used with server-side and machine-to-machine applications. Client secrets are
|
|
6727
|
+
* automatically generated; you can't specify a secret value. For more information,
|
|
6728
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html#user-pool-settings-client-app-client-types">App client types</a>.</p>
|
|
6616
6729
|
* @public
|
|
6617
6730
|
*/
|
|
6618
6731
|
GenerateSecret?: boolean | undefined;
|
|
@@ -6672,15 +6785,12 @@ export interface CreateUserPoolClientRequest {
|
|
|
6672
6785
|
/**
|
|
6673
6786
|
* <p>The list of user attributes that you want your app client to have read access to.
|
|
6674
6787
|
* After your user authenticates in your app, their access token authorizes them to read
|
|
6675
|
-
* their own attribute value for any attribute in this list
|
|
6676
|
-
* activity is when your user selects a link to view their profile information. Your app
|
|
6677
|
-
* makes a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html">GetUser</a> API request to retrieve and display your user's profile
|
|
6678
|
-
* data.</p>
|
|
6788
|
+
* their own attribute value for any attribute in this list.</p>
|
|
6679
6789
|
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
6680
6790
|
* app can read the values of <code>email_verified</code>,
|
|
6681
|
-
*
|
|
6791
|
+
* <code>phone_number_verified</code>, and the standard attributes of your user pool.
|
|
6682
6792
|
* When your user pool app client has read access to these default attributes,
|
|
6683
|
-
*
|
|
6793
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
6684
6794
|
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
6685
6795
|
* custom set of read attributes.</p>
|
|
6686
6796
|
* @public
|
|
@@ -6689,10 +6799,7 @@ export interface CreateUserPoolClientRequest {
|
|
|
6689
6799
|
/**
|
|
6690
6800
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
6691
6801
|
* After your user authenticates in your app, their access token authorizes them to set or
|
|
6692
|
-
* modify their own attribute value for any attribute in this list
|
|
6693
|
-
* of activity is when you present your user with a form to update their profile
|
|
6694
|
-
* information and they change their last name. Your app then makes an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> API request and sets <code>family_name</code> to the
|
|
6695
|
-
* new value. </p>
|
|
6802
|
+
* modify their own attribute value for any attribute in this list.</p>
|
|
6696
6803
|
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
6697
6804
|
* app can write the values of the Standard attributes of your user pool. When your user
|
|
6698
6805
|
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
@@ -6709,13 +6816,16 @@ export interface CreateUserPoolClientRequest {
|
|
|
6709
6816
|
*/
|
|
6710
6817
|
WriteAttributes?: string[] | undefined;
|
|
6711
6818
|
/**
|
|
6712
|
-
* <p>The authentication flows that you want your user pool client to support. For each app
|
|
6713
|
-
* your users with any combination of one or more flows, including with
|
|
6714
|
-
* password, or a custom authentication process that
|
|
6819
|
+
* <p>The <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html">authentication flows</a> that you want your user pool client to support. For each app
|
|
6820
|
+
* client in your user pool, you can sign in your users with any combination of one or more flows, including with
|
|
6821
|
+
* a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
|
|
6822
|
+
* you define with Lambda functions.</p>
|
|
6715
6823
|
* <note>
|
|
6716
|
-
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your
|
|
6824
|
+
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
|
|
6825
|
+
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
|
|
6826
|
+
* </p>
|
|
6717
6827
|
* </note>
|
|
6718
|
-
* <p>
|
|
6828
|
+
* <p>The values for authentication flow options include the following.</p>
|
|
6719
6829
|
* <ul>
|
|
6720
6830
|
* <li>
|
|
6721
6831
|
* <p>
|
|
@@ -6728,6 +6838,8 @@ export interface CreateUserPoolClientRequest {
|
|
|
6728
6838
|
* without the flow <code>USER_SRP_AUTH</code> being active for the app
|
|
6729
6839
|
* client. This flow doesn't include <code>CUSTOM_AUTH</code>.
|
|
6730
6840
|
* </p>
|
|
6841
|
+
* <p>To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
6842
|
+
* Essentials tier</a> or higher.</p>
|
|
6731
6843
|
* </li>
|
|
6732
6844
|
* <li>
|
|
6733
6845
|
* <p>
|
|
@@ -6767,20 +6879,25 @@ export interface CreateUserPoolClientRequest {
|
|
|
6767
6879
|
/**
|
|
6768
6880
|
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
6769
6881
|
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
6770
|
-
*
|
|
6882
|
+
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
6771
6883
|
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
6772
6884
|
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
6773
|
-
* <p>This
|
|
6774
|
-
*
|
|
6775
|
-
* from this list doesn't prevent authentication operations
|
|
6776
|
-
* user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
6777
|
-
* block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a
|
|
6885
|
+
* <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
6886
|
+
* login</a> will display on the login page for your app client. The removal of
|
|
6887
|
+
* <code>COGNITO</code> from this list doesn't prevent authentication operations
|
|
6888
|
+
* for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
6889
|
+
* SDK-based authentication is to block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.
|
|
6890
|
+
* </p>
|
|
6778
6891
|
* @public
|
|
6779
6892
|
*/
|
|
6780
6893
|
SupportedIdentityProviders?: string[] | undefined;
|
|
6781
6894
|
/**
|
|
6782
|
-
* <p>A list of allowed redirect
|
|
6783
|
-
*
|
|
6895
|
+
* <p>A list of allowed redirect, or callback, URLs for managed login authentication. These
|
|
6896
|
+
* URLs are the paths where you want to send your users' browsers after they complete
|
|
6897
|
+
* authentication with managed login or a third-party IdP. Typically, callback URLs are the
|
|
6898
|
+
* home of an application that uses OAuth or OIDC libraries to process authentication
|
|
6899
|
+
* outcomes.</p>
|
|
6900
|
+
* <p>A redirect URI must meet the following requirements:</p>
|
|
6784
6901
|
* <ul>
|
|
6785
6902
|
* <li>
|
|
6786
6903
|
* <p>Be an absolute URI.</p>
|
|
@@ -6803,8 +6920,13 @@ export interface CreateUserPoolClientRequest {
|
|
|
6803
6920
|
*/
|
|
6804
6921
|
CallbackURLs?: string[] | undefined;
|
|
6805
6922
|
/**
|
|
6806
|
-
* <p>A list of allowed logout URLs for managed login authentication.
|
|
6807
|
-
*
|
|
6923
|
+
* <p>A list of allowed logout URLs for managed login authentication. When you pass
|
|
6924
|
+
* <code>logout_uri</code> and <code>client_id</code> parameters to
|
|
6925
|
+
* <code>/logout</code>, Amazon Cognito signs out your user and redirects them to the logout
|
|
6926
|
+
* URL. This parameter describes the URLs that you want to be the permitted targets of
|
|
6927
|
+
* <code>logout_uri</code>. A typical use of these URLs is when a user selects "Sign
|
|
6928
|
+
* out" and you redirect them to your public homepage. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html">Logout
|
|
6929
|
+
* endpoint</a>.</p>
|
|
6808
6930
|
* @public
|
|
6809
6931
|
*/
|
|
6810
6932
|
LogoutURLs?: string[] | undefined;
|
|
@@ -6816,9 +6938,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
6816
6938
|
*/
|
|
6817
6939
|
DefaultRedirectURI?: string | undefined;
|
|
6818
6940
|
/**
|
|
6819
|
-
* <p>The OAuth grant types that you want your app client to generate
|
|
6820
|
-
* client that generates client credentials grants,
|
|
6821
|
-
*
|
|
6941
|
+
* <p>The OAuth grant types that you want your app client to generate for clients in managed
|
|
6942
|
+
* login authentication. To create an app client that generates client credentials grants,
|
|
6943
|
+
* you must add <code>client_credentials</code> as the only allowed OAuth flow.</p>
|
|
6822
6944
|
* <dl>
|
|
6823
6945
|
* <dt>code</dt>
|
|
6824
6946
|
* <dd>
|
|
@@ -6828,34 +6950,34 @@ export interface CreateUserPoolClientRequest {
|
|
|
6828
6950
|
* </dd>
|
|
6829
6951
|
* <dt>implicit</dt>
|
|
6830
6952
|
* <dd>
|
|
6831
|
-
* <p>Issue the access token
|
|
6832
|
-
*
|
|
6953
|
+
* <p>Issue the access token, and the ID token when scopes like
|
|
6954
|
+
* <code>openid</code> and <code>profile</code> are requested, directly to
|
|
6955
|
+
* your user.</p>
|
|
6833
6956
|
* </dd>
|
|
6834
6957
|
* <dt>client_credentials</dt>
|
|
6835
6958
|
* <dd>
|
|
6836
6959
|
* <p>Issue the access token from the <code>/oauth2/token</code> endpoint
|
|
6837
|
-
* directly to a non-person user
|
|
6838
|
-
* client secret.</p>
|
|
6960
|
+
* directly to a non-person user, authorized by a combination of the client ID
|
|
6961
|
+
* and client secret.</p>
|
|
6839
6962
|
* </dd>
|
|
6840
6963
|
* </dl>
|
|
6841
6964
|
* @public
|
|
6842
6965
|
*/
|
|
6843
6966
|
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
6844
6967
|
/**
|
|
6845
|
-
* <p>The OAuth
|
|
6846
|
-
* govern access control to user pool self-service
|
|
6847
|
-
*
|
|
6848
|
-
*
|
|
6849
|
-
* <code>profile</code>.
|
|
6850
|
-
*
|
|
6851
|
-
*
|
|
6968
|
+
* <p>The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app
|
|
6969
|
+
* client to authorize access with. Scopes govern access control to user pool self-service
|
|
6970
|
+
* API operations, user data from the <code>userInfo</code> endpoint, and third-party APIs.
|
|
6971
|
+
* Scope values include <code>phone</code>, <code>email</code>, <code>openid</code>, and
|
|
6972
|
+
* <code>profile</code>. The <code>aws.cognito.signin.user.admin</code> scope
|
|
6973
|
+
* authorizes user self-service operations. Custom scopes with resource servers authorize
|
|
6974
|
+
* access to external APIs.</p>
|
|
6852
6975
|
* @public
|
|
6853
6976
|
*/
|
|
6854
6977
|
AllowedOAuthScopes?: string[] | undefined;
|
|
6855
6978
|
/**
|
|
6856
|
-
* <p>Set to <code>true</code> to use OAuth 2.0 features in your
|
|
6857
|
-
* <p>
|
|
6858
|
-
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
6979
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
|
|
6980
|
+
* <p>This parameter must have a value of <code>true</code> before you can configure
|
|
6859
6981
|
* the following features in your app client.</p>
|
|
6860
6982
|
* <ul>
|
|
6861
6983
|
* <li>
|
|
@@ -6875,11 +6997,11 @@ export interface CreateUserPoolClientRequest {
|
|
|
6875
6997
|
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
6876
6998
|
* </li>
|
|
6877
6999
|
* </ul>
|
|
6878
|
-
* <p>To use
|
|
7000
|
+
* <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
|
|
6879
7001
|
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
6880
7002
|
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
6881
7003
|
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
6882
|
-
* to <code>false</code
|
|
7004
|
+
* to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
|
|
6883
7005
|
* @public
|
|
6884
7006
|
*/
|
|
6885
7007
|
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
@@ -6893,45 +7015,36 @@ export interface CreateUserPoolClientRequest {
|
|
|
6893
7015
|
*/
|
|
6894
7016
|
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
6895
7017
|
/**
|
|
6896
|
-
* <p>
|
|
7018
|
+
* <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
|
|
7019
|
+
* when someone attempts sign-in. This parameters sets your preference for the errors and
|
|
7020
|
+
* responses that you want Amazon Cognito APIs to return during authentication, account
|
|
6897
7021
|
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
6898
7022
|
* set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
|
|
6899
7023
|
* indicating either the username or password was incorrect. Account confirmation and
|
|
6900
7024
|
* password recovery return a response indicating a code was sent to a simulated
|
|
6901
7025
|
* destination. When set to <code>LEGACY</code>, those APIs return a
|
|
6902
|
-
*
|
|
7026
|
+
* <code>UserNotFoundException</code> exception if the user doesn't exist in the user
|
|
6903
7027
|
* pool.</p>
|
|
6904
|
-
* <p>
|
|
6905
|
-
* <ul>
|
|
6906
|
-
* <li>
|
|
6907
|
-
* <p>
|
|
6908
|
-
* <code>ENABLED</code> - This prevents user existence-related errors.</p>
|
|
6909
|
-
* </li>
|
|
6910
|
-
* <li>
|
|
6911
|
-
* <p>
|
|
6912
|
-
* <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user
|
|
6913
|
-
* existence related errors aren't prevented.</p>
|
|
6914
|
-
* </li>
|
|
6915
|
-
* </ul>
|
|
6916
|
-
* <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
|
|
7028
|
+
* <p>Defaults to <code>LEGACY</code>.</p>
|
|
6917
7029
|
* @public
|
|
6918
7030
|
*/
|
|
6919
7031
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
6920
7032
|
/**
|
|
6921
|
-
* <p>Activates or deactivates token
|
|
6922
|
-
*
|
|
7033
|
+
* <p>Activates or deactivates <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html">token
|
|
7034
|
+
* revocation</a> in the target app client.</p>
|
|
6923
7035
|
* <p>If you don't include this parameter, token revocation is automatically activated for
|
|
6924
7036
|
* the new user pool client.</p>
|
|
6925
7037
|
* @public
|
|
6926
7038
|
*/
|
|
6927
7039
|
EnableTokenRevocation?: boolean | undefined;
|
|
6928
7040
|
/**
|
|
6929
|
-
* <p>
|
|
6930
|
-
*
|
|
6931
|
-
*
|
|
6932
|
-
*
|
|
6933
|
-
*
|
|
6934
|
-
* client
|
|
7041
|
+
* <p>When <code>true</code>, your application can include additional
|
|
7042
|
+
* <code>UserContextData</code> in authentication requests. This data includes the IP
|
|
7043
|
+
* address, and contributes to analysis by threat protection features. For more information
|
|
7044
|
+
* about propagation of user context data, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint">Adding session data to API requests</a>. If you don’t include this parameter,
|
|
7045
|
+
* you can't send the source IP address to Amazon Cognito threat protection features. You can only
|
|
7046
|
+
* activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has
|
|
7047
|
+
* a client secret.</p>
|
|
6935
7048
|
* @public
|
|
6936
7049
|
*/
|
|
6937
7050
|
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
@@ -6944,8 +7057,6 @@ export interface CreateUserPoolClientRequest {
|
|
|
6944
7057
|
}
|
|
6945
7058
|
/**
|
|
6946
7059
|
* <p>The configuration of a user pool client.</p>
|
|
6947
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html">CreateUserPoolClient</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html">UpdateUserPoolClient</a>, and a response parameter of
|
|
6948
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">DescribeUserPoolClient</a>.</p>
|
|
6949
7060
|
* @public
|
|
6950
7061
|
*/
|
|
6951
7062
|
export interface UserPoolClientType {
|
|
@@ -7039,15 +7150,12 @@ export interface UserPoolClientType {
|
|
|
7039
7150
|
/**
|
|
7040
7151
|
* <p>The list of user attributes that you want your app client to have read access to.
|
|
7041
7152
|
* After your user authenticates in your app, their access token authorizes them to read
|
|
7042
|
-
* their own attribute value for any attribute in this list
|
|
7043
|
-
* activity is when your user selects a link to view their profile information. Your app
|
|
7044
|
-
* makes a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUser.html">GetUser</a> API request to retrieve and display your user's profile
|
|
7045
|
-
* data.</p>
|
|
7153
|
+
* their own attribute value for any attribute in this list.</p>
|
|
7046
7154
|
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
7047
7155
|
* app can read the values of <code>email_verified</code>,
|
|
7048
|
-
*
|
|
7156
|
+
* <code>phone_number_verified</code>, and the standard attributes of your user pool.
|
|
7049
7157
|
* When your user pool app client has read access to these default attributes,
|
|
7050
|
-
*
|
|
7158
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
7051
7159
|
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
7052
7160
|
* custom set of read attributes.</p>
|
|
7053
7161
|
* @public
|
|
@@ -7056,10 +7164,7 @@ export interface UserPoolClientType {
|
|
|
7056
7164
|
/**
|
|
7057
7165
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
7058
7166
|
* After your user authenticates in your app, their access token authorizes them to set or
|
|
7059
|
-
* modify their own attribute value for any attribute in this list
|
|
7060
|
-
* of activity is when you present your user with a form to update their profile
|
|
7061
|
-
* information and they change their last name. Your app then makes an <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserAttributes.html">UpdateUserAttributes</a> API request and sets <code>family_name</code> to the
|
|
7062
|
-
* new value. </p>
|
|
7167
|
+
* modify their own attribute value for any attribute in this list.</p>
|
|
7063
7168
|
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
7064
7169
|
* app can write the values of the Standard attributes of your user pool. When your user
|
|
7065
7170
|
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
@@ -7076,13 +7181,16 @@ export interface UserPoolClientType {
|
|
|
7076
7181
|
*/
|
|
7077
7182
|
WriteAttributes?: string[] | undefined;
|
|
7078
7183
|
/**
|
|
7079
|
-
* <p>The authentication flows that you want your user pool client to support. For each app
|
|
7080
|
-
* your users with any combination of one or more flows, including with
|
|
7081
|
-
* password, or a custom authentication process that
|
|
7184
|
+
* <p>The <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow-methods.html">authentication flows</a> that you want your user pool client to support. For each app
|
|
7185
|
+
* client in your user pool, you can sign in your users with any combination of one or more flows, including with
|
|
7186
|
+
* a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
|
|
7187
|
+
* you define with Lambda functions.</p>
|
|
7082
7188
|
* <note>
|
|
7083
|
-
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your
|
|
7189
|
+
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
|
|
7190
|
+
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
|
|
7191
|
+
* </p>
|
|
7084
7192
|
* </note>
|
|
7085
|
-
* <p>
|
|
7193
|
+
* <p>The values for authentication flow options include the following.</p>
|
|
7086
7194
|
* <ul>
|
|
7087
7195
|
* <li>
|
|
7088
7196
|
* <p>
|
|
@@ -7095,6 +7203,8 @@ export interface UserPoolClientType {
|
|
|
7095
7203
|
* without the flow <code>USER_SRP_AUTH</code> being active for the app
|
|
7096
7204
|
* client. This flow doesn't include <code>CUSTOM_AUTH</code>.
|
|
7097
7205
|
* </p>
|
|
7206
|
+
* <p>To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
7207
|
+
* Essentials tier</a> or higher.</p>
|
|
7098
7208
|
* </li>
|
|
7099
7209
|
* <li>
|
|
7100
7210
|
* <p>
|
|
@@ -7134,14 +7244,15 @@ export interface UserPoolClientType {
|
|
|
7134
7244
|
/**
|
|
7135
7245
|
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
7136
7246
|
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
7137
|
-
*
|
|
7247
|
+
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
7138
7248
|
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
7139
7249
|
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
7140
|
-
* <p>This
|
|
7141
|
-
*
|
|
7142
|
-
* from this list doesn't prevent authentication operations
|
|
7143
|
-
* user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
7144
|
-
* block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a
|
|
7250
|
+
* <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
7251
|
+
* login</a> will display on the login page for your app client. The removal of
|
|
7252
|
+
* <code>COGNITO</code> from this list doesn't prevent authentication operations
|
|
7253
|
+
* for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
7254
|
+
* SDK-based authentication is to block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a>.
|
|
7255
|
+
* </p>
|
|
7145
7256
|
* @public
|
|
7146
7257
|
*/
|
|
7147
7258
|
SupportedIdentityProviders?: string[] | undefined;
|
|
@@ -7230,9 +7341,8 @@ export interface UserPoolClientType {
|
|
|
7230
7341
|
*/
|
|
7231
7342
|
AllowedOAuthScopes?: string[] | undefined;
|
|
7232
7343
|
/**
|
|
7233
|
-
* <p>Set to <code>true</code> to use OAuth 2.0 features in your
|
|
7234
|
-
* <p>
|
|
7235
|
-
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
7344
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
|
|
7345
|
+
* <p>This parameter must have a value of <code>true</code> before you can configure
|
|
7236
7346
|
* the following features in your app client.</p>
|
|
7237
7347
|
* <ul>
|
|
7238
7348
|
* <li>
|
|
@@ -7252,11 +7362,11 @@ export interface UserPoolClientType {
|
|
|
7252
7362
|
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
7253
7363
|
* </li>
|
|
7254
7364
|
* </ul>
|
|
7255
|
-
* <p>To use
|
|
7365
|
+
* <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
|
|
7256
7366
|
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
7257
7367
|
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
7258
7368
|
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
7259
|
-
* to <code>false</code
|
|
7369
|
+
* to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
|
|
7260
7370
|
* @public
|
|
7261
7371
|
*/
|
|
7262
7372
|
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
@@ -7273,34 +7383,23 @@ export interface UserPoolClientType {
|
|
|
7273
7383
|
*/
|
|
7274
7384
|
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
7275
7385
|
/**
|
|
7276
|
-
* <p>
|
|
7386
|
+
* <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
|
|
7387
|
+
* when someone attempts sign-in. This parameters sets your preference for the errors and
|
|
7388
|
+
* responses that you want Amazon Cognito APIs to return during authentication, account
|
|
7277
7389
|
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
7278
7390
|
* set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
|
|
7279
7391
|
* indicating either the username or password was incorrect. Account confirmation and
|
|
7280
7392
|
* password recovery return a response indicating a code was sent to a simulated
|
|
7281
7393
|
* destination. When set to <code>LEGACY</code>, those APIs return a
|
|
7282
|
-
*
|
|
7394
|
+
* <code>UserNotFoundException</code> exception if the user doesn't exist in the user
|
|
7283
7395
|
* pool.</p>
|
|
7284
|
-
* <p>
|
|
7285
|
-
* <ul>
|
|
7286
|
-
* <li>
|
|
7287
|
-
* <p>
|
|
7288
|
-
* <code>ENABLED</code> - This prevents user existence-related errors.</p>
|
|
7289
|
-
* </li>
|
|
7290
|
-
* <li>
|
|
7291
|
-
* <p>
|
|
7292
|
-
* <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user
|
|
7293
|
-
* existence related errors aren't prevented.</p>
|
|
7294
|
-
* </li>
|
|
7295
|
-
* </ul>
|
|
7296
|
-
* <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
|
|
7396
|
+
* <p>Defaults to <code>LEGACY</code>.</p>
|
|
7297
7397
|
* @public
|
|
7298
7398
|
*/
|
|
7299
7399
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
7300
7400
|
/**
|
|
7301
7401
|
* <p>Indicates whether token revocation is activated for the user pool client. When you
|
|
7302
|
-
* create a new user pool client, token revocation is activated by default
|
|
7303
|
-
* information about revoking tokens, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html">RevokeToken</a>.</p>
|
|
7402
|
+
* create a new user pool client, token revocation is activated by default.</p>
|
|
7304
7403
|
* @public
|
|
7305
7404
|
*/
|
|
7306
7405
|
EnableTokenRevocation?: boolean | undefined;
|
|
@@ -7308,11 +7407,11 @@ export interface UserPoolClientType {
|
|
|
7308
7407
|
* <p>When <code>EnablePropagateAdditionalUserContextData</code> is true, Amazon Cognito accepts an
|
|
7309
7408
|
* <code>IpAddress</code> value that you send in the <code>UserContextData</code>
|
|
7310
7409
|
* parameter. The <code>UserContextData</code> parameter sends information to Amazon Cognito
|
|
7311
|
-
*
|
|
7410
|
+
* threat protection for risk analysis. You can send <code>UserContextData</code> when you
|
|
7312
7411
|
* sign in Amazon Cognito native users with the <code>InitiateAuth</code> and
|
|
7313
7412
|
* <code>RespondToAuthChallenge</code> API operations.</p>
|
|
7314
7413
|
* <p>When <code>EnablePropagateAdditionalUserContextData</code> is false, you can't send
|
|
7315
|
-
* your user's source IP address to Amazon Cognito
|
|
7414
|
+
* your user's source IP address to Amazon Cognito threat protection with unauthenticated API
|
|
7316
7415
|
* operations. <code>EnablePropagateAdditionalUserContextData</code> doesn't affect whether
|
|
7317
7416
|
* you can send a source IP address in a <code>ContextData</code> parameter with the
|
|
7318
7417
|
* authenticated API operations <code>AdminInitiateAuth</code> and
|
|
@@ -7367,7 +7466,6 @@ export declare class ScopeDoesNotExistException extends __BaseException {
|
|
|
7367
7466
|
}
|
|
7368
7467
|
/**
|
|
7369
7468
|
* <p>The configuration for a hosted UI custom domain.</p>
|
|
7370
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html">CreateUserPoolDomain</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html">UpdateUserPoolDomain</a>.</p>
|
|
7371
7469
|
* @public
|
|
7372
7470
|
*/
|
|
7373
7471
|
export interface CustomDomainConfigType {
|
|
@@ -7386,7 +7484,7 @@ export interface CreateUserPoolDomainRequest {
|
|
|
7386
7484
|
* <p>The domain string. For custom domains, this is the fully-qualified domain name, such
|
|
7387
7485
|
* as <code>auth.example.com</code>. For prefix domains, this is the prefix alone, such as
|
|
7388
7486
|
* <code>myprefix</code>. A prefix value of <code>myprefix</code> for a user pool in
|
|
7389
|
-
* the us-east-1 Region results in a domain of
|
|
7487
|
+
* the <code>us-east-1</code> Region results in a domain of
|
|
7390
7488
|
* <code>myprefix.auth.us-east-1.amazoncognito.com</code>.</p>
|
|
7391
7489
|
* @public
|
|
7392
7490
|
*/
|
|
@@ -7407,9 +7505,12 @@ export interface CreateUserPoolDomainRequest {
|
|
|
7407
7505
|
/**
|
|
7408
7506
|
* <p>The configuration for a custom domain. Configures your domain with an Certificate Manager
|
|
7409
7507
|
* certificate in the <code>us-east-1</code> Region.</p>
|
|
7410
|
-
* <p>Provide this parameter only if you want to use a custom domain for your user pool.
|
|
7411
|
-
*
|
|
7412
|
-
* <p>
|
|
7508
|
+
* <p>Provide this parameter only if you want to use a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html">custom domain</a> for your user pool. Otherwise, you can
|
|
7509
|
+
* omit this parameter and use a <a href="cognito/latest/developerguide/cognito-user-pools-assign-domain-prefix.html">prefix domain</a> instead.</p>
|
|
7510
|
+
* <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If
|
|
7511
|
+
* you had a prefix domain active, this will cause passkey integration for your prefix
|
|
7512
|
+
* domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey
|
|
7513
|
+
* integration working, you can explicitly set RP ID to the prefix domain.</p>
|
|
7413
7514
|
* @public
|
|
7414
7515
|
*/
|
|
7415
7516
|
CustomDomainConfig?: CustomDomainConfigType | undefined;
|
|
@@ -7426,10 +7527,11 @@ export interface CreateUserPoolDomainResponse {
|
|
|
7426
7527
|
*/
|
|
7427
7528
|
ManagedLoginVersion?: number | undefined;
|
|
7428
7529
|
/**
|
|
7429
|
-
* <p>The
|
|
7430
|
-
*
|
|
7431
|
-
*
|
|
7432
|
-
*
|
|
7530
|
+
* <p>The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your
|
|
7531
|
+
* managed login or classic hosted UI pages. Your domain-name authority must have an alias
|
|
7532
|
+
* record that points requests for your custom domain to this FQDN. Amazon Cognito returns this
|
|
7533
|
+
* value if you set a custom domain with <code>CustomDomainConfig</code>. If you set an
|
|
7534
|
+
* Amazon Cognito prefix domain, this parameter returns null.</p>
|
|
7433
7535
|
* @public
|
|
7434
7536
|
*/
|
|
7435
7537
|
CloudFrontDomain?: string | undefined;
|
|
@@ -7513,8 +7615,8 @@ export interface DeleteResourceServerRequest {
|
|
|
7513
7615
|
*/
|
|
7514
7616
|
export interface DeleteUserRequest {
|
|
7515
7617
|
/**
|
|
7516
|
-
* <p>A valid access token that Amazon Cognito issued to the
|
|
7517
|
-
*
|
|
7618
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
7619
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
7518
7620
|
* @public
|
|
7519
7621
|
*/
|
|
7520
7622
|
AccessToken: string | undefined;
|
|
@@ -7532,8 +7634,8 @@ export interface DeleteUserAttributesRequest {
|
|
|
7532
7634
|
*/
|
|
7533
7635
|
UserAttributeNames: string[] | undefined;
|
|
7534
7636
|
/**
|
|
7535
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
7536
|
-
*
|
|
7637
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
7638
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
7537
7639
|
* @public
|
|
7538
7640
|
*/
|
|
7539
7641
|
AccessToken: string | undefined;
|
|
@@ -7577,8 +7679,8 @@ export interface DeleteUserPoolClientRequest {
|
|
|
7577
7679
|
export interface DeleteUserPoolDomainRequest {
|
|
7578
7680
|
/**
|
|
7579
7681
|
* <p>The domain that you want to delete. For custom domains, this is the fully-qualified
|
|
7580
|
-
* domain name
|
|
7581
|
-
*
|
|
7682
|
+
* domain name like <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the
|
|
7683
|
+
* prefix alone, like <code>myprefix</code>.</p>
|
|
7582
7684
|
* @public
|
|
7583
7685
|
*/
|
|
7584
7686
|
Domain: string | undefined;
|
|
@@ -7598,14 +7700,13 @@ export interface DeleteUserPoolDomainResponse {
|
|
|
7598
7700
|
*/
|
|
7599
7701
|
export interface DeleteWebAuthnCredentialRequest {
|
|
7600
7702
|
/**
|
|
7601
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
7602
|
-
*
|
|
7703
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
7704
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
7603
7705
|
* @public
|
|
7604
7706
|
*/
|
|
7605
7707
|
AccessToken: string | undefined;
|
|
7606
7708
|
/**
|
|
7607
|
-
* <p>The unique identifier of the passkey that you want to delete
|
|
7608
|
-
* devices with <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">ListWebAuthnCredentials</a>.</p>
|
|
7709
|
+
* <p>The unique identifier of the passkey that you want to delete.</p>
|
|
7609
7710
|
* @public
|
|
7610
7711
|
*/
|
|
7611
7712
|
CredentialId: string | undefined;
|
|
@@ -7775,8 +7876,7 @@ export declare const CompromisedCredentialsEventActionType: {
|
|
|
7775
7876
|
export type CompromisedCredentialsEventActionType = (typeof CompromisedCredentialsEventActionType)[keyof typeof CompromisedCredentialsEventActionType];
|
|
7776
7877
|
/**
|
|
7777
7878
|
* <p>Settings for user pool actions when Amazon Cognito detects compromised credentials with
|
|
7778
|
-
*
|
|
7779
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
7879
|
+
* threat protection in full-function <code>ENFORCED</code> mode.</p>
|
|
7780
7880
|
* @public
|
|
7781
7881
|
*/
|
|
7782
7882
|
export interface CompromisedCredentialsActionsType {
|
|
@@ -7801,8 +7901,7 @@ export declare const EventFilterType: {
|
|
|
7801
7901
|
export type EventFilterType = (typeof EventFilterType)[keyof typeof EventFilterType];
|
|
7802
7902
|
/**
|
|
7803
7903
|
* <p>Settings for compromised-credentials actions and authentication-event sources with
|
|
7804
|
-
*
|
|
7805
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
7904
|
+
* threat protection in full-function <code>ENFORCED</code> mode.</p>
|
|
7806
7905
|
* @public
|
|
7807
7906
|
*/
|
|
7808
7907
|
export interface CompromisedCredentialsRiskConfigurationType {
|
|
@@ -7822,7 +7921,6 @@ export interface CompromisedCredentialsRiskConfigurationType {
|
|
|
7822
7921
|
/**
|
|
7823
7922
|
* <p>Exceptions to the risk evaluation configuration, including always-allow and
|
|
7824
7923
|
* always-block IP address ranges. </p>
|
|
7825
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a>.</p>
|
|
7826
7924
|
* @public
|
|
7827
7925
|
*/
|
|
7828
7926
|
export interface RiskExceptionConfigurationType {
|
|
@@ -7840,9 +7938,7 @@ export interface RiskExceptionConfigurationType {
|
|
|
7840
7938
|
SkippedIPRangeList?: string[] | undefined;
|
|
7841
7939
|
}
|
|
7842
7940
|
/**
|
|
7843
|
-
* <p>The settings of risk configuration for threat protection with
|
|
7844
|
-
* features in a user pool.</p>
|
|
7845
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html">DescribeRiskConfiguration</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html">SetRiskConfiguration</a>.</p>
|
|
7941
|
+
* <p>The settings of risk configuration for threat protection with threat protection in a user pool.</p>
|
|
7846
7942
|
* @public
|
|
7847
7943
|
*/
|
|
7848
7944
|
export interface RiskConfigurationType {
|
|
@@ -7859,14 +7955,13 @@ export interface RiskConfigurationType {
|
|
|
7859
7955
|
*/
|
|
7860
7956
|
ClientId?: string | undefined;
|
|
7861
7957
|
/**
|
|
7862
|
-
* <p>Settings for compromised-credentials actions and authentication types with
|
|
7863
|
-
* security features in full-function <code>ENFORCED</code> mode.</p>
|
|
7958
|
+
* <p>Settings for compromised-credentials actions and authentication types with threat protection in full-function <code>ENFORCED</code> mode.</p>
|
|
7864
7959
|
* @public
|
|
7865
7960
|
*/
|
|
7866
7961
|
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
|
|
7867
7962
|
/**
|
|
7868
7963
|
* <p>The settings for automated responses and notification templates for adaptive
|
|
7869
|
-
* authentication with
|
|
7964
|
+
* authentication with threat protection.</p>
|
|
7870
7965
|
* @public
|
|
7871
7966
|
*/
|
|
7872
7967
|
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
|
|
@@ -7916,7 +8011,8 @@ export interface DescribeUserImportJobRequest {
|
|
|
7916
8011
|
*/
|
|
7917
8012
|
export interface DescribeUserImportJobResponse {
|
|
7918
8013
|
/**
|
|
7919
|
-
* <p>The details of the user import job
|
|
8014
|
+
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
8015
|
+
* pre-signed URL for CSV upload.</p>
|
|
7920
8016
|
* @public
|
|
7921
8017
|
*/
|
|
7922
8018
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -8001,7 +8097,6 @@ export type DomainStatusType = (typeof DomainStatusType)[keyof typeof DomainStat
|
|
|
8001
8097
|
/**
|
|
8002
8098
|
* <p>A container for information about the user pool domain associated with the hosted UI
|
|
8003
8099
|
* and OAuth endpoints.</p>
|
|
8004
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolDomain.html">DescribeUserPoolDomain</a>.</p>
|
|
8005
8100
|
* @public
|
|
8006
8101
|
*/
|
|
8007
8102
|
export interface DomainDescriptionType {
|
|
@@ -8073,13 +8168,14 @@ export interface DescribeUserPoolDomainResponse {
|
|
|
8073
8168
|
*/
|
|
8074
8169
|
export interface ForgetDeviceRequest {
|
|
8075
8170
|
/**
|
|
8076
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
8077
|
-
*
|
|
8171
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
8172
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
8078
8173
|
* @public
|
|
8079
8174
|
*/
|
|
8080
8175
|
AccessToken?: string | undefined;
|
|
8081
8176
|
/**
|
|
8082
|
-
* <p>The device key
|
|
8177
|
+
* <p>The unique identifier, or device key, of the device that the user wants to
|
|
8178
|
+
* forget.</p>
|
|
8083
8179
|
* @public
|
|
8084
8180
|
*/
|
|
8085
8181
|
DeviceKey: string | undefined;
|
|
@@ -8090,7 +8186,7 @@ export interface ForgetDeviceRequest {
|
|
|
8090
8186
|
*/
|
|
8091
8187
|
export interface ForgotPasswordRequest {
|
|
8092
8188
|
/**
|
|
8093
|
-
* <p>The ID of the client associated with the user
|
|
8189
|
+
* <p>The ID of the user pool app client associated with the current signed-in user.</p>
|
|
8094
8190
|
* @public
|
|
8095
8191
|
*/
|
|
8096
8192
|
ClientId: string | undefined;
|
|
@@ -8102,8 +8198,8 @@ export interface ForgotPasswordRequest {
|
|
|
8102
8198
|
*/
|
|
8103
8199
|
SecretHash?: string | undefined;
|
|
8104
8200
|
/**
|
|
8105
|
-
* <p>Contextual data about your user session
|
|
8106
|
-
*
|
|
8201
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
8202
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
8107
8203
|
* when it makes API requests.</p>
|
|
8108
8204
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-viewing-threat-protection-app.html">Collecting data for threat protection in
|
|
8109
8205
|
* applications</a>.</p>
|
|
@@ -8111,7 +8207,7 @@ export interface ForgotPasswordRequest {
|
|
|
8111
8207
|
*/
|
|
8112
8208
|
UserContextData?: UserContextDataType | undefined;
|
|
8113
8209
|
/**
|
|
8114
|
-
* <p>The
|
|
8210
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
8115
8211
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
8116
8212
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
8117
8213
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -8120,8 +8216,9 @@ export interface ForgotPasswordRequest {
|
|
|
8120
8216
|
*/
|
|
8121
8217
|
Username: string | undefined;
|
|
8122
8218
|
/**
|
|
8123
|
-
* <p>
|
|
8124
|
-
*
|
|
8219
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
8220
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
8221
|
+
* email address, or phone number.</p>
|
|
8125
8222
|
* @public
|
|
8126
8223
|
*/
|
|
8127
8224
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
@@ -8139,7 +8236,7 @@ export interface ForgotPasswordRequest {
|
|
|
8139
8236
|
* process the <code>clientMetadata</code> value to enhance your workflow for your specific
|
|
8140
8237
|
* needs.</p>
|
|
8141
8238
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
8142
|
-
*
|
|
8239
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
8143
8240
|
* <note>
|
|
8144
8241
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
8145
8242
|
* following:</p>
|
|
@@ -8166,8 +8263,6 @@ export interface ForgotPasswordRequest {
|
|
|
8166
8263
|
/**
|
|
8167
8264
|
* <p>The delivery details for an email or SMS message that Amazon Cognito sent for authentication or
|
|
8168
8265
|
* verification.</p>
|
|
8169
|
-
* <p>This data type is a response parameter of operations that send a code for user profile
|
|
8170
|
-
* confirmation, verification, or management, for example <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html">ForgotPassword</a> and <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html">SignUp</a>.</p>
|
|
8171
8266
|
* @public
|
|
8172
8267
|
*/
|
|
8173
8268
|
export interface CodeDeliveryDetailsType {
|
|
@@ -8193,8 +8288,8 @@ export interface CodeDeliveryDetailsType {
|
|
|
8193
8288
|
*/
|
|
8194
8289
|
export interface ForgotPasswordResponse {
|
|
8195
8290
|
/**
|
|
8196
|
-
* <p>
|
|
8197
|
-
* password.</p>
|
|
8291
|
+
* <p>Information about the phone number or email address that Amazon Cognito sent the
|
|
8292
|
+
* password-recovery code to.</p>
|
|
8198
8293
|
* @public
|
|
8199
8294
|
*/
|
|
8200
8295
|
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
@@ -8206,7 +8301,7 @@ export interface ForgotPasswordResponse {
|
|
|
8206
8301
|
*/
|
|
8207
8302
|
export interface GetCSVHeaderRequest {
|
|
8208
8303
|
/**
|
|
8209
|
-
* <p>The ID of the user pool that
|
|
8304
|
+
* <p>The ID of the user pool that you want to import users into.</p>
|
|
8210
8305
|
* @public
|
|
8211
8306
|
*/
|
|
8212
8307
|
UserPoolId: string | undefined;
|
|
@@ -8218,12 +8313,14 @@ export interface GetCSVHeaderRequest {
|
|
|
8218
8313
|
*/
|
|
8219
8314
|
export interface GetCSVHeaderResponse {
|
|
8220
8315
|
/**
|
|
8221
|
-
* <p>The ID of the user pool
|
|
8316
|
+
* <p>The ID of the requested user pool.</p>
|
|
8222
8317
|
* @public
|
|
8223
8318
|
*/
|
|
8224
8319
|
UserPoolId?: string | undefined;
|
|
8225
8320
|
/**
|
|
8226
|
-
* <p>
|
|
8321
|
+
* <p>A comma-separated list of attributes from your user pool. Save this output to a
|
|
8322
|
+
* <code>.csv</code> file and populate it with the attributes of the users that you
|
|
8323
|
+
* want to import.</p>
|
|
8227
8324
|
* @public
|
|
8228
8325
|
*/
|
|
8229
8326
|
CSVHeader?: string[] | undefined;
|
|
@@ -8234,13 +8331,13 @@ export interface GetCSVHeaderResponse {
|
|
|
8234
8331
|
*/
|
|
8235
8332
|
export interface GetDeviceRequest {
|
|
8236
8333
|
/**
|
|
8237
|
-
* <p>The device
|
|
8334
|
+
* <p>The key of the device that you want to get information about.</p>
|
|
8238
8335
|
* @public
|
|
8239
8336
|
*/
|
|
8240
8337
|
DeviceKey: string | undefined;
|
|
8241
8338
|
/**
|
|
8242
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
8243
|
-
*
|
|
8339
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
8340
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
8244
8341
|
* @public
|
|
8245
8342
|
*/
|
|
8246
8343
|
AccessToken?: string | undefined;
|
|
@@ -8251,7 +8348,8 @@ export interface GetDeviceRequest {
|
|
|
8251
8348
|
*/
|
|
8252
8349
|
export interface GetDeviceResponse {
|
|
8253
8350
|
/**
|
|
8254
|
-
* <p>
|
|
8351
|
+
* <p>Details of the requested device. Includes device information, last-accessed and
|
|
8352
|
+
* created dates, and the device key.</p>
|
|
8255
8353
|
* @public
|
|
8256
8354
|
*/
|
|
8257
8355
|
Device: DeviceType | undefined;
|
|
@@ -8261,12 +8359,12 @@ export interface GetDeviceResponse {
|
|
|
8261
8359
|
*/
|
|
8262
8360
|
export interface GetGroupRequest {
|
|
8263
8361
|
/**
|
|
8264
|
-
* <p>The name of the group.</p>
|
|
8362
|
+
* <p>The name of the group that you want to get information about.</p>
|
|
8265
8363
|
* @public
|
|
8266
8364
|
*/
|
|
8267
8365
|
GroupName: string | undefined;
|
|
8268
8366
|
/**
|
|
8269
|
-
* <p>The ID of the user pool.</p>
|
|
8367
|
+
* <p>The ID of the user pool that contains the group that you want to query.</p>
|
|
8270
8368
|
* @public
|
|
8271
8369
|
*/
|
|
8272
8370
|
UserPoolId: string | undefined;
|
|
@@ -8276,7 +8374,8 @@ export interface GetGroupRequest {
|
|
|
8276
8374
|
*/
|
|
8277
8375
|
export interface GetGroupResponse {
|
|
8278
8376
|
/**
|
|
8279
|
-
* <p>
|
|
8377
|
+
* <p>A container for the requested group. Includes description, precedence, and IAM role
|
|
8378
|
+
* values.</p>
|
|
8280
8379
|
* @public
|
|
8281
8380
|
*/
|
|
8282
8381
|
Group?: GroupType | undefined;
|
|
@@ -8286,12 +8385,15 @@ export interface GetGroupResponse {
|
|
|
8286
8385
|
*/
|
|
8287
8386
|
export interface GetIdentityProviderByIdentifierRequest {
|
|
8288
8387
|
/**
|
|
8289
|
-
* <p>The user pool
|
|
8388
|
+
* <p>The ID of the user pool where you want to get information about the IdP.</p>
|
|
8290
8389
|
* @public
|
|
8291
8390
|
*/
|
|
8292
8391
|
UserPoolId: string | undefined;
|
|
8293
8392
|
/**
|
|
8294
|
-
* <p>The
|
|
8393
|
+
* <p>The identifier that you assigned to your user pool. The identifier is an alternative
|
|
8394
|
+
* name for an IdP that is distinct from the IdP name. For example, an IdP with a name of
|
|
8395
|
+
* <code>MyIdP</code> might have an identifier of the email domain
|
|
8396
|
+
* <code>example.com</code>.</p>
|
|
8295
8397
|
* @public
|
|
8296
8398
|
*/
|
|
8297
8399
|
IdpIdentifier: string | undefined;
|
|
@@ -8301,7 +8403,8 @@ export interface GetIdentityProviderByIdentifierRequest {
|
|
|
8301
8403
|
*/
|
|
8302
8404
|
export interface GetIdentityProviderByIdentifierResponse {
|
|
8303
8405
|
/**
|
|
8304
|
-
* <p>The
|
|
8406
|
+
* <p>The configuration of the IdP in your user pool. Includes additional identifiers, the
|
|
8407
|
+
* IdP name and type, and trust-relationship details like the issuer URL.</p>
|
|
8305
8408
|
* @public
|
|
8306
8409
|
*/
|
|
8307
8410
|
IdentityProvider: IdentityProviderType | undefined;
|
|
@@ -8319,9 +8422,7 @@ export interface GetLogDeliveryConfigurationRequest {
|
|
|
8319
8422
|
}
|
|
8320
8423
|
/**
|
|
8321
8424
|
* <p>Configuration for the CloudWatch log group destination of user pool detailed activity
|
|
8322
|
-
* logging, or of user activity log export with
|
|
8323
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html">SetLogDeliveryConfiguration</a> and a response parameter of
|
|
8324
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html">GetLogDeliveryConfiguration</a>.</p>
|
|
8425
|
+
* logging, or of user activity log export with threat protection.</p>
|
|
8325
8426
|
* @public
|
|
8326
8427
|
*/
|
|
8327
8428
|
export interface CloudWatchLogsConfigurationType {
|
|
@@ -8351,13 +8452,12 @@ export declare const EventSourceName: {
|
|
|
8351
8452
|
export type EventSourceName = (typeof EventSourceName)[keyof typeof EventSourceName];
|
|
8352
8453
|
/**
|
|
8353
8454
|
* <p>Configuration for the Amazon Data Firehose stream destination of user activity log export with
|
|
8354
|
-
*
|
|
8455
|
+
* threat protection.</p>
|
|
8355
8456
|
* @public
|
|
8356
8457
|
*/
|
|
8357
8458
|
export interface FirehoseConfigurationType {
|
|
8358
8459
|
/**
|
|
8359
|
-
* <p>The ARN of an Amazon Data Firehose stream that's the destination for
|
|
8360
|
-
* features log export.</p>
|
|
8460
|
+
* <p>The ARN of an Amazon Data Firehose stream that's the destination for threat protection log export.</p>
|
|
8361
8461
|
* @public
|
|
8362
8462
|
*/
|
|
8363
8463
|
StreamArn?: string | undefined;
|
|
@@ -8376,12 +8476,12 @@ export declare const LogLevel: {
|
|
|
8376
8476
|
export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
|
|
8377
8477
|
/**
|
|
8378
8478
|
* <p>Configuration for the Amazon S3 bucket destination of user activity log export with
|
|
8379
|
-
*
|
|
8479
|
+
* threat protection.</p>
|
|
8380
8480
|
* @public
|
|
8381
8481
|
*/
|
|
8382
8482
|
export interface S3ConfigurationType {
|
|
8383
8483
|
/**
|
|
8384
|
-
* <p>The ARN of an Amazon S3 bucket that's the destination for
|
|
8484
|
+
* <p>The ARN of an Amazon S3 bucket that's the destination for threat protection
|
|
8385
8485
|
* log export.</p>
|
|
8386
8486
|
* @public
|
|
8387
8487
|
*/
|
|
@@ -8390,52 +8490,50 @@ export interface S3ConfigurationType {
|
|
|
8390
8490
|
/**
|
|
8391
8491
|
* <p>The configuration of user event logs to an external Amazon Web Services service like
|
|
8392
8492
|
* Amazon Data Firehose, Amazon S3, or Amazon CloudWatch Logs.</p>
|
|
8393
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetLogDeliveryConfiguration.html">SetLogDeliveryConfiguration</a> and a response parameter of
|
|
8394
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetLogDeliveryConfiguration.html">GetLogDeliveryConfiguration</a>.</p>
|
|
8395
8493
|
* @public
|
|
8396
8494
|
*/
|
|
8397
8495
|
export interface LogConfigurationType {
|
|
8398
8496
|
/**
|
|
8399
8497
|
* <p>The <code>errorlevel</code> selection of logs that a user pool sends for detailed
|
|
8400
|
-
* activity logging. To send <code>userNotification</code> activity with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/
|
|
8498
|
+
* activity logging. To send <code>userNotification</code> activity with <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html">information
|
|
8499
|
+
* about message delivery</a>, choose <code>ERROR</code> with
|
|
8401
8500
|
* <code>CloudWatchLogsConfiguration</code>. To send <code>userAuthEvents</code>
|
|
8402
|
-
* activity with user logs from
|
|
8403
|
-
*
|
|
8404
|
-
* <code>S3Configuration</code>.</p>
|
|
8501
|
+
* activity with user logs from threat protection with the Plus feature plan, choose
|
|
8502
|
+
* <code>INFO</code> with one of <code>CloudWatchLogsConfiguration</code>,
|
|
8503
|
+
* <code>FirehoseConfiguration</code>, or <code>S3Configuration</code>.</p>
|
|
8405
8504
|
* @public
|
|
8406
8505
|
*/
|
|
8407
8506
|
LogLevel: LogLevel | undefined;
|
|
8408
8507
|
/**
|
|
8409
8508
|
* <p>The source of events that your user pool sends for logging. To send error-level logs
|
|
8410
8509
|
* about user notification activity, set to <code>userNotification</code>. To send
|
|
8411
|
-
* info-level logs about
|
|
8412
|
-
*
|
|
8510
|
+
* info-level logs about threat-protection user activity in user pools with the Plus
|
|
8511
|
+
* feature plan, set to <code>userAuthEvents</code>.</p>
|
|
8413
8512
|
* @public
|
|
8414
8513
|
*/
|
|
8415
8514
|
EventSource: EventSourceName | undefined;
|
|
8416
8515
|
/**
|
|
8417
8516
|
* <p>The CloudWatch log group destination of user pool detailed activity logs, or of user
|
|
8418
|
-
* activity log export with
|
|
8517
|
+
* activity log export with threat protection.</p>
|
|
8419
8518
|
* @public
|
|
8420
8519
|
*/
|
|
8421
8520
|
CloudWatchLogsConfiguration?: CloudWatchLogsConfigurationType | undefined;
|
|
8422
8521
|
/**
|
|
8423
|
-
* <p>The Amazon S3 bucket destination of user activity log export with
|
|
8424
|
-
*
|
|
8425
|
-
* advanced security features</a> must be active in your user pool.</p>
|
|
8522
|
+
* <p>The Amazon S3 bucket destination of user activity log export with threat protection. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
8523
|
+
* Plus tier</a>.</p>
|
|
8426
8524
|
* @public
|
|
8427
8525
|
*/
|
|
8428
8526
|
S3Configuration?: S3ConfigurationType | undefined;
|
|
8429
8527
|
/**
|
|
8430
|
-
* <p>The Amazon Data Firehose stream destination of user activity log export with
|
|
8431
|
-
*
|
|
8432
|
-
* advanced security features</a> must be active in your user pool.</p>
|
|
8528
|
+
* <p>The Amazon Data Firehose stream destination of user activity log export with threat protection. To activate this setting, your user pool must be on the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-plus.html">
|
|
8529
|
+
* Plus tier</a>.</p>
|
|
8433
8530
|
* @public
|
|
8434
8531
|
*/
|
|
8435
8532
|
FirehoseConfiguration?: FirehoseConfigurationType | undefined;
|
|
8436
8533
|
}
|
|
8437
8534
|
/**
|
|
8438
|
-
* <p>The logging parameters of a user pool, as returned in the response to a
|
|
8535
|
+
* <p>The logging parameters of a user pool, as returned in the response to a
|
|
8536
|
+
* <code>GetLogDeliveryConfiguration</code> request.</p>
|
|
8439
8537
|
* @public
|
|
8440
8538
|
*/
|
|
8441
8539
|
export interface LogDeliveryConfigurationType {
|
|
@@ -8456,7 +8554,8 @@ export interface LogDeliveryConfigurationType {
|
|
|
8456
8554
|
*/
|
|
8457
8555
|
export interface GetLogDeliveryConfigurationResponse {
|
|
8458
8556
|
/**
|
|
8459
|
-
* <p>The logging configuration of the requested user pool
|
|
8557
|
+
* <p>The logging configuration of the requested user pool. Includes types of logs
|
|
8558
|
+
* configured and their destinations.</p>
|
|
8460
8559
|
* @public
|
|
8461
8560
|
*/
|
|
8462
8561
|
LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
|
|
@@ -8467,7 +8566,7 @@ export interface GetLogDeliveryConfigurationResponse {
|
|
|
8467
8566
|
*/
|
|
8468
8567
|
export interface GetSigningCertificateRequest {
|
|
8469
8568
|
/**
|
|
8470
|
-
* <p>The user pool
|
|
8569
|
+
* <p>The ID of the user pool where you want to view the signing certificate.</p>
|
|
8471
8570
|
* @public
|
|
8472
8571
|
*/
|
|
8473
8572
|
UserPoolId: string | undefined;
|
|
@@ -8478,7 +8577,8 @@ export interface GetSigningCertificateRequest {
|
|
|
8478
8577
|
*/
|
|
8479
8578
|
export interface GetSigningCertificateResponse {
|
|
8480
8579
|
/**
|
|
8481
|
-
* <p>The
|
|
8580
|
+
* <p>The x.509 certificate that signs SAML 2.0 authentication requests for your user
|
|
8581
|
+
* pool.</p>
|
|
8482
8582
|
* @public
|
|
8483
8583
|
*/
|
|
8484
8584
|
Certificate?: string | undefined;
|
|
@@ -8488,12 +8588,12 @@ export interface GetSigningCertificateResponse {
|
|
|
8488
8588
|
*/
|
|
8489
8589
|
export interface GetUICustomizationRequest {
|
|
8490
8590
|
/**
|
|
8491
|
-
* <p>The ID of the user pool.</p>
|
|
8591
|
+
* <p>The ID of the user pool that you want to query for branding settings.</p>
|
|
8492
8592
|
* @public
|
|
8493
8593
|
*/
|
|
8494
8594
|
UserPoolId: string | undefined;
|
|
8495
8595
|
/**
|
|
8496
|
-
* <p>The
|
|
8596
|
+
* <p>The ID of the app client that you want to query for branding settings.</p>
|
|
8497
8597
|
* @public
|
|
8498
8598
|
*/
|
|
8499
8599
|
ClientId?: string | undefined;
|
|
@@ -8501,7 +8601,6 @@ export interface GetUICustomizationRequest {
|
|
|
8501
8601
|
/**
|
|
8502
8602
|
* <p>A container for the UI customization information for the hosted UI in a user
|
|
8503
8603
|
* pool.</p>
|
|
8504
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html">GetUICustomization</a>.</p>
|
|
8505
8604
|
* @public
|
|
8506
8605
|
*/
|
|
8507
8606
|
export interface UICustomizationType {
|
|
@@ -8523,8 +8622,7 @@ export interface UICustomizationType {
|
|
|
8523
8622
|
*/
|
|
8524
8623
|
ImageUrl?: string | undefined;
|
|
8525
8624
|
/**
|
|
8526
|
-
* <p>The CSS values in the UI customization
|
|
8527
|
-
* options, make a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUiCustomization.html">GetUiCustomization</a> request.</p>
|
|
8625
|
+
* <p>The CSS values in the UI customization.</p>
|
|
8528
8626
|
* @public
|
|
8529
8627
|
*/
|
|
8530
8628
|
CSS?: string | undefined;
|
|
@@ -8551,7 +8649,8 @@ export interface UICustomizationType {
|
|
|
8551
8649
|
*/
|
|
8552
8650
|
export interface GetUICustomizationResponse {
|
|
8553
8651
|
/**
|
|
8554
|
-
* <p>
|
|
8652
|
+
* <p>Information about the classic hosted UI custom CSS and logo-image branding that you
|
|
8653
|
+
* applied to the user pool or app client.</p>
|
|
8555
8654
|
* @public
|
|
8556
8655
|
*/
|
|
8557
8656
|
UICustomization: UICustomizationType | undefined;
|
|
@@ -8562,7 +8661,8 @@ export interface GetUICustomizationResponse {
|
|
|
8562
8661
|
*/
|
|
8563
8662
|
export interface GetUserRequest {
|
|
8564
8663
|
/**
|
|
8565
|
-
* <p>A
|
|
8664
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
8665
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
8566
8666
|
* @public
|
|
8567
8667
|
*/
|
|
8568
8668
|
AccessToken: string | undefined;
|
|
@@ -8574,14 +8674,13 @@ export interface GetUserRequest {
|
|
|
8574
8674
|
*/
|
|
8575
8675
|
export interface GetUserResponse {
|
|
8576
8676
|
/**
|
|
8577
|
-
* <p>The
|
|
8677
|
+
* <p>The name of the user that you requested.</p>
|
|
8578
8678
|
* @public
|
|
8579
8679
|
*/
|
|
8580
8680
|
Username: string | undefined;
|
|
8581
8681
|
/**
|
|
8582
8682
|
* <p>An array of name-value pairs representing user attributes.</p>
|
|
8583
|
-
* <p>
|
|
8584
|
-
* attribute name.</p>
|
|
8683
|
+
* <p>Custom attributes are prepended with the <code>custom:</code> prefix.</p>
|
|
8585
8684
|
* @public
|
|
8586
8685
|
*/
|
|
8587
8686
|
UserAttributes: AttributeType[] | undefined;
|
|
@@ -8596,7 +8695,8 @@ export interface GetUserResponse {
|
|
|
8596
8695
|
*/
|
|
8597
8696
|
MFAOptions?: MFAOptionType[] | undefined;
|
|
8598
8697
|
/**
|
|
8599
|
-
* <p>The user's preferred MFA
|
|
8698
|
+
* <p>The user's preferred MFA. Users can prefer SMS message, email message, or TOTP
|
|
8699
|
+
* MFA.</p>
|
|
8600
8700
|
* @public
|
|
8601
8701
|
*/
|
|
8602
8702
|
PreferredMfaSetting?: string | undefined;
|
|
@@ -8614,14 +8714,14 @@ export interface GetUserResponse {
|
|
|
8614
8714
|
*/
|
|
8615
8715
|
export interface GetUserAttributeVerificationCodeRequest {
|
|
8616
8716
|
/**
|
|
8617
|
-
* <p>A
|
|
8618
|
-
*
|
|
8717
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
8718
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
8619
8719
|
* @public
|
|
8620
8720
|
*/
|
|
8621
8721
|
AccessToken: string | undefined;
|
|
8622
8722
|
/**
|
|
8623
|
-
* <p>The
|
|
8624
|
-
*
|
|
8723
|
+
* <p>The name of the attribute that the user wants to verify, for example
|
|
8724
|
+
* <code>email</code>.</p>
|
|
8625
8725
|
* @public
|
|
8626
8726
|
*/
|
|
8627
8727
|
AttributeName: string | undefined;
|
|
@@ -8637,7 +8737,7 @@ export interface GetUserAttributeVerificationCodeRequest {
|
|
|
8637
8737
|
* GetUserAttributeVerificationCode request. In your function code in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow for
|
|
8638
8738
|
* your specific needs.</p>
|
|
8639
8739
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">
|
|
8640
|
-
*
|
|
8740
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
8641
8741
|
* <note>
|
|
8642
8742
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
8643
8743
|
* following:</p>
|
|
@@ -8668,8 +8768,8 @@ export interface GetUserAttributeVerificationCodeRequest {
|
|
|
8668
8768
|
*/
|
|
8669
8769
|
export interface GetUserAttributeVerificationCodeResponse {
|
|
8670
8770
|
/**
|
|
8671
|
-
* <p>
|
|
8672
|
-
*
|
|
8771
|
+
* <p>Information about the delivery destination of the user attribute verification
|
|
8772
|
+
* code.</p>
|
|
8673
8773
|
* @public
|
|
8674
8774
|
*/
|
|
8675
8775
|
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
@@ -8679,8 +8779,8 @@ export interface GetUserAttributeVerificationCodeResponse {
|
|
|
8679
8779
|
*/
|
|
8680
8780
|
export interface GetUserAuthFactorsRequest {
|
|
8681
8781
|
/**
|
|
8682
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
8683
|
-
*
|
|
8782
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
8783
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
8684
8784
|
* @public
|
|
8685
8785
|
*/
|
|
8686
8786
|
AccessToken: string | undefined;
|
|
@@ -8690,12 +8790,14 @@ export interface GetUserAuthFactorsRequest {
|
|
|
8690
8790
|
*/
|
|
8691
8791
|
export interface GetUserAuthFactorsResponse {
|
|
8692
8792
|
/**
|
|
8693
|
-
* <p>The
|
|
8793
|
+
* <p>The name of the user who is eligible for the authentication factors in the
|
|
8794
|
+
* response.</p>
|
|
8694
8795
|
* @public
|
|
8695
8796
|
*/
|
|
8696
8797
|
Username: string | undefined;
|
|
8697
8798
|
/**
|
|
8698
|
-
* <p>The user
|
|
8799
|
+
* <p>The challenge method that Amazon Cognito returns to the user in response to sign-in requests.
|
|
8800
|
+
* Users can prefer SMS message, email message, or TOTP MFA.</p>
|
|
8699
8801
|
* @public
|
|
8700
8802
|
*/
|
|
8701
8803
|
PreferredMfaSetting?: string | undefined;
|
|
@@ -8708,7 +8810,7 @@ export interface GetUserAuthFactorsResponse {
|
|
|
8708
8810
|
UserMFASettingList?: string[] | undefined;
|
|
8709
8811
|
/**
|
|
8710
8812
|
* <p>The authentication types that are available to the user with <code>USER_AUTH</code>
|
|
8711
|
-
* sign-in
|
|
8813
|
+
* sign-in, for example <code>["PASSWORD", "WEB_AUTHN"]</code>.</p>
|
|
8712
8814
|
* @public
|
|
8713
8815
|
*/
|
|
8714
8816
|
ConfiguredUserAuthFactors?: AuthFactorType[] | undefined;
|
|
@@ -8718,29 +8820,29 @@ export interface GetUserAuthFactorsResponse {
|
|
|
8718
8820
|
*/
|
|
8719
8821
|
export interface GetUserPoolMfaConfigRequest {
|
|
8720
8822
|
/**
|
|
8721
|
-
* <p>The user pool
|
|
8823
|
+
* <p>The ID of the user pool where you want to query WebAuthn and MFA configuration.</p>
|
|
8722
8824
|
* @public
|
|
8723
8825
|
*/
|
|
8724
8826
|
UserPoolId: string | undefined;
|
|
8725
8827
|
}
|
|
8726
8828
|
/**
|
|
8727
|
-
* <p>Sets or shows user pool email message
|
|
8728
|
-
* body of the email message template for
|
|
8729
|
-
*
|
|
8730
|
-
*
|
|
8829
|
+
* <p>Sets or shows configuration for user pool email message MFA and sign-in with one-time
|
|
8830
|
+
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
8831
|
+
* sign-in and MFA messages. To activate this setting, your user pool must be in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html">
|
|
8832
|
+
* Essentials tier</a> or higher.</p>
|
|
8731
8833
|
* @public
|
|
8732
8834
|
*/
|
|
8733
8835
|
export interface EmailMfaConfigType {
|
|
8734
8836
|
/**
|
|
8735
|
-
* <p>The template for the email
|
|
8736
|
-
* MFA and sign-in with
|
|
8837
|
+
* <p>The template for the email messages that your user pool sends to users with codes for
|
|
8838
|
+
* MFA and sign-in with email OTPs. The message must contain the <code>\{####\}</code>
|
|
8737
8839
|
* placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you
|
|
8738
8840
|
* don't provide this parameter, Amazon Cognito sends messages in the default format.</p>
|
|
8739
8841
|
* @public
|
|
8740
8842
|
*/
|
|
8741
8843
|
Message?: string | undefined;
|
|
8742
8844
|
/**
|
|
8743
|
-
* <p>The subject of the email
|
|
8845
|
+
* <p>The subject of the email messages that your user pool sends to users with codes for
|
|
8744
8846
|
* MFA and email OTP sign-in.</p>
|
|
8745
8847
|
* @public
|
|
8746
8848
|
*/
|
|
@@ -8749,7 +8851,6 @@ export interface EmailMfaConfigType {
|
|
|
8749
8851
|
/**
|
|
8750
8852
|
* <p>The configuration of multi-factor authentication (MFA) with SMS messages in a user
|
|
8751
8853
|
* pool.</p>
|
|
8752
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>.</p>
|
|
8753
8854
|
* @public
|
|
8754
8855
|
*/
|
|
8755
8856
|
export interface SmsMfaConfigType {
|
|
@@ -8774,7 +8875,6 @@ export interface SmsMfaConfigType {
|
|
|
8774
8875
|
/**
|
|
8775
8876
|
* <p>Settings for time-based one-time password (TOTP) multi-factor authentication (MFA) in
|
|
8776
8877
|
* a user pool. Enables and disables availability of this feature.</p>
|
|
8777
|
-
* <p>This data type is a request parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> and a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html">GetUserPoolMfaConfig</a>. </p>
|
|
8778
8878
|
* @public
|
|
8779
8879
|
*/
|
|
8780
8880
|
export interface SoftwareTokenMfaConfigType {
|
|
@@ -8784,18 +8884,6 @@ export interface SoftwareTokenMfaConfigType {
|
|
|
8784
8884
|
*/
|
|
8785
8885
|
Enabled?: boolean | undefined;
|
|
8786
8886
|
}
|
|
8787
|
-
/**
|
|
8788
|
-
* @public
|
|
8789
|
-
* @enum
|
|
8790
|
-
*/
|
|
8791
|
-
export declare const UserVerificationType: {
|
|
8792
|
-
readonly PREFERRED: "preferred";
|
|
8793
|
-
readonly REQUIRED: "required";
|
|
8794
|
-
};
|
|
8795
|
-
/**
|
|
8796
|
-
* @public
|
|
8797
|
-
*/
|
|
8798
|
-
export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType];
|
|
8799
8887
|
/**
|
|
8800
8888
|
* @internal
|
|
8801
8889
|
*/
|