@aws-sdk/client-cognito-identity-provider 3.1144.0 → 3.1146.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +43 -29
- package/dist-es/models/errors.js +12 -12
- package/dist-es/schemas/schemas_0.js +30 -16
- package/dist-types/commands/AdminInitiateAuthCommand.d.ts +16 -0
- package/dist-types/commands/AdminRespondToAuthChallengeCommand.d.ts +3 -0
- package/dist-types/commands/CreateIdentityProviderCommand.d.ts +6 -0
- package/dist-types/commands/CreateUserPoolClientCommand.d.ts +14 -2
- package/dist-types/commands/CreateUserPoolCommand.d.ts +24 -2
- package/dist-types/commands/CreateUserPoolDomainCommand.d.ts +14 -2
- package/dist-types/commands/CreateUserPoolReplicaCommand.d.ts +14 -2
- package/dist-types/commands/DescribeIdentityProviderCommand.d.ts +3 -0
- package/dist-types/commands/DescribeTermsByClientCommand.d.ts +2 -4
- package/dist-types/commands/DescribeUserPoolCommand.d.ts +5 -0
- package/dist-types/commands/GetClientTokenCommand.d.ts +1 -2
- package/dist-types/commands/GetIdentityProviderByIdentifierCommand.d.ts +3 -0
- package/dist-types/commands/InitiateAuthCommand.d.ts +16 -0
- package/dist-types/commands/RespondToAuthChallengeCommand.d.ts +3 -0
- package/dist-types/commands/SetLogDeliveryConfigurationCommand.d.ts +14 -2
- package/dist-types/commands/SetUserPoolMfaConfigCommand.d.ts +15 -4
- package/dist-types/commands/UpdateIdentityProviderCommand.d.ts +6 -0
- package/dist-types/commands/UpdateUserPoolClientCommand.d.ts +14 -2
- package/dist-types/commands/UpdateUserPoolCommand.d.ts +19 -2
- package/dist-types/commands/UpdateUserPoolDomainCommand.d.ts +14 -2
- package/dist-types/models/errors.d.ts +25 -13
- package/dist-types/models/models_0.d.ts +147 -51
- package/dist-types/models/models_1.d.ts +73 -1
- package/dist-types/schemas/schemas_0.d.ts +1 -0
- package/dist-types/ts3.4/commands/SetUserPoolMfaConfigCommand.d.ts +1 -2
- package/dist-types/ts3.4/models/errors.d.ts +5 -5
- package/dist-types/ts3.4/models/models_0.d.ts +9 -8
- package/dist-types/ts3.4/models/models_1.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +1 -0
- package/package.json +1 -1
|
@@ -99,6 +99,9 @@ declare const RespondToAuthChallengeCommand_base: {
|
|
|
99
99
|
* // DeviceGroupKey: "STRING_VALUE",
|
|
100
100
|
* // },
|
|
101
101
|
* // },
|
|
102
|
+
* // AvailableChallenges: [ // AvailableChallengeListType
|
|
103
|
+
* // "SMS_MFA" || "EMAIL_OTP" || "SOFTWARE_TOKEN_MFA" || "SELECT_MFA_TYPE" || "MFA_SETUP" || "PASSWORD_VERIFIER" || "CUSTOM_CHALLENGE" || "SELECT_CHALLENGE" || "DEVICE_SRP_AUTH" || "DEVICE_PASSWORD_VERIFIER" || "ADMIN_NO_SRP_AUTH" || "NEW_PASSWORD_REQUIRED" || "SMS_OTP" || "PASSWORD" || "WEB_AUTHN" || "PASSWORD_SRP",
|
|
104
|
+
* // ],
|
|
102
105
|
* // };
|
|
103
106
|
*
|
|
104
107
|
* ```
|
|
@@ -86,8 +86,20 @@ declare const SetLogDeliveryConfigurationCommand_base: {
|
|
|
86
86
|
* @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape.
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link FeatureUnavailableInTierException} (client fault)
|
|
89
|
-
* <p>This exception is thrown when a feature you attempted to configure
|
|
90
|
-
*
|
|
89
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
90
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
91
|
+
* when:</p>
|
|
92
|
+
* <ul>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
98
|
+
* plan.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* </ul>
|
|
101
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
102
|
+
* feature.</p>
|
|
91
103
|
*
|
|
92
104
|
* @throws {@link InternalErrorException} (server fault)
|
|
93
105
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import type { SetUserPoolMfaConfigRequest } from "../models/
|
|
3
|
-
import type { SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
2
|
+
import type { SetUserPoolMfaConfigRequest, SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
4
3
|
/**
|
|
5
4
|
* @public
|
|
6
5
|
*/
|
|
@@ -133,8 +132,20 @@ declare const SetUserPoolMfaConfigCommand_base: {
|
|
|
133
132
|
* concurrently.</p>
|
|
134
133
|
*
|
|
135
134
|
* @throws {@link FeatureUnavailableInTierException} (client fault)
|
|
136
|
-
* <p>This exception is thrown when a feature you attempted to configure
|
|
137
|
-
*
|
|
135
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
136
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
137
|
+
* when:</p>
|
|
138
|
+
* <ul>
|
|
139
|
+
* <li>
|
|
140
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
141
|
+
* </li>
|
|
142
|
+
* <li>
|
|
143
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
144
|
+
* plan.</p>
|
|
145
|
+
* </li>
|
|
146
|
+
* </ul>
|
|
147
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
148
|
+
* feature.</p>
|
|
138
149
|
*
|
|
139
150
|
* @throws {@link InternalErrorException} (server fault)
|
|
140
151
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -68,6 +68,9 @@ declare const UpdateIdentityProviderCommand_base: {
|
|
|
68
68
|
* IdpIdentifiers: [ // IdpIdentifiersListType
|
|
69
69
|
* "STRING_VALUE",
|
|
70
70
|
* ],
|
|
71
|
+
* AcrMapping: { // AcrMappingType
|
|
72
|
+
* "<keys>": "STRING_VALUE",
|
|
73
|
+
* },
|
|
71
74
|
* };
|
|
72
75
|
* const command = new UpdateIdentityProviderCommand(input);
|
|
73
76
|
* const response = await client.send(command);
|
|
@@ -85,6 +88,9 @@ declare const UpdateIdentityProviderCommand_base: {
|
|
|
85
88
|
* // IdpIdentifiers: [ // IdpIdentifiersListType
|
|
86
89
|
* // "STRING_VALUE",
|
|
87
90
|
* // ],
|
|
91
|
+
* // AcrMapping: { // AcrMappingType
|
|
92
|
+
* // "<keys>": "STRING_VALUE",
|
|
93
|
+
* // },
|
|
88
94
|
* // LastModifiedDate: new Date("TIMESTAMP"),
|
|
89
95
|
* // CreationDate: new Date("TIMESTAMP"),
|
|
90
96
|
* // },
|
|
@@ -191,8 +191,20 @@ declare const UpdateUserPoolClientCommand_base: {
|
|
|
191
191
|
* concurrently.</p>
|
|
192
192
|
*
|
|
193
193
|
* @throws {@link FeatureUnavailableInTierException} (client fault)
|
|
194
|
-
* <p>This exception is thrown when a feature you attempted to configure
|
|
195
|
-
*
|
|
194
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
195
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
196
|
+
* when:</p>
|
|
197
|
+
* <ul>
|
|
198
|
+
* <li>
|
|
199
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
200
|
+
* </li>
|
|
201
|
+
* <li>
|
|
202
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
203
|
+
* plan.</p>
|
|
204
|
+
* </li>
|
|
205
|
+
* </ul>
|
|
206
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
207
|
+
* feature.</p>
|
|
196
208
|
*
|
|
197
209
|
* @throws {@link InternalErrorException} (server fault)
|
|
198
210
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -208,6 +208,11 @@ declare const UpdateUserPoolCommand_base: {
|
|
|
208
208
|
* IssuerConfiguration: { // IssuerConfigurationType
|
|
209
209
|
* Type: "ORIGINAL" || "UPDATED",
|
|
210
210
|
* },
|
|
211
|
+
* AcrConfiguration: { // AcrConfigurationType
|
|
212
|
+
* "<keys>": { // AcrLevelConfigType
|
|
213
|
+
* AcrValue: "STRING_VALUE", // required
|
|
214
|
+
* },
|
|
215
|
+
* },
|
|
211
216
|
* };
|
|
212
217
|
* const command = new UpdateUserPoolCommand(input);
|
|
213
218
|
* const response = await client.send(command);
|
|
@@ -226,8 +231,20 @@ declare const UpdateUserPoolCommand_base: {
|
|
|
226
231
|
* concurrently.</p>
|
|
227
232
|
*
|
|
228
233
|
* @throws {@link FeatureUnavailableInTierException} (client fault)
|
|
229
|
-
* <p>This exception is thrown when a feature you attempted to configure
|
|
230
|
-
*
|
|
234
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
235
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
236
|
+
* when:</p>
|
|
237
|
+
* <ul>
|
|
238
|
+
* <li>
|
|
239
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
240
|
+
* </li>
|
|
241
|
+
* <li>
|
|
242
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
243
|
+
* plan.</p>
|
|
244
|
+
* </li>
|
|
245
|
+
* </ul>
|
|
246
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
247
|
+
* feature.</p>
|
|
231
248
|
*
|
|
232
249
|
* @throws {@link InternalErrorException} (server fault)
|
|
233
250
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -110,8 +110,20 @@ declare const UpdateUserPoolDomainCommand_base: {
|
|
|
110
110
|
* concurrently.</p>
|
|
111
111
|
*
|
|
112
112
|
* @throws {@link FeatureUnavailableInTierException} (client fault)
|
|
113
|
-
* <p>This exception is thrown when a feature you attempted to configure
|
|
114
|
-
*
|
|
113
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
114
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
115
|
+
* when:</p>
|
|
116
|
+
* <ul>
|
|
117
|
+
* <li>
|
|
118
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
122
|
+
* plan.</p>
|
|
123
|
+
* </li>
|
|
124
|
+
* </ul>
|
|
125
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
126
|
+
* feature.</p>
|
|
115
127
|
*
|
|
116
128
|
* @throws {@link InternalErrorException} (server fault)
|
|
117
129
|
* <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
|
|
@@ -323,6 +323,31 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
|
|
|
323
323
|
*/
|
|
324
324
|
constructor(opts: __ExceptionOptionType<InvalidUserPoolConfigurationException, __BaseException>);
|
|
325
325
|
}
|
|
326
|
+
/**
|
|
327
|
+
* <p>This exception is thrown when a feature that you attempted to use or configure
|
|
328
|
+
* isn't included in your user pool's current feature plan. This can occur
|
|
329
|
+
* when:</p>
|
|
330
|
+
* <ul>
|
|
331
|
+
* <li>
|
|
332
|
+
* <p>You configure a feature that your feature plan doesn't support.</p>
|
|
333
|
+
* </li>
|
|
334
|
+
* <li>
|
|
335
|
+
* <p>You make a request that uses a feature that requires a higher feature
|
|
336
|
+
* plan.</p>
|
|
337
|
+
* </li>
|
|
338
|
+
* </ul>
|
|
339
|
+
* <p>To resolve this issue, upgrade your user pool to a feature plan that includes the
|
|
340
|
+
* feature.</p>
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
export declare class FeatureUnavailableInTierException extends __BaseException {
|
|
344
|
+
readonly name: "FeatureUnavailableInTierException";
|
|
345
|
+
readonly $fault: "client";
|
|
346
|
+
/**
|
|
347
|
+
* @internal
|
|
348
|
+
*/
|
|
349
|
+
constructor(opts: __ExceptionOptionType<FeatureUnavailableInTierException, __BaseException>);
|
|
350
|
+
}
|
|
326
351
|
/**
|
|
327
352
|
* <p>This exception is thrown when Amazon Cognito isn't allowed to use your email identity. HTTP
|
|
328
353
|
* status code: 400.</p>
|
|
@@ -606,19 +631,6 @@ export declare class TermsExistsException extends __BaseException {
|
|
|
606
631
|
*/
|
|
607
632
|
constructor(opts: __ExceptionOptionType<TermsExistsException, __BaseException>);
|
|
608
633
|
}
|
|
609
|
-
/**
|
|
610
|
-
* <p>This exception is thrown when a feature you attempted to configure isn't
|
|
611
|
-
* available in your current feature plan.</p>
|
|
612
|
-
* @public
|
|
613
|
-
*/
|
|
614
|
-
export declare class FeatureUnavailableInTierException extends __BaseException {
|
|
615
|
-
readonly name: "FeatureUnavailableInTierException";
|
|
616
|
-
readonly $fault: "client";
|
|
617
|
-
/**
|
|
618
|
-
* @internal
|
|
619
|
-
*/
|
|
620
|
-
constructor(opts: __ExceptionOptionType<FeatureUnavailableInTierException, __BaseException>);
|
|
621
|
-
}
|
|
622
634
|
/**
|
|
623
635
|
* <p>This exception is thrown when you've attempted to change your feature plan but
|
|
624
636
|
* the operation isn't permitted.</p>
|
|
@@ -201,6 +201,20 @@ export interface AccountTakeoverRiskConfigurationType {
|
|
|
201
201
|
*/
|
|
202
202
|
Actions: AccountTakeoverActionsType | undefined;
|
|
203
203
|
}
|
|
204
|
+
/**
|
|
205
|
+
* <p>The configuration for a single authentication context class reference (ACR) level in a user pool. Each entry in an <code>AcrConfiguration</code> map associates a level (<code>Level1</code> through <code>Level4</code>) with this configuration, which provides the custom name that Amazon Cognito reports for that level in the <code>acr</code> token claim.</p>
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export interface AcrLevelConfigType {
|
|
209
|
+
/**
|
|
210
|
+
* <p>The custom name for this authentication context class reference (ACR) level. This
|
|
211
|
+
* value is the URI that Amazon Cognito reports in the <code>acr</code> token claim when a
|
|
212
|
+
* user meets this level. The name must be unique across all levels in the user pool,
|
|
213
|
+
* including default names.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
AcrValue: string | undefined;
|
|
217
|
+
}
|
|
204
218
|
/**
|
|
205
219
|
* <p>The minimum and maximum values of an attribute that is of the number type, for example
|
|
206
220
|
* <code>custom:age</code>.</p>
|
|
@@ -1445,6 +1459,38 @@ export interface AdminInitiateAuthRequest {
|
|
|
1445
1459
|
* <code>AvailableChallenges</code> parameter that specifies the
|
|
1446
1460
|
* available sign-in methods.</p>
|
|
1447
1461
|
* </li>
|
|
1462
|
+
* <li>
|
|
1463
|
+
* <p>
|
|
1464
|
+
* <code>TARGET_ACR_VALUES</code>. An optional, space-separated list
|
|
1465
|
+
* of the authentication context class reference (ACR) level URIs that
|
|
1466
|
+
* you want the user to reach. List the levels in priority order, from
|
|
1467
|
+
* highest to lowest. Amazon Cognito attempts the highest-priority level that the
|
|
1468
|
+
* user can satisfy, and falls back through the list. Amazon Cognito ignores any
|
|
1469
|
+
* value that it doesn't recognize. If none of the requested values are
|
|
1470
|
+
* valid, Amazon Cognito returns an error.</p>
|
|
1471
|
+
* <p>Requesting step-up authentication with this parameter requires the
|
|
1472
|
+
* Essentials or Plus feature plan. On a lower feature plan,
|
|
1473
|
+
* AdminInitiateAuth returns a FeatureUnavailableInTierException.
|
|
1474
|
+
* <code>USERNAME</code> is required. When you provide an
|
|
1475
|
+
* <code>ACCESS_TOKEN</code>, you must also provide
|
|
1476
|
+
* <code>TARGET_ACR_VALUES</code>. Amazon Cognito returns an error if you provide
|
|
1477
|
+
* an <code>ACCESS_TOKEN</code> without <code>TARGET_ACR_VALUES</code>.
|
|
1478
|
+
* The <code>USERNAME</code> that you provide must match the user that the
|
|
1479
|
+
* <code>ACCESS_TOKEN</code> was issued for.</p>
|
|
1480
|
+
* <p>For more information about step-up authentication and how Amazon Cognito
|
|
1481
|
+
* handles multi-factor authentication requirements, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html">Step-up
|
|
1482
|
+
* authentication with ACR and AMR</a> in the <i>Amazon Cognito
|
|
1483
|
+
* Developer Guide</i>.</p>
|
|
1484
|
+
* </li>
|
|
1485
|
+
* <li>
|
|
1486
|
+
* <p>
|
|
1487
|
+
* <code>MAX_AGE</code>. An optional integer that sets the maximum
|
|
1488
|
+
* number of seconds allowed since the user last authenticated. If the
|
|
1489
|
+
* user's most recent authentication is older than this value, Amazon Cognito
|
|
1490
|
+
* discards the authentication-methods credit from any access token that
|
|
1491
|
+
* you provide and processes the request as a fresh authentication toward
|
|
1492
|
+
* the target level. The access token itself remains valid.</p>
|
|
1493
|
+
* </li>
|
|
1448
1494
|
* </ul>
|
|
1449
1495
|
* </dd>
|
|
1450
1496
|
* <dt>USER_SRP_AUTH</dt>
|
|
@@ -3097,6 +3143,14 @@ export interface AdminRespondToAuthChallengeResponse {
|
|
|
3097
3143
|
* @public
|
|
3098
3144
|
*/
|
|
3099
3145
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
3146
|
+
/**
|
|
3147
|
+
* <p>This response parameter lists the available authentication challenges that users can
|
|
3148
|
+
* 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
|
|
3149
|
+
* able to choose between passkey authentication, a one-time password from an SMS message,
|
|
3150
|
+
* and a traditional password.</p>
|
|
3151
|
+
* @public
|
|
3152
|
+
*/
|
|
3153
|
+
AvailableChallenges?: ChallengeNameType[] | undefined;
|
|
3100
3154
|
}
|
|
3101
3155
|
/**
|
|
3102
3156
|
* <p>User preferences for multi-factor authentication with email messages. Activates or
|
|
@@ -4186,6 +4240,20 @@ export interface CreateIdentityProviderRequest {
|
|
|
4186
4240
|
* @public
|
|
4187
4241
|
*/
|
|
4188
4242
|
IdpIdentifiers?: string[] | undefined;
|
|
4243
|
+
/**
|
|
4244
|
+
* <p>A mapping between the authentication context class reference (ACR) levels of your user
|
|
4245
|
+
* pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP).
|
|
4246
|
+
* The map is keyed by level, from <code>Level1</code> through <code>Level4</code>, and each
|
|
4247
|
+
* value is the ACR value that the IdP uses for the corresponding level. Amazon Cognito uses
|
|
4248
|
+
* this mapping to translate a requested user pool ACR level to the value that the IdP
|
|
4249
|
+
* expects, and to map an ACR value that the IdP returns back to a user pool level. When the
|
|
4250
|
+
* IdP returns an ACR value that isn't mapped, Amazon Cognito resolves it to the lowest
|
|
4251
|
+
* level. Only OIDC IdPs support ACR mapping.</p>
|
|
4252
|
+
* <p>Setting <code>AcrMapping</code> is available in all feature plans. It isn't restricted
|
|
4253
|
+
* to the Essentials or Plus feature plan.</p>
|
|
4254
|
+
* @public
|
|
4255
|
+
*/
|
|
4256
|
+
AcrMapping?: Record<string, string> | undefined;
|
|
4189
4257
|
}
|
|
4190
4258
|
/**
|
|
4191
4259
|
* <p>A user pool identity provider (IdP). Contains information about a third-party IdP to a
|
|
@@ -4346,6 +4414,15 @@ export interface IdentityProviderType {
|
|
|
4346
4414
|
* @public
|
|
4347
4415
|
*/
|
|
4348
4416
|
IdpIdentifiers?: string[] | undefined;
|
|
4417
|
+
/**
|
|
4418
|
+
* <p>A mapping between the authentication context class reference (ACR) levels of your user
|
|
4419
|
+
* pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP), so
|
|
4420
|
+
* that your application gets a consistent step-up experience regardless of which IdP
|
|
4421
|
+
* authenticated the user. The map is keyed by level, from <code>Level1</code> through
|
|
4422
|
+
* <code>Level4</code>.</p>
|
|
4423
|
+
* @public
|
|
4424
|
+
*/
|
|
4425
|
+
AcrMapping?: Record<string, string> | undefined;
|
|
4349
4426
|
/**
|
|
4350
4427
|
* <p>The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a
|
|
4351
4428
|
* human-readable format like ISO 8601 or a Java <code>Date</code> object.</p>
|
|
@@ -5858,6 +5935,25 @@ export interface CreateUserPoolRequest {
|
|
|
5858
5935
|
* @public
|
|
5859
5936
|
*/
|
|
5860
5937
|
IssuerConfiguration?: IssuerConfigurationType | undefined;
|
|
5938
|
+
/**
|
|
5939
|
+
* <p>The custom names for the authentication context class reference
|
|
5940
|
+
* (ACR) levels in your user pool. Amazon Cognito defines four fixed ACR levels that
|
|
5941
|
+
* represent increasing authentication assurance. The combination of authentication factors
|
|
5942
|
+
* that satisfies each level is fixed and you can't change it. With this configuration, you
|
|
5943
|
+
* customize only the URI name that Amazon Cognito reports for each level in the
|
|
5944
|
+
* <code>acr</code> token claim.</p>
|
|
5945
|
+
* <p>You can override a subset of the levels. By default, the levels are named
|
|
5946
|
+
* <code>urn:cognito:loa:1</code> through <code>urn:cognito:loa:4</code>, and Amazon Cognito
|
|
5947
|
+
* applies the default name to any level that you don't specify. Each name must be
|
|
5948
|
+
* unique across all four levels, including any default names that apply to levels you
|
|
5949
|
+
* don't override. A name can contain any character
|
|
5950
|
+
* that is valid in a URL or a URN.</p>
|
|
5951
|
+
* <p>Configuring custom ACR level names requires the Essentials or Plus feature plan.
|
|
5952
|
+
* 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">
|
|
5953
|
+
* Essentials tier</a> or higher.</p>
|
|
5954
|
+
* @public
|
|
5955
|
+
*/
|
|
5956
|
+
AcrConfiguration?: Record<string, AcrLevelConfigType> | undefined;
|
|
5861
5957
|
}
|
|
5862
5958
|
/**
|
|
5863
5959
|
* <p>The configuration of a user pool.</p>
|
|
@@ -6141,6 +6237,16 @@ export interface UserPoolType {
|
|
|
6141
6237
|
* @public
|
|
6142
6238
|
*/
|
|
6143
6239
|
IssuerConfiguration?: IssuerConfigurationType | undefined;
|
|
6240
|
+
/**
|
|
6241
|
+
* <p>The names of the authentication context class reference (ACR) levels for the user
|
|
6242
|
+
* pool. Amazon Cognito always returns the effective configuration, with default names
|
|
6243
|
+
* merged in for any level that you haven't customized.</p>
|
|
6244
|
+
* <p>Configuring custom ACR level names requires the Essentials or Plus feature plan.
|
|
6245
|
+
* 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">
|
|
6246
|
+
* Essentials tier</a> or higher.</p>
|
|
6247
|
+
* @public
|
|
6248
|
+
*/
|
|
6249
|
+
AcrConfiguration?: Record<string, AcrLevelConfigType> | undefined;
|
|
6144
6250
|
}
|
|
6145
6251
|
/**
|
|
6146
6252
|
* <p>Represents the response from the server for the request to create a user pool.</p>
|
|
@@ -7748,7 +7854,7 @@ export interface DescribeTermsByClientRequest {
|
|
|
7748
7854
|
*/
|
|
7749
7855
|
export interface DescribeTermsByClientResponse {
|
|
7750
7856
|
/**
|
|
7751
|
-
* <p>A summary of the requested terms documents
|
|
7857
|
+
* <p>A summary of the requested terms documents, including a unique identifier for later
|
|
7752
7858
|
* changes to the terms documents.</p>
|
|
7753
7859
|
* @public
|
|
7754
7860
|
*/
|
|
@@ -9050,6 +9156,38 @@ export interface InitiateAuthRequest {
|
|
|
9050
9156
|
* <code>AvailableChallenges</code> parameter that specifies the
|
|
9051
9157
|
* available sign-in methods.</p>
|
|
9052
9158
|
* </li>
|
|
9159
|
+
* <li>
|
|
9160
|
+
* <p>
|
|
9161
|
+
* <code>TARGET_ACR_VALUES</code>. An optional, space-separated list
|
|
9162
|
+
* of the authentication context class reference (ACR) level URIs that
|
|
9163
|
+
* you want the user to reach. List the levels in priority order, from
|
|
9164
|
+
* highest to lowest. Amazon Cognito attempts the highest-priority level that the
|
|
9165
|
+
* user can satisfy, and falls back through the list. Amazon Cognito ignores any
|
|
9166
|
+
* value that it doesn't recognize. If none of the requested values are
|
|
9167
|
+
* valid, Amazon Cognito returns an error.</p>
|
|
9168
|
+
* <p>Requesting step-up authentication with this parameter requires the
|
|
9169
|
+
* Essentials or Plus feature plan. On a lower feature plan, InitiateAuth
|
|
9170
|
+
* returns a FeatureUnavailableInTierException. <code>USERNAME</code> is
|
|
9171
|
+
* required. When you provide an <code>ACCESS_TOKEN</code>, you must also
|
|
9172
|
+
* provide <code>TARGET_ACR_VALUES</code>. Amazon Cognito returns an error if you
|
|
9173
|
+
* provide an <code>ACCESS_TOKEN</code> without
|
|
9174
|
+
* <code>TARGET_ACR_VALUES</code>. The <code>USERNAME</code> that you
|
|
9175
|
+
* provide must match the user that the <code>ACCESS_TOKEN</code> was
|
|
9176
|
+
* issued for.</p>
|
|
9177
|
+
* <p>For more information about step-up authentication and how Amazon Cognito
|
|
9178
|
+
* handles multi-factor authentication requirements, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-step-up-authentication.html">Step-up
|
|
9179
|
+
* authentication with ACR and AMR</a> in the <i>Amazon Cognito
|
|
9180
|
+
* Developer Guide</i>.</p>
|
|
9181
|
+
* </li>
|
|
9182
|
+
* <li>
|
|
9183
|
+
* <p>
|
|
9184
|
+
* <code>MAX_AGE</code>. An optional integer that sets the maximum
|
|
9185
|
+
* number of seconds allowed since the user last authenticated. If the
|
|
9186
|
+
* user's most recent authentication is older than this value, Amazon Cognito
|
|
9187
|
+
* discards the authentication-methods credit from any access token that
|
|
9188
|
+
* you provide and processes the request as a fresh authentication toward
|
|
9189
|
+
* the target level. The access token itself remains valid.</p>
|
|
9190
|
+
* </li>
|
|
9053
9191
|
* </ul>
|
|
9054
9192
|
* </dd>
|
|
9055
9193
|
* <dt>USER_SRP_AUTH</dt>
|
|
@@ -10860,6 +10998,14 @@ export interface RespondToAuthChallengeResponse {
|
|
|
10860
10998
|
* @public
|
|
10861
10999
|
*/
|
|
10862
11000
|
AuthenticationResult?: AuthenticationResultType | undefined;
|
|
11001
|
+
/**
|
|
11002
|
+
* <p>This response parameter lists the available authentication challenges that users can
|
|
11003
|
+
* 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
|
|
11004
|
+
* able to choose between passkey authentication, a one-time password from an SMS message,
|
|
11005
|
+
* and a traditional password.</p>
|
|
11006
|
+
* @public
|
|
11007
|
+
*/
|
|
11008
|
+
AvailableChallenges?: ChallengeNameType[] | undefined;
|
|
10863
11009
|
}
|
|
10864
11010
|
/**
|
|
10865
11011
|
* @public
|
|
@@ -11058,53 +11204,3 @@ export interface SetUserMFAPreferenceRequest {
|
|
|
11058
11204
|
*/
|
|
11059
11205
|
export interface SetUserMFAPreferenceResponse {
|
|
11060
11206
|
}
|
|
11061
|
-
/**
|
|
11062
|
-
* @public
|
|
11063
|
-
*/
|
|
11064
|
-
export interface SetUserPoolMfaConfigRequest {
|
|
11065
|
-
/**
|
|
11066
|
-
* <p>The user pool ID.</p>
|
|
11067
|
-
* @public
|
|
11068
|
-
*/
|
|
11069
|
-
UserPoolId: string | undefined;
|
|
11070
|
-
/**
|
|
11071
|
-
* <p>Configures user pool SMS messages for MFA. Sets the message template and the SMS
|
|
11072
|
-
* message sending configuration for Amazon SNS.</p>
|
|
11073
|
-
* @public
|
|
11074
|
-
*/
|
|
11075
|
-
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
11076
|
-
/**
|
|
11077
|
-
* <p>Configures a user pool for time-based one-time password (TOTP) MFA. Enables or
|
|
11078
|
-
* disables TOTP.</p>
|
|
11079
|
-
* @public
|
|
11080
|
-
*/
|
|
11081
|
-
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
11082
|
-
/**
|
|
11083
|
-
* <p>Sets configuration for user pool email message MFA and sign-in with one-time passwords
|
|
11084
|
-
* (OTPs). Includes the subject and body of the email message template for sign-in and MFA
|
|
11085
|
-
* 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">
|
|
11086
|
-
* Essentials tier</a> or higher.</p>
|
|
11087
|
-
* @public
|
|
11088
|
-
*/
|
|
11089
|
-
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
11090
|
-
/**
|
|
11091
|
-
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
11092
|
-
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
11093
|
-
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
11094
|
-
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
11095
|
-
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
11096
|
-
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
11097
|
-
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
11098
|
-
* API responses and in managed login for users who have chosen and configured a preferred
|
|
11099
|
-
* MFA factor.</p>
|
|
11100
|
-
* @public
|
|
11101
|
-
*/
|
|
11102
|
-
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
11103
|
-
/**
|
|
11104
|
-
* <p>The configuration of your user pool for passkey, or WebAuthn, authentication and
|
|
11105
|
-
* registration. Includes relying-party configuration, user-verification requirements,
|
|
11106
|
-
* and whether passkeys can satisfy MFA requirements.</p>
|
|
11107
|
-
* @public
|
|
11108
|
-
*/
|
|
11109
|
-
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
11110
|
-
}
|
|
@@ -1,6 +1,56 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
2
|
import type { DeletionProtectionType, DeviceRememberedStatusType, ExplicitAuthFlowsType, FeedbackValueType, OAuthFlowType, PreventUserExistenceErrorTypes, TermsEnforcementType, TermsSourceType, UpdateReplicaStatusType, UserPoolMfaType, UserPoolTierType, VerifiedAttributeType, VerifySoftwareTokenResponseType } from "./enums";
|
|
3
|
-
import type { AccountRecoverySettingType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeviceConfigurationType, EmailConfigurationType, EmailMfaConfigType, GroupType, IdentityProviderType, IssuerConfigurationType, KeyConfigurationType, LambdaConfigType, LimitDefinitionType, LimitType, ManagedLoginBrandingType, MFAOptionType, RefreshTokenRotationType, ResourceServerScopeType, ResourceServerType, RoutingType, SmsConfigurationType, SmsMfaConfigType, SoftwareTokenMfaConfigType, TermsType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolPolicyType, UserPoolReplicaType, VerificationMessageTemplateType, WebAuthnConfigurationType } from "./models_0";
|
|
3
|
+
import type { AccountRecoverySettingType, AcrLevelConfigType, AdminCreateUserConfigType, AnalyticsConfigurationType, AnalyticsMetadataType, AssetType, AttributeType, CodeDeliveryDetailsType, CustomDomainConfigType, DeviceConfigurationType, EmailConfigurationType, EmailMfaConfigType, GroupType, IdentityProviderType, IssuerConfigurationType, KeyConfigurationType, LambdaConfigType, LimitDefinitionType, LimitType, ManagedLoginBrandingType, MFAOptionType, RefreshTokenRotationType, ResourceServerScopeType, ResourceServerType, RoutingType, SmsConfigurationType, SmsMfaConfigType, SoftwareTokenMfaConfigType, TermsType, TokenValidityUnitsType, UserAttributeUpdateSettingsType, UserContextDataType, UserImportJobType, UserPoolAddOnsType, UserPoolClientType, UserPoolPolicyType, UserPoolReplicaType, VerificationMessageTemplateType, WebAuthnConfigurationType } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface SetUserPoolMfaConfigRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The user pool ID.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
UserPoolId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>Configures user pool SMS messages for MFA. Sets the message template and the SMS
|
|
15
|
+
* message sending configuration for Amazon SNS.</p>
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
SmsMfaConfiguration?: SmsMfaConfigType | undefined;
|
|
19
|
+
/**
|
|
20
|
+
* <p>Configures a user pool for time-based one-time password (TOTP) MFA. Enables or
|
|
21
|
+
* disables TOTP.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>Sets configuration for user pool email message MFA and sign-in with one-time passwords
|
|
27
|
+
* (OTPs). Includes the subject and body of the email message template for sign-in and MFA
|
|
28
|
+
* 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">
|
|
29
|
+
* Essentials tier</a> or higher.</p>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
EmailMfaConfiguration?: EmailMfaConfigType | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <p>Sets multi-factor authentication (MFA) to be on, off, or optional. When
|
|
35
|
+
* <code>ON</code>, all users must set up MFA before they can sign in. When
|
|
36
|
+
* <code>OPTIONAL</code>, your application must make a client-side determination of
|
|
37
|
+
* whether a user wants to register an MFA device. For user pools with adaptive
|
|
38
|
+
* authentication with threat protection, choose <code>OPTIONAL</code>.</p>
|
|
39
|
+
* <p>When <code>MfaConfiguration</code> is <code>OPTIONAL</code>, managed login
|
|
40
|
+
* doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in
|
|
41
|
+
* API responses and in managed login for users who have chosen and configured a preferred
|
|
42
|
+
* MFA factor.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
MfaConfiguration?: UserPoolMfaType | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The configuration of your user pool for passkey, or WebAuthn, authentication and
|
|
48
|
+
* registration. Includes relying-party configuration, user-verification requirements,
|
|
49
|
+
* and whether passkeys can satisfy MFA requirements.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
WebAuthnConfiguration?: WebAuthnConfigurationType | undefined;
|
|
53
|
+
}
|
|
4
54
|
/**
|
|
5
55
|
* @public
|
|
6
56
|
*/
|
|
@@ -609,6 +659,16 @@ export interface UpdateIdentityProviderRequest {
|
|
|
609
659
|
* @public
|
|
610
660
|
*/
|
|
611
661
|
IdpIdentifiers?: string[] | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* <p>A mapping between the authentication context class reference (ACR) levels of your user
|
|
664
|
+
* pool and the ACR values of the external OpenID Connect (OIDC) identity provider (IdP).
|
|
665
|
+
* This mapping has the same behavior as it does when you create an identity provider. Only
|
|
666
|
+
* OIDC IdPs support ACR mapping.</p>
|
|
667
|
+
* <p>Setting <code>AcrMapping</code> is available in all feature plans. It isn't restricted
|
|
668
|
+
* to the Essentials or Plus feature plan.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
AcrMapping?: Record<string, string> | undefined;
|
|
612
672
|
}
|
|
613
673
|
/**
|
|
614
674
|
* @public
|
|
@@ -1065,6 +1125,18 @@ export interface UpdateUserPoolRequest {
|
|
|
1065
1125
|
* @public
|
|
1066
1126
|
*/
|
|
1067
1127
|
IssuerConfiguration?: IssuerConfigurationType | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>The custom names for the authentication context class reference
|
|
1130
|
+
* (ACR) levels in your user pool. This configuration has the same behavior as it does when
|
|
1131
|
+
* you create a user pool: you customize only the URI name that Amazon Cognito reports for
|
|
1132
|
+
* each of the four fixed ACR levels, and any level that you don't specify keeps its default
|
|
1133
|
+
* name. Each name must be unique across all four levels, including default names.</p>
|
|
1134
|
+
* <p>Configuring custom ACR level names requires the Essentials or Plus feature plan.
|
|
1135
|
+
* 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">
|
|
1136
|
+
* Essentials tier</a> or higher.</p>
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
AcrConfiguration?: Record<string, AcrLevelConfigType> | undefined;
|
|
1068
1140
|
}
|
|
1069
1141
|
/**
|
|
1070
1142
|
* <p>Represents the response from the server when you make a request to update the user
|
|
@@ -70,6 +70,7 @@ export declare var AccountRecoverySettingType$: StaticStructureSchema;
|
|
|
70
70
|
export declare var AccountTakeoverActionsType$: StaticStructureSchema;
|
|
71
71
|
export declare var AccountTakeoverActionType$: StaticStructureSchema;
|
|
72
72
|
export declare var AccountTakeoverRiskConfigurationType$: StaticStructureSchema;
|
|
73
|
+
export declare var AcrLevelConfigType$: StaticStructureSchema;
|
|
73
74
|
export declare var AddCustomAttributesRequest$: StaticStructureSchema;
|
|
74
75
|
export declare var AddCustomAttributesResponse$: StaticStructureSchema;
|
|
75
76
|
export declare var AddUserPoolClientSecretRequest$: StaticStructureSchema;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
-
import { SetUserPoolMfaConfigRequest } from "../models/
|
|
3
|
-
import { SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
2
|
+
import { SetUserPoolMfaConfigRequest, SetUserPoolMfaConfigResponse } from "../models/models_1";
|
|
4
3
|
export { __MetadataBearer };
|
|
5
4
|
export interface SetUserPoolMfaConfigCommandInput extends SetUserPoolMfaConfigRequest {}
|
|
6
5
|
export interface SetUserPoolMfaConfigCommandOutput
|
|
@@ -128,6 +128,11 @@ export declare class InvalidUserPoolConfigurationException extends __BaseExcepti
|
|
|
128
128
|
readonly $fault: "client";
|
|
129
129
|
constructor(opts: __ExceptionOptionType<InvalidUserPoolConfigurationException, __BaseException>);
|
|
130
130
|
}
|
|
131
|
+
export declare class FeatureUnavailableInTierException extends __BaseException {
|
|
132
|
+
readonly name: "FeatureUnavailableInTierException";
|
|
133
|
+
readonly $fault: "client";
|
|
134
|
+
constructor(opts: __ExceptionOptionType<FeatureUnavailableInTierException, __BaseException>);
|
|
135
|
+
}
|
|
131
136
|
export declare class InvalidEmailRoleAccessPolicyException extends __BaseException {
|
|
132
137
|
readonly name: "InvalidEmailRoleAccessPolicyException";
|
|
133
138
|
readonly $fault: "client";
|
|
@@ -242,11 +247,6 @@ export declare class TermsExistsException extends __BaseException {
|
|
|
242
247
|
readonly $fault: "client";
|
|
243
248
|
constructor(opts: __ExceptionOptionType<TermsExistsException, __BaseException>);
|
|
244
249
|
}
|
|
245
|
-
export declare class FeatureUnavailableInTierException extends __BaseException {
|
|
246
|
-
readonly name: "FeatureUnavailableInTierException";
|
|
247
|
-
readonly $fault: "client";
|
|
248
|
-
constructor(opts: __ExceptionOptionType<FeatureUnavailableInTierException, __BaseException>);
|
|
249
|
-
}
|
|
250
250
|
export declare class TierChangeNotAllowedException extends __BaseException {
|
|
251
251
|
readonly name: "TierChangeNotAllowedException";
|
|
252
252
|
readonly $fault: "client";
|