@aws-sdk/client-cognito-identity-provider 3.504.0 → 3.505.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/dist-types/commands/AddCustomAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminAddUserToGroupCommand.d.ts +2 -2
- package/dist-types/commands/AdminConfirmSignUpCommand.d.ts +2 -2
- package/dist-types/commands/AdminCreateUserCommand.d.ts +13 -13
- package/dist-types/commands/AdminDeleteUserAttributesCommand.d.ts +2 -2
- package/dist-types/commands/AdminDeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableProviderForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminDisableUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminEnableUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminForgetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/AdminGetDeviceCommand.d.ts +2 -2
- package/dist-types/commands/AdminGetUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +13 -13
- package/dist-types/commands/AdminLinkProviderForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminListDevicesCommand.d.ts +2 -2
- package/dist-types/commands/AdminListGroupsForUserCommand.d.ts +2 -2
- package/dist-types/commands/AdminListUserAuthEventsCommand.d.ts +2 -2
- package/dist-types/commands/AdminRemoveUserFromGroupCommand.d.ts +2 -2
- package/dist-types/commands/AdminResetUserPasswordCommand.d.ts +13 -13
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +13 -13
- package/dist-types/commands/AdminSetUserMFAPreferenceCommand.d.ts +2 -2
- package/dist-types/commands/AdminSetUserPasswordCommand.d.ts +2 -2
- package/dist-types/commands/AdminSetUserSettingsCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateAuthEventFeedbackCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateDeviceStatusCommand.d.ts +2 -2
- package/dist-types/commands/AdminUpdateUserAttributesCommand.d.ts +13 -13
- package/dist-types/commands/AdminUserGlobalSignOutCommand.d.ts +2 -2
- package/dist-types/commands/AssociateSoftwareTokenCommand.d.ts +3 -3
- package/dist-types/commands/ChangePasswordCommand.d.ts +4 -3
- package/dist-types/commands/ConfirmDeviceCommand.d.ts +5 -4
- package/dist-types/commands/ConfirmForgotPasswordCommand.d.ts +3 -3
- package/dist-types/commands/ConfirmSignUpCommand.d.ts +3 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +2 -2
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +3 -3
- package/dist-types/commands/CreateResourceServerCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserImportJobCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +15 -15
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +2 -2
- package/dist-types/commands/DeleteUserAttributesCommand.d.ts +4 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +4 -3
- package/dist-types/commands/DescribeUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +3 -3
- package/dist-types/commands/ForgetDeviceCommand.d.ts +6 -4
- package/dist-types/commands/ForgotPasswordCommand.d.ts +14 -14
- package/dist-types/commands/GetDeviceCommand.d.ts +5 -4
- package/dist-types/commands/GetUserAttributeVerificationCodeCommand.d.ts +15 -14
- package/dist-types/commands/GetUserCommand.d.ts +4 -3
- package/dist-types/commands/GlobalSignOutCommand.d.ts +4 -3
- package/dist-types/commands/InitiateAuthCommand.d.ts +14 -14
- package/dist-types/commands/ListDevicesCommand.d.ts +6 -4
- package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListIdentityProvidersCommand.d.ts +2 -2
- package/dist-types/commands/ListResourceServersCommand.d.ts +2 -2
- package/dist-types/commands/ListUserImportJobsCommand.d.ts +2 -2
- package/dist-types/commands/ListUserPoolClientsCommand.d.ts +2 -2
- package/dist-types/commands/ListUserPoolsCommand.d.ts +3 -3
- package/dist-types/commands/ListUsersCommand.d.ts +2 -2
- package/dist-types/commands/ListUsersInGroupCommand.d.ts +2 -2
- package/dist-types/commands/ResendConfirmationCodeCommand.d.ts +14 -14
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +14 -14
- package/dist-types/commands/RevokeTokenCommand.d.ts +3 -3
- package/dist-types/commands/SetUserMFAPreferenceCommand.d.ts +4 -3
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +11 -11
- package/dist-types/commands/SetUserSettingsCommand.d.ts +4 -3
- package/dist-types/commands/SignUpCommand.d.ts +14 -14
- package/dist-types/commands/UpdateAuthEventFeedbackCommand.d.ts +3 -3
- package/dist-types/commands/UpdateDeviceStatusCommand.d.ts +6 -4
- package/dist-types/commands/UpdateGroupCommand.d.ts +2 -2
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +2 -2
- package/dist-types/commands/UpdateResourceServerCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserAttributesCommand.d.ts +15 -14
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +2 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +14 -14
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +2 -2
- package/dist-types/commands/VerifySoftwareTokenCommand.d.ts +3 -3
- package/dist-types/commands/VerifyUserAttributeCommand.d.ts +4 -3
- package/dist-types/models/models_0.d.ts +473 -459
- package/dist-types/models/models_1.d.ts +191 -74
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +1 -1
|
@@ -679,13 +679,13 @@ export interface AdminCreateUserRequest {
|
|
|
679
679
|
/**
|
|
680
680
|
* @public
|
|
681
681
|
* <p>Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda
|
|
682
|
-
*
|
|
683
|
-
*
|
|
682
|
+
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
683
|
+
* collect from your users but don't need to retain.</p>
|
|
684
684
|
* <p>Your Lambda function can analyze this additional data and act on it. Your function
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
*
|
|
685
|
+
* might perform external API operations like logging user attributes and validation data
|
|
686
|
+
* to Amazon CloudWatch Logs. Validation data might also affect the response that your function returns
|
|
687
|
+
* to Amazon Cognito, like automatically confirming the user if they sign up from within your
|
|
688
|
+
* network.</p>
|
|
689
689
|
* <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>
|
|
690
690
|
*/
|
|
691
691
|
ValidationData?: AttributeType[];
|
|
@@ -1969,10 +1969,10 @@ export interface AdminListDevicesRequest {
|
|
|
1969
1969
|
/**
|
|
1970
1970
|
* @public
|
|
1971
1971
|
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1972
|
-
*
|
|
1973
|
-
*
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1972
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1973
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1974
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1975
|
+
* through the full list of items.</p>
|
|
1976
1976
|
*/
|
|
1977
1977
|
PaginationToken?: string;
|
|
1978
1978
|
}
|
|
@@ -1989,8 +1989,8 @@ export interface AdminListDevicesResponse {
|
|
|
1989
1989
|
/**
|
|
1990
1990
|
* @public
|
|
1991
1991
|
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1992
|
-
*
|
|
1993
|
-
*
|
|
1992
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1993
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1994
1994
|
*/
|
|
1995
1995
|
PaginationToken?: string;
|
|
1996
1996
|
}
|
|
@@ -2212,10 +2212,10 @@ export interface EventFeedbackType {
|
|
|
2212
2212
|
/**
|
|
2213
2213
|
* @public
|
|
2214
2214
|
* <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
|
|
2215
|
-
*
|
|
2216
|
-
*
|
|
2217
|
-
*
|
|
2218
|
-
*
|
|
2215
|
+
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2216
|
+
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2217
|
+
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
2218
|
+
* don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
|
|
2219
2219
|
*/
|
|
2220
2220
|
FeedbackValue: FeedbackValueType | undefined;
|
|
2221
2221
|
/**
|
|
@@ -2500,52 +2500,52 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
2500
2500
|
/**
|
|
2501
2501
|
* @public
|
|
2502
2502
|
* <p>The responses to the challenge that you received in the previous request. Each
|
|
2503
|
-
*
|
|
2504
|
-
*
|
|
2503
|
+
* challenge has its own required response parameters. The following examples are partial
|
|
2504
|
+
* JSON request bodies that highlight challenge-response parameters.</p>
|
|
2505
2505
|
* <important>
|
|
2506
2506
|
* <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
|
|
2507
|
-
*
|
|
2507
|
+
* client that has a client secret.</p>
|
|
2508
2508
|
* </important>
|
|
2509
2509
|
* <dl>
|
|
2510
2510
|
* <dt>SMS_MFA</dt>
|
|
2511
2511
|
* <dd>
|
|
2512
2512
|
* <p>
|
|
2513
2513
|
* <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
|
|
2514
|
-
*
|
|
2514
|
+
* "[SMS_code]", "USERNAME": "[username]"\}</code>
|
|
2515
2515
|
* </p>
|
|
2516
2516
|
* </dd>
|
|
2517
2517
|
* <dt>PASSWORD_VERIFIER</dt>
|
|
2518
2518
|
* <dd>
|
|
2519
2519
|
* <p>
|
|
2520
2520
|
* <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
|
2521
|
-
*
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
2521
|
+
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
|
2522
|
+
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
|
2523
|
+
* [timestamp], "USERNAME": "[username]"\}</code>
|
|
2524
2524
|
* </p>
|
|
2525
2525
|
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
2526
|
-
*
|
|
2526
|
+
* device.</p>
|
|
2527
2527
|
* </dd>
|
|
2528
2528
|
* <dt>CUSTOM_CHALLENGE</dt>
|
|
2529
2529
|
* <dd>
|
|
2530
2530
|
* <p>
|
|
2531
2531
|
* <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
|
2532
|
-
*
|
|
2532
|
+
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
|
|
2533
2533
|
* </p>
|
|
2534
2534
|
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
2535
|
-
*
|
|
2535
|
+
* device.</p>
|
|
2536
2536
|
* </dd>
|
|
2537
2537
|
* <dt>NEW_PASSWORD_REQUIRED</dt>
|
|
2538
2538
|
* <dd>
|
|
2539
2539
|
* <p>
|
|
2540
2540
|
* <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
|
2541
|
-
*
|
|
2542
|
-
*
|
|
2541
|
+
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
|
|
2542
|
+
* "[username]"\}</code>
|
|
2543
2543
|
* </p>
|
|
2544
2544
|
* <p>To set any required attributes that <code>InitiateAuth</code> returned in
|
|
2545
|
-
*
|
|
2546
|
-
*
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2545
|
+
* an <code>requiredAttributes</code> parameter, add
|
|
2546
|
+
* <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
|
|
2547
|
+
* This parameter can also set values for writable attributes that aren't
|
|
2548
|
+
* required by your user pool.</p>
|
|
2549
2549
|
* <note>
|
|
2550
2550
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
2551
2551
|
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
|
|
@@ -2556,45 +2556,45 @@ export interface AdminRespondToAuthChallengeRequest {
|
|
|
2556
2556
|
* <dd>
|
|
2557
2557
|
* <p>
|
|
2558
2558
|
* <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
|
2559
|
-
*
|
|
2560
|
-
*
|
|
2559
|
+
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
|
2560
|
+
* [authenticator_code]\}</code>
|
|
2561
2561
|
* </p>
|
|
2562
2562
|
* </dd>
|
|
2563
2563
|
* <dt>DEVICE_SRP_AUTH</dt>
|
|
2564
2564
|
* <dd>
|
|
2565
2565
|
* <p>
|
|
2566
2566
|
* <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
|
|
2567
|
-
*
|
|
2568
|
-
*
|
|
2567
|
+
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
|
2568
|
+
* "[srp_a]"\}</code>
|
|
2569
2569
|
* </p>
|
|
2570
2570
|
* </dd>
|
|
2571
2571
|
* <dt>DEVICE_PASSWORD_VERIFIER</dt>
|
|
2572
2572
|
* <dd>
|
|
2573
2573
|
* <p>
|
|
2574
2574
|
* <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
|
|
2575
|
-
*
|
|
2576
|
-
*
|
|
2577
|
-
*
|
|
2575
|
+
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
|
|
2576
|
+
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
|
|
2577
|
+
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
|
|
2578
2578
|
* </p>
|
|
2579
2579
|
* </dd>
|
|
2580
2580
|
* <dt>MFA_SETUP</dt>
|
|
2581
2581
|
* <dd>
|
|
2582
2582
|
* <p>
|
|
2583
2583
|
* <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
|
|
2584
|
-
*
|
|
2585
|
-
*
|
|
2584
|
+
* "[username]"\}, "SESSION": "[Session ID from
|
|
2585
|
+
* VerifySoftwareToken]"</code>
|
|
2586
2586
|
* </p>
|
|
2587
2587
|
* </dd>
|
|
2588
2588
|
* <dt>SELECT_MFA_TYPE</dt>
|
|
2589
2589
|
* <dd>
|
|
2590
2590
|
* <p>
|
|
2591
2591
|
* <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
|
|
2592
|
-
*
|
|
2592
|
+
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}</code>
|
|
2593
2593
|
* </p>
|
|
2594
2594
|
* </dd>
|
|
2595
2595
|
* </dl>
|
|
2596
2596
|
* <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
|
|
2597
|
-
*
|
|
2597
|
+
* <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>
|
|
2598
2598
|
*/
|
|
2599
2599
|
ChallengeResponses?: Record<string, string>;
|
|
2600
2600
|
/**
|
|
@@ -2916,10 +2916,10 @@ export interface AdminUpdateAuthEventFeedbackRequest {
|
|
|
2916
2916
|
/**
|
|
2917
2917
|
* @public
|
|
2918
2918
|
* <p>The authentication event feedback value. When you provide a <code>FeedbackValue</code>
|
|
2919
|
-
*
|
|
2920
|
-
*
|
|
2921
|
-
*
|
|
2922
|
-
*
|
|
2919
|
+
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2920
|
+
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2921
|
+
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
2922
|
+
* don't believe that Amazon Cognito evaluated a high-enough risk level.</p>
|
|
2923
2923
|
*/
|
|
2924
2924
|
FeedbackValue: FeedbackValueType | undefined;
|
|
2925
2925
|
}
|
|
@@ -3605,120 +3605,125 @@ export interface CreateIdentityProviderRequest {
|
|
|
3605
3605
|
ProviderType: IdentityProviderTypeType | undefined;
|
|
3606
3606
|
/**
|
|
3607
3607
|
* @public
|
|
3608
|
-
* <p>The
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
*
|
|
3612
|
-
*
|
|
3613
|
-
*
|
|
3614
|
-
*
|
|
3615
|
-
*
|
|
3616
|
-
*
|
|
3617
|
-
*
|
|
3618
|
-
*
|
|
3619
|
-
*
|
|
3620
|
-
*
|
|
3621
|
-
*
|
|
3622
|
-
*
|
|
3623
|
-
*
|
|
3624
|
-
*
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
3627
|
-
*
|
|
3628
|
-
*
|
|
3629
|
-
*
|
|
3630
|
-
*
|
|
3631
|
-
*
|
|
3632
|
-
*
|
|
3633
|
-
*
|
|
3634
|
-
*
|
|
3635
|
-
*
|
|
3636
|
-
*
|
|
3637
|
-
*
|
|
3638
|
-
*
|
|
3639
|
-
*
|
|
3640
|
-
*
|
|
3641
|
-
*
|
|
3642
|
-
*
|
|
3643
|
-
*
|
|
3644
|
-
*
|
|
3645
|
-
*
|
|
3646
|
-
*
|
|
3647
|
-
*
|
|
3648
|
-
*
|
|
3649
|
-
*
|
|
3650
|
-
*
|
|
3651
|
-
*
|
|
3652
|
-
*
|
|
3653
|
-
*
|
|
3654
|
-
*
|
|
3655
|
-
*
|
|
3656
|
-
*
|
|
3657
|
-
*
|
|
3658
|
-
*
|
|
3659
|
-
*
|
|
3660
|
-
* </
|
|
3661
|
-
* </
|
|
3662
|
-
* <
|
|
3663
|
-
*
|
|
3664
|
-
* <
|
|
3665
|
-
*
|
|
3666
|
-
*
|
|
3667
|
-
*
|
|
3668
|
-
*
|
|
3669
|
-
*
|
|
3670
|
-
*
|
|
3671
|
-
*
|
|
3672
|
-
*
|
|
3673
|
-
*
|
|
3674
|
-
*
|
|
3675
|
-
*
|
|
3676
|
-
*
|
|
3677
|
-
*
|
|
3678
|
-
*
|
|
3679
|
-
*
|
|
3680
|
-
*
|
|
3681
|
-
*
|
|
3682
|
-
*
|
|
3683
|
-
*
|
|
3684
|
-
*
|
|
3685
|
-
*
|
|
3686
|
-
*
|
|
3687
|
-
*
|
|
3688
|
-
*
|
|
3689
|
-
*
|
|
3690
|
-
*
|
|
3691
|
-
*
|
|
3692
|
-
*
|
|
3693
|
-
*
|
|
3694
|
-
*
|
|
3695
|
-
*
|
|
3696
|
-
*
|
|
3697
|
-
*
|
|
3698
|
-
*
|
|
3699
|
-
*
|
|
3700
|
-
*
|
|
3701
|
-
*
|
|
3702
|
-
*
|
|
3703
|
-
*
|
|
3704
|
-
*
|
|
3705
|
-
*
|
|
3706
|
-
*
|
|
3707
|
-
*
|
|
3708
|
-
*
|
|
3709
|
-
*
|
|
3710
|
-
*
|
|
3711
|
-
*
|
|
3712
|
-
*
|
|
3713
|
-
*
|
|
3714
|
-
*
|
|
3715
|
-
*
|
|
3716
|
-
*
|
|
3717
|
-
*
|
|
3718
|
-
*
|
|
3719
|
-
*
|
|
3720
|
-
*
|
|
3721
|
-
*
|
|
3608
|
+
* <p>The scopes, URLs, and identifiers for your external identity provider. The following
|
|
3609
|
+
* examples describe the provider detail keys for each IdP type. These values and their
|
|
3610
|
+
* schema are subject to change. Social IdP <code>authorize_scopes</code> values must match
|
|
3611
|
+
* the values listed here.</p>
|
|
3612
|
+
* <dl>
|
|
3613
|
+
* <dt>OpenID Connect (OIDC)</dt>
|
|
3614
|
+
* <dd>
|
|
3615
|
+
* <p>Amazon Cognito accepts the following elements when it can't discover endpoint
|
|
3616
|
+
* URLs from <code>oidc_issuer</code>: <code>attributes_url</code>,
|
|
3617
|
+
* <code>authorize_url</code>, <code>jwks_uri</code>,
|
|
3618
|
+
* <code>token_url</code>.</p>
|
|
3619
|
+
* <p>Create or update request: <code>"ProviderDetails": \{
|
|
3620
|
+
* "attributes_request_method": "GET", "attributes_url":
|
|
3621
|
+
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
|
|
3622
|
+
* email", "authorize_url": "https://auth.example.com/authorize",
|
|
3623
|
+
* "client_id": "1example23456789", "client_secret":
|
|
3624
|
+
* "provider-app-client-secret", "jwks_uri":
|
|
3625
|
+
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3626
|
+
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3627
|
+
* \}</code>
|
|
3628
|
+
* </p>
|
|
3629
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_request_method":
|
|
3630
|
+
* "GET", "attributes_url": "https://auth.example.com/userInfo",
|
|
3631
|
+
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
|
|
3632
|
+
* profile email", "authorize_url": "https://auth.example.com/authorize",
|
|
3633
|
+
* "client_id": "1example23456789", "client_secret":
|
|
3634
|
+
* "provider-app-client-secret", "jwks_uri":
|
|
3635
|
+
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3636
|
+
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3637
|
+
* \}</code>
|
|
3638
|
+
* </p>
|
|
3639
|
+
* </dd>
|
|
3640
|
+
* <dt>SAML</dt>
|
|
3641
|
+
* <dd>
|
|
3642
|
+
* <p>Create or update request with Metadata URL: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3643
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
|
|
3644
|
+
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3645
|
+
* "rsa-sha256" \}</code>
|
|
3646
|
+
* </p>
|
|
3647
|
+
* <p>Create or update request with Metadata file: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3648
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true",
|
|
3649
|
+
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
|
|
3650
|
+
* "rsa-sha256" \}</code>
|
|
3651
|
+
* </p>
|
|
3652
|
+
* <p>The value of <code>MetadataFile</code> must be the plaintext metadata document with all
|
|
3653
|
+
* quote (") characters escaped by backslashes.</p>
|
|
3654
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3655
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
|
|
3656
|
+
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3657
|
+
* "rsa-sha256", "SLORedirectBindingURI":
|
|
3658
|
+
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
|
3659
|
+
* "https://auth.example.com/sso/saml" \}</code>
|
|
3660
|
+
* </p>
|
|
3661
|
+
* </dd>
|
|
3662
|
+
* <dt>LoginWithAmazon</dt>
|
|
3663
|
+
* <dd>
|
|
3664
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3665
|
+
* "profile postal_code", "client_id":
|
|
3666
|
+
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3667
|
+
* "provider-app-client-secret"</code>
|
|
3668
|
+
* </p>
|
|
3669
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3670
|
+
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
|
|
3671
|
+
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
|
|
3672
|
+
* "https://www.amazon.com/ap/oa", "client_id":
|
|
3673
|
+
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3674
|
+
* "provider-app-client-secret", "token_request_method": "POST",
|
|
3675
|
+
* "token_url": "https://api.amazon.com/auth/o2/token" \}</code>
|
|
3676
|
+
* </p>
|
|
3677
|
+
* </dd>
|
|
3678
|
+
* <dt>Google</dt>
|
|
3679
|
+
* <dd>
|
|
3680
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3681
|
+
* "email profile openid", "client_id":
|
|
3682
|
+
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3683
|
+
* "provider-app-client-secret" \}</code>
|
|
3684
|
+
* </p>
|
|
3685
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3686
|
+
* "https://people.googleapis.com/v1/people/me?personFields=",
|
|
3687
|
+
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
|
|
3688
|
+
* profile openid", "authorize_url":
|
|
3689
|
+
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
|
|
3690
|
+
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3691
|
+
* "provider-app-client-secret", "oidc_issuer":
|
|
3692
|
+
* "https://accounts.google.com", "token_request_method": "POST",
|
|
3693
|
+
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
|
3694
|
+
* \}</code>
|
|
3695
|
+
* </p>
|
|
3696
|
+
* </dd>
|
|
3697
|
+
* <dt>SignInWithApple</dt>
|
|
3698
|
+
* <dd>
|
|
3699
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3700
|
+
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
|
|
3701
|
+
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}</code>
|
|
3702
|
+
* </p>
|
|
3703
|
+
* <p>Describe response: <code>"ProviderDetails": \{
|
|
3704
|
+
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
|
|
3705
|
+
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
|
|
3706
|
+
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
|
3707
|
+
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
|
3708
|
+
* "token_request_method": "POST", "token_url":
|
|
3709
|
+
* "https://appleid.apple.com/auth/token" \}</code>
|
|
3710
|
+
* </p>
|
|
3711
|
+
* </dd>
|
|
3712
|
+
* <dt>Facebook</dt>
|
|
3713
|
+
* <dd>
|
|
3714
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "api_version": "v17.0",
|
|
3715
|
+
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
|
|
3716
|
+
* "client_secret": "provider-app-client-secret" \}</code>
|
|
3717
|
+
* </p>
|
|
3718
|
+
* <p>Describe response: <code>"ProviderDetails":
|
|
3719
|
+
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
|
3720
|
+
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
|
|
3721
|
+
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
|
3722
|
+
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
|
|
3723
|
+
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}</code>
|
|
3724
|
+
* </p>
|
|
3725
|
+
* </dd>
|
|
3726
|
+
* </dl>
|
|
3722
3727
|
*/
|
|
3723
3728
|
ProviderDetails: Record<string, string> | undefined;
|
|
3724
3729
|
/**
|
|
@@ -3754,124 +3759,125 @@ export interface IdentityProviderType {
|
|
|
3754
3759
|
ProviderType?: IdentityProviderTypeType;
|
|
3755
3760
|
/**
|
|
3756
3761
|
* @public
|
|
3757
|
-
* <p>The
|
|
3758
|
-
*
|
|
3759
|
-
*
|
|
3760
|
-
*
|
|
3761
|
-
*
|
|
3762
|
-
*
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3765
|
-
*
|
|
3766
|
-
*
|
|
3767
|
-
*
|
|
3768
|
-
*
|
|
3769
|
-
*
|
|
3770
|
-
*
|
|
3771
|
-
*
|
|
3772
|
-
*
|
|
3773
|
-
*
|
|
3774
|
-
*
|
|
3775
|
-
*
|
|
3776
|
-
*
|
|
3777
|
-
*
|
|
3778
|
-
*
|
|
3779
|
-
*
|
|
3780
|
-
*
|
|
3781
|
-
*
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
3784
|
-
*
|
|
3785
|
-
*
|
|
3786
|
-
*
|
|
3787
|
-
*
|
|
3788
|
-
*
|
|
3789
|
-
*
|
|
3790
|
-
*
|
|
3791
|
-
*
|
|
3792
|
-
*
|
|
3793
|
-
*
|
|
3794
|
-
*
|
|
3795
|
-
*
|
|
3796
|
-
*
|
|
3797
|
-
*
|
|
3798
|
-
*
|
|
3799
|
-
*
|
|
3800
|
-
*
|
|
3801
|
-
*
|
|
3802
|
-
*
|
|
3803
|
-
*
|
|
3804
|
-
*
|
|
3805
|
-
*
|
|
3806
|
-
*
|
|
3807
|
-
*
|
|
3808
|
-
*
|
|
3809
|
-
*
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3812
|
-
*
|
|
3813
|
-
*
|
|
3814
|
-
*
|
|
3815
|
-
*
|
|
3816
|
-
*
|
|
3817
|
-
*
|
|
3818
|
-
*
|
|
3819
|
-
*
|
|
3820
|
-
*
|
|
3821
|
-
*
|
|
3822
|
-
*
|
|
3823
|
-
*
|
|
3824
|
-
*
|
|
3825
|
-
*
|
|
3826
|
-
*
|
|
3827
|
-
*
|
|
3828
|
-
*
|
|
3829
|
-
*
|
|
3830
|
-
*
|
|
3831
|
-
*
|
|
3832
|
-
*
|
|
3833
|
-
*
|
|
3834
|
-
*
|
|
3835
|
-
*
|
|
3836
|
-
*
|
|
3837
|
-
*
|
|
3838
|
-
*
|
|
3839
|
-
*
|
|
3840
|
-
*
|
|
3841
|
-
*
|
|
3842
|
-
*
|
|
3843
|
-
*
|
|
3844
|
-
*
|
|
3845
|
-
*
|
|
3846
|
-
*
|
|
3847
|
-
*
|
|
3848
|
-
*
|
|
3849
|
-
*
|
|
3850
|
-
*
|
|
3851
|
-
*
|
|
3852
|
-
*
|
|
3853
|
-
*
|
|
3854
|
-
*
|
|
3855
|
-
*
|
|
3856
|
-
*
|
|
3857
|
-
*
|
|
3858
|
-
*
|
|
3859
|
-
*
|
|
3860
|
-
*
|
|
3861
|
-
* </
|
|
3862
|
-
* <
|
|
3863
|
-
* <p>
|
|
3864
|
-
*
|
|
3865
|
-
*
|
|
3866
|
-
*
|
|
3867
|
-
*
|
|
3868
|
-
*
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
3871
|
-
*
|
|
3872
|
-
*
|
|
3873
|
-
*
|
|
3874
|
-
*
|
|
3762
|
+
* <p>The scopes, URLs, and identifiers for your external identity provider. The following
|
|
3763
|
+
* examples describe the provider detail keys for each IdP type. These values and their
|
|
3764
|
+
* schema are subject to change. Social IdP <code>authorize_scopes</code> values must match
|
|
3765
|
+
* the values listed here.</p>
|
|
3766
|
+
* <dl>
|
|
3767
|
+
* <dt>OpenID Connect (OIDC)</dt>
|
|
3768
|
+
* <dd>
|
|
3769
|
+
* <p>Amazon Cognito accepts the following elements when it can't discover endpoint
|
|
3770
|
+
* URLs from <code>oidc_issuer</code>: <code>attributes_url</code>,
|
|
3771
|
+
* <code>authorize_url</code>, <code>jwks_uri</code>,
|
|
3772
|
+
* <code>token_url</code>.</p>
|
|
3773
|
+
* <p>Create or update request: <code>"ProviderDetails": \{
|
|
3774
|
+
* "attributes_request_method": "GET", "attributes_url":
|
|
3775
|
+
* "https://auth.example.com/userInfo", "authorize_scopes": "openid profile
|
|
3776
|
+
* email", "authorize_url": "https://auth.example.com/authorize",
|
|
3777
|
+
* "client_id": "1example23456789", "client_secret":
|
|
3778
|
+
* "provider-app-client-secret", "jwks_uri":
|
|
3779
|
+
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3780
|
+
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3781
|
+
* \}</code>
|
|
3782
|
+
* </p>
|
|
3783
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_request_method":
|
|
3784
|
+
* "GET", "attributes_url": "https://auth.example.com/userInfo",
|
|
3785
|
+
* "attributes_url_add_attributes": "false", "authorize_scopes": "openid
|
|
3786
|
+
* profile email", "authorize_url": "https://auth.example.com/authorize",
|
|
3787
|
+
* "client_id": "1example23456789", "client_secret":
|
|
3788
|
+
* "provider-app-client-secret", "jwks_uri":
|
|
3789
|
+
* "https://auth.example.com/.well-known/jwks.json", "oidc_issuer":
|
|
3790
|
+
* "https://auth.example.com", "token_url": "https://example.com/token"
|
|
3791
|
+
* \}</code>
|
|
3792
|
+
* </p>
|
|
3793
|
+
* </dd>
|
|
3794
|
+
* <dt>SAML</dt>
|
|
3795
|
+
* <dd>
|
|
3796
|
+
* <p>Create or update request with Metadata URL: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3797
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true", "MetadataURL":
|
|
3798
|
+
* "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3799
|
+
* "rsa-sha256" \}</code>
|
|
3800
|
+
* </p>
|
|
3801
|
+
* <p>Create or update request with Metadata file: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3802
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true",
|
|
3803
|
+
* "MetadataFile": "[metadata XML]", "RequestSigningAlgorithm":
|
|
3804
|
+
* "rsa-sha256" \}</code>
|
|
3805
|
+
* </p>
|
|
3806
|
+
* <p>The value of <code>MetadataFile</code> must be the plaintext metadata document with all
|
|
3807
|
+
* quote (") characters escaped by backslashes.</p>
|
|
3808
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "IDPInit": "true",
|
|
3809
|
+
* "IDPSignout": "true", "EncryptedResponses" : "true", "ActiveEncryptionCertificate": "[certificate]",
|
|
3810
|
+
* "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm":
|
|
3811
|
+
* "rsa-sha256", "SLORedirectBindingURI":
|
|
3812
|
+
* "https://auth.example.com/slo/saml", "SSORedirectBindingURI":
|
|
3813
|
+
* "https://auth.example.com/sso/saml" \}</code>
|
|
3814
|
+
* </p>
|
|
3815
|
+
* </dd>
|
|
3816
|
+
* <dt>LoginWithAmazon</dt>
|
|
3817
|
+
* <dd>
|
|
3818
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3819
|
+
* "profile postal_code", "client_id":
|
|
3820
|
+
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3821
|
+
* "provider-app-client-secret"</code>
|
|
3822
|
+
* </p>
|
|
3823
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3824
|
+
* "https://api.amazon.com/user/profile", "attributes_url_add_attributes":
|
|
3825
|
+
* "false", "authorize_scopes": "profile postal_code", "authorize_url":
|
|
3826
|
+
* "https://www.amazon.com/ap/oa", "client_id":
|
|
3827
|
+
* "amzn1.application-oa2-client.1example23456789", "client_secret":
|
|
3828
|
+
* "provider-app-client-secret", "token_request_method": "POST",
|
|
3829
|
+
* "token_url": "https://api.amazon.com/auth/o2/token" \}</code>
|
|
3830
|
+
* </p>
|
|
3831
|
+
* </dd>
|
|
3832
|
+
* <dt>Google</dt>
|
|
3833
|
+
* <dd>
|
|
3834
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3835
|
+
* "email profile openid", "client_id":
|
|
3836
|
+
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3837
|
+
* "provider-app-client-secret" \}</code>
|
|
3838
|
+
* </p>
|
|
3839
|
+
* <p>Describe response: <code>"ProviderDetails": \{ "attributes_url":
|
|
3840
|
+
* "https://people.googleapis.com/v1/people/me?personFields=",
|
|
3841
|
+
* "attributes_url_add_attributes": "true", "authorize_scopes": "email
|
|
3842
|
+
* profile openid", "authorize_url":
|
|
3843
|
+
* "https://accounts.google.com/o/oauth2/v2/auth", "client_id":
|
|
3844
|
+
* "1example23456789.apps.googleusercontent.com", "client_secret":
|
|
3845
|
+
* "provider-app-client-secret", "oidc_issuer":
|
|
3846
|
+
* "https://accounts.google.com", "token_request_method": "POST",
|
|
3847
|
+
* "token_url": "https://www.googleapis.com/oauth2/v4/token"
|
|
3848
|
+
* \}</code>
|
|
3849
|
+
* </p>
|
|
3850
|
+
* </dd>
|
|
3851
|
+
* <dt>SignInWithApple</dt>
|
|
3852
|
+
* <dd>
|
|
3853
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "authorize_scopes":
|
|
3854
|
+
* "email name", "client_id": "com.example.cognito", "private_key": "1EXAMPLE",
|
|
3855
|
+
* "key_id": "2EXAMPLE", "team_id": "3EXAMPLE" \}</code>
|
|
3856
|
+
* </p>
|
|
3857
|
+
* <p>Describe response: <code>"ProviderDetails": \{
|
|
3858
|
+
* "attributes_url_add_attributes": "false", "authorize_scopes": "email
|
|
3859
|
+
* name", "authorize_url": "https://appleid.apple.com/auth/authorize",
|
|
3860
|
+
* "client_id": "com.example.cognito", "key_id": "1EXAMPLE", "oidc_issuer":
|
|
3861
|
+
* "https://appleid.apple.com", "team_id": "2EXAMPLE",
|
|
3862
|
+
* "token_request_method": "POST", "token_url":
|
|
3863
|
+
* "https://appleid.apple.com/auth/token" \}</code>
|
|
3864
|
+
* </p>
|
|
3865
|
+
* </dd>
|
|
3866
|
+
* <dt>Facebook</dt>
|
|
3867
|
+
* <dd>
|
|
3868
|
+
* <p>Create or update request: <code>"ProviderDetails": \{ "api_version": "v17.0",
|
|
3869
|
+
* "authorize_scopes": "public_profile, email", "client_id": "1example23456789",
|
|
3870
|
+
* "client_secret": "provider-app-client-secret" \}</code>
|
|
3871
|
+
* </p>
|
|
3872
|
+
* <p>Describe response: <code>"ProviderDetails":
|
|
3873
|
+
* \{ "api_version": "v17.0", "attributes_url": "https://graph.facebook.com/v17.0/me?fields=",
|
|
3874
|
+
* "attributes_url_add_attributes": "true", "authorize_scopes": "public_profile, email",
|
|
3875
|
+
* "authorize_url": "https://www.facebook.com/v17.0/dialog/oauth", "client_id":
|
|
3876
|
+
* "1example23456789", "client_secret": "provider-app-client-secret", "token_request_method":
|
|
3877
|
+
* "GET", "token_url": "https://graph.facebook.com/v17.0/oauth/access_token" \}</code>
|
|
3878
|
+
* </p>
|
|
3879
|
+
* </dd>
|
|
3880
|
+
* </dl>
|
|
3875
3881
|
*/
|
|
3876
3882
|
ProviderDetails?: Record<string, string>;
|
|
3877
3883
|
/**
|
|
@@ -4485,22 +4491,26 @@ export interface LambdaConfigType {
|
|
|
4485
4491
|
/**
|
|
4486
4492
|
* @public
|
|
4487
4493
|
* <p>The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.</p>
|
|
4488
|
-
* <p>Set this parameter for legacy purposes. If you also set an ARN in
|
|
4489
|
-
*
|
|
4494
|
+
* <p>Set this parameter for legacy purposes. If you also set an ARN in
|
|
4495
|
+
* <code>PreTokenGenerationConfig</code>, its value must be identical to
|
|
4496
|
+
* <code>PreTokenGeneration</code>. For new instances of pre token generation triggers,
|
|
4497
|
+
* set the <code>LambdaArn</code> of <code>PreTokenGenerationConfig</code>.</p>
|
|
4490
4498
|
* <p>You can set <code></code>
|
|
4491
4499
|
* </p>
|
|
4492
4500
|
*/
|
|
4493
4501
|
PreTokenGeneration?: string;
|
|
4494
4502
|
/**
|
|
4495
4503
|
* @public
|
|
4496
|
-
* <p>The
|
|
4504
|
+
* <p>The user migration Lambda config type.</p>
|
|
4497
4505
|
*/
|
|
4498
|
-
|
|
4506
|
+
UserMigration?: string;
|
|
4499
4507
|
/**
|
|
4500
4508
|
* @public
|
|
4501
|
-
* <p>The
|
|
4509
|
+
* <p>The detailed configuration of a pre token generation trigger. If you also set an ARN
|
|
4510
|
+
* in <code>PreTokenGeneration</code>, its value must be identical to
|
|
4511
|
+
* <code>PreTokenGenerationConfig</code>.</p>
|
|
4502
4512
|
*/
|
|
4503
|
-
|
|
4513
|
+
PreTokenGenerationConfig?: PreTokenGenerationVersionConfigType;
|
|
4504
4514
|
/**
|
|
4505
4515
|
* @public
|
|
4506
4516
|
* <p>A custom SMS sender Lambda trigger.</p>
|
|
@@ -4708,9 +4718,9 @@ export interface UsernameConfigurationType {
|
|
|
4708
4718
|
/**
|
|
4709
4719
|
* @public
|
|
4710
4720
|
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
4711
|
-
*
|
|
4712
|
-
*
|
|
4713
|
-
*
|
|
4721
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
4722
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
4723
|
+
* <code>ENFORCED</code>.</p>
|
|
4714
4724
|
* <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>.</p>
|
|
4715
4725
|
*/
|
|
4716
4726
|
export interface UserPoolAddOnsType {
|
|
@@ -4795,12 +4805,12 @@ export interface CreateUserPoolRequest {
|
|
|
4795
4805
|
/**
|
|
4796
4806
|
* @public
|
|
4797
4807
|
* <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
|
|
4798
|
-
*
|
|
4799
|
-
*
|
|
4808
|
+
* pool. Before you can delete a user pool that you have protected against deletion, you
|
|
4809
|
+
* must deactivate this feature.</p>
|
|
4800
4810
|
* <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request,
|
|
4801
|
-
*
|
|
4802
|
-
*
|
|
4803
|
-
*
|
|
4811
|
+
* Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool,
|
|
4812
|
+
* send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an
|
|
4813
|
+
* <code>UpdateUserPool</code> API request.</p>
|
|
4804
4814
|
*/
|
|
4805
4815
|
DeletionProtection?: DeletionProtectionType;
|
|
4806
4816
|
/**
|
|
@@ -4920,9 +4930,9 @@ export interface CreateUserPoolRequest {
|
|
|
4920
4930
|
/**
|
|
4921
4931
|
* @public
|
|
4922
4932
|
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
4923
|
-
*
|
|
4924
|
-
*
|
|
4925
|
-
*
|
|
4933
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
4934
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
4935
|
+
* <code>ENFORCED</code>.</p>
|
|
4926
4936
|
* <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>.</p>
|
|
4927
4937
|
*/
|
|
4928
4938
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
@@ -4986,12 +4996,12 @@ export interface UserPoolType {
|
|
|
4986
4996
|
/**
|
|
4987
4997
|
* @public
|
|
4988
4998
|
* <p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user
|
|
4989
|
-
*
|
|
4990
|
-
*
|
|
4999
|
+
* pool. Before you can delete a user pool that you have protected against deletion, you
|
|
5000
|
+
* must deactivate this feature.</p>
|
|
4991
5001
|
* <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request,
|
|
4992
|
-
*
|
|
4993
|
-
*
|
|
4994
|
-
*
|
|
5002
|
+
* Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool,
|
|
5003
|
+
* send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an
|
|
5004
|
+
* <code>UpdateUserPool</code> API request.</p>
|
|
4995
5005
|
*/
|
|
4996
5006
|
DeletionProtection?: DeletionProtectionType;
|
|
4997
5007
|
/**
|
|
@@ -5187,9 +5197,9 @@ export interface UserPoolType {
|
|
|
5187
5197
|
/**
|
|
5188
5198
|
* @public
|
|
5189
5199
|
* <p>User pool add-ons. Contains settings for activation of advanced security features. To
|
|
5190
|
-
*
|
|
5191
|
-
*
|
|
5192
|
-
*
|
|
5200
|
+
* log user security information but take no action, set to <code>AUDIT</code>. To
|
|
5201
|
+
* configure automatic security responses to risky traffic to your user pool, set to
|
|
5202
|
+
* <code>ENFORCED</code>.</p>
|
|
5193
5203
|
* <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>.</p>
|
|
5194
5204
|
*/
|
|
5195
5205
|
UserPoolAddOns?: UserPoolAddOnsType;
|
|
@@ -5355,48 +5365,48 @@ export interface CreateUserPoolClientRequest {
|
|
|
5355
5365
|
/**
|
|
5356
5366
|
* @public
|
|
5357
5367
|
* <p>The refresh token time limit. After this limit expires, your user can't use
|
|
5358
|
-
*
|
|
5359
|
-
*
|
|
5360
|
-
*
|
|
5368
|
+
* their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
|
|
5369
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5370
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5361
5371
|
* <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and
|
|
5362
|
-
*
|
|
5363
|
-
*
|
|
5372
|
+
* <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session
|
|
5373
|
+
* and retrieve new access and ID tokens for 10 days.</p>
|
|
5364
5374
|
* <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days.
|
|
5365
|
-
*
|
|
5366
|
-
*
|
|
5367
|
-
*
|
|
5375
|
+
* You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the
|
|
5376
|
+
* value with the default value of 30 days. <i>Valid range</i> is displayed below
|
|
5377
|
+
* in seconds.</p>
|
|
5368
5378
|
* <p>If you don't specify otherwise in the configuration of your app client, your refresh
|
|
5369
|
-
*
|
|
5379
|
+
* tokens are valid for 30 days.</p>
|
|
5370
5380
|
*/
|
|
5371
5381
|
RefreshTokenValidity?: number;
|
|
5372
5382
|
/**
|
|
5373
5383
|
* @public
|
|
5374
5384
|
* <p>The access token time limit. After this limit expires, your user can't use
|
|
5375
|
-
*
|
|
5376
|
-
*
|
|
5377
|
-
*
|
|
5385
|
+
* their access token. To specify the time unit for <code>AccessTokenValidity</code> as
|
|
5386
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5387
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5378
5388
|
* <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and
|
|
5379
|
-
*
|
|
5380
|
-
*
|
|
5389
|
+
* <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with
|
|
5390
|
+
* their access token for 10 hours.</p>
|
|
5381
5391
|
* <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
|
|
5382
|
-
*
|
|
5392
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5383
5393
|
* <p>If you don't specify otherwise in the configuration of your app client, your access
|
|
5384
|
-
*
|
|
5394
|
+
* tokens are valid for one hour.</p>
|
|
5385
5395
|
*/
|
|
5386
5396
|
AccessTokenValidity?: number;
|
|
5387
5397
|
/**
|
|
5388
5398
|
* @public
|
|
5389
5399
|
* <p>The ID token time limit. After this limit expires, your user can't use
|
|
5390
|
-
*
|
|
5391
|
-
*
|
|
5392
|
-
*
|
|
5400
|
+
* their ID token. To specify the time unit for <code>IdTokenValidity</code> as
|
|
5401
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5402
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5393
5403
|
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
5394
|
-
*
|
|
5395
|
-
*
|
|
5404
|
+
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
5405
|
+
* session with their ID token for 10 hours.</p>
|
|
5396
5406
|
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
5397
|
-
*
|
|
5407
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5398
5408
|
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
5399
|
-
*
|
|
5409
|
+
* tokens are valid for one hour.</p>
|
|
5400
5410
|
*/
|
|
5401
5411
|
IdTokenValidity?: number;
|
|
5402
5412
|
/**
|
|
@@ -5408,40 +5418,40 @@ export interface CreateUserPoolClientRequest {
|
|
|
5408
5418
|
/**
|
|
5409
5419
|
* @public
|
|
5410
5420
|
* <p>The list of user attributes that you want your app client to have read-only access to.
|
|
5411
|
-
*
|
|
5412
|
-
*
|
|
5413
|
-
*
|
|
5414
|
-
*
|
|
5415
|
-
*
|
|
5421
|
+
* After your user authenticates in your app, their access token authorizes them to read
|
|
5422
|
+
* their own attribute value for any attribute in this list. An example of this kind of
|
|
5423
|
+
* activity is when your user selects a link to view their profile information. Your app
|
|
5424
|
+
* 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
|
|
5425
|
+
* data.</p>
|
|
5416
5426
|
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
5417
|
-
*
|
|
5418
|
-
*
|
|
5419
|
-
*
|
|
5420
|
-
*
|
|
5421
|
-
*
|
|
5422
|
-
*
|
|
5427
|
+
* app can read the values of <code>email_verified</code>,
|
|
5428
|
+
* <code>phone_number_verified</code>, and the Standard attributes of your user pool.
|
|
5429
|
+
* When your user pool has read access to these default attributes,
|
|
5430
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
5431
|
+
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
5432
|
+
* custom set of read attributes.</p>
|
|
5423
5433
|
*/
|
|
5424
5434
|
ReadAttributes?: string[];
|
|
5425
5435
|
/**
|
|
5426
5436
|
* @public
|
|
5427
5437
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
5428
|
-
*
|
|
5429
|
-
*
|
|
5430
|
-
*
|
|
5431
|
-
*
|
|
5432
|
-
*
|
|
5438
|
+
* After your user authenticates in your app, their access token authorizes them to set or
|
|
5439
|
+
* modify their own attribute value for any attribute in this list. An example of this kind
|
|
5440
|
+
* of activity is when you present your user with a form to update their profile
|
|
5441
|
+
* 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
|
|
5442
|
+
* new value. </p>
|
|
5433
5443
|
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
5434
|
-
*
|
|
5435
|
-
*
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5438
|
-
*
|
|
5444
|
+
* app can write the values of the Standard attributes of your user pool. When your user
|
|
5445
|
+
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
5446
|
+
* doesn't return any information. Amazon Cognito only populates
|
|
5447
|
+
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
5448
|
+
* custom set of write attributes.</p>
|
|
5439
5449
|
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
5440
|
-
*
|
|
5441
|
-
*
|
|
5442
|
-
*
|
|
5443
|
-
*
|
|
5444
|
-
*
|
|
5450
|
+
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
5451
|
+
* users sign in to your application through an IdP. If your app client does not have write
|
|
5452
|
+
* access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
|
|
5453
|
+
* attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user
|
|
5454
|
+
* pool</a>.</p>
|
|
5445
5455
|
*/
|
|
5446
5456
|
WriteAttributes?: string[];
|
|
5447
5457
|
/**
|
|
@@ -5548,7 +5558,9 @@ export interface CreateUserPoolClientRequest {
|
|
|
5548
5558
|
DefaultRedirectURI?: string;
|
|
5549
5559
|
/**
|
|
5550
5560
|
* @public
|
|
5551
|
-
* <p>The
|
|
5561
|
+
* <p>The OAuth grant types that you want your app client to generate. To create an app
|
|
5562
|
+
* client that generates client credentials grants, you must add
|
|
5563
|
+
* <code>client_credentials</code> as the only allowed OAuth flow.</p>
|
|
5552
5564
|
* <dl>
|
|
5553
5565
|
* <dt>code</dt>
|
|
5554
5566
|
* <dd>
|
|
@@ -5583,7 +5595,7 @@ export interface CreateUserPoolClientRequest {
|
|
|
5583
5595
|
* <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
|
|
5584
5596
|
* <p>
|
|
5585
5597
|
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
5586
|
-
*
|
|
5598
|
+
* the following features in your app client.</p>
|
|
5587
5599
|
* <ul>
|
|
5588
5600
|
* <li>
|
|
5589
5601
|
* <p>
|
|
@@ -5603,10 +5615,10 @@ export interface CreateUserPoolClientRequest {
|
|
|
5603
5615
|
* </li>
|
|
5604
5616
|
* </ul>
|
|
5605
5617
|
* <p>To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
|
|
5606
|
-
*
|
|
5607
|
-
*
|
|
5608
|
-
*
|
|
5609
|
-
*
|
|
5618
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
5619
|
+
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
5620
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
5621
|
+
* to <code>false</code>.</p>
|
|
5610
5622
|
*/
|
|
5611
5623
|
AllowedOAuthFlowsUserPoolClient?: boolean;
|
|
5612
5624
|
/**
|
|
@@ -5708,48 +5720,48 @@ export interface UserPoolClientType {
|
|
|
5708
5720
|
/**
|
|
5709
5721
|
* @public
|
|
5710
5722
|
* <p>The refresh token time limit. After this limit expires, your user can't use
|
|
5711
|
-
*
|
|
5712
|
-
*
|
|
5713
|
-
*
|
|
5723
|
+
* their refresh token. To specify the time unit for <code>RefreshTokenValidity</code> as
|
|
5724
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5725
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5714
5726
|
* <p>For example, when you set <code>RefreshTokenValidity</code> as <code>10</code> and
|
|
5715
|
-
*
|
|
5716
|
-
*
|
|
5727
|
+
* <code>TokenValidityUnits</code> as <code>days</code>, your user can refresh their session
|
|
5728
|
+
* and retrieve new access and ID tokens for 10 days.</p>
|
|
5717
5729
|
* <p>The default time unit for <code>RefreshTokenValidity</code> in an API request is days.
|
|
5718
|
-
*
|
|
5719
|
-
*
|
|
5720
|
-
*
|
|
5730
|
+
* You can't set <code>RefreshTokenValidity</code> to 0. If you do, Amazon Cognito overrides the
|
|
5731
|
+
* value with the default value of 30 days. <i>Valid range</i> is displayed below
|
|
5732
|
+
* in seconds.</p>
|
|
5721
5733
|
* <p>If you don't specify otherwise in the configuration of your app client, your refresh
|
|
5722
|
-
*
|
|
5734
|
+
* tokens are valid for 30 days.</p>
|
|
5723
5735
|
*/
|
|
5724
5736
|
RefreshTokenValidity?: number;
|
|
5725
5737
|
/**
|
|
5726
5738
|
* @public
|
|
5727
5739
|
* <p>The access token time limit. After this limit expires, your user can't use
|
|
5728
|
-
*
|
|
5729
|
-
*
|
|
5730
|
-
*
|
|
5740
|
+
* their access token. To specify the time unit for <code>AccessTokenValidity</code> as
|
|
5741
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5742
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5731
5743
|
* <p>For example, when you set <code>AccessTokenValidity</code> to <code>10</code> and
|
|
5732
|
-
*
|
|
5733
|
-
*
|
|
5744
|
+
* <code>TokenValidityUnits</code> to <code>hours</code>, your user can authorize access with
|
|
5745
|
+
* their access token for 10 hours.</p>
|
|
5734
5746
|
* <p>The default time unit for <code>AccessTokenValidity</code> in an API request is hours.
|
|
5735
|
-
*
|
|
5747
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5736
5748
|
* <p>If you don't specify otherwise in the configuration of your app client, your access
|
|
5737
|
-
*
|
|
5749
|
+
* tokens are valid for one hour.</p>
|
|
5738
5750
|
*/
|
|
5739
5751
|
AccessTokenValidity?: number;
|
|
5740
5752
|
/**
|
|
5741
5753
|
* @public
|
|
5742
5754
|
* <p>The ID token time limit. After this limit expires, your user can't use
|
|
5743
|
-
*
|
|
5744
|
-
*
|
|
5745
|
-
*
|
|
5755
|
+
* their ID token. To specify the time unit for <code>IdTokenValidity</code> as
|
|
5756
|
+
* <code>seconds</code>, <code>minutes</code>, <code>hours</code>, or <code>days</code>,
|
|
5757
|
+
* set a <code>TokenValidityUnits</code> value in your API request.</p>
|
|
5746
5758
|
* <p>For example, when you set <code>IdTokenValidity</code> as <code>10</code> and
|
|
5747
|
-
*
|
|
5748
|
-
*
|
|
5759
|
+
* <code>TokenValidityUnits</code> as <code>hours</code>, your user can authenticate their
|
|
5760
|
+
* session with their ID token for 10 hours.</p>
|
|
5749
5761
|
* <p>The default time unit for <code>IdTokenValidity</code> in an API request is hours.
|
|
5750
|
-
*
|
|
5762
|
+
* <i>Valid range</i> is displayed below in seconds.</p>
|
|
5751
5763
|
* <p>If you don't specify otherwise in the configuration of your app client, your ID
|
|
5752
|
-
*
|
|
5764
|
+
* tokens are valid for one hour.</p>
|
|
5753
5765
|
*/
|
|
5754
5766
|
IdTokenValidity?: number;
|
|
5755
5767
|
/**
|
|
@@ -5761,40 +5773,40 @@ export interface UserPoolClientType {
|
|
|
5761
5773
|
/**
|
|
5762
5774
|
* @public
|
|
5763
5775
|
* <p>The list of user attributes that you want your app client to have read-only access to.
|
|
5764
|
-
*
|
|
5765
|
-
*
|
|
5766
|
-
*
|
|
5767
|
-
*
|
|
5768
|
-
*
|
|
5776
|
+
* After your user authenticates in your app, their access token authorizes them to read
|
|
5777
|
+
* their own attribute value for any attribute in this list. An example of this kind of
|
|
5778
|
+
* activity is when your user selects a link to view their profile information. Your app
|
|
5779
|
+
* 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
|
|
5780
|
+
* data.</p>
|
|
5769
5781
|
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
5770
|
-
*
|
|
5771
|
-
*
|
|
5772
|
-
*
|
|
5773
|
-
*
|
|
5774
|
-
*
|
|
5775
|
-
*
|
|
5782
|
+
* app can read the values of <code>email_verified</code>,
|
|
5783
|
+
* <code>phone_number_verified</code>, and the Standard attributes of your user pool.
|
|
5784
|
+
* When your user pool has read access to these default attributes,
|
|
5785
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
5786
|
+
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
5787
|
+
* custom set of read attributes.</p>
|
|
5776
5788
|
*/
|
|
5777
5789
|
ReadAttributes?: string[];
|
|
5778
5790
|
/**
|
|
5779
5791
|
* @public
|
|
5780
5792
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
5781
|
-
*
|
|
5782
|
-
*
|
|
5783
|
-
*
|
|
5784
|
-
*
|
|
5785
|
-
*
|
|
5793
|
+
* After your user authenticates in your app, their access token authorizes them to set or
|
|
5794
|
+
* modify their own attribute value for any attribute in this list. An example of this kind
|
|
5795
|
+
* of activity is when you present your user with a form to update their profile
|
|
5796
|
+
* 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
|
|
5797
|
+
* new value. </p>
|
|
5786
5798
|
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
5787
|
-
*
|
|
5788
|
-
*
|
|
5789
|
-
*
|
|
5790
|
-
*
|
|
5791
|
-
*
|
|
5799
|
+
* app can write the values of the Standard attributes of your user pool. When your user
|
|
5800
|
+
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
5801
|
+
* doesn't return any information. Amazon Cognito only populates
|
|
5802
|
+
* <code>WriteAttributes</code> in the API response if you have specified your own
|
|
5803
|
+
* custom set of write attributes.</p>
|
|
5792
5804
|
* <p>If your app client allows users to sign in through an IdP, this array must include all
|
|
5793
|
-
*
|
|
5794
|
-
*
|
|
5795
|
-
*
|
|
5796
|
-
*
|
|
5797
|
-
*
|
|
5805
|
+
* attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when
|
|
5806
|
+
* users sign in to your application through an IdP. If your app client does not have write
|
|
5807
|
+
* access to a mapped attribute, Amazon Cognito throws an error when it tries to update the
|
|
5808
|
+
* attribute. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html">Specifying IdP Attribute Mappings for Your user
|
|
5809
|
+
* pool</a>.</p>
|
|
5798
5810
|
*/
|
|
5799
5811
|
WriteAttributes?: string[];
|
|
5800
5812
|
/**
|
|
@@ -5936,7 +5948,7 @@ export interface UserPoolClientType {
|
|
|
5936
5948
|
* <p>Set to <code>true</code> to use OAuth 2.0 features in your user pool app client.</p>
|
|
5937
5949
|
* <p>
|
|
5938
5950
|
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
5939
|
-
*
|
|
5951
|
+
* the following features in your app client.</p>
|
|
5940
5952
|
* <ul>
|
|
5941
5953
|
* <li>
|
|
5942
5954
|
* <p>
|
|
@@ -5956,10 +5968,10 @@ export interface UserPoolClientType {
|
|
|
5956
5968
|
* </li>
|
|
5957
5969
|
* </ul>
|
|
5958
5970
|
* <p>To use OAuth 2.0 features, configure one of these features in the Amazon Cognito console or set
|
|
5959
|
-
*
|
|
5960
|
-
*
|
|
5961
|
-
*
|
|
5962
|
-
*
|
|
5971
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
5972
|
+
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
5973
|
+
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
5974
|
+
* to <code>false</code>.</p>
|
|
5963
5975
|
*/
|
|
5964
5976
|
AllowedOAuthFlowsUserPoolClient?: boolean;
|
|
5965
5977
|
/**
|
|
@@ -6111,7 +6123,9 @@ export interface CreateUserPoolDomainResponse {
|
|
|
6111
6123
|
/**
|
|
6112
6124
|
* @public
|
|
6113
6125
|
* <p>The Amazon CloudFront endpoint that you use as the target of the alias that you set up with
|
|
6114
|
-
* your Domain Name Service (DNS) provider
|
|
6126
|
+
* your Domain Name Service (DNS) provider. Amazon Cognito returns this value if you set a custom
|
|
6127
|
+
* domain with <code>CustomDomainConfig</code>. If you set an Amazon Cognito prefix domain, this
|
|
6128
|
+
* operation returns a blank response.</p>
|
|
6115
6129
|
*/
|
|
6116
6130
|
CloudFrontDomain?: string;
|
|
6117
6131
|
}
|
|
@@ -7537,10 +7551,10 @@ export interface ListDevicesRequest {
|
|
|
7537
7551
|
/**
|
|
7538
7552
|
* @public
|
|
7539
7553
|
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7540
|
-
*
|
|
7541
|
-
*
|
|
7542
|
-
*
|
|
7543
|
-
*
|
|
7554
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7555
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7556
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7557
|
+
* through the full list of items.</p>
|
|
7544
7558
|
*/
|
|
7545
7559
|
PaginationToken?: string;
|
|
7546
7560
|
}
|
|
@@ -7557,8 +7571,8 @@ export interface ListDevicesResponse {
|
|
|
7557
7571
|
/**
|
|
7558
7572
|
* @public
|
|
7559
7573
|
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
7560
|
-
*
|
|
7561
|
-
*
|
|
7574
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
7575
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
7562
7576
|
*/
|
|
7563
7577
|
PaginationToken?: string;
|
|
7564
7578
|
}
|
|
@@ -7733,10 +7747,10 @@ export interface ListUserImportJobsRequest {
|
|
|
7733
7747
|
/**
|
|
7734
7748
|
* @public
|
|
7735
7749
|
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7736
|
-
*
|
|
7737
|
-
*
|
|
7738
|
-
*
|
|
7739
|
-
*
|
|
7750
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7751
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7752
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7753
|
+
* through the full list of items.</p>
|
|
7740
7754
|
*/
|
|
7741
7755
|
PaginationToken?: string;
|
|
7742
7756
|
}
|
|
@@ -7754,8 +7768,8 @@ export interface ListUserImportJobsResponse {
|
|
|
7754
7768
|
/**
|
|
7755
7769
|
* @public
|
|
7756
7770
|
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
7757
|
-
*
|
|
7758
|
-
*
|
|
7771
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
7772
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
7759
7773
|
*/
|
|
7760
7774
|
PaginationToken?: string;
|
|
7761
7775
|
}
|
|
@@ -7925,10 +7939,10 @@ export interface ListUsersRequest {
|
|
|
7925
7939
|
/**
|
|
7926
7940
|
* @public
|
|
7927
7941
|
* <p>This API operation returns a limited number of results. The pagination token is
|
|
7928
|
-
*
|
|
7929
|
-
*
|
|
7930
|
-
*
|
|
7931
|
-
*
|
|
7942
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
7943
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
7944
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
7945
|
+
* through the full list of items.</p>
|
|
7932
7946
|
*/
|
|
7933
7947
|
PaginationToken?: string;
|
|
7934
7948
|
/**
|
|
@@ -8047,8 +8061,8 @@ export interface ListUsersResponse {
|
|
|
8047
8061
|
/**
|
|
8048
8062
|
* @public
|
|
8049
8063
|
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
8050
|
-
*
|
|
8051
|
-
*
|
|
8064
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
8065
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
8052
8066
|
*/
|
|
8053
8067
|
PaginationToken?: string;
|
|
8054
8068
|
}
|
|
@@ -8208,52 +8222,52 @@ export interface RespondToAuthChallengeRequest {
|
|
|
8208
8222
|
/**
|
|
8209
8223
|
* @public
|
|
8210
8224
|
* <p>The responses to the challenge that you received in the previous request. Each
|
|
8211
|
-
*
|
|
8212
|
-
*
|
|
8225
|
+
* challenge has its own required response parameters. The following examples are partial
|
|
8226
|
+
* JSON request bodies that highlight challenge-response parameters.</p>
|
|
8213
8227
|
* <important>
|
|
8214
8228
|
* <p>You must provide a SECRET_HASH parameter in all challenge responses to an app
|
|
8215
|
-
*
|
|
8229
|
+
* client that has a client secret.</p>
|
|
8216
8230
|
* </important>
|
|
8217
8231
|
* <dl>
|
|
8218
8232
|
* <dt>SMS_MFA</dt>
|
|
8219
8233
|
* <dd>
|
|
8220
8234
|
* <p>
|
|
8221
8235
|
* <code>"ChallengeName": "SMS_MFA", "ChallengeResponses": \{"SMS_MFA_CODE":
|
|
8222
|
-
*
|
|
8236
|
+
* "[SMS_code]", "USERNAME": "[username]"\}</code>
|
|
8223
8237
|
* </p>
|
|
8224
8238
|
* </dd>
|
|
8225
8239
|
* <dt>PASSWORD_VERIFIER</dt>
|
|
8226
8240
|
* <dd>
|
|
8227
8241
|
* <p>
|
|
8228
8242
|
* <code>"ChallengeName": "PASSWORD_VERIFIER", "ChallengeResponses":
|
|
8229
|
-
*
|
|
8230
|
-
*
|
|
8231
|
-
*
|
|
8243
|
+
* \{"PASSWORD_CLAIM_SIGNATURE": "[claim_signature]",
|
|
8244
|
+
* "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]", "TIMESTAMP":
|
|
8245
|
+
* [timestamp], "USERNAME": "[username]"\}</code>
|
|
8232
8246
|
* </p>
|
|
8233
8247
|
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
8234
|
-
*
|
|
8248
|
+
* device.</p>
|
|
8235
8249
|
* </dd>
|
|
8236
8250
|
* <dt>CUSTOM_CHALLENGE</dt>
|
|
8237
8251
|
* <dd>
|
|
8238
8252
|
* <p>
|
|
8239
8253
|
* <code>"ChallengeName": "CUSTOM_CHALLENGE", "ChallengeResponses":
|
|
8240
|
-
*
|
|
8254
|
+
* \{"USERNAME": "[username]", "ANSWER": "[challenge_answer]"\}</code>
|
|
8241
8255
|
* </p>
|
|
8242
8256
|
* <p>Add <code>"DEVICE_KEY"</code> when you sign in with a remembered
|
|
8243
|
-
*
|
|
8257
|
+
* device.</p>
|
|
8244
8258
|
* </dd>
|
|
8245
8259
|
* <dt>NEW_PASSWORD_REQUIRED</dt>
|
|
8246
8260
|
* <dd>
|
|
8247
8261
|
* <p>
|
|
8248
8262
|
* <code>"ChallengeName": "NEW_PASSWORD_REQUIRED", "ChallengeResponses":
|
|
8249
|
-
*
|
|
8250
|
-
*
|
|
8263
|
+
* \{"NEW_PASSWORD": "[new_password]", "USERNAME":
|
|
8264
|
+
* "[username]"\}</code>
|
|
8251
8265
|
* </p>
|
|
8252
8266
|
* <p>To set any required attributes that <code>InitiateAuth</code> returned in
|
|
8253
|
-
*
|
|
8254
|
-
*
|
|
8255
|
-
*
|
|
8256
|
-
*
|
|
8267
|
+
* an <code>requiredAttributes</code> parameter, add
|
|
8268
|
+
* <code>"userAttributes.[attribute_name]": "[attribute_value]"</code>.
|
|
8269
|
+
* This parameter can also set values for writable attributes that aren't
|
|
8270
|
+
* required by your user pool.</p>
|
|
8257
8271
|
* <note>
|
|
8258
8272
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
8259
8273
|
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the <code>requiredAttributes</code> parameter,
|
|
@@ -8264,45 +8278,45 @@ export interface RespondToAuthChallengeRequest {
|
|
|
8264
8278
|
* <dd>
|
|
8265
8279
|
* <p>
|
|
8266
8280
|
* <code>"ChallengeName": "SOFTWARE_TOKEN_MFA", "ChallengeResponses":
|
|
8267
|
-
*
|
|
8268
|
-
*
|
|
8281
|
+
* \{"USERNAME": "[username]", "SOFTWARE_TOKEN_MFA_CODE":
|
|
8282
|
+
* [authenticator_code]\}</code>
|
|
8269
8283
|
* </p>
|
|
8270
8284
|
* </dd>
|
|
8271
8285
|
* <dt>DEVICE_SRP_AUTH</dt>
|
|
8272
8286
|
* <dd>
|
|
8273
8287
|
* <p>
|
|
8274
8288
|
* <code>"ChallengeName": "DEVICE_SRP_AUTH", "ChallengeResponses": \{"USERNAME":
|
|
8275
|
-
*
|
|
8276
|
-
*
|
|
8289
|
+
* "[username]", "DEVICE_KEY": "[device_key]", "SRP_A":
|
|
8290
|
+
* "[srp_a]"\}</code>
|
|
8277
8291
|
* </p>
|
|
8278
8292
|
* </dd>
|
|
8279
8293
|
* <dt>DEVICE_PASSWORD_VERIFIER</dt>
|
|
8280
8294
|
* <dd>
|
|
8281
8295
|
* <p>
|
|
8282
8296
|
* <code>"ChallengeName": "DEVICE_PASSWORD_VERIFIER", "ChallengeResponses":
|
|
8283
|
-
*
|
|
8284
|
-
*
|
|
8285
|
-
*
|
|
8297
|
+
* \{"DEVICE_KEY": "[device_key]", "PASSWORD_CLAIM_SIGNATURE":
|
|
8298
|
+
* "[claim_signature]", "PASSWORD_CLAIM_SECRET_BLOCK": "[secret_block]",
|
|
8299
|
+
* "TIMESTAMP": [timestamp], "USERNAME": "[username]"\}</code>
|
|
8286
8300
|
* </p>
|
|
8287
8301
|
* </dd>
|
|
8288
8302
|
* <dt>MFA_SETUP</dt>
|
|
8289
8303
|
* <dd>
|
|
8290
8304
|
* <p>
|
|
8291
8305
|
* <code>"ChallengeName": "MFA_SETUP", "ChallengeResponses": \{"USERNAME":
|
|
8292
|
-
*
|
|
8293
|
-
*
|
|
8306
|
+
* "[username]"\}, "SESSION": "[Session ID from
|
|
8307
|
+
* VerifySoftwareToken]"</code>
|
|
8294
8308
|
* </p>
|
|
8295
8309
|
* </dd>
|
|
8296
8310
|
* <dt>SELECT_MFA_TYPE</dt>
|
|
8297
8311
|
* <dd>
|
|
8298
8312
|
* <p>
|
|
8299
8313
|
* <code>"ChallengeName": "SELECT_MFA_TYPE", "ChallengeResponses": \{"USERNAME":
|
|
8300
|
-
*
|
|
8314
|
+
* "[username]", "ANSWER": "[SMS_MFA or SOFTWARE_TOKEN_MFA]"\}</code>
|
|
8301
8315
|
* </p>
|
|
8302
8316
|
* </dd>
|
|
8303
8317
|
* </dl>
|
|
8304
8318
|
* <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
|
|
8305
|
-
*
|
|
8319
|
+
* <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>
|
|
8306
8320
|
*/
|
|
8307
8321
|
ChallengeResponses?: Record<string, string>;
|
|
8308
8322
|
/**
|