@aws-sdk/client-cognito-identity-provider 3.758.0 → 3.768.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 +121 -88
- 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 +749 -656
- package/dist-types/models/models_1.d.ts +837 -560
- 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
|
@@ -1,25 +1,36 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { CognitoIdentityProviderServiceException as __BaseException } from "./CognitoIdentityProviderServiceException";
|
|
4
|
-
import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, StatusType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType,
|
|
4
|
+
import { AccountRecoverySettingType, AccountTakeoverRiskConfigurationType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, AuthenticationResultType, AuthFlowType, ChallengeNameType, CodeDeliveryDetailsType, CompromisedCredentialsRiskConfigurationType, CustomDomainConfigType, DeletionProtectionType, DeviceConfigurationType, DeviceRememberedStatusType, DeviceType, EmailConfigurationType, EmailMfaConfigType, EmailMfaSettingsType, ExplicitAuthFlowsType, FeedbackValueType, GroupType, IdentityProviderType, IdentityProviderTypeType, LambdaConfigType, LogConfigurationType, LogDeliveryConfigurationType, ManagedLoginBrandingType, MFAOptionType, OAuthFlowType, PreventUserExistenceErrorTypes, ResourceServerScopeType, ResourceServerType, RiskConfigurationType, RiskExceptionConfigurationType, SmsConfigurationType, SmsMfaConfigType, SMSMfaSettingsType, SoftwareTokenMfaConfigType, SoftwareTokenMfaSettingsType, StatusType, TokenValidityUnitsType, UICustomizationType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolMfaType, UserPoolPolicyType, UserPoolTierType, UserType, VerificationMessageTemplateType, VerifiedAttributeType } from "./models_0";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* @public
|
|
7
|
+
* @enum
|
|
8
|
+
*/
|
|
9
|
+
export declare const UserVerificationType: {
|
|
10
|
+
readonly PREFERRED: "preferred";
|
|
11
|
+
readonly REQUIRED: "required";
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
export type UserVerificationType = (typeof UserVerificationType)[keyof typeof UserVerificationType];
|
|
17
|
+
/**
|
|
18
|
+
* <p>Settings for authentication (MFA) with passkey, or webauthN, biometric and
|
|
19
|
+
* security-key devices in a user pool. Configures the following:</p>
|
|
8
20
|
* <ul>
|
|
9
21
|
* <li>
|
|
10
|
-
* <p>Configuration
|
|
11
|
-
* configuration as an MFA factor, or include it as a choice.</p>
|
|
22
|
+
* <p>Configuration for requiring user-verification support in passkeys.</p>
|
|
12
23
|
* </li>
|
|
13
24
|
* <li>
|
|
14
|
-
* <p>The user pool relying-party ID. This is the
|
|
15
|
-
* passkey providers should trust as a receiver of passkey
|
|
25
|
+
* <p>The user pool relying-party ID. This is the domain, typically your user pool
|
|
26
|
+
* domain, that user's passkey providers should trust as a receiver of passkey
|
|
27
|
+
* authentication.</p>
|
|
16
28
|
* </li>
|
|
17
29
|
* <li>
|
|
18
30
|
* <p>The providers that you want to allow as origins for passkey
|
|
19
31
|
* authentication.</p>
|
|
20
32
|
* </li>
|
|
21
33
|
* </ul>
|
|
22
|
-
* <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>
|
|
23
34
|
* @public
|
|
24
35
|
*/
|
|
25
36
|
export interface WebAuthnConfigurationType {
|
|
@@ -58,7 +69,7 @@ export interface WebAuthnConfigurationType {
|
|
|
58
69
|
*/
|
|
59
70
|
export interface GetUserPoolMfaConfigResponse {
|
|
60
71
|
/**
|
|
61
|
-
* <p>Shows user pool SMS message
|
|
72
|
+
* <p>Shows user pool configuration for SMS message MFA. Includes the message template and
|
|
62
73
|
* the SMS message sending configuration for Amazon SNS.</p>
|
|
63
74
|
* @public
|
|
64
75
|
*/
|
|
@@ -70,35 +81,31 @@ export interface GetUserPoolMfaConfigResponse {
|
|
|
70
81
|
*/
|
|
71
82
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
72
83
|
/**
|
|
73
|
-
* <p>Shows user pool email message
|
|
74
|
-
*
|
|
75
|
-
*
|
|
84
|
+
* <p>Shows configuration for user pool email message MFA and sign-in with one-time
|
|
85
|
+
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
86
|
+
* 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">
|
|
87
|
+
* Essentials tier</a> or higher.</p>
|
|
76
88
|
* @public
|
|
77
89
|
*/
|
|
78
90
|
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
79
91
|
/**
|
|
80
|
-
* <p>
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* </li>
|
|
90
|
-
* <li>
|
|
91
|
-
* <p>
|
|
92
|
-
* <code>OPTIONAL</code> MFA will be required only for individual users who have
|
|
93
|
-
* an MFA factor activated.</p>
|
|
94
|
-
* </li>
|
|
95
|
-
* </ul>
|
|
92
|
+
* <p>Displays the state of multi-factor authentication (MFA) as on, off, or optional. When
|
|
93
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
94
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
95
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
96
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
97
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
98
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
99
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
100
|
+
* MFA factor.</p>
|
|
96
101
|
* @public
|
|
97
102
|
*/
|
|
98
103
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
99
104
|
/**
|
|
100
|
-
* <p>Shows user pool configuration for
|
|
101
|
-
* security keys
|
|
105
|
+
* <p>Shows user pool configuration for sign-in with passkey authenticators like biometric
|
|
106
|
+
* devices and security keys. Passkeys are not eligible MFA factors. They are instead an
|
|
107
|
+
* eligible primary sign-in factor for <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>, or the
|
|
108
|
+
* <code>USER_AUTH</code> flow.</p>
|
|
102
109
|
* @public
|
|
103
110
|
*/
|
|
104
111
|
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
@@ -109,7 +116,8 @@ export interface GetUserPoolMfaConfigResponse {
|
|
|
109
116
|
*/
|
|
110
117
|
export interface GlobalSignOutRequest {
|
|
111
118
|
/**
|
|
112
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
119
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
120
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
113
121
|
* @public
|
|
114
122
|
*/
|
|
115
123
|
AccessToken: string | undefined;
|
|
@@ -128,42 +136,17 @@ export interface InitiateAuthRequest {
|
|
|
128
136
|
/**
|
|
129
137
|
* <p>The authentication flow that you want to initiate. Each <code>AuthFlow</code> has
|
|
130
138
|
* linked <code>AuthParameters</code> that you must submit. The following are some example
|
|
131
|
-
* flows
|
|
132
|
-
* <ul>
|
|
133
|
-
* <li>
|
|
134
|
-
* <p>
|
|
135
|
-
* <code>USER_AUTH</code>: Request a preferred authentication type or review
|
|
136
|
-
* available authentication types. From the offered authentication types, select
|
|
137
|
-
* one in a challenge response and then authenticate with that method in an
|
|
138
|
-
* additional challenge response.</p>
|
|
139
|
-
* </li>
|
|
140
|
-
* <li>
|
|
141
|
-
* <p>
|
|
142
|
-
* <code>REFRESH_TOKEN_AUTH</code>: Receive new ID and access tokens when you
|
|
143
|
-
* pass a <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
|
|
144
|
-
* value.</p>
|
|
145
|
-
* </li>
|
|
146
|
-
* <li>
|
|
147
|
-
* <p>
|
|
148
|
-
* <code>USER_SRP_AUTH</code>: Receive secure remote password (SRP) variables for
|
|
149
|
-
* the next challenge, <code>PASSWORD_VERIFIER</code>, when you pass
|
|
150
|
-
* <code>USERNAME</code> and <code>SRP_A</code> parameters.</p>
|
|
151
|
-
* </li>
|
|
152
|
-
* <li>
|
|
153
|
-
* <p>
|
|
154
|
-
* <code>USER_PASSWORD_AUTH</code>: Receive new tokens or the next challenge, for
|
|
155
|
-
* example <code>SOFTWARE_TOKEN_MFA</code>, when you pass <code>USERNAME</code> and
|
|
156
|
-
* <code>PASSWORD</code> parameters.</p>
|
|
157
|
-
* </li>
|
|
158
|
-
* </ul>
|
|
159
|
-
* <p>
|
|
160
|
-
* <i>All flows</i>
|
|
161
|
-
* </p>
|
|
139
|
+
* flows.</p>
|
|
162
140
|
* <dl>
|
|
163
141
|
* <dt>USER_AUTH</dt>
|
|
164
142
|
* <dd>
|
|
165
|
-
* <p>The entry point for
|
|
166
|
-
*
|
|
143
|
+
* <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,
|
|
144
|
+
* one-time passwords, and WebAuthn authenticators. Request a preferred
|
|
145
|
+
* authentication type or review available authentication types. From the
|
|
146
|
+
* offered authentication types, select one in a challenge response and then
|
|
147
|
+
* authenticate with that method in an additional challenge response.
|
|
148
|
+
* 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">
|
|
149
|
+
* Essentials tier</a> or higher.</p>
|
|
167
150
|
* </dd>
|
|
168
151
|
* <dt>USER_SRP_AUTH</dt>
|
|
169
152
|
* <dd>
|
|
@@ -173,8 +156,9 @@ export interface InitiateAuthRequest {
|
|
|
173
156
|
* </dd>
|
|
174
157
|
* <dt>REFRESH_TOKEN_AUTH and REFRESH_TOKEN</dt>
|
|
175
158
|
* <dd>
|
|
176
|
-
* <p>
|
|
177
|
-
*
|
|
159
|
+
* <p>Receive new ID and access tokens when you pass a
|
|
160
|
+
* <code>REFRESH_TOKEN</code> parameter with a valid refresh token as the
|
|
161
|
+
* 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>
|
|
178
162
|
* </dd>
|
|
179
163
|
* <dt>CUSTOM_AUTH</dt>
|
|
180
164
|
* <dd>
|
|
@@ -184,46 +168,51 @@ export interface InitiateAuthRequest {
|
|
|
184
168
|
* </dd>
|
|
185
169
|
* <dt>USER_PASSWORD_AUTH</dt>
|
|
186
170
|
* <dd>
|
|
187
|
-
* <p>
|
|
188
|
-
* request. For more information
|
|
171
|
+
* <p>Client-side username-password authentication with the password sent
|
|
172
|
+
* directly in the request. For more information about client-side and
|
|
173
|
+
* 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>
|
|
189
174
|
* </dd>
|
|
190
175
|
* </dl>
|
|
191
176
|
* <p>
|
|
192
|
-
* <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <
|
|
193
|
-
*
|
|
194
|
-
* isn't valid for InitiateAuth.</p>
|
|
177
|
+
* <code>ADMIN_USER_PASSWORD_AUTH</code> is a flow type of <code>AdminInitiateAuth</code>
|
|
178
|
+
* and isn't valid for InitiateAuth. <code>ADMIN_NO_SRP_AUTH</code> is a legacy server-side
|
|
179
|
+
* username-password flow and isn't valid for InitiateAuth.</p>
|
|
195
180
|
* @public
|
|
196
181
|
*/
|
|
197
182
|
AuthFlow: AuthFlowType | undefined;
|
|
198
183
|
/**
|
|
199
184
|
* <p>The authentication parameters. These are inputs corresponding to the
|
|
200
|
-
* <code>AuthFlow</code> that you're invoking
|
|
201
|
-
*
|
|
185
|
+
* <code>AuthFlow</code> that you're invoking.</p>
|
|
186
|
+
* <p>The required values are specific to the <a>InitiateAuthRequest$AuthFlow</a>.</p>
|
|
187
|
+
* <p>The following are some authentication flows and their parameters. Add a
|
|
188
|
+
* <code>SECRET_HASH</code> parameter if your app client has a client secret.</p>
|
|
202
189
|
* <ul>
|
|
203
190
|
* <li>
|
|
204
|
-
* <p>
|
|
191
|
+
* <p>
|
|
192
|
+
* <code>USER_AUTH</code>: <code>USERNAME</code> (required),
|
|
205
193
|
* <code>PREFERRED_CHALLENGE</code>. If you don't provide a value for
|
|
206
194
|
* <code>PREFERRED_CHALLENGE</code>, Amazon Cognito responds with the
|
|
207
195
|
* <code>AvailableChallenges</code> parameter that specifies the available
|
|
208
196
|
* sign-in methods.</p>
|
|
209
197
|
* </li>
|
|
210
198
|
* <li>
|
|
211
|
-
* <p>
|
|
212
|
-
*
|
|
213
|
-
*
|
|
199
|
+
* <p>
|
|
200
|
+
* <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required),
|
|
201
|
+
* <code>SRP_A</code> (required), <code>DEVICE_KEY</code>.</p>
|
|
214
202
|
* </li>
|
|
215
203
|
* <li>
|
|
216
|
-
* <p>
|
|
217
|
-
*
|
|
218
|
-
*
|
|
204
|
+
* <p>
|
|
205
|
+
* <code>USER_PASSWORD_AUTH</code>: <code>USERNAME</code> (required),
|
|
206
|
+
* <code>PASSWORD</code> (required), <code>DEVICE_KEY</code>.</p>
|
|
219
207
|
* </li>
|
|
220
208
|
* <li>
|
|
221
|
-
* <p>
|
|
222
|
-
*
|
|
223
|
-
*
|
|
209
|
+
* <p>
|
|
210
|
+
* <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>REFRESH_TOKEN</code>
|
|
211
|
+
* (required), <code>DEVICE_KEY</code>.</p>
|
|
224
212
|
* </li>
|
|
225
213
|
* <li>
|
|
226
|
-
* <p>
|
|
214
|
+
* <p>
|
|
215
|
+
* <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required),
|
|
227
216
|
* <code>SECRET_HASH</code> (if app client is configured with client secret),
|
|
228
217
|
* <code>DEVICE_KEY</code>. To start the authentication flow with password
|
|
229
218
|
* verification, include <code>ChallengeName: SRP_A</code> and <code>SRP_A: (The
|
|
@@ -239,12 +228,12 @@ export interface InitiateAuthRequest {
|
|
|
239
228
|
* <p>A map of custom key-value pairs that you can provide as input for certain custom
|
|
240
229
|
* workflows that this action triggers.</p>
|
|
241
230
|
* <p>You create custom workflows by assigning Lambda functions to user pool triggers.
|
|
242
|
-
* When you
|
|
243
|
-
* specified for various triggers. The ClientMetadata value is passed
|
|
244
|
-
* functions for only the following triggers
|
|
231
|
+
* When you send an <code>InitiateAuth</code> request, Amazon Cognito invokes the Lambda functions
|
|
232
|
+
* that are specified for various triggers. The <code>ClientMetadata</code> value is passed
|
|
233
|
+
* as input to the functions for only the following triggers.</p>
|
|
245
234
|
* <ul>
|
|
246
235
|
* <li>
|
|
247
|
-
* <p>Pre
|
|
236
|
+
* <p>Pre sign-up</p>
|
|
248
237
|
* </li>
|
|
249
238
|
* <li>
|
|
250
239
|
* <p>Pre authentication</p>
|
|
@@ -253,14 +242,15 @@ export interface InitiateAuthRequest {
|
|
|
253
242
|
* <p>User migration</p>
|
|
254
243
|
* </li>
|
|
255
244
|
* </ul>
|
|
256
|
-
* <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload
|
|
257
|
-
* the function
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* <p>
|
|
263
|
-
*
|
|
245
|
+
* <p>When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload as input
|
|
246
|
+
* to the function. This payload contains a <code>validationData</code> attribute with the
|
|
247
|
+
* data that you assigned to the <code>ClientMetadata</code> parameter in your
|
|
248
|
+
* <code>InitiateAuth</code> request. In your function, <code>validationData</code> can
|
|
249
|
+
* contribute to operations that require data that isn't in the default
|
|
250
|
+
* payload.</p>
|
|
251
|
+
* <p>
|
|
252
|
+
* <code>InitiateAuth</code> requests invokes the following triggers without
|
|
253
|
+
* <code>ClientMetadata</code> as input.</p>
|
|
264
254
|
* <ul>
|
|
265
255
|
* <li>
|
|
266
256
|
* <p>Post authentication</p>
|
|
@@ -285,7 +275,7 @@ export interface InitiateAuthRequest {
|
|
|
285
275
|
* </li>
|
|
286
276
|
* </ul>
|
|
287
277
|
* <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">
|
|
288
|
-
*
|
|
278
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
289
279
|
* <note>
|
|
290
280
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
291
281
|
* following:</p>
|
|
@@ -309,19 +299,20 @@ export interface InitiateAuthRequest {
|
|
|
309
299
|
*/
|
|
310
300
|
ClientMetadata?: Record<string, string> | undefined;
|
|
311
301
|
/**
|
|
312
|
-
* <p>The app client
|
|
302
|
+
* <p>The ID of the app client that your user wants to sign in to.</p>
|
|
313
303
|
* @public
|
|
314
304
|
*/
|
|
315
305
|
ClientId: string | undefined;
|
|
316
306
|
/**
|
|
317
|
-
* <p>
|
|
318
|
-
*
|
|
307
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
308
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
309
|
+
* email address, or phone number.</p>
|
|
319
310
|
* @public
|
|
320
311
|
*/
|
|
321
312
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
322
313
|
/**
|
|
323
|
-
* <p>Contextual data about your user session
|
|
324
|
-
*
|
|
314
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
315
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
325
316
|
* when it makes API requests.</p>
|
|
326
317
|
* <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
|
|
327
318
|
* applications</a>.</p>
|
|
@@ -331,7 +322,12 @@ export interface InitiateAuthRequest {
|
|
|
331
322
|
/**
|
|
332
323
|
* <p>The optional session ID from a <code>ConfirmSignUp</code> API request. You can sign in
|
|
333
324
|
* a user directly from the sign-up process with the <code>USER_AUTH</code> authentication
|
|
334
|
-
* flow
|
|
325
|
+
* flow. When you pass the session ID to <code>InitiateAuth</code>, Amazon Cognito assumes the SMS
|
|
326
|
+
* or email message one-time verification password from <code>ConfirmSignUp</code> as the
|
|
327
|
+
* primary authentication factor. You're not required to submit this code a second
|
|
328
|
+
* time. This option is only valid for users who have confirmed their sign-up and are
|
|
329
|
+
* signing in for the first time within the authentication flow session duration of the
|
|
330
|
+
* session ID.</p>
|
|
335
331
|
* @public
|
|
336
332
|
*/
|
|
337
333
|
Session?: string | undefined;
|
|
@@ -342,20 +338,18 @@ export interface InitiateAuthRequest {
|
|
|
342
338
|
*/
|
|
343
339
|
export interface InitiateAuthResponse {
|
|
344
340
|
/**
|
|
345
|
-
* <p>The name of
|
|
346
|
-
*
|
|
347
|
-
* challenge.</p>
|
|
348
|
-
* <p>Valid values include the following:</p>
|
|
341
|
+
* <p>The name of an additional authentication challenge that you must respond to.</p>
|
|
342
|
+
* <p>Possible challenges include the following:</p>
|
|
349
343
|
* <note>
|
|
350
|
-
* <p>All of the following challenges require <code>USERNAME</code> and
|
|
351
|
-
*
|
|
344
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
345
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
352
346
|
* </note>
|
|
353
347
|
* <ul>
|
|
354
348
|
* <li>
|
|
355
349
|
* <p>
|
|
356
350
|
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
357
|
-
* successful authentication with a
|
|
358
|
-
*
|
|
351
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
352
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
359
353
|
* </li>
|
|
360
354
|
* <li>
|
|
361
355
|
* <p>
|
|
@@ -380,58 +374,56 @@ export interface InitiateAuthResponse {
|
|
|
380
374
|
* </li>
|
|
381
375
|
* <li>
|
|
382
376
|
* <p>
|
|
383
|
-
* <code>SMS_MFA</code>:
|
|
384
|
-
* <code>SMS_MFA_CODE</code>that your user pool delivered in an SMS message.</p>
|
|
377
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
378
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
385
379
|
* </li>
|
|
386
380
|
* <li>
|
|
387
381
|
* <p>
|
|
388
|
-
* <code>EMAIL_OTP</code>:
|
|
382
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
389
383
|
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
390
384
|
* message.</p>
|
|
391
385
|
* </li>
|
|
392
386
|
* <li>
|
|
393
387
|
* <p>
|
|
394
|
-
* <code>PASSWORD_VERIFIER</code>:
|
|
388
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
395
389
|
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
396
390
|
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
397
|
-
*
|
|
391
|
+
* client-side SRP calculations.</p>
|
|
398
392
|
* </li>
|
|
399
393
|
* <li>
|
|
400
394
|
* <p>
|
|
401
395
|
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
402
396
|
* flow determines that the user should pass another challenge before tokens are
|
|
403
|
-
* issued.</p>
|
|
397
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
404
398
|
* </li>
|
|
405
399
|
* <li>
|
|
406
400
|
* <p>
|
|
407
|
-
* <code>DEVICE_SRP_AUTH</code>:
|
|
408
|
-
*
|
|
409
|
-
* Amazon Cognito can start tracking this device.</p>
|
|
401
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
402
|
+
* 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>
|
|
410
403
|
* </li>
|
|
411
404
|
* <li>
|
|
412
405
|
* <p>
|
|
413
|
-
* <code>DEVICE_PASSWORD_VERIFIER</code>:
|
|
414
|
-
* <code>
|
|
406
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
407
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
408
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
409
|
+
* 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>
|
|
415
410
|
* </li>
|
|
416
411
|
* <li>
|
|
417
412
|
* <p>
|
|
418
413
|
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
419
|
-
* passwords after successful first login
|
|
420
|
-
*
|
|
421
|
-
*
|
|
422
|
-
*
|
|
423
|
-
*
|
|
414
|
+
* passwords after successful first login. Respond to this challenge with
|
|
415
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
416
|
+
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
417
|
+
* attributes that aren't required by your user pool and that your app client
|
|
418
|
+
* can write.</p>
|
|
424
419
|
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
* required-attribute values for all users who don't have passwords. You can create
|
|
428
|
-
* a user in the Amazon Cognito console without, for example, a required
|
|
429
|
-
* <code>birthdate</code> attribute. The API response from Amazon Cognito won't prompt
|
|
430
|
-
* you to submit a birthdate for the user if they don't have a password.</p>
|
|
420
|
+
* When you create passwordless users, you must provide values for all required
|
|
421
|
+
* attributes.</p>
|
|
431
422
|
* <note>
|
|
432
423
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
433
|
-
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
434
|
-
* then use the <code>UpdateUserAttributes</code> API
|
|
424
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
425
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
426
|
+
* operation to modify the value of any additional attributes.</p>
|
|
435
427
|
* </note>
|
|
436
428
|
* </li>
|
|
437
429
|
* <li>
|
|
@@ -439,49 +431,50 @@ export interface InitiateAuthResponse {
|
|
|
439
431
|
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
440
432
|
* before they can sign in. The MFA types activated for the user pool will be
|
|
441
433
|
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
442
|
-
* <p>
|
|
443
|
-
*
|
|
444
|
-
* <code>AssociateSoftwareToken</code>.
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
450
|
-
*
|
|
434
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
435
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
436
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
437
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
438
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
439
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
440
|
+
* </p>
|
|
441
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
442
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
443
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
444
|
+
* </p>
|
|
451
445
|
* </li>
|
|
452
446
|
* </ul>
|
|
453
447
|
* @public
|
|
454
448
|
*/
|
|
455
449
|
ChallengeName?: ChallengeNameType | undefined;
|
|
456
450
|
/**
|
|
457
|
-
* <p>The session that
|
|
458
|
-
* the
|
|
459
|
-
* parameters
|
|
460
|
-
* request.</p>
|
|
451
|
+
* <p>The session identifier that links a challenge response to the initial authentication
|
|
452
|
+
* request. If the user must pass another challenge, Amazon Cognito returns a session ID and
|
|
453
|
+
* challenge parameters.</p>
|
|
461
454
|
* @public
|
|
462
455
|
*/
|
|
463
456
|
Session?: string | undefined;
|
|
464
457
|
/**
|
|
465
|
-
* <p>The
|
|
466
|
-
* if you must pass another challenge. The responses in this parameter should be used to
|
|
467
|
-
* compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p>
|
|
458
|
+
* <p>The required parameters of the <code>ChallengeName</code> challenge.</p>
|
|
468
459
|
* <p>All challenges require <code>USERNAME</code>. They also require
|
|
469
460
|
* <code>SECRET_HASH</code> if your app client has a client secret.</p>
|
|
470
461
|
* @public
|
|
471
462
|
*/
|
|
472
463
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
473
464
|
/**
|
|
474
|
-
* <p>The result of
|
|
475
|
-
* doesn't need to pass another challenge. If
|
|
476
|
-
* challenge before
|
|
477
|
-
* <code>
|
|
465
|
+
* <p>The result of a successful and complete authentication request. This result is only
|
|
466
|
+
* returned if the user doesn't need to pass another challenge. If they must pass another
|
|
467
|
+
* challenge before they get tokens, Amazon Cognito returns a challenge in
|
|
468
|
+
* <code>ChallengeName</code>, <code>ChallengeParameters</code>, and
|
|
469
|
+
* <code>Session</code> response parameters.</p>
|
|
478
470
|
* @public
|
|
479
471
|
*/
|
|
480
472
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
481
473
|
/**
|
|
482
|
-
* <p>This response parameter
|
|
483
|
-
*
|
|
484
|
-
*
|
|
474
|
+
* <p>This response parameter lists the available authentication challenges that users can
|
|
475
|
+
* 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
|
|
476
|
+
* able to choose between passkey authentication, a one-time password from an SMS message,
|
|
477
|
+
* and a traditional password.</p>
|
|
485
478
|
* @public
|
|
486
479
|
*/
|
|
487
480
|
AvailableChallenges?: ChallengeNameType[] | undefined;
|
|
@@ -492,13 +485,13 @@ export interface InitiateAuthResponse {
|
|
|
492
485
|
*/
|
|
493
486
|
export interface ListDevicesRequest {
|
|
494
487
|
/**
|
|
495
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
496
|
-
*
|
|
488
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
489
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
497
490
|
* @public
|
|
498
491
|
*/
|
|
499
492
|
AccessToken: string | undefined;
|
|
500
493
|
/**
|
|
501
|
-
* <p>The
|
|
494
|
+
* <p>The maximum number of devices that you want Amazon Cognito to return in the response.</p>
|
|
502
495
|
* @public
|
|
503
496
|
*/
|
|
504
497
|
Limit?: number | undefined;
|
|
@@ -518,7 +511,8 @@ export interface ListDevicesRequest {
|
|
|
518
511
|
*/
|
|
519
512
|
export interface ListDevicesResponse {
|
|
520
513
|
/**
|
|
521
|
-
* <p>
|
|
514
|
+
* <p>An array of devices and their details. Each entry that's returned includes device
|
|
515
|
+
* information, last-accessed and created dates, and the device key.</p>
|
|
522
516
|
* @public
|
|
523
517
|
*/
|
|
524
518
|
Devices?: DeviceType[] | undefined;
|
|
@@ -535,18 +529,21 @@ export interface ListDevicesResponse {
|
|
|
535
529
|
*/
|
|
536
530
|
export interface ListGroupsRequest {
|
|
537
531
|
/**
|
|
538
|
-
* <p>The ID of the user pool.</p>
|
|
532
|
+
* <p>The ID of the user pool where you want to list user groups.</p>
|
|
539
533
|
* @public
|
|
540
534
|
*/
|
|
541
535
|
UserPoolId: string | undefined;
|
|
542
536
|
/**
|
|
543
|
-
* <p>The
|
|
537
|
+
* <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
|
|
544
538
|
* @public
|
|
545
539
|
*/
|
|
546
540
|
Limit?: number | undefined;
|
|
547
541
|
/**
|
|
548
|
-
* <p>
|
|
549
|
-
*
|
|
542
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
543
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
544
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
545
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
546
|
+
* through the full list of items.</p>
|
|
550
547
|
* @public
|
|
551
548
|
*/
|
|
552
549
|
NextToken?: string | undefined;
|
|
@@ -556,13 +553,15 @@ export interface ListGroupsRequest {
|
|
|
556
553
|
*/
|
|
557
554
|
export interface ListGroupsResponse {
|
|
558
555
|
/**
|
|
559
|
-
* <p>
|
|
556
|
+
* <p>An array of groups and their details. Each entry that's returned includes
|
|
557
|
+
* description, precedence, and IAM role values.</p>
|
|
560
558
|
* @public
|
|
561
559
|
*/
|
|
562
560
|
Groups?: GroupType[] | undefined;
|
|
563
561
|
/**
|
|
564
|
-
* <p>
|
|
565
|
-
*
|
|
562
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
563
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
564
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
566
565
|
* @public
|
|
567
566
|
*/
|
|
568
567
|
NextToken?: string | undefined;
|
|
@@ -572,24 +571,27 @@ export interface ListGroupsResponse {
|
|
|
572
571
|
*/
|
|
573
572
|
export interface ListIdentityProvidersRequest {
|
|
574
573
|
/**
|
|
575
|
-
* <p>The user pool
|
|
574
|
+
* <p>The ID of the user pool where you want to list IdPs.</p>
|
|
576
575
|
* @public
|
|
577
576
|
*/
|
|
578
577
|
UserPoolId: string | undefined;
|
|
579
578
|
/**
|
|
580
|
-
* <p>The maximum number of IdPs to return.</p>
|
|
579
|
+
* <p>The maximum number of IdPs that you want Amazon Cognito to return in the response.</p>
|
|
581
580
|
* @public
|
|
582
581
|
*/
|
|
583
582
|
MaxResults?: number | undefined;
|
|
584
583
|
/**
|
|
585
|
-
* <p>
|
|
584
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
585
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
586
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
587
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
588
|
+
* through the full list of items.</p>
|
|
586
589
|
* @public
|
|
587
590
|
*/
|
|
588
591
|
NextToken?: string | undefined;
|
|
589
592
|
}
|
|
590
593
|
/**
|
|
591
594
|
* <p>The details of a user pool identity provider (IdP), including name and type.</p>
|
|
592
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html">ListIdentityProviders</a>.</p>
|
|
593
595
|
* @public
|
|
594
596
|
*/
|
|
595
597
|
export interface ProviderDescription {
|
|
@@ -623,12 +625,15 @@ export interface ProviderDescription {
|
|
|
623
625
|
*/
|
|
624
626
|
export interface ListIdentityProvidersResponse {
|
|
625
627
|
/**
|
|
626
|
-
* <p>
|
|
628
|
+
* <p>An array of the IdPs in your user pool. For each, the response includes identifiers,
|
|
629
|
+
* the IdP name and type, and trust-relationship details like the issuer URL.</p>
|
|
627
630
|
* @public
|
|
628
631
|
*/
|
|
629
632
|
Providers: ProviderDescription[] | undefined;
|
|
630
633
|
/**
|
|
631
|
-
* <p>
|
|
634
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
635
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
636
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
632
637
|
* @public
|
|
633
638
|
*/
|
|
634
639
|
NextToken?: string | undefined;
|
|
@@ -638,17 +643,22 @@ export interface ListIdentityProvidersResponse {
|
|
|
638
643
|
*/
|
|
639
644
|
export interface ListResourceServersRequest {
|
|
640
645
|
/**
|
|
641
|
-
* <p>The ID of the user pool.</p>
|
|
646
|
+
* <p>The ID of the user pool where you want to list resource servers.</p>
|
|
642
647
|
* @public
|
|
643
648
|
*/
|
|
644
649
|
UserPoolId: string | undefined;
|
|
645
650
|
/**
|
|
646
|
-
* <p>The maximum number of resource servers to return
|
|
651
|
+
* <p>The maximum number of resource servers that you want Amazon Cognito to return in the
|
|
652
|
+
* response.</p>
|
|
647
653
|
* @public
|
|
648
654
|
*/
|
|
649
655
|
MaxResults?: number | undefined;
|
|
650
656
|
/**
|
|
651
|
-
* <p>
|
|
657
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
658
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
659
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
660
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
661
|
+
* through the full list of items.</p>
|
|
652
662
|
* @public
|
|
653
663
|
*/
|
|
654
664
|
NextToken?: string | undefined;
|
|
@@ -658,12 +668,15 @@ export interface ListResourceServersRequest {
|
|
|
658
668
|
*/
|
|
659
669
|
export interface ListResourceServersResponse {
|
|
660
670
|
/**
|
|
661
|
-
* <p>
|
|
671
|
+
* <p>An array of resource servers and the details of their configuration. For each, the
|
|
672
|
+
* response includes names, identifiers, and custom scopes.</p>
|
|
662
673
|
* @public
|
|
663
674
|
*/
|
|
664
675
|
ResourceServers: ResourceServerType[] | undefined;
|
|
665
676
|
/**
|
|
666
|
-
* <p>
|
|
677
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
678
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
679
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
667
680
|
* @public
|
|
668
681
|
*/
|
|
669
682
|
NextToken?: string | undefined;
|
|
@@ -694,12 +707,13 @@ export interface ListTagsForResourceResponse {
|
|
|
694
707
|
*/
|
|
695
708
|
export interface ListUserImportJobsRequest {
|
|
696
709
|
/**
|
|
697
|
-
* <p>The ID of the user pool
|
|
710
|
+
* <p>The ID of the user pool where you want to list import jobs.</p>
|
|
698
711
|
* @public
|
|
699
712
|
*/
|
|
700
713
|
UserPoolId: string | undefined;
|
|
701
714
|
/**
|
|
702
|
-
* <p>The maximum number of import jobs you want
|
|
715
|
+
* <p>The maximum number of import jobs that you want Amazon Cognito to return in the
|
|
716
|
+
* response.</p>
|
|
703
717
|
* @public
|
|
704
718
|
*/
|
|
705
719
|
MaxResults: number | undefined;
|
|
@@ -720,7 +734,8 @@ export interface ListUserImportJobsRequest {
|
|
|
720
734
|
*/
|
|
721
735
|
export interface ListUserImportJobsResponse {
|
|
722
736
|
/**
|
|
723
|
-
* <p>
|
|
737
|
+
* <p>An array of user import jobs from the requested user pool. For each, the response
|
|
738
|
+
* includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.</p>
|
|
724
739
|
* @public
|
|
725
740
|
*/
|
|
726
741
|
UserImportJobs?: UserImportJobType[] | undefined;
|
|
@@ -743,21 +758,23 @@ export interface ListUserPoolClientsRequest {
|
|
|
743
758
|
*/
|
|
744
759
|
UserPoolId: string | undefined;
|
|
745
760
|
/**
|
|
746
|
-
* <p>The maximum number of
|
|
747
|
-
*
|
|
761
|
+
* <p>The maximum number of app clients that you want Amazon Cognito to return in the
|
|
762
|
+
* response.</p>
|
|
748
763
|
* @public
|
|
749
764
|
*/
|
|
750
765
|
MaxResults?: number | undefined;
|
|
751
766
|
/**
|
|
752
|
-
* <p>
|
|
753
|
-
*
|
|
767
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
768
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
769
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
770
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
771
|
+
* through the full list of items.</p>
|
|
754
772
|
* @public
|
|
755
773
|
*/
|
|
756
774
|
NextToken?: string | undefined;
|
|
757
775
|
}
|
|
758
776
|
/**
|
|
759
777
|
* <p>A short description of a user pool app client.</p>
|
|
760
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html">ListUserPoolClients</a>. </p>
|
|
761
778
|
* @public
|
|
762
779
|
*/
|
|
763
780
|
export interface UserPoolClientDescription {
|
|
@@ -783,13 +800,14 @@ export interface UserPoolClientDescription {
|
|
|
783
800
|
*/
|
|
784
801
|
export interface ListUserPoolClientsResponse {
|
|
785
802
|
/**
|
|
786
|
-
* <p>
|
|
803
|
+
* <p>An array of app clients and their details. Includes app client ID and name.</p>
|
|
787
804
|
* @public
|
|
788
805
|
*/
|
|
789
806
|
UserPoolClients?: UserPoolClientDescription[] | undefined;
|
|
790
807
|
/**
|
|
791
|
-
* <p>
|
|
792
|
-
*
|
|
808
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
809
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
810
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
793
811
|
* @public
|
|
794
812
|
*/
|
|
795
813
|
NextToken?: string | undefined;
|
|
@@ -800,21 +818,22 @@ export interface ListUserPoolClientsResponse {
|
|
|
800
818
|
*/
|
|
801
819
|
export interface ListUserPoolsRequest {
|
|
802
820
|
/**
|
|
803
|
-
* <p>
|
|
804
|
-
*
|
|
821
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
822
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
823
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
824
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
825
|
+
* through the full list of items.</p>
|
|
805
826
|
* @public
|
|
806
827
|
*/
|
|
807
828
|
NextToken?: string | undefined;
|
|
808
829
|
/**
|
|
809
|
-
* <p>The maximum number of
|
|
810
|
-
* pools.</p>
|
|
830
|
+
* <p>The maximum number of user pools that you want Amazon Cognito to return in the response.</p>
|
|
811
831
|
* @public
|
|
812
832
|
*/
|
|
813
833
|
MaxResults: number | undefined;
|
|
814
834
|
}
|
|
815
835
|
/**
|
|
816
836
|
* <p>A short description of a user pool.</p>
|
|
817
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPools.html">ListUserPools</a>. </p>
|
|
818
837
|
* @public
|
|
819
838
|
*/
|
|
820
839
|
export interface UserPoolDescriptionType {
|
|
@@ -861,13 +880,14 @@ export interface UserPoolDescriptionType {
|
|
|
861
880
|
*/
|
|
862
881
|
export interface ListUserPoolsResponse {
|
|
863
882
|
/**
|
|
864
|
-
* <p>
|
|
883
|
+
* <p>An array of user pools and their configuration details.</p>
|
|
865
884
|
* @public
|
|
866
885
|
*/
|
|
867
886
|
UserPools?: UserPoolDescriptionType[] | undefined;
|
|
868
887
|
/**
|
|
869
|
-
* <p>
|
|
870
|
-
*
|
|
888
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
889
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
890
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
871
891
|
* @public
|
|
872
892
|
*/
|
|
873
893
|
NextToken?: string | undefined;
|
|
@@ -878,7 +898,7 @@ export interface ListUserPoolsResponse {
|
|
|
878
898
|
*/
|
|
879
899
|
export interface ListUsersRequest {
|
|
880
900
|
/**
|
|
881
|
-
* <p>The ID of the user pool
|
|
901
|
+
* <p>The ID of the user pool where you want to display or search for users.</p>
|
|
882
902
|
* @public
|
|
883
903
|
*/
|
|
884
904
|
UserPoolId: string | undefined;
|
|
@@ -896,7 +916,7 @@ export interface ListUsersRequest {
|
|
|
896
916
|
*/
|
|
897
917
|
AttributesToGet?: string[] | undefined;
|
|
898
918
|
/**
|
|
899
|
-
* <p>
|
|
919
|
+
* <p>The maximum number of users that you want Amazon Cognito to return in the response.</p>
|
|
900
920
|
* @public
|
|
901
921
|
*/
|
|
902
922
|
Limit?: number | undefined;
|
|
@@ -1011,15 +1031,7 @@ export interface ListUsersRequest {
|
|
|
1011
1031
|
*/
|
|
1012
1032
|
export interface ListUsersResponse {
|
|
1013
1033
|
/**
|
|
1014
|
-
* <p>
|
|
1015
|
-
* <note>
|
|
1016
|
-
* <p>Amazon Cognito creates a profile in your user pool for each native user in your user pool,
|
|
1017
|
-
* and each unique user ID from your third-party identity providers (IdPs). When you
|
|
1018
|
-
* link users with the <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html">AdminLinkProviderForUser</a> API operation, the output of
|
|
1019
|
-
* <code>ListUsers</code> displays both the IdP user and the native user that you
|
|
1020
|
-
* linked. You can identify IdP users in the <code>Users</code> object of this API
|
|
1021
|
-
* response by the IdP prefix that Amazon Cognito appends to <code>Username</code>.</p>
|
|
1022
|
-
* </note>
|
|
1034
|
+
* <p>An array of user pool users who match your query, and their attributes.</p>
|
|
1023
1035
|
* @public
|
|
1024
1036
|
*/
|
|
1025
1037
|
Users?: UserType[] | undefined;
|
|
@@ -1036,23 +1048,27 @@ export interface ListUsersResponse {
|
|
|
1036
1048
|
*/
|
|
1037
1049
|
export interface ListUsersInGroupRequest {
|
|
1038
1050
|
/**
|
|
1039
|
-
* <p>The ID of the user pool
|
|
1051
|
+
* <p>The ID of the user pool where you want to view the membership of the requested
|
|
1052
|
+
* group.</p>
|
|
1040
1053
|
* @public
|
|
1041
1054
|
*/
|
|
1042
1055
|
UserPoolId: string | undefined;
|
|
1043
1056
|
/**
|
|
1044
|
-
* <p>The name of the group.</p>
|
|
1057
|
+
* <p>The name of the group that you want to query for user membership.</p>
|
|
1045
1058
|
* @public
|
|
1046
1059
|
*/
|
|
1047
1060
|
GroupName: string | undefined;
|
|
1048
1061
|
/**
|
|
1049
|
-
* <p>The maximum number of
|
|
1062
|
+
* <p>The maximum number of groups that you want Amazon Cognito to return in the response.</p>
|
|
1050
1063
|
* @public
|
|
1051
1064
|
*/
|
|
1052
1065
|
Limit?: number | undefined;
|
|
1053
1066
|
/**
|
|
1054
|
-
* <p>
|
|
1055
|
-
*
|
|
1067
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1068
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1069
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1070
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1071
|
+
* through the full list of items.</p>
|
|
1056
1072
|
* @public
|
|
1057
1073
|
*/
|
|
1058
1074
|
NextToken?: string | undefined;
|
|
@@ -1062,13 +1078,14 @@ export interface ListUsersInGroupRequest {
|
|
|
1062
1078
|
*/
|
|
1063
1079
|
export interface ListUsersInGroupResponse {
|
|
1064
1080
|
/**
|
|
1065
|
-
* <p>
|
|
1081
|
+
* <p>An array of users who are members in the group, and their attributes.</p>
|
|
1066
1082
|
* @public
|
|
1067
1083
|
*/
|
|
1068
1084
|
Users?: UserType[] | undefined;
|
|
1069
1085
|
/**
|
|
1070
|
-
* <p>
|
|
1071
|
-
*
|
|
1086
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1087
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1088
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1072
1089
|
* @public
|
|
1073
1090
|
*/
|
|
1074
1091
|
NextToken?: string | undefined;
|
|
@@ -1078,14 +1095,17 @@ export interface ListUsersInGroupResponse {
|
|
|
1078
1095
|
*/
|
|
1079
1096
|
export interface ListWebAuthnCredentialsRequest {
|
|
1080
1097
|
/**
|
|
1081
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
1082
|
-
*
|
|
1098
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
1099
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
1083
1100
|
* @public
|
|
1084
1101
|
*/
|
|
1085
1102
|
AccessToken: string | undefined;
|
|
1086
1103
|
/**
|
|
1087
|
-
* <p>
|
|
1088
|
-
*
|
|
1104
|
+
* <p>This API operation returns a limited number of results. The pagination token is
|
|
1105
|
+
* an identifier that you can present in an additional API request with the same parameters. When
|
|
1106
|
+
* you include the pagination token, Amazon Cognito returns the next set of items after the current list.
|
|
1107
|
+
* Subsequent requests return a new pagination token. By use of this token, you can paginate
|
|
1108
|
+
* through the full list of items.</p>
|
|
1089
1109
|
* @public
|
|
1090
1110
|
*/
|
|
1091
1111
|
NextToken?: string | undefined;
|
|
@@ -1099,7 +1119,6 @@ export interface ListWebAuthnCredentialsRequest {
|
|
|
1099
1119
|
/**
|
|
1100
1120
|
* <p>The details of a passkey, or webauthN, biometric or security-key authentication factor
|
|
1101
1121
|
* for a user.</p>
|
|
1102
|
-
* <p>This data type is a response parameter of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html">ListWebAuthnCredentials</a>.</p>
|
|
1103
1122
|
* @public
|
|
1104
1123
|
*/
|
|
1105
1124
|
export interface WebAuthnCredentialDescription {
|
|
@@ -1148,8 +1167,9 @@ export interface ListWebAuthnCredentialsResponse {
|
|
|
1148
1167
|
*/
|
|
1149
1168
|
Credentials: WebAuthnCredentialDescription[] | undefined;
|
|
1150
1169
|
/**
|
|
1151
|
-
* <p>
|
|
1152
|
-
*
|
|
1170
|
+
* <p>The identifier that Amazon Cognito returned with the previous request to this operation. When
|
|
1171
|
+
* you include a pagination token in your request, Amazon Cognito returns the next set of items in
|
|
1172
|
+
* the list. By use of this token, you can paginate through the full list of items.</p>
|
|
1153
1173
|
* @public
|
|
1154
1174
|
*/
|
|
1155
1175
|
NextToken?: string | undefined;
|
|
@@ -1160,7 +1180,7 @@ export interface ListWebAuthnCredentialsResponse {
|
|
|
1160
1180
|
*/
|
|
1161
1181
|
export interface ResendConfirmationCodeRequest {
|
|
1162
1182
|
/**
|
|
1163
|
-
* <p>The ID of the client
|
|
1183
|
+
* <p>The ID of the user pool app client where the user signed up.</p>
|
|
1164
1184
|
* @public
|
|
1165
1185
|
*/
|
|
1166
1186
|
ClientId: string | undefined;
|
|
@@ -1172,8 +1192,8 @@ export interface ResendConfirmationCodeRequest {
|
|
|
1172
1192
|
*/
|
|
1173
1193
|
SecretHash?: string | undefined;
|
|
1174
1194
|
/**
|
|
1175
|
-
* <p>Contextual data about your user session
|
|
1176
|
-
*
|
|
1195
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
1196
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1177
1197
|
* when it makes API requests.</p>
|
|
1178
1198
|
* <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
|
|
1179
1199
|
* applications</a>.</p>
|
|
@@ -1181,7 +1201,7 @@ export interface ResendConfirmationCodeRequest {
|
|
|
1181
1201
|
*/
|
|
1182
1202
|
UserContextData?: UserContextDataType | undefined;
|
|
1183
1203
|
/**
|
|
1184
|
-
* <p>The
|
|
1204
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
1185
1205
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
1186
1206
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
1187
1207
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -1190,8 +1210,9 @@ export interface ResendConfirmationCodeRequest {
|
|
|
1190
1210
|
*/
|
|
1191
1211
|
Username: string | undefined;
|
|
1192
1212
|
/**
|
|
1193
|
-
* <p>
|
|
1194
|
-
*
|
|
1213
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
1214
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
1215
|
+
* email address, or phone number.</p>
|
|
1195
1216
|
* @public
|
|
1196
1217
|
*/
|
|
1197
1218
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
@@ -1207,7 +1228,7 @@ export interface ResendConfirmationCodeRequest {
|
|
|
1207
1228
|
* function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
|
|
1208
1229
|
* your workflow for your specific needs.</p>
|
|
1209
1230
|
* <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">
|
|
1210
|
-
*
|
|
1231
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1211
1232
|
* <note>
|
|
1212
1233
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1213
1234
|
* following:</p>
|
|
@@ -1238,8 +1259,8 @@ export interface ResendConfirmationCodeRequest {
|
|
|
1238
1259
|
*/
|
|
1239
1260
|
export interface ResendConfirmationCodeResponse {
|
|
1240
1261
|
/**
|
|
1241
|
-
* <p>
|
|
1242
|
-
*
|
|
1262
|
+
* <p>Information about the phone number or email address that Amazon Cognito sent the confirmation
|
|
1263
|
+
* code to.</p>
|
|
1243
1264
|
* @public
|
|
1244
1265
|
*/
|
|
1245
1266
|
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
@@ -1250,23 +1271,131 @@ export interface ResendConfirmationCodeResponse {
|
|
|
1250
1271
|
*/
|
|
1251
1272
|
export interface RespondToAuthChallengeRequest {
|
|
1252
1273
|
/**
|
|
1253
|
-
* <p>The app client
|
|
1274
|
+
* <p>The ID of the app client where the user is signing in.</p>
|
|
1254
1275
|
* @public
|
|
1255
1276
|
*/
|
|
1256
1277
|
ClientId: string | undefined;
|
|
1257
1278
|
/**
|
|
1258
|
-
* <p>The
|
|
1259
|
-
* <
|
|
1260
|
-
* <code>ADMIN_NO_SRP_AUTH</code>
|
|
1279
|
+
* <p>The name of the challenge that you are responding to.</p>
|
|
1280
|
+
* <note>
|
|
1281
|
+
* <p>You can't respond to an <code>ADMIN_NO_SRP_AUTH</code> challenge with this
|
|
1282
|
+
* operation.</p>
|
|
1283
|
+
* </note>
|
|
1284
|
+
* <p>Possible challenges include the following:</p>
|
|
1285
|
+
* <note>
|
|
1286
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
1287
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
1288
|
+
* </note>
|
|
1289
|
+
* <ul>
|
|
1290
|
+
* <li>
|
|
1291
|
+
* <p>
|
|
1292
|
+
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
1293
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
1294
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
1295
|
+
* </li>
|
|
1296
|
+
* <li>
|
|
1297
|
+
* <p>
|
|
1298
|
+
* <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
|
|
1299
|
+
* parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
|
|
1300
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
1301
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
1302
|
+
* </li>
|
|
1303
|
+
* <li>
|
|
1304
|
+
* <p>
|
|
1305
|
+
* <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
|
|
1306
|
+
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|
1307
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
1308
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
1309
|
+
* </li>
|
|
1310
|
+
* <li>
|
|
1311
|
+
* <p>
|
|
1312
|
+
* <code>SELECT_CHALLENGE</code>: Respond to the challenge with
|
|
1313
|
+
* <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
|
|
1314
|
+
* challenge types in the <code>AvailableChallenges</code> response
|
|
1315
|
+
* parameter.</p>
|
|
1316
|
+
* </li>
|
|
1317
|
+
* <li>
|
|
1318
|
+
* <p>
|
|
1319
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
1320
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
1321
|
+
* </li>
|
|
1322
|
+
* <li>
|
|
1323
|
+
* <p>
|
|
1324
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
1325
|
+
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
1326
|
+
* message.</p>
|
|
1327
|
+
* </li>
|
|
1328
|
+
* <li>
|
|
1329
|
+
* <p>
|
|
1330
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
1331
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1332
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1333
|
+
* client-side SRP calculations.</p>
|
|
1334
|
+
* </li>
|
|
1335
|
+
* <li>
|
|
1336
|
+
* <p>
|
|
1337
|
+
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
1338
|
+
* flow determines that the user should pass another challenge before tokens are
|
|
1339
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
1340
|
+
* </li>
|
|
1341
|
+
* <li>
|
|
1342
|
+
* <p>
|
|
1343
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
1344
|
+
* 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>
|
|
1345
|
+
* </li>
|
|
1346
|
+
* <li>
|
|
1347
|
+
* <p>
|
|
1348
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
1349
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1350
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1351
|
+
* 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>
|
|
1352
|
+
* </li>
|
|
1353
|
+
* <li>
|
|
1354
|
+
* <p>
|
|
1355
|
+
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
1356
|
+
* passwords after successful first login. Respond to this challenge with
|
|
1357
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
1358
|
+
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
1359
|
+
* attributes that aren't required by your user pool and that your app client
|
|
1360
|
+
* can write.</p>
|
|
1361
|
+
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
1362
|
+
* When you create passwordless users, you must provide values for all required
|
|
1363
|
+
* attributes.</p>
|
|
1364
|
+
* <note>
|
|
1365
|
+
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
1366
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1367
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
1368
|
+
* operation to modify the value of any additional attributes.</p>
|
|
1369
|
+
* </note>
|
|
1370
|
+
* </li>
|
|
1371
|
+
* <li>
|
|
1372
|
+
* <p>
|
|
1373
|
+
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
1374
|
+
* before they can sign in. The MFA types activated for the user pool will be
|
|
1375
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
1376
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
1377
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
1378
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
1379
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
1380
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
1381
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
1382
|
+
* </p>
|
|
1383
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
1384
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
1385
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
1386
|
+
* </p>
|
|
1387
|
+
* </li>
|
|
1388
|
+
* </ul>
|
|
1261
1389
|
* @public
|
|
1262
1390
|
*/
|
|
1263
1391
|
ChallengeName: ChallengeNameType | undefined;
|
|
1264
1392
|
/**
|
|
1265
|
-
* <p>The session that
|
|
1266
|
-
*
|
|
1267
|
-
*
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1393
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
1394
|
+
* challenge responses. If an <code>AdminInitiateAuth</code> or
|
|
1395
|
+
* <code>AdminRespondToAuthChallenge</code> API request results in a determination that
|
|
1396
|
+
* your application must pass another challenge, Amazon Cognito returns a session with other
|
|
1397
|
+
* challenge parameters. Send this session identifier, unmodified, to the next
|
|
1398
|
+
* <code>AdminRespondToAuthChallenge</code> request.</p>
|
|
1270
1399
|
* @public
|
|
1271
1400
|
*/
|
|
1272
1401
|
Session?: string | undefined;
|
|
@@ -1299,7 +1428,7 @@ export interface RespondToAuthChallengeRequest {
|
|
|
1299
1428
|
* "USERNAME": "[username]",
|
|
1300
1429
|
* "CREDENTIAL": "[AuthenticationResponseJSON]"\}</code>
|
|
1301
1430
|
* </p>
|
|
1302
|
-
* <p>See <a href="https://www.w3.org/TR/
|
|
1431
|
+
* <p>See <a href="https://www.w3.org/TR/WebAuthn-3/#dictdef-authenticationresponsejson">
|
|
1303
1432
|
* AuthenticationResponseJSON</a>.</p>
|
|
1304
1433
|
* </li>
|
|
1305
1434
|
* <li>
|
|
@@ -1398,8 +1527,9 @@ export interface RespondToAuthChallengeRequest {
|
|
|
1398
1527
|
* required by your user pool.</p>
|
|
1399
1528
|
* <note>
|
|
1400
1529
|
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
1401
|
-
* In <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1402
|
-
* then use the <code>UpdateUserAttributes</code> API
|
|
1530
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1531
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
1532
|
+
* operation to modify the value of any additional attributes.</p>
|
|
1403
1533
|
* </note>
|
|
1404
1534
|
* </dd>
|
|
1405
1535
|
* <dt>SOFTWARE_TOKEN_MFA</dt>
|
|
@@ -1449,14 +1579,15 @@ export interface RespondToAuthChallengeRequest {
|
|
|
1449
1579
|
*/
|
|
1450
1580
|
ChallengeResponses?: Record<string, string> | undefined;
|
|
1451
1581
|
/**
|
|
1452
|
-
* <p>
|
|
1453
|
-
*
|
|
1582
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
1583
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
1584
|
+
* email address, or phone number.</p>
|
|
1454
1585
|
* @public
|
|
1455
1586
|
*/
|
|
1456
1587
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
1457
1588
|
/**
|
|
1458
|
-
* <p>Contextual data about your user session
|
|
1459
|
-
*
|
|
1589
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
1590
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1460
1591
|
* when it makes API requests.</p>
|
|
1461
1592
|
* <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
|
|
1462
1593
|
* applications</a>.</p>
|
|
@@ -1479,7 +1610,7 @@ export interface RespondToAuthChallengeRequest {
|
|
|
1479
1610
|
* <code>clientMetadata</code> value to enhance your workflow for your specific
|
|
1480
1611
|
* needs.</p>
|
|
1481
1612
|
* <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">
|
|
1482
|
-
*
|
|
1613
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1483
1614
|
* <note>
|
|
1484
1615
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1485
1616
|
* following:</p>
|
|
@@ -1509,26 +1640,134 @@ export interface RespondToAuthChallengeRequest {
|
|
|
1509
1640
|
*/
|
|
1510
1641
|
export interface RespondToAuthChallengeResponse {
|
|
1511
1642
|
/**
|
|
1512
|
-
* <p>The
|
|
1643
|
+
* <p>The name of the next challenge that you must respond to.</p>
|
|
1644
|
+
* <p>Possible challenges include the following:</p>
|
|
1645
|
+
* <note>
|
|
1646
|
+
* <p>All of the following challenges require <code>USERNAME</code> and, when the app
|
|
1647
|
+
* client has a client secret, <code>SECRET_HASH</code> in the parameters.</p>
|
|
1648
|
+
* </note>
|
|
1649
|
+
* <ul>
|
|
1650
|
+
* <li>
|
|
1651
|
+
* <p>
|
|
1652
|
+
* <code>WEB_AUTHN</code>: Respond to the challenge with the results of a
|
|
1653
|
+
* successful authentication with a WebAuthn authenticator, or passkey. Examples
|
|
1654
|
+
* of WebAuthn authenticators include biometric devices and security keys.</p>
|
|
1655
|
+
* </li>
|
|
1656
|
+
* <li>
|
|
1657
|
+
* <p>
|
|
1658
|
+
* <code>PASSWORD</code>: Respond with <code>USER_PASSWORD_AUTH</code>
|
|
1659
|
+
* parameters: <code>USERNAME</code> (required), <code>PASSWORD</code> (required),
|
|
1660
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
1661
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
1662
|
+
* </li>
|
|
1663
|
+
* <li>
|
|
1664
|
+
* <p>
|
|
1665
|
+
* <code>PASSWORD_SRP</code>: Respond with <code>USER_SRP_AUTH</code> parameters:
|
|
1666
|
+
* <code>USERNAME</code> (required), <code>SRP_A</code> (required),
|
|
1667
|
+
* <code>SECRET_HASH</code> (required if the app client is configured with a
|
|
1668
|
+
* client secret), <code>DEVICE_KEY</code>.</p>
|
|
1669
|
+
* </li>
|
|
1670
|
+
* <li>
|
|
1671
|
+
* <p>
|
|
1672
|
+
* <code>SELECT_CHALLENGE</code>: Respond to the challenge with
|
|
1673
|
+
* <code>USERNAME</code> and an <code>ANSWER</code> that matches one of the
|
|
1674
|
+
* challenge types in the <code>AvailableChallenges</code> response
|
|
1675
|
+
* parameter.</p>
|
|
1676
|
+
* </li>
|
|
1677
|
+
* <li>
|
|
1678
|
+
* <p>
|
|
1679
|
+
* <code>SMS_MFA</code>: Respond with an
|
|
1680
|
+
* <code>SMS_MFA_CODE</code> that your user pool delivered in an SMS message.</p>
|
|
1681
|
+
* </li>
|
|
1682
|
+
* <li>
|
|
1683
|
+
* <p>
|
|
1684
|
+
* <code>EMAIL_OTP</code>: Respond with an
|
|
1685
|
+
* <code>EMAIL_OTP_CODE</code> that your user pool delivered in an email
|
|
1686
|
+
* message.</p>
|
|
1687
|
+
* </li>
|
|
1688
|
+
* <li>
|
|
1689
|
+
* <p>
|
|
1690
|
+
* <code>PASSWORD_VERIFIER</code>: Respond with
|
|
1691
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1692
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1693
|
+
* client-side SRP calculations.</p>
|
|
1694
|
+
* </li>
|
|
1695
|
+
* <li>
|
|
1696
|
+
* <p>
|
|
1697
|
+
* <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication
|
|
1698
|
+
* flow determines that the user should pass another challenge before tokens are
|
|
1699
|
+
* issued. The parameters of the challenge are determined by your Lambda function.</p>
|
|
1700
|
+
* </li>
|
|
1701
|
+
* <li>
|
|
1702
|
+
* <p>
|
|
1703
|
+
* <code>DEVICE_SRP_AUTH</code>: Respond with the initial parameters of device SRP
|
|
1704
|
+
* 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>
|
|
1705
|
+
* </li>
|
|
1706
|
+
* <li>
|
|
1707
|
+
* <p>
|
|
1708
|
+
* <code>DEVICE_PASSWORD_VERIFIER</code>: Respond with
|
|
1709
|
+
* <code>PASSWORD_CLAIM_SIGNATURE</code>,
|
|
1710
|
+
* <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after
|
|
1711
|
+
* 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>
|
|
1712
|
+
* </li>
|
|
1713
|
+
* <li>
|
|
1714
|
+
* <p>
|
|
1715
|
+
* <code>NEW_PASSWORD_REQUIRED</code>: For users who are required to change their
|
|
1716
|
+
* passwords after successful first login. Respond to this challenge with
|
|
1717
|
+
* <code>NEW_PASSWORD</code> and any required attributes that Amazon Cognito returned in
|
|
1718
|
+
* the <code>requiredAttributes</code> parameter. You can also set values for
|
|
1719
|
+
* attributes that aren't required by your user pool and that your app client
|
|
1720
|
+
* can write.</p>
|
|
1721
|
+
* <p>Amazon Cognito only returns this challenge for users who have temporary passwords.
|
|
1722
|
+
* When you create passwordless users, you must provide values for all required
|
|
1723
|
+
* attributes.</p>
|
|
1724
|
+
* <note>
|
|
1725
|
+
* <p>In a <code>NEW_PASSWORD_REQUIRED</code> challenge response, you can't modify a required attribute that already has a value.
|
|
1726
|
+
* In <code>AdminRespondToAuthChallenge</code> or <code>RespondToAuthChallenge</code>, set a value for any keys that Amazon Cognito returned in the
|
|
1727
|
+
* <code>requiredAttributes</code> parameter, then use the <code>AdminUpdateUserAttributes</code> or <code>UpdateUserAttributes</code> API
|
|
1728
|
+
* operation to modify the value of any additional attributes.</p>
|
|
1729
|
+
* </note>
|
|
1730
|
+
* </li>
|
|
1731
|
+
* <li>
|
|
1732
|
+
* <p>
|
|
1733
|
+
* <code>MFA_SETUP</code>: For users who are required to setup an MFA factor
|
|
1734
|
+
* before they can sign in. The MFA types activated for the user pool will be
|
|
1735
|
+
* listed in the challenge parameters <code>MFAS_CAN_SETUP</code> value. </p>
|
|
1736
|
+
* <p>To set up time-based one-time password (TOTP) MFA, use the session returned
|
|
1737
|
+
* in this challenge from <code>InitiateAuth</code> or <code>AdminInitiateAuth</code>
|
|
1738
|
+
* as an input to <code>AssociateSoftwareToken</code>. Then, use the session returned
|
|
1739
|
+
* by <code>VerifySoftwareToken</code> as an input to
|
|
1740
|
+
* <code>RespondToAuthChallenge</code> or <code>AdminRespondToAuthChallenge</code>
|
|
1741
|
+
* with challenge name <code>MFA_SETUP</code> to complete sign-in.
|
|
1742
|
+
* </p>
|
|
1743
|
+
* <p>To set up SMS or email MFA, collect a <code>phone_number</code> or
|
|
1744
|
+
* <code>email</code> attribute for the user. Then restart the authentication
|
|
1745
|
+
* flow with an <code>InitiateAuth</code> or <code>AdminInitiateAuth</code> request.
|
|
1746
|
+
* </p>
|
|
1747
|
+
* </li>
|
|
1748
|
+
* </ul>
|
|
1513
1749
|
* @public
|
|
1514
1750
|
*/
|
|
1515
1751
|
ChallengeName?: ChallengeNameType | undefined;
|
|
1516
1752
|
/**
|
|
1517
|
-
* <p>The session that
|
|
1518
|
-
*
|
|
1519
|
-
*
|
|
1520
|
-
*
|
|
1753
|
+
* <p>The session identifier that maintains the state of authentication requests and
|
|
1754
|
+
* challenge responses. If an <code>InitiateAuth</code> or
|
|
1755
|
+
* <code>RespondToAuthChallenge</code> API request results in a determination that your
|
|
1756
|
+
* application must pass another challenge, Amazon Cognito returns a session with other challenge
|
|
1757
|
+
* parameters. Send this session identifier, unmodified, to the next
|
|
1758
|
+
* <code>RespondToAuthChallenge</code> request.</p>
|
|
1521
1759
|
* @public
|
|
1522
1760
|
*/
|
|
1523
1761
|
Session?: string | undefined;
|
|
1524
1762
|
/**
|
|
1525
|
-
* <p>The
|
|
1763
|
+
* <p>The parameters that define your response to the next challenge.</p>
|
|
1526
1764
|
* @public
|
|
1527
1765
|
*/
|
|
1528
1766
|
ChallengeParameters?: Record<string, string> | undefined;
|
|
1529
1767
|
/**
|
|
1530
|
-
* <p>The
|
|
1531
|
-
*
|
|
1768
|
+
* <p>The outcome of a successful authentication process. After your application has passed
|
|
1769
|
+
* all challenges, Amazon Cognito returns an <code>AuthenticationResult</code> with the JSON web
|
|
1770
|
+
* tokens (JWTs) that indicate successful sign-in.</p>
|
|
1532
1771
|
* @public
|
|
1533
1772
|
*/
|
|
1534
1773
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
@@ -1543,13 +1782,12 @@ export interface RevokeTokenRequest {
|
|
|
1543
1782
|
*/
|
|
1544
1783
|
Token: string | undefined;
|
|
1545
1784
|
/**
|
|
1546
|
-
* <p>The
|
|
1785
|
+
* <p>The ID of the app client where the token that you want to revoke was issued.</p>
|
|
1547
1786
|
* @public
|
|
1548
1787
|
*/
|
|
1549
1788
|
ClientId: string | undefined;
|
|
1550
1789
|
/**
|
|
1551
|
-
* <p>The secret
|
|
1552
|
-
* secret.</p>
|
|
1790
|
+
* <p>The client secret of the requested app client, if the client has a secret.</p>
|
|
1553
1791
|
* @public
|
|
1554
1792
|
*/
|
|
1555
1793
|
ClientSecret?: string | undefined;
|
|
@@ -1617,8 +1855,7 @@ export interface SetLogDeliveryConfigurationRequest {
|
|
|
1617
1855
|
*/
|
|
1618
1856
|
export interface SetLogDeliveryConfigurationResponse {
|
|
1619
1857
|
/**
|
|
1620
|
-
* <p>The
|
|
1621
|
-
* pool.</p>
|
|
1858
|
+
* <p>The logging configuration that you applied to the requested user pool.</p>
|
|
1622
1859
|
* @public
|
|
1623
1860
|
*/
|
|
1624
1861
|
LogDeliveryConfiguration?: LogDeliveryConfigurationType | undefined;
|
|
@@ -1628,32 +1865,41 @@ export interface SetLogDeliveryConfigurationResponse {
|
|
|
1628
1865
|
*/
|
|
1629
1866
|
export interface SetRiskConfigurationRequest {
|
|
1630
1867
|
/**
|
|
1631
|
-
* <p>The user pool
|
|
1868
|
+
* <p>The ID of the user pool where you want to set a risk configuration. If you include
|
|
1869
|
+
* <code>UserPoolId</code> in your request, don't include <code>ClientId</code>.
|
|
1870
|
+
* When the client ID is null, the same risk configuration is applied to all the clients in
|
|
1871
|
+
* the userPool. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
|
|
1872
|
+
* Amazon Cognito maps the configuration to the app client only.</p>
|
|
1632
1873
|
* @public
|
|
1633
1874
|
*/
|
|
1634
1875
|
UserPoolId: string | undefined;
|
|
1635
1876
|
/**
|
|
1636
|
-
* <p>The app client
|
|
1637
|
-
*
|
|
1638
|
-
*
|
|
1639
|
-
*
|
|
1640
|
-
*
|
|
1641
|
-
* client
|
|
1877
|
+
* <p>The ID of the app client where you want to set a risk configuration. If
|
|
1878
|
+
* <code>ClientId</code> is null, then the risk configuration is mapped to
|
|
1879
|
+
* <code>UserPoolId</code>. When the client ID is null, the same risk configuration is
|
|
1880
|
+
* applied to all the clients in the userPool.</p>
|
|
1881
|
+
* <p>When you include a <code>ClientId</code> parameter, Amazon Cognito maps the configuration to
|
|
1882
|
+
* the app client. When you include both <code>ClientId</code> and <code>UserPoolId</code>,
|
|
1883
|
+
* Amazon Cognito maps the configuration to the app client only.</p>
|
|
1642
1884
|
* @public
|
|
1643
1885
|
*/
|
|
1644
1886
|
ClientId?: string | undefined;
|
|
1645
1887
|
/**
|
|
1646
|
-
* <p>The compromised credentials
|
|
1888
|
+
* <p>The configuration of automated reactions to detected compromised credentials. Includes
|
|
1889
|
+
* settings for blocking future sign-in requests and for the types of password-submission
|
|
1890
|
+
* events you want to monitor.</p>
|
|
1647
1891
|
* @public
|
|
1648
1892
|
*/
|
|
1649
1893
|
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType | undefined;
|
|
1650
1894
|
/**
|
|
1651
|
-
* <p>The
|
|
1895
|
+
* <p>The settings for automated responses and notification templates for adaptive
|
|
1896
|
+
* authentication with threat protection.</p>
|
|
1652
1897
|
* @public
|
|
1653
1898
|
*/
|
|
1654
1899
|
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType | undefined;
|
|
1655
1900
|
/**
|
|
1656
|
-
* <p>
|
|
1901
|
+
* <p>A set of IP-address overrides to threat protection. You can set up IP-address
|
|
1902
|
+
* always-block and always-allow lists.</p>
|
|
1657
1903
|
* @public
|
|
1658
1904
|
*/
|
|
1659
1905
|
RiskExceptionConfiguration?: RiskExceptionConfigurationType | undefined;
|
|
@@ -1663,7 +1909,8 @@ export interface SetRiskConfigurationRequest {
|
|
|
1663
1909
|
*/
|
|
1664
1910
|
export interface SetRiskConfigurationResponse {
|
|
1665
1911
|
/**
|
|
1666
|
-
* <p>The risk configuration
|
|
1912
|
+
* <p>The API response that contains the risk configuration that you set and the timestamp
|
|
1913
|
+
* of the most recent change.</p>
|
|
1667
1914
|
* @public
|
|
1668
1915
|
*/
|
|
1669
1916
|
RiskConfiguration: RiskConfigurationType | undefined;
|
|
@@ -1673,22 +1920,30 @@ export interface SetRiskConfigurationResponse {
|
|
|
1673
1920
|
*/
|
|
1674
1921
|
export interface SetUICustomizationRequest {
|
|
1675
1922
|
/**
|
|
1676
|
-
* <p>The ID of the user pool
|
|
1923
|
+
* <p>The ID of the user pool where you want to apply branding to the classic hosted
|
|
1924
|
+
* UI.</p>
|
|
1677
1925
|
* @public
|
|
1678
1926
|
*/
|
|
1679
1927
|
UserPoolId: string | undefined;
|
|
1680
1928
|
/**
|
|
1681
|
-
* <p>The
|
|
1929
|
+
* <p>The ID of the app client that you want to customize. To apply a default style to all
|
|
1930
|
+
* app clients not configured with client-level branding, set this parameter value to
|
|
1931
|
+
* <code>ALL</code>.</p>
|
|
1682
1932
|
* @public
|
|
1683
1933
|
*/
|
|
1684
1934
|
ClientId?: string | undefined;
|
|
1685
1935
|
/**
|
|
1686
|
-
* <p>
|
|
1936
|
+
* <p>A plaintext CSS file that contains the custom fields that you want to apply to your
|
|
1937
|
+
* user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to
|
|
1938
|
+
* your user pool <i>App clients</i> tab, select <i>Login
|
|
1939
|
+
* pages</i>, edit <i>Hosted UI (classic) style</i>, and select
|
|
1940
|
+
* the link to <code>CSS template.css</code>.</p>
|
|
1687
1941
|
* @public
|
|
1688
1942
|
*/
|
|
1689
1943
|
CSS?: string | undefined;
|
|
1690
1944
|
/**
|
|
1691
|
-
* <p>The
|
|
1945
|
+
* <p>The image that you want to set as your login in the classic hosted UI, as a
|
|
1946
|
+
* Base64-formatted binary object.</p>
|
|
1692
1947
|
* @public
|
|
1693
1948
|
*/
|
|
1694
1949
|
ImageFile?: Uint8Array | undefined;
|
|
@@ -1698,7 +1953,7 @@ export interface SetUICustomizationRequest {
|
|
|
1698
1953
|
*/
|
|
1699
1954
|
export interface SetUICustomizationResponse {
|
|
1700
1955
|
/**
|
|
1701
|
-
* <p>
|
|
1956
|
+
* <p>Information about the hosted UI branding that you applied.</p>
|
|
1702
1957
|
* @public
|
|
1703
1958
|
*/
|
|
1704
1959
|
UICustomization: UICustomizationType | undefined;
|
|
@@ -1715,21 +1970,23 @@ export interface SetUserMFAPreferenceRequest {
|
|
|
1715
1970
|
SMSMfaSettings?: SMSMfaSettingsType | undefined;
|
|
1716
1971
|
/**
|
|
1717
1972
|
* <p>User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates
|
|
1718
|
-
* TOTP MFA and sets it as the preferred MFA method when multiple methods are
|
|
1719
|
-
*
|
|
1973
|
+
* TOTP MFA and sets it as the preferred MFA method when multiple methods are available.
|
|
1974
|
+
* Users must register a TOTP authenticator before they set this as their preferred MFA
|
|
1975
|
+
* method.</p>
|
|
1720
1976
|
* @public
|
|
1721
1977
|
*/
|
|
1722
1978
|
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType | undefined;
|
|
1723
1979
|
/**
|
|
1724
1980
|
* <p>User preferences for email message MFA. Activates or deactivates email MFA and sets it
|
|
1725
|
-
* as the preferred MFA method when multiple methods are available.
|
|
1726
|
-
*
|
|
1981
|
+
* as the preferred MFA method when multiple methods are available.
|
|
1982
|
+
* 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">
|
|
1983
|
+
* Essentials tier</a> or higher.</p>
|
|
1727
1984
|
* @public
|
|
1728
1985
|
*/
|
|
1729
1986
|
EmailMfaSettings?: EmailMfaSettingsType | undefined;
|
|
1730
1987
|
/**
|
|
1731
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
1732
|
-
*
|
|
1988
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
1989
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
1733
1990
|
* @public
|
|
1734
1991
|
*/
|
|
1735
1992
|
AccessToken: string | undefined;
|
|
@@ -1761,36 +2018,28 @@ export interface SetUserPoolMfaConfigRequest {
|
|
|
1761
2018
|
*/
|
|
1762
2019
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
1763
2020
|
/**
|
|
1764
|
-
* <p>
|
|
1765
|
-
*
|
|
1766
|
-
*
|
|
2021
|
+
* <p>Sets configuration for user pool email message MFA and sign-in with one-time passwords
|
|
2022
|
+
* (OTPs). Includes the subject and body of the email message template for sign-in and MFA
|
|
2023
|
+
* 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">
|
|
2024
|
+
* Essentials tier</a> or higher.</p>
|
|
1767
2025
|
* @public
|
|
1768
2026
|
*/
|
|
1769
2027
|
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
1770
2028
|
/**
|
|
1771
|
-
* <p>
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1774
|
-
*
|
|
1775
|
-
* <
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
* <p>
|
|
1781
|
-
* <code>ON</code> MFA is required for all users to sign in.</p>
|
|
1782
|
-
* </li>
|
|
1783
|
-
* <li>
|
|
1784
|
-
* <p>
|
|
1785
|
-
* <code>OPTIONAL</code> MFA will be required only for individual users who have
|
|
1786
|
-
* an MFA factor activated.</p>
|
|
1787
|
-
* </li>
|
|
1788
|
-
* </ul>
|
|
2029
|
+
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
2030
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
2031
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
2032
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
2033
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
2034
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
2035
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
2036
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
2037
|
+
* MFA factor.</p>
|
|
1789
2038
|
* @public
|
|
1790
2039
|
*/
|
|
1791
2040
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
1792
2041
|
/**
|
|
1793
|
-
* <p>The configuration of your user pool for passkey, or
|
|
2042
|
+
* <p>The configuration of your user pool for passkey, or WebAuthn, authentication and
|
|
1794
2043
|
* registration. You can set this configuration independent of the MFA configuration
|
|
1795
2044
|
* options in this operation.</p>
|
|
1796
2045
|
* @public
|
|
@@ -1802,8 +2051,9 @@ export interface SetUserPoolMfaConfigRequest {
|
|
|
1802
2051
|
*/
|
|
1803
2052
|
export interface SetUserPoolMfaConfigResponse {
|
|
1804
2053
|
/**
|
|
1805
|
-
* <p>Shows user pool SMS message configuration for MFA
|
|
1806
|
-
* the SMS message sending configuration for
|
|
2054
|
+
* <p>Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs.
|
|
2055
|
+
* Includes the message template and the SMS message sending configuration for
|
|
2056
|
+
* Amazon SNS.</p>
|
|
1807
2057
|
* @public
|
|
1808
2058
|
*/
|
|
1809
2059
|
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
@@ -1814,35 +2064,30 @@ export interface SetUserPoolMfaConfigResponse {
|
|
|
1814
2064
|
*/
|
|
1815
2065
|
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
1816
2066
|
/**
|
|
1817
|
-
* <p>Shows user pool email message
|
|
1818
|
-
*
|
|
1819
|
-
*
|
|
2067
|
+
* <p>Shows configuration for user pool email message MFA and sign-in with one-time
|
|
2068
|
+
* passwords (OTPs). Includes the subject and body of the email message template for
|
|
2069
|
+
* 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">
|
|
2070
|
+
* Essentials tier</a> or higher.</p>
|
|
1820
2071
|
* @public
|
|
1821
2072
|
*/
|
|
1822
2073
|
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
1823
2074
|
/**
|
|
1824
|
-
* <p>
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1827
|
-
*
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1831
|
-
*
|
|
1832
|
-
*
|
|
1833
|
-
* </li>
|
|
1834
|
-
* <li>
|
|
1835
|
-
* <p>
|
|
1836
|
-
* <code>OPTIONAL</code> MFA will be required only for individual users who have
|
|
1837
|
-
* an MFA factor enabled.</p>
|
|
1838
|
-
* </li>
|
|
1839
|
-
* </ul>
|
|
2075
|
+
* <p>Displays multi-factor authentication (MFA) as on, off, or optional. When
|
|
2076
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
2077
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
2078
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
2079
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
2080
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
2081
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
2082
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
2083
|
+
* MFA factor.</p>
|
|
1840
2084
|
* @public
|
|
1841
2085
|
*/
|
|
1842
2086
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
1843
2087
|
/**
|
|
1844
|
-
* <p>The configuration of your user pool for passkey, or
|
|
1845
|
-
* security-key devices
|
|
2088
|
+
* <p>The configuration of your user pool for passkey, or WebAuthn, sign-in with
|
|
2089
|
+
* authenticators like biometric and security-key devices. Includes relying-party
|
|
2090
|
+
* configuration and settings for user-verification requirements.</p>
|
|
1846
2091
|
* @public
|
|
1847
2092
|
*/
|
|
1848
2093
|
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
@@ -1853,8 +2098,8 @@ export interface SetUserPoolMfaConfigResponse {
|
|
|
1853
2098
|
*/
|
|
1854
2099
|
export interface SetUserSettingsRequest {
|
|
1855
2100
|
/**
|
|
1856
|
-
* <p>A valid access token that Amazon Cognito issued to the
|
|
1857
|
-
*
|
|
2101
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2102
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
1858
2103
|
* @public
|
|
1859
2104
|
*/
|
|
1860
2105
|
AccessToken: string | undefined;
|
|
@@ -1877,7 +2122,7 @@ export interface SetUserSettingsResponse {
|
|
|
1877
2122
|
*/
|
|
1878
2123
|
export interface SignUpRequest {
|
|
1879
2124
|
/**
|
|
1880
|
-
* <p>The ID of the client
|
|
2125
|
+
* <p>The ID of the app client where the user wants to sign up.</p>
|
|
1881
2126
|
* @public
|
|
1882
2127
|
*/
|
|
1883
2128
|
ClientId: string | undefined;
|
|
@@ -1895,18 +2140,18 @@ export interface SignUpRequest {
|
|
|
1895
2140
|
*/
|
|
1896
2141
|
Username: string | undefined;
|
|
1897
2142
|
/**
|
|
1898
|
-
* <p>The password
|
|
2143
|
+
* <p>The user's proposed password. The password must comply with the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html">password requirements</a> of your user pool.</p>
|
|
1899
2144
|
* <p>Users can sign up without a password when your user pool supports passwordless sign-in
|
|
1900
2145
|
* with email or SMS OTPs. To create a user with no password, omit this parameter or submit
|
|
1901
2146
|
* a blank value. You can only create a passwordless user when passwordless sign-in is
|
|
1902
|
-
* available
|
|
2147
|
+
* available.</p>
|
|
1903
2148
|
* @public
|
|
1904
2149
|
*/
|
|
1905
2150
|
Password?: string | undefined;
|
|
1906
2151
|
/**
|
|
1907
2152
|
* <p>An array of name-value pairs representing user attributes.</p>
|
|
1908
|
-
* <p>For custom attributes,
|
|
1909
|
-
*
|
|
2153
|
+
* <p>For custom attributes, include a <code>custom:</code> prefix in the attribute name,
|
|
2154
|
+
* for example <code>custom:department</code>.</p>
|
|
1910
2155
|
* @public
|
|
1911
2156
|
*/
|
|
1912
2157
|
UserAttributes?: AttributeType[] | undefined;
|
|
@@ -1915,23 +2160,22 @@ export interface SignUpRequest {
|
|
|
1915
2160
|
* trigger. This set of key-value pairs are for custom validation of information that you
|
|
1916
2161
|
* collect from your users but don't need to retain.</p>
|
|
1917
2162
|
* <p>Your Lambda function can analyze this additional data and act on it. Your function
|
|
1918
|
-
*
|
|
1919
|
-
*
|
|
1920
|
-
* to Amazon Cognito, like automatically confirming the user if they sign up from within your
|
|
1921
|
-
* network.</p>
|
|
2163
|
+
* can automatically confirm and verify select users or perform external API operations
|
|
2164
|
+
* like logging user attributes and validation data to Amazon CloudWatch Logs.</p>
|
|
1922
2165
|
* <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>
|
|
1923
2166
|
* @public
|
|
1924
2167
|
*/
|
|
1925
2168
|
ValidationData?: AttributeType[] | undefined;
|
|
1926
2169
|
/**
|
|
1927
|
-
* <p>
|
|
1928
|
-
*
|
|
2170
|
+
* <p>Information that supports analytics outcomes with Amazon Pinpoint, including the
|
|
2171
|
+
* user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier,
|
|
2172
|
+
* email address, or phone number.</p>
|
|
1929
2173
|
* @public
|
|
1930
2174
|
*/
|
|
1931
2175
|
AnalyticsMetadata?: AnalyticsMetadataType | undefined;
|
|
1932
2176
|
/**
|
|
1933
|
-
* <p>Contextual data about your user session
|
|
1934
|
-
*
|
|
2177
|
+
* <p>Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat
|
|
2178
|
+
* protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito
|
|
1935
2179
|
* when it makes API requests.</p>
|
|
1936
2180
|
* <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
|
|
1937
2181
|
* applications</a>.</p>
|
|
@@ -1951,7 +2195,7 @@ export interface SignUpRequest {
|
|
|
1951
2195
|
* function code in Lambda, you can process the <code>clientMetadata</code> value to enhance
|
|
1952
2196
|
* your workflow for your specific needs.</p>
|
|
1953
2197
|
* <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">
|
|
1954
|
-
*
|
|
2198
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
1955
2199
|
* <note>
|
|
1956
2200
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
1957
2201
|
* following:</p>
|
|
@@ -1981,20 +2225,22 @@ export interface SignUpRequest {
|
|
|
1981
2225
|
*/
|
|
1982
2226
|
export interface SignUpResponse {
|
|
1983
2227
|
/**
|
|
1984
|
-
* <p>
|
|
1985
|
-
*
|
|
2228
|
+
* <p>Indicates whether the user was automatically confirmed. You can auto-confirm users
|
|
2229
|
+
* with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">pre sign-up Lambda trigger</a>.</p>
|
|
1986
2230
|
* @public
|
|
1987
2231
|
*/
|
|
1988
2232
|
UserConfirmed: boolean | undefined;
|
|
1989
2233
|
/**
|
|
1990
|
-
* <p>
|
|
1991
|
-
*
|
|
2234
|
+
* <p>In user pools that automatically verify and confirm new users, Amazon Cognito sends users a
|
|
2235
|
+
* message with a code or link that confirms ownership of the phone number or email address
|
|
2236
|
+
* that they entered. The <code>CodeDeliveryDetails</code> object is information about the
|
|
2237
|
+
* delivery destination for that link or code.</p>
|
|
1992
2238
|
* @public
|
|
1993
2239
|
*/
|
|
1994
2240
|
CodeDeliveryDetails?: CodeDeliveryDetailsType | undefined;
|
|
1995
2241
|
/**
|
|
1996
|
-
* <p>The
|
|
1997
|
-
*
|
|
2242
|
+
* <p>The unique identifier of the new user, for example
|
|
2243
|
+
* <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1998
2244
|
* @public
|
|
1999
2245
|
*/
|
|
2000
2246
|
UserSub: string | undefined;
|
|
@@ -2012,12 +2258,12 @@ export interface SignUpResponse {
|
|
|
2012
2258
|
*/
|
|
2013
2259
|
export interface StartUserImportJobRequest {
|
|
2014
2260
|
/**
|
|
2015
|
-
* <p>The ID of the user pool that
|
|
2261
|
+
* <p>The ID of the user pool that you want to start importing users into.</p>
|
|
2016
2262
|
* @public
|
|
2017
2263
|
*/
|
|
2018
2264
|
UserPoolId: string | undefined;
|
|
2019
2265
|
/**
|
|
2020
|
-
* <p>The
|
|
2266
|
+
* <p>The ID of a user import job that you previously created.</p>
|
|
2021
2267
|
* @public
|
|
2022
2268
|
*/
|
|
2023
2269
|
JobId: string | undefined;
|
|
@@ -2029,7 +2275,8 @@ export interface StartUserImportJobRequest {
|
|
|
2029
2275
|
*/
|
|
2030
2276
|
export interface StartUserImportJobResponse {
|
|
2031
2277
|
/**
|
|
2032
|
-
* <p>The
|
|
2278
|
+
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
2279
|
+
* pre-signed URL for CSV upload.</p>
|
|
2033
2280
|
* @public
|
|
2034
2281
|
*/
|
|
2035
2282
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -2039,8 +2286,8 @@ export interface StartUserImportJobResponse {
|
|
|
2039
2286
|
*/
|
|
2040
2287
|
export interface StartWebAuthnRegistrationRequest {
|
|
2041
2288
|
/**
|
|
2042
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
2043
|
-
*
|
|
2289
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2290
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2044
2291
|
* @public
|
|
2045
2292
|
*/
|
|
2046
2293
|
AccessToken: string | undefined;
|
|
@@ -2075,12 +2322,12 @@ export declare class WebAuthnConfigurationMissingException extends __BaseExcepti
|
|
|
2075
2322
|
*/
|
|
2076
2323
|
export interface StopUserImportJobRequest {
|
|
2077
2324
|
/**
|
|
2078
|
-
* <p>The ID of the user pool that
|
|
2325
|
+
* <p>The ID of the user pool that you want to stop.</p>
|
|
2079
2326
|
* @public
|
|
2080
2327
|
*/
|
|
2081
2328
|
UserPoolId: string | undefined;
|
|
2082
2329
|
/**
|
|
2083
|
-
* <p>The
|
|
2330
|
+
* <p>The ID of a running user import job.</p>
|
|
2084
2331
|
* @public
|
|
2085
2332
|
*/
|
|
2086
2333
|
JobId: string | undefined;
|
|
@@ -2092,7 +2339,8 @@ export interface StopUserImportJobRequest {
|
|
|
2092
2339
|
*/
|
|
2093
2340
|
export interface StopUserImportJobResponse {
|
|
2094
2341
|
/**
|
|
2095
|
-
* <p>The
|
|
2342
|
+
* <p>The details of the user import job. Includes logging destination, status, and the Amazon S3
|
|
2343
|
+
* pre-signed URL for CSV upload.</p>
|
|
2096
2344
|
* @public
|
|
2097
2345
|
*/
|
|
2098
2346
|
UserImportJob?: UserImportJobType | undefined;
|
|
@@ -2107,7 +2355,7 @@ export interface TagResourceRequest {
|
|
|
2107
2355
|
*/
|
|
2108
2356
|
ResourceArn: string | undefined;
|
|
2109
2357
|
/**
|
|
2110
|
-
* <p>
|
|
2358
|
+
* <p>An array of tag keys and values that you want to assign to the user pool.</p>
|
|
2111
2359
|
* @public
|
|
2112
2360
|
*/
|
|
2113
2361
|
Tags: Record<string, string> | undefined;
|
|
@@ -2127,7 +2375,7 @@ export interface UntagResourceRequest {
|
|
|
2127
2375
|
*/
|
|
2128
2376
|
ResourceArn: string | undefined;
|
|
2129
2377
|
/**
|
|
2130
|
-
* <p>
|
|
2378
|
+
* <p>An array of tag keys that you want to remove from the user pool.</p>
|
|
2131
2379
|
* @public
|
|
2132
2380
|
*/
|
|
2133
2381
|
TagKeys: string[] | undefined;
|
|
@@ -2142,12 +2390,12 @@ export interface UntagResourceResponse {
|
|
|
2142
2390
|
*/
|
|
2143
2391
|
export interface UpdateAuthEventFeedbackRequest {
|
|
2144
2392
|
/**
|
|
2145
|
-
* <p>The user pool
|
|
2393
|
+
* <p>The ID of the user pool where you want to update auth event feedback.</p>
|
|
2146
2394
|
* @public
|
|
2147
2395
|
*/
|
|
2148
2396
|
UserPoolId: string | undefined;
|
|
2149
2397
|
/**
|
|
2150
|
-
* <p>The
|
|
2398
|
+
* <p>The name of the user that you want to query or modify. The value of this parameter
|
|
2151
2399
|
* is typically your user's username, but it can be any of their alias attributes. If
|
|
2152
2400
|
* <code>username</code> isn't an alias attribute in your user pool, this value
|
|
2153
2401
|
* must be the <code>sub</code> of a local user or the username of a user from a
|
|
@@ -2156,17 +2404,18 @@ export interface UpdateAuthEventFeedbackRequest {
|
|
|
2156
2404
|
*/
|
|
2157
2405
|
Username: string | undefined;
|
|
2158
2406
|
/**
|
|
2159
|
-
* <p>The event
|
|
2407
|
+
* <p>The ID of the authentication event that you want to submit feedback for.</p>
|
|
2160
2408
|
* @public
|
|
2161
2409
|
*/
|
|
2162
2410
|
EventId: string | undefined;
|
|
2163
2411
|
/**
|
|
2164
|
-
* <p>The feedback token
|
|
2412
|
+
* <p>The feedback token, an encrypted object generated by Amazon Cognito and passed to your user in
|
|
2413
|
+
* the notification email message from the event.</p>
|
|
2165
2414
|
* @public
|
|
2166
2415
|
*/
|
|
2167
2416
|
FeedbackToken: string | undefined;
|
|
2168
2417
|
/**
|
|
2169
|
-
* <p>
|
|
2418
|
+
* <p>Your feedback to the authentication event. When you provide a <code>FeedbackValue</code>
|
|
2170
2419
|
* value of <code>valid</code>, you tell Amazon Cognito that you trust a user session where Amazon Cognito
|
|
2171
2420
|
* has evaluated some level of risk. When you provide a <code>FeedbackValue</code> value of
|
|
2172
2421
|
* <code>invalid</code>, you tell Amazon Cognito that you don't trust a user session, or you
|
|
@@ -2186,18 +2435,20 @@ export interface UpdateAuthEventFeedbackResponse {
|
|
|
2186
2435
|
*/
|
|
2187
2436
|
export interface UpdateDeviceStatusRequest {
|
|
2188
2437
|
/**
|
|
2189
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
2190
|
-
*
|
|
2438
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2439
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2191
2440
|
* @public
|
|
2192
2441
|
*/
|
|
2193
2442
|
AccessToken: string | undefined;
|
|
2194
2443
|
/**
|
|
2195
|
-
* <p>The device key
|
|
2444
|
+
* <p>The device key of the device you want to update, for example
|
|
2445
|
+
* <code>us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
2196
2446
|
* @public
|
|
2197
2447
|
*/
|
|
2198
2448
|
DeviceKey: string | undefined;
|
|
2199
2449
|
/**
|
|
2200
|
-
* <p>
|
|
2450
|
+
* <p>To enable device authentication with the specified device, set to
|
|
2451
|
+
* <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>
|
|
2201
2452
|
* @public
|
|
2202
2453
|
*/
|
|
2203
2454
|
DeviceRememberedStatus?: DeviceRememberedStatusType | undefined;
|
|
@@ -2213,30 +2464,43 @@ export interface UpdateDeviceStatusResponse {
|
|
|
2213
2464
|
*/
|
|
2214
2465
|
export interface UpdateGroupRequest {
|
|
2215
2466
|
/**
|
|
2216
|
-
* <p>The name of the group.</p>
|
|
2467
|
+
* <p>The name of the group that you want to update.</p>
|
|
2217
2468
|
* @public
|
|
2218
2469
|
*/
|
|
2219
2470
|
GroupName: string | undefined;
|
|
2220
2471
|
/**
|
|
2221
|
-
* <p>The ID of the user pool.</p>
|
|
2472
|
+
* <p>The ID of the user pool that contains the group you want to update.</p>
|
|
2222
2473
|
* @public
|
|
2223
2474
|
*/
|
|
2224
2475
|
UserPoolId: string | undefined;
|
|
2225
2476
|
/**
|
|
2226
|
-
* <p>A
|
|
2477
|
+
* <p>A new description of the existing group.</p>
|
|
2227
2478
|
* @public
|
|
2228
2479
|
*/
|
|
2229
2480
|
Description?: string | undefined;
|
|
2230
2481
|
/**
|
|
2231
|
-
* <p>The
|
|
2232
|
-
*
|
|
2233
|
-
*
|
|
2482
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that you want to associate with the
|
|
2483
|
+
* group. The role assignment contributes to the <code>cognito:roles</code> and
|
|
2484
|
+
* <code>cognito:preferred_role</code> claims in group members' tokens.</p>
|
|
2234
2485
|
* @public
|
|
2235
2486
|
*/
|
|
2236
2487
|
RoleArn?: string | undefined;
|
|
2237
2488
|
/**
|
|
2238
|
-
* <p>
|
|
2239
|
-
*
|
|
2489
|
+
* <p>A non-negative integer value that specifies the precedence of this group relative to
|
|
2490
|
+
* the other groups that a user can belong to in the user pool. Zero is the highest
|
|
2491
|
+
* precedence value. Groups with lower <code>Precedence</code> values take precedence over
|
|
2492
|
+
* groups with higher or null <code>Precedence</code> values. If a user belongs to two or
|
|
2493
|
+
* more groups, it is the group with the lowest precedence value whose role ARN is given in
|
|
2494
|
+
* the user's tokens for the <code>cognito:roles</code> and
|
|
2495
|
+
* <code>cognito:preferred_role</code> claims.</p>
|
|
2496
|
+
* <p>Two groups can have the same <code>Precedence</code> value. If this happens, neither
|
|
2497
|
+
* group takes precedence over the other. If two groups with the same
|
|
2498
|
+
* <code>Precedence</code> have the same role ARN, that role is used in the
|
|
2499
|
+
* <code>cognito:preferred_role</code> claim in tokens for users in each group. If the
|
|
2500
|
+
* two groups have different role ARNs, the <code>cognito:preferred_role</code> claim isn't
|
|
2501
|
+
* set in users' tokens.</p>
|
|
2502
|
+
* <p>The default <code>Precedence</code> value is null. The maximum <code>Precedence</code>
|
|
2503
|
+
* value is <code>2^31-1</code>.</p>
|
|
2240
2504
|
* @public
|
|
2241
2505
|
*/
|
|
2242
2506
|
Precedence?: number | undefined;
|
|
@@ -2246,7 +2510,8 @@ export interface UpdateGroupRequest {
|
|
|
2246
2510
|
*/
|
|
2247
2511
|
export interface UpdateGroupResponse {
|
|
2248
2512
|
/**
|
|
2249
|
-
* <p>
|
|
2513
|
+
* <p>Contains the updated details of the group, including precedence, IAM role, and
|
|
2514
|
+
* description.</p>
|
|
2250
2515
|
* @public
|
|
2251
2516
|
*/
|
|
2252
2517
|
Group?: GroupType | undefined;
|
|
@@ -2256,12 +2521,14 @@ export interface UpdateGroupResponse {
|
|
|
2256
2521
|
*/
|
|
2257
2522
|
export interface UpdateIdentityProviderRequest {
|
|
2258
2523
|
/**
|
|
2259
|
-
* <p>The user pool
|
|
2524
|
+
* <p>The Id of the user pool where you want to update your IdP.</p>
|
|
2260
2525
|
* @public
|
|
2261
2526
|
*/
|
|
2262
2527
|
UserPoolId: string | undefined;
|
|
2263
2528
|
/**
|
|
2264
|
-
* <p>The IdP name
|
|
2529
|
+
* <p>The name of the IdP that you want to update. You can pass the identity provider name
|
|
2530
|
+
* in the <code>identity_provider</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated
|
|
2531
|
+
* IdP.</p>
|
|
2265
2532
|
* @public
|
|
2266
2533
|
*/
|
|
2267
2534
|
ProviderName: string | undefined;
|
|
@@ -2389,12 +2656,17 @@ export interface UpdateIdentityProviderRequest {
|
|
|
2389
2656
|
*/
|
|
2390
2657
|
ProviderDetails?: Record<string, string> | undefined;
|
|
2391
2658
|
/**
|
|
2392
|
-
* <p>
|
|
2659
|
+
* <p>A mapping of IdP attributes to standard and custom user pool attributes. Specify a
|
|
2660
|
+
* user pool attribute as the key of the key-value pair, and the IdP attribute claim name
|
|
2661
|
+
* as the value.</p>
|
|
2393
2662
|
* @public
|
|
2394
2663
|
*/
|
|
2395
2664
|
AttributeMapping?: Record<string, string> | undefined;
|
|
2396
2665
|
/**
|
|
2397
|
-
* <p>
|
|
2666
|
+
* <p>An array of IdP identifiers, for example <code>"IdPIdentifiers": [ "MyIdP", "MyIdP2"
|
|
2667
|
+
* ]</code>. Identifiers are friendly names that you can pass in the
|
|
2668
|
+
* <code>idp_identifier</code> query parameter of requests to the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html">Authorize endpoint</a> to silently redirect to sign-in with the associated IdP.
|
|
2669
|
+
* Identifiers in a domain format also enable the use of <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managing-saml-idp-naming.html">email-address matching with SAML providers</a>. </p>
|
|
2398
2670
|
* @public
|
|
2399
2671
|
*/
|
|
2400
2672
|
IdpIdentifiers?: string[] | undefined;
|
|
@@ -2425,9 +2697,9 @@ export interface UpdateManagedLoginBrandingRequest {
|
|
|
2425
2697
|
*/
|
|
2426
2698
|
ManagedLoginBrandingId?: string | undefined;
|
|
2427
2699
|
/**
|
|
2428
|
-
* <p>When true
|
|
2429
|
-
* style options that are managed by Amazon Cognito. You can modify them later in
|
|
2430
|
-
* designer.</p>
|
|
2700
|
+
* <p>When <code>true</code>, applies the default branding style options. This option
|
|
2701
|
+
* reverts to default style options that are managed by Amazon Cognito. You can modify them later in
|
|
2702
|
+
* the branding designer.</p>
|
|
2431
2703
|
* <p>When you specify <code>true</code> for this option, you must also omit values for
|
|
2432
2704
|
* <code>Settings</code> and <code>Assets</code> in the request.</p>
|
|
2433
2705
|
* @public
|
|
@@ -2462,7 +2734,8 @@ export interface UpdateManagedLoginBrandingResponse {
|
|
|
2462
2734
|
*/
|
|
2463
2735
|
export interface UpdateResourceServerRequest {
|
|
2464
2736
|
/**
|
|
2465
|
-
* <p>The ID of the user pool
|
|
2737
|
+
* <p>The ID of the user pool that contains the resource server that you want to
|
|
2738
|
+
* update.</p>
|
|
2466
2739
|
* @public
|
|
2467
2740
|
*/
|
|
2468
2741
|
UserPoolId: string | undefined;
|
|
@@ -2477,12 +2750,13 @@ export interface UpdateResourceServerRequest {
|
|
|
2477
2750
|
*/
|
|
2478
2751
|
Identifier: string | undefined;
|
|
2479
2752
|
/**
|
|
2480
|
-
* <p>The name of the resource server.</p>
|
|
2753
|
+
* <p>The updated name of the resource server.</p>
|
|
2481
2754
|
* @public
|
|
2482
2755
|
*/
|
|
2483
2756
|
Name: string | undefined;
|
|
2484
2757
|
/**
|
|
2485
|
-
* <p>
|
|
2758
|
+
* <p>An array of updated custom scope names and descriptions that you want to associate
|
|
2759
|
+
* with your resource server.</p>
|
|
2486
2760
|
* @public
|
|
2487
2761
|
*/
|
|
2488
2762
|
Scopes?: ResourceServerScopeType[] | undefined;
|
|
@@ -2492,7 +2766,7 @@ export interface UpdateResourceServerRequest {
|
|
|
2492
2766
|
*/
|
|
2493
2767
|
export interface UpdateResourceServerResponse {
|
|
2494
2768
|
/**
|
|
2495
|
-
* <p>The resource server.</p>
|
|
2769
|
+
* <p>The updated details of the requested resource server.</p>
|
|
2496
2770
|
* @public
|
|
2497
2771
|
*/
|
|
2498
2772
|
ResourceServer: ResourceServerType | undefined;
|
|
@@ -2504,8 +2778,8 @@ export interface UpdateResourceServerResponse {
|
|
|
2504
2778
|
export interface UpdateUserAttributesRequest {
|
|
2505
2779
|
/**
|
|
2506
2780
|
* <p>An array of name-value pairs representing user attributes.</p>
|
|
2507
|
-
* <p>For custom attributes, you must
|
|
2508
|
-
*
|
|
2781
|
+
* <p>For custom attributes, you must add a <code>custom:</code> prefix to the attribute
|
|
2782
|
+
* name.</p>
|
|
2509
2783
|
* <p>If you have set an attribute to require verification before Amazon Cognito updates its value,
|
|
2510
2784
|
* this request doesn’t immediately update the value of that attribute. After your user
|
|
2511
2785
|
* receives and responds to a verification message to verify the new value, Amazon Cognito updates
|
|
@@ -2515,8 +2789,8 @@ export interface UpdateUserAttributesRequest {
|
|
|
2515
2789
|
*/
|
|
2516
2790
|
UserAttributes: AttributeType[] | undefined;
|
|
2517
2791
|
/**
|
|
2518
|
-
* <p>A valid access token that Amazon Cognito issued to the
|
|
2519
|
-
*
|
|
2792
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
2793
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
2520
2794
|
* @public
|
|
2521
2795
|
*/
|
|
2522
2796
|
AccessToken: string | undefined;
|
|
@@ -2532,7 +2806,7 @@ export interface UpdateUserAttributesRequest {
|
|
|
2532
2806
|
* in Lambda, you can process the <code>clientMetadata</code> value to enhance your workflow
|
|
2533
2807
|
* for your specific needs.</p>
|
|
2534
2808
|
* <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">
|
|
2535
|
-
*
|
|
2809
|
+
* Using Lambda triggers</a> in the <i>Amazon Cognito Developer Guide</i>.</p>
|
|
2536
2810
|
* <note>
|
|
2537
2811
|
* <p>When you use the <code>ClientMetadata</code> parameter, note that Amazon Cognito won't do the
|
|
2538
2812
|
* following:</p>
|
|
@@ -2563,8 +2837,13 @@ export interface UpdateUserAttributesRequest {
|
|
|
2563
2837
|
*/
|
|
2564
2838
|
export interface UpdateUserAttributesResponse {
|
|
2565
2839
|
/**
|
|
2566
|
-
* <p>
|
|
2567
|
-
*
|
|
2840
|
+
* <p>When the attribute-update request includes an email address or phone number attribute,
|
|
2841
|
+
* Amazon Cognito sends a message to users with a code that confirms ownership of the new value that
|
|
2842
|
+
* they entered. The <code>CodeDeliveryDetails</code> object is information about the
|
|
2843
|
+
* delivery destination for that link or code. This behavior happens in user pools
|
|
2844
|
+
* configured to automatically verify changes to those attributes. For more information,
|
|
2845
|
+
* see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#verifying-when-users-change-their-email-or-phone-number">Verifying when users change their email or phone
|
|
2846
|
+
* number</a>.</p>
|
|
2568
2847
|
* @public
|
|
2569
2848
|
*/
|
|
2570
2849
|
CodeDeliveryDetailsList?: CodeDeliveryDetailsType[] | undefined;
|
|
@@ -2580,7 +2859,9 @@ export interface UpdateUserPoolRequest {
|
|
|
2580
2859
|
*/
|
|
2581
2860
|
UserPoolId: string | undefined;
|
|
2582
2861
|
/**
|
|
2583
|
-
* <p>
|
|
2862
|
+
* <p>The password policy and sign-in policy in the user pool. The password policy sets
|
|
2863
|
+
* options like password complexity requirements and password history. The sign-in policy
|
|
2864
|
+
* sets the options available to applications in <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice">choice-based authentication</a>.</p>
|
|
2584
2865
|
* @public
|
|
2585
2866
|
*/
|
|
2586
2867
|
Policies?: UserPoolPolicyType | undefined;
|
|
@@ -2596,38 +2877,48 @@ export interface UpdateUserPoolRequest {
|
|
|
2596
2877
|
*/
|
|
2597
2878
|
DeletionProtection?: DeletionProtectionType | undefined;
|
|
2598
2879
|
/**
|
|
2599
|
-
* <p>
|
|
2880
|
+
* <p>A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible
|
|
2881
|
+
* stages of authentication operations. Triggers can modify the outcome of the operations
|
|
2882
|
+
* that invoked them.</p>
|
|
2600
2883
|
* @public
|
|
2601
2884
|
*/
|
|
2602
2885
|
LambdaConfig?: LambdaConfigType | undefined;
|
|
2603
2886
|
/**
|
|
2604
|
-
* <p>The attributes that
|
|
2605
|
-
*
|
|
2887
|
+
* <p>The attributes that you want your user pool to automatically verify. Possible values:
|
|
2888
|
+
* <b>email</b>, <b>phone_number</b>. For more 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>
|
|
2606
2889
|
* @public
|
|
2607
2890
|
*/
|
|
2608
2891
|
AutoVerifiedAttributes?: VerifiedAttributeType[] | undefined;
|
|
2609
2892
|
/**
|
|
2610
|
-
* <p>This parameter is no longer used
|
|
2893
|
+
* <p>This parameter is no longer used.</p>
|
|
2611
2894
|
* @public
|
|
2612
2895
|
*/
|
|
2613
2896
|
SmsVerificationMessage?: string | undefined;
|
|
2614
2897
|
/**
|
|
2615
|
-
* <p>This parameter is no longer used
|
|
2898
|
+
* <p>This parameter is no longer used.</p>
|
|
2616
2899
|
* @public
|
|
2617
2900
|
*/
|
|
2618
2901
|
EmailVerificationMessage?: string | undefined;
|
|
2619
2902
|
/**
|
|
2620
|
-
* <p>This parameter is no longer used
|
|
2903
|
+
* <p>This parameter is no longer used.</p>
|
|
2621
2904
|
* @public
|
|
2622
2905
|
*/
|
|
2623
2906
|
EmailVerificationSubject?: string | undefined;
|
|
2624
2907
|
/**
|
|
2625
|
-
* <p>The template for verification
|
|
2908
|
+
* <p>The template for the verification message that your user pool delivers to users who
|
|
2909
|
+
* set an email address or phone number attribute.</p>
|
|
2910
|
+
* <p>Set the email message type that corresponds to your <code>DefaultEmailOption</code>
|
|
2911
|
+
* selection. For <code>CONFIRM_WITH_LINK</code>, specify an
|
|
2912
|
+
* <code>EmailMessageByLink</code> and leave <code>EmailMessage</code> blank. For
|
|
2913
|
+
* <code>CONFIRM_WITH_CODE</code>, specify an <code>EmailMessage</code> and leave
|
|
2914
|
+
* <code>EmailMessageByLink</code> blank. When you supply both parameters with either
|
|
2915
|
+
* choice, Amazon Cognito returns an error.</p>
|
|
2626
2916
|
* @public
|
|
2627
2917
|
*/
|
|
2628
2918
|
VerificationMessageTemplate?: VerificationMessageTemplateType | undefined;
|
|
2629
2919
|
/**
|
|
2630
|
-
* <p>The contents of the SMS
|
|
2920
|
+
* <p>The contents of the SMS message that your user pool sends to users in SMS
|
|
2921
|
+
* authentication.</p>
|
|
2631
2922
|
* @public
|
|
2632
2923
|
*/
|
|
2633
2924
|
SmsAuthenticationMessage?: string | undefined;
|
|
@@ -2640,35 +2931,27 @@ export interface UpdateUserPoolRequest {
|
|
|
2640
2931
|
*/
|
|
2641
2932
|
UserAttributeUpdateSettings?: UserAttributeUpdateSettingsType | undefined;
|
|
2642
2933
|
/**
|
|
2643
|
-
* <p>
|
|
2644
|
-
*
|
|
2645
|
-
*
|
|
2646
|
-
*
|
|
2647
|
-
*
|
|
2648
|
-
*
|
|
2649
|
-
*
|
|
2650
|
-
*
|
|
2651
|
-
*
|
|
2652
|
-
* <code>ON</code> - MFA tokens are required for all user registrations. You can
|
|
2653
|
-
* only specify ON when you're initially creating a user pool. You can use the
|
|
2654
|
-
* <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> API operation to turn MFA "ON" for existing
|
|
2655
|
-
* user pools. </p>
|
|
2656
|
-
* </li>
|
|
2657
|
-
* <li>
|
|
2658
|
-
* <p>
|
|
2659
|
-
* <code>OPTIONAL</code> - Users have the option when registering to create an MFA
|
|
2660
|
-
* token.</p>
|
|
2661
|
-
* </li>
|
|
2662
|
-
* </ul>
|
|
2934
|
+
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
2935
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
2936
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
2937
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
2938
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
2939
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
2940
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
2941
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
2942
|
+
* MFA factor.</p>
|
|
2663
2943
|
* @public
|
|
2664
2944
|
*/
|
|
2665
2945
|
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
2666
2946
|
/**
|
|
2667
|
-
* <p>The device-remembering configuration for a user pool.
|
|
2668
|
-
*
|
|
2947
|
+
* <p>The device-remembering configuration for a user pool. Device remembering or device
|
|
2948
|
+
* tracking is a "Remember me on this device" option for user pools that perform
|
|
2949
|
+
* authentication with the device key of a trusted device in the back end, instead of a
|
|
2950
|
+
* user-provided MFA code. For more information about device authentication, 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>. A null value indicates that
|
|
2951
|
+
* you have deactivated device remembering in your user pool.</p>
|
|
2669
2952
|
* <note>
|
|
2670
2953
|
* <p>When you provide a value for any <code>DeviceConfiguration</code> field, you
|
|
2671
|
-
* activate the Amazon Cognito device-remembering feature
|
|
2954
|
+
* activate the Amazon Cognito device-remembering feature. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p>
|
|
2672
2955
|
* </note>
|
|
2673
2956
|
* @public
|
|
2674
2957
|
*/
|
|
@@ -2681,10 +2964,10 @@ export interface UpdateUserPoolRequest {
|
|
|
2681
2964
|
*/
|
|
2682
2965
|
EmailConfiguration?: EmailConfigurationType | undefined;
|
|
2683
2966
|
/**
|
|
2684
|
-
* <p>The SMS configuration with the settings
|
|
2685
|
-
*
|
|
2686
|
-
*
|
|
2687
|
-
*
|
|
2967
|
+
* <p>The SMS configuration with the settings for your Amazon Cognito user pool to send SMS message
|
|
2968
|
+
* with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the
|
|
2969
|
+
* Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account. For
|
|
2970
|
+
* more information see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html">SMS message settings</a>.</p>
|
|
2688
2971
|
* @public
|
|
2689
2972
|
*/
|
|
2690
2973
|
SmsConfiguration?: SmsConfigurationType | undefined;
|
|
@@ -2696,16 +2979,19 @@ export interface UpdateUserPoolRequest {
|
|
|
2696
2979
|
*/
|
|
2697
2980
|
UserPoolTags?: Record<string, string> | undefined;
|
|
2698
2981
|
/**
|
|
2699
|
-
* <p>The configuration for
|
|
2982
|
+
* <p>The configuration for administrative creation of users. Includes the template for the
|
|
2983
|
+
* invitation message for new users, the duration of temporary passwords, and permitting
|
|
2984
|
+
* self-service sign-up.</p>
|
|
2700
2985
|
* @public
|
|
2701
2986
|
*/
|
|
2702
2987
|
AdminCreateUserConfig?: AdminCreateUserConfigType | undefined;
|
|
2703
2988
|
/**
|
|
2704
|
-
* <p>
|
|
2705
|
-
*
|
|
2706
|
-
*
|
|
2707
|
-
*
|
|
2708
|
-
* <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
|
|
2989
|
+
* <p>Contains settings for activation of threat protection, including the operating
|
|
2990
|
+
* mode and additional authentication types. To log user security information but take
|
|
2991
|
+
* no action, set to <code>AUDIT</code>. To configure automatic security responses to
|
|
2992
|
+
* potentially unwanted traffic to your user pool, set to <code>ENFORCED</code>.</p>
|
|
2993
|
+
* <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">
|
|
2994
|
+
* Plus tier</a>.</p>
|
|
2709
2995
|
* @public
|
|
2710
2996
|
*/
|
|
2711
2997
|
UserPoolAddOns?: UserPoolAddOnsType | undefined;
|
|
@@ -2745,17 +3031,17 @@ export interface UpdateUserPoolResponse {
|
|
|
2745
3031
|
*/
|
|
2746
3032
|
export interface UpdateUserPoolClientRequest {
|
|
2747
3033
|
/**
|
|
2748
|
-
* <p>The ID of the user pool where you want to update the
|
|
3034
|
+
* <p>The ID of the user pool where you want to update the app client.</p>
|
|
2749
3035
|
* @public
|
|
2750
3036
|
*/
|
|
2751
3037
|
UserPoolId: string | undefined;
|
|
2752
3038
|
/**
|
|
2753
|
-
* <p>The ID of the client
|
|
3039
|
+
* <p>The ID of the app client that you want to update.</p>
|
|
2754
3040
|
* @public
|
|
2755
3041
|
*/
|
|
2756
3042
|
ClientId: string | undefined;
|
|
2757
3043
|
/**
|
|
2758
|
-
* <p>
|
|
3044
|
+
* <p>A friendly name for the app client.</p>
|
|
2759
3045
|
* @public
|
|
2760
3046
|
*/
|
|
2761
3047
|
ClientName?: string | undefined;
|
|
@@ -2807,24 +3093,20 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2807
3093
|
*/
|
|
2808
3094
|
IdTokenValidity?: number | undefined;
|
|
2809
3095
|
/**
|
|
2810
|
-
* <p>The
|
|
2811
|
-
*
|
|
2812
|
-
* hours.</p>
|
|
3096
|
+
* <p>The units that validity times are represented in. The default unit for refresh tokens
|
|
3097
|
+
* is days, and the default for ID and access tokens are hours.</p>
|
|
2813
3098
|
* @public
|
|
2814
3099
|
*/
|
|
2815
3100
|
TokenValidityUnits?: TokenValidityUnitsType | undefined;
|
|
2816
3101
|
/**
|
|
2817
3102
|
* <p>The list of user attributes that you want your app client to have read access to.
|
|
2818
3103
|
* After your user authenticates in your app, their access token authorizes them to read
|
|
2819
|
-
* their own attribute value for any attribute in this list
|
|
2820
|
-
* activity is when your user selects a link to view their profile information. Your app
|
|
2821
|
-
* 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
|
|
2822
|
-
* data.</p>
|
|
3104
|
+
* their own attribute value for any attribute in this list.</p>
|
|
2823
3105
|
* <p>When you don't specify the <code>ReadAttributes</code> for your app client, your
|
|
2824
3106
|
* app can read the values of <code>email_verified</code>,
|
|
2825
|
-
*
|
|
3107
|
+
* <code>phone_number_verified</code>, and the standard attributes of your user pool.
|
|
2826
3108
|
* When your user pool app client has read access to these default attributes,
|
|
2827
|
-
*
|
|
3109
|
+
* <code>ReadAttributes</code> doesn't return any information. Amazon Cognito only
|
|
2828
3110
|
* populates <code>ReadAttributes</code> in the API response if you have specified your own
|
|
2829
3111
|
* custom set of read attributes.</p>
|
|
2830
3112
|
* @public
|
|
@@ -2833,10 +3115,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2833
3115
|
/**
|
|
2834
3116
|
* <p>The list of user attributes that you want your app client to have write access to.
|
|
2835
3117
|
* After your user authenticates in your app, their access token authorizes them to set or
|
|
2836
|
-
* modify their own attribute value for any attribute in this list
|
|
2837
|
-
* of activity is when you present your user with a form to update their profile
|
|
2838
|
-
* 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
|
|
2839
|
-
* new value. </p>
|
|
3118
|
+
* modify their own attribute value for any attribute in this list.</p>
|
|
2840
3119
|
* <p>When you don't specify the <code>WriteAttributes</code> for your app client, your
|
|
2841
3120
|
* app can write the values of the Standard attributes of your user pool. When your user
|
|
2842
3121
|
* pool has write access to these default attributes, <code>WriteAttributes</code>
|
|
@@ -2853,13 +3132,16 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2853
3132
|
*/
|
|
2854
3133
|
WriteAttributes?: string[] | undefined;
|
|
2855
3134
|
/**
|
|
2856
|
-
* <p>The authentication flows that you want your user pool client to support. For each app
|
|
2857
|
-
* your users with any combination of one or more flows, including with
|
|
2858
|
-
* password, or a custom authentication process that
|
|
3135
|
+
* <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
|
|
3136
|
+
* client in your user pool, you can sign in your users with any combination of one or more flows, including with
|
|
3137
|
+
* a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that
|
|
3138
|
+
* you define with Lambda functions.</p>
|
|
2859
3139
|
* <note>
|
|
2860
|
-
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your
|
|
3140
|
+
* <p>If you don't specify a value for <code>ExplicitAuthFlows</code>, your app client supports
|
|
3141
|
+
* <code>ALLOW_REFRESH_TOKEN_AUTH</code>, <code>ALLOW_USER_SRP_AUTH</code>, and <code>ALLOW_CUSTOM_AUTH</code>.
|
|
3142
|
+
* </p>
|
|
2861
3143
|
* </note>
|
|
2862
|
-
* <p>
|
|
3144
|
+
* <p>The values for authentication flow options include the following.</p>
|
|
2863
3145
|
* <ul>
|
|
2864
3146
|
* <li>
|
|
2865
3147
|
* <p>
|
|
@@ -2872,6 +3154,8 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2872
3154
|
* without the flow <code>USER_SRP_AUTH</code> being active for the app
|
|
2873
3155
|
* client. This flow doesn't include <code>CUSTOM_AUTH</code>.
|
|
2874
3156
|
* </p>
|
|
3157
|
+
* <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">
|
|
3158
|
+
* Essentials tier</a> or higher.</p>
|
|
2875
3159
|
* </li>
|
|
2876
3160
|
* <li>
|
|
2877
3161
|
* <p>
|
|
@@ -2911,26 +3195,33 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2911
3195
|
/**
|
|
2912
3196
|
* <p>A list of provider names for the identity providers (IdPs) that are supported on this
|
|
2913
3197
|
* client. The following are supported: <code>COGNITO</code>, <code>Facebook</code>,
|
|
2914
|
-
*
|
|
3198
|
+
* <code>Google</code>, <code>SignInWithApple</code>, and <code>LoginWithAmazon</code>.
|
|
2915
3199
|
* You can also specify the names that you configured for the SAML and OIDC IdPs in your
|
|
2916
3200
|
* user pool, for example <code>MySAMLIdP</code> or <code>MyOIDCIdP</code>.</p>
|
|
2917
|
-
* <p>This
|
|
2918
|
-
*
|
|
2919
|
-
* from this list doesn't prevent authentication operations
|
|
2920
|
-
* user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
2921
|
-
* block access with a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-waf.html">WAF rule</a
|
|
3201
|
+
* <p>This parameter sets the IdPs that <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">managed
|
|
3202
|
+
* login</a> will display on the login page for your app client. The removal of
|
|
3203
|
+
* <code>COGNITO</code> from this list doesn't prevent authentication operations
|
|
3204
|
+
* for local users with the user pools API in an Amazon Web Services SDK. The only way to prevent
|
|
3205
|
+
* 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>.
|
|
3206
|
+
* </p>
|
|
2922
3207
|
* @public
|
|
2923
3208
|
*/
|
|
2924
3209
|
SupportedIdentityProviders?: string[] | undefined;
|
|
2925
3210
|
/**
|
|
2926
|
-
* <p>A list of allowed redirect
|
|
2927
|
-
*
|
|
3211
|
+
* <p>A list of allowed redirect, or callback, URLs for managed login authentication. These
|
|
3212
|
+
* URLs are the paths where you want to send your users' browsers after they complete
|
|
3213
|
+
* authentication with managed login or a third-party IdP. Typically, callback URLs are the
|
|
3214
|
+
* home of an application that uses OAuth or OIDC libraries to process authentication
|
|
3215
|
+
* outcomes.</p>
|
|
3216
|
+
* <p>A redirect URI must meet the following requirements:</p>
|
|
2928
3217
|
* <ul>
|
|
2929
3218
|
* <li>
|
|
2930
3219
|
* <p>Be an absolute URI.</p>
|
|
2931
3220
|
* </li>
|
|
2932
3221
|
* <li>
|
|
2933
|
-
* <p>Be registered with the authorization server
|
|
3222
|
+
* <p>Be registered with the authorization server. Amazon Cognito doesn't accept
|
|
3223
|
+
* authorization requests with <code>redirect_uri</code> values that aren't in
|
|
3224
|
+
* the list of <code>CallbackURLs</code> that you provide in this parameter.</p>
|
|
2934
3225
|
* </li>
|
|
2935
3226
|
* <li>
|
|
2936
3227
|
* <p>Not include a fragment component.</p>
|
|
@@ -2945,34 +3236,27 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2945
3236
|
*/
|
|
2946
3237
|
CallbackURLs?: string[] | undefined;
|
|
2947
3238
|
/**
|
|
2948
|
-
* <p>A list of allowed logout URLs for
|
|
3239
|
+
* <p>A list of allowed logout URLs for managed login authentication. When you pass
|
|
3240
|
+
* <code>logout_uri</code> and <code>client_id</code> parameters to
|
|
3241
|
+
* <code>/logout</code>, Amazon Cognito signs out your user and redirects them to the logout
|
|
3242
|
+
* URL. This parameter describes the URLs that you want to be the permitted targets of
|
|
3243
|
+
* <code>logout_uri</code>. A typical use of these URLs is when a user selects "Sign
|
|
3244
|
+
* 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
|
|
3245
|
+
* endpoint</a>.</p>
|
|
2949
3246
|
* @public
|
|
2950
3247
|
*/
|
|
2951
3248
|
LogoutURLs?: string[] | undefined;
|
|
2952
3249
|
/**
|
|
2953
|
-
* <p>The default redirect URI.
|
|
2954
|
-
*
|
|
2955
|
-
*
|
|
2956
|
-
* <li>
|
|
2957
|
-
* <p>Be an absolute URI.</p>
|
|
2958
|
-
* </li>
|
|
2959
|
-
* <li>
|
|
2960
|
-
* <p>Be registered with the authorization server.</p>
|
|
2961
|
-
* </li>
|
|
2962
|
-
* <li>
|
|
2963
|
-
* <p>Not include a fragment component.</p>
|
|
2964
|
-
* </li>
|
|
2965
|
-
* </ul>
|
|
2966
|
-
* <p>See <a href="https://tools.ietf.org/html/rfc6749#section-3.1.2">OAuth 2.0 -
|
|
2967
|
-
* Redirection Endpoint</a>.</p>
|
|
2968
|
-
* <p>Amazon Cognito requires HTTPS over HTTP except for <code>http://localhost</code> for testing
|
|
2969
|
-
* purposes only.</p>
|
|
2970
|
-
* <p>App callback URLs such as <code>myapp://example</code> are also supported.</p>
|
|
3250
|
+
* <p>The default redirect URI. In app clients with one assigned IdP, replaces
|
|
3251
|
+
* <code>redirect_uri</code> in authentication requests. Must be in the
|
|
3252
|
+
* <code>CallbackURLs</code> list.</p>
|
|
2971
3253
|
* @public
|
|
2972
3254
|
*/
|
|
2973
3255
|
DefaultRedirectURI?: string | undefined;
|
|
2974
3256
|
/**
|
|
2975
|
-
* <p>The
|
|
3257
|
+
* <p>The OAuth grant types that you want your app client to generate. To create an app
|
|
3258
|
+
* client that generates client credentials grants, you must add
|
|
3259
|
+
* <code>client_credentials</code> as the only allowed OAuth flow.</p>
|
|
2976
3260
|
* <dl>
|
|
2977
3261
|
* <dt>code</dt>
|
|
2978
3262
|
* <dd>
|
|
@@ -2996,17 +3280,19 @@ export interface UpdateUserPoolClientRequest {
|
|
|
2996
3280
|
*/
|
|
2997
3281
|
AllowedOAuthFlows?: OAuthFlowType[] | undefined;
|
|
2998
3282
|
/**
|
|
2999
|
-
* <p>The
|
|
3000
|
-
*
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
3283
|
+
* <p>The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app
|
|
3284
|
+
* client to authorize access with. Scopes govern access control to user pool self-service
|
|
3285
|
+
* API operations, user data from the <code>userInfo</code> endpoint, and third-party APIs.
|
|
3286
|
+
* Scope values include <code>phone</code>, <code>email</code>, <code>openid</code>, and
|
|
3287
|
+
* <code>profile</code>. The <code>aws.cognito.signin.user.admin</code> scope
|
|
3288
|
+
* authorizes user self-service operations. Custom scopes with resource servers authorize
|
|
3289
|
+
* access to external APIs.</p>
|
|
3003
3290
|
* @public
|
|
3004
3291
|
*/
|
|
3005
3292
|
AllowedOAuthScopes?: string[] | undefined;
|
|
3006
3293
|
/**
|
|
3007
|
-
* <p>Set to <code>true</code> to use OAuth 2.0 features in your
|
|
3008
|
-
* <p>
|
|
3009
|
-
* <code>AllowedOAuthFlowsUserPoolClient</code> must be <code>true</code> before you can configure
|
|
3294
|
+
* <p>Set to <code>true</code> to use OAuth 2.0 authorization server features in your app client.</p>
|
|
3295
|
+
* <p>This parameter must have a value of <code>true</code> before you can configure
|
|
3010
3296
|
* the following features in your app client.</p>
|
|
3011
3297
|
* <ul>
|
|
3012
3298
|
* <li>
|
|
@@ -3026,63 +3312,52 @@ export interface UpdateUserPoolClientRequest {
|
|
|
3026
3312
|
* <code>AllowedOAuthFlows</code>: Support for authorization code, implicit, and client credentials OAuth 2.0 grants.</p>
|
|
3027
3313
|
* </li>
|
|
3028
3314
|
* </ul>
|
|
3029
|
-
* <p>To use
|
|
3315
|
+
* <p>To use authorization server features, configure one of these features in the Amazon Cognito console or set
|
|
3030
3316
|
* <code>AllowedOAuthFlowsUserPoolClient</code> to <code>true</code> in a <code>CreateUserPoolClient</code> or
|
|
3031
3317
|
* <code>UpdateUserPoolClient</code> API request. If you don't set a value for
|
|
3032
3318
|
* <code>AllowedOAuthFlowsUserPoolClient</code> in a request with the CLI or SDKs, it defaults
|
|
3033
|
-
* to <code>false</code
|
|
3319
|
+
* to <code>false</code>. When <code>false</code>, only SDK-based API sign-in is permitted.</p>
|
|
3034
3320
|
* @public
|
|
3035
3321
|
*/
|
|
3036
3322
|
AllowedOAuthFlowsUserPoolClient?: boolean | undefined;
|
|
3037
3323
|
/**
|
|
3038
|
-
* <p>The
|
|
3039
|
-
*
|
|
3040
|
-
* <
|
|
3041
|
-
*
|
|
3042
|
-
*
|
|
3043
|
-
* pools support sending events to Amazon Pinpoint projects within that same Region.</p>
|
|
3044
|
-
* </note>
|
|
3324
|
+
* <p>The user pool analytics configuration for collecting metrics and sending them to your
|
|
3325
|
+
* Amazon Pinpoint campaign.</p>
|
|
3326
|
+
* <p>In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools might not have access to
|
|
3327
|
+
* analytics or might be configurable with campaigns in the US East (N. Virginia) Region.
|
|
3328
|
+
* For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html">Using Amazon Pinpoint analytics</a>.</p>
|
|
3045
3329
|
* @public
|
|
3046
3330
|
*/
|
|
3047
3331
|
AnalyticsConfiguration?: AnalyticsConfigurationType | undefined;
|
|
3048
3332
|
/**
|
|
3049
|
-
* <p>
|
|
3333
|
+
* <p>When <code>ENABLED</code>, suppresses messages that might indicate a valid user exists
|
|
3334
|
+
* when someone attempts sign-in. This parameters sets your preference for the errors and
|
|
3335
|
+
* responses that you want Amazon Cognito APIs to return during authentication, account
|
|
3050
3336
|
* confirmation, and password recovery when the user doesn't exist in the user pool. When
|
|
3051
3337
|
* set to <code>ENABLED</code> and the user doesn't exist, authentication returns an error
|
|
3052
3338
|
* indicating either the username or password was incorrect. Account confirmation and
|
|
3053
3339
|
* password recovery return a response indicating a code was sent to a simulated
|
|
3054
3340
|
* destination. When set to <code>LEGACY</code>, those APIs return a
|
|
3055
|
-
*
|
|
3341
|
+
* <code>UserNotFoundException</code> exception if the user doesn't exist in the user
|
|
3056
3342
|
* pool.</p>
|
|
3057
|
-
* <p>
|
|
3058
|
-
* <ul>
|
|
3059
|
-
* <li>
|
|
3060
|
-
* <p>
|
|
3061
|
-
* <code>ENABLED</code> - This prevents user existence-related errors.</p>
|
|
3062
|
-
* </li>
|
|
3063
|
-
* <li>
|
|
3064
|
-
* <p>
|
|
3065
|
-
* <code>LEGACY</code> - This represents the early behavior of Amazon Cognito where user
|
|
3066
|
-
* existence related errors aren't prevented.</p>
|
|
3067
|
-
* </li>
|
|
3068
|
-
* </ul>
|
|
3069
|
-
* <p>Defaults to <code>LEGACY</code> when you don't provide a value.</p>
|
|
3343
|
+
* <p>Defaults to <code>LEGACY</code>.</p>
|
|
3070
3344
|
* @public
|
|
3071
3345
|
*/
|
|
3072
3346
|
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes | undefined;
|
|
3073
3347
|
/**
|
|
3074
|
-
* <p>Activates or deactivates token
|
|
3075
|
-
*
|
|
3348
|
+
* <p>Activates or deactivates <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html">token
|
|
3349
|
+
* revocation</a> in the target app client.</p>
|
|
3076
3350
|
* @public
|
|
3077
3351
|
*/
|
|
3078
3352
|
EnableTokenRevocation?: boolean | undefined;
|
|
3079
3353
|
/**
|
|
3080
|
-
* <p>
|
|
3081
|
-
*
|
|
3082
|
-
*
|
|
3083
|
-
*
|
|
3084
|
-
*
|
|
3085
|
-
* client
|
|
3354
|
+
* <p>When <code>true</code>, your application can include additional
|
|
3355
|
+
* <code>UserContextData</code> in authentication requests. This data includes the IP
|
|
3356
|
+
* address, and contributes to analysis by threat protection features. For more information
|
|
3357
|
+
* 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,
|
|
3358
|
+
* you can't send the source IP address to Amazon Cognito threat protection features. You can only
|
|
3359
|
+
* activate <code>EnablePropagateAdditionalUserContextData</code> in an app client that has
|
|
3360
|
+
* a client secret.</p>
|
|
3086
3361
|
* @public
|
|
3087
3362
|
*/
|
|
3088
3363
|
EnablePropagateAdditionalUserContextData?: boolean | undefined;
|
|
@@ -3100,8 +3375,7 @@ export interface UpdateUserPoolClientRequest {
|
|
|
3100
3375
|
*/
|
|
3101
3376
|
export interface UpdateUserPoolClientResponse {
|
|
3102
3377
|
/**
|
|
3103
|
-
* <p>The
|
|
3104
|
-
* update the user pool client.</p>
|
|
3378
|
+
* <p>The updated details of your app client.</p>
|
|
3105
3379
|
* @public
|
|
3106
3380
|
*/
|
|
3107
3381
|
UserPoolClient?: UserPoolClientType | undefined;
|
|
@@ -3112,35 +3386,33 @@ export interface UpdateUserPoolClientResponse {
|
|
|
3112
3386
|
*/
|
|
3113
3387
|
export interface UpdateUserPoolDomainRequest {
|
|
3114
3388
|
/**
|
|
3115
|
-
* <p>The
|
|
3116
|
-
*
|
|
3117
|
-
*
|
|
3118
|
-
* hyphen for the first or last character. Use periods to separate subdomain names.</p>
|
|
3389
|
+
* <p>The name of the domain that you want to update. For custom domains, this is the
|
|
3390
|
+
* fully-qualified domain name, for example <code>auth.example.com</code>. For prefix
|
|
3391
|
+
* domains, this is the prefix alone, such as <code>myprefix</code>.</p>
|
|
3119
3392
|
* @public
|
|
3120
3393
|
*/
|
|
3121
3394
|
Domain: string | undefined;
|
|
3122
3395
|
/**
|
|
3123
|
-
* <p>The ID of the user pool that is associated with the
|
|
3124
|
-
* you're updating.</p>
|
|
3396
|
+
* <p>The ID of the user pool that is associated with the domain you're updating.</p>
|
|
3125
3397
|
* @public
|
|
3126
3398
|
*/
|
|
3127
3399
|
UserPoolId: string | undefined;
|
|
3128
3400
|
/**
|
|
3129
3401
|
* <p>A version number that indicates the state of managed login for your domain. Version
|
|
3130
|
-
*
|
|
3402
|
+
* <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
|
|
3131
3403
|
* login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
|
|
3132
3404
|
* @public
|
|
3133
3405
|
*/
|
|
3134
3406
|
ManagedLoginVersion?: number | undefined;
|
|
3135
3407
|
/**
|
|
3136
|
-
* <p>The configuration for a custom domain that hosts
|
|
3137
|
-
*
|
|
3138
|
-
* ACM
|
|
3408
|
+
* <p>The configuration for a custom domain that hosts managed login for your application.
|
|
3409
|
+
* In an <code>UpdateUserPoolDomain</code> request, this parameter specifies an SSL
|
|
3410
|
+
* certificate for the managed login hosted webserver. The certificate must be an ACM ARN
|
|
3411
|
+
* in <code>us-east-1</code>.</p>
|
|
3139
3412
|
* <p>When you create a custom domain, the passkey RP ID defaults to the custom domain. If
|
|
3140
3413
|
* you had a prefix domain active, this will cause passkey integration for your prefix
|
|
3141
3414
|
* domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey
|
|
3142
|
-
* integration working, you can explicitly set RP ID to the prefix domain
|
|
3143
|
-
* in a <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html">SetUserPoolMfaConfig</a> request.</p>
|
|
3415
|
+
* integration working, you can explicitly set RP ID to the prefix domain.</p>
|
|
3144
3416
|
* @public
|
|
3145
3417
|
*/
|
|
3146
3418
|
CustomDomainConfig?: CustomDomainConfigType | undefined;
|
|
@@ -3152,14 +3424,17 @@ export interface UpdateUserPoolDomainRequest {
|
|
|
3152
3424
|
export interface UpdateUserPoolDomainResponse {
|
|
3153
3425
|
/**
|
|
3154
3426
|
* <p>A version number that indicates the state of managed login for your domain. Version
|
|
3155
|
-
*
|
|
3427
|
+
* <code>1</code> is hosted UI (classic). Version <code>2</code> is the newer managed
|
|
3156
3428
|
* login with the branding designer. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html">Managed login</a>.</p>
|
|
3157
3429
|
* @public
|
|
3158
3430
|
*/
|
|
3159
3431
|
ManagedLoginVersion?: number | undefined;
|
|
3160
3432
|
/**
|
|
3161
|
-
* <p>The
|
|
3162
|
-
*
|
|
3433
|
+
* <p>The fully-qualified domain name (FQDN) of the Amazon CloudFront distribution that hosts your
|
|
3434
|
+
* managed login or classic hosted UI pages. You domain-name authority must have an alias
|
|
3435
|
+
* record that points requests for your custom domain to this FQDN. Amazon Cognito returns this
|
|
3436
|
+
* value if you set a custom domain with <code>CustomDomainConfig</code>. If you set an
|
|
3437
|
+
* Amazon Cognito prefix domain, this operation returns a blank response.</p>
|
|
3163
3438
|
* @public
|
|
3164
3439
|
*/
|
|
3165
3440
|
CloudFrontDomain?: string | undefined;
|
|
@@ -3182,24 +3457,23 @@ export declare class EnableSoftwareTokenMFAException extends __BaseException {
|
|
|
3182
3457
|
*/
|
|
3183
3458
|
export interface VerifySoftwareTokenRequest {
|
|
3184
3459
|
/**
|
|
3185
|
-
* <p>A valid access token that Amazon Cognito issued to the user
|
|
3186
|
-
*
|
|
3460
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
3461
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
3187
3462
|
* @public
|
|
3188
3463
|
*/
|
|
3189
3464
|
AccessToken?: string | undefined;
|
|
3190
3465
|
/**
|
|
3191
|
-
* <p>The session
|
|
3192
|
-
* service.</p>
|
|
3466
|
+
* <p>The session ID from an <code>AssociateSoftwareToken</code> request.</p>
|
|
3193
3467
|
* @public
|
|
3194
3468
|
*/
|
|
3195
3469
|
Session?: string | undefined;
|
|
3196
3470
|
/**
|
|
3197
|
-
* <p>
|
|
3471
|
+
* <p>A TOTP that the user generated in their configured authenticator app.</p>
|
|
3198
3472
|
* @public
|
|
3199
3473
|
*/
|
|
3200
3474
|
UserCode: string | undefined;
|
|
3201
3475
|
/**
|
|
3202
|
-
* <p>
|
|
3476
|
+
* <p>A friendly name for the device that's running the TOTP authenticator.</p>
|
|
3203
3477
|
* @public
|
|
3204
3478
|
*/
|
|
3205
3479
|
FriendlyDeviceName?: string | undefined;
|
|
@@ -3221,13 +3495,15 @@ export type VerifySoftwareTokenResponseType = (typeof VerifySoftwareTokenRespons
|
|
|
3221
3495
|
*/
|
|
3222
3496
|
export interface VerifySoftwareTokenResponse {
|
|
3223
3497
|
/**
|
|
3224
|
-
* <p>
|
|
3498
|
+
* <p>Amazon Cognito can accept or reject the code that you provide. This response parameter
|
|
3499
|
+
* indicates the success of TOTP verification. Some reasons that this operation might
|
|
3500
|
+
* return an error are clock skew on the user's device and excessive retries.</p>
|
|
3225
3501
|
* @public
|
|
3226
3502
|
*/
|
|
3227
3503
|
Status?: VerifySoftwareTokenResponseType | undefined;
|
|
3228
3504
|
/**
|
|
3229
|
-
* <p>
|
|
3230
|
-
*
|
|
3505
|
+
* <p>This session ID satisfies an <code>MFA_SETUP</code> challenge. Supply the session ID
|
|
3506
|
+
* in your challenge response.</p>
|
|
3231
3507
|
* @public
|
|
3232
3508
|
*/
|
|
3233
3509
|
Session?: string | undefined;
|
|
@@ -3238,18 +3514,19 @@ export interface VerifySoftwareTokenResponse {
|
|
|
3238
3514
|
*/
|
|
3239
3515
|
export interface VerifyUserAttributeRequest {
|
|
3240
3516
|
/**
|
|
3241
|
-
* <p>A valid access token that Amazon Cognito issued to the
|
|
3242
|
-
*
|
|
3517
|
+
* <p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for
|
|
3518
|
+
* <code>aws.cognito.signin.user.admin</code>.</p>
|
|
3243
3519
|
* @public
|
|
3244
3520
|
*/
|
|
3245
3521
|
AccessToken: string | undefined;
|
|
3246
3522
|
/**
|
|
3247
|
-
* <p>The
|
|
3523
|
+
* <p>The name of the attribute that you want to verify.</p>
|
|
3248
3524
|
* @public
|
|
3249
3525
|
*/
|
|
3250
3526
|
AttributeName: string | undefined;
|
|
3251
3527
|
/**
|
|
3252
|
-
* <p>The verification code
|
|
3528
|
+
* <p>The verification code that your user pool sent to the added or changed attribute, for
|
|
3529
|
+
* example the user's email address.</p>
|
|
3253
3530
|
* @public
|
|
3254
3531
|
*/
|
|
3255
3532
|
Code: string | undefined;
|