|
3355 | 3355 | "shape":"EmailMfaSettingsType", |
3356 | 3356 | "documentation":"<p>User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html\"> Essentials tier</a> or higher.</p>" |
3357 | 3357 | }, |
| 3358 | + "WebAuthnMfaSettings":{ |
| 3359 | + "shape":"WebAuthnMfaSettingsType", |
| 3360 | + "documentation":"<p>User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the <code>FactorConfiguration</code> of your user pool <code>WebAuthnConfiguration</code> must be <code>MULTI_FACTOR_WITH_USER_VERIFICATION</code>. 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\"> Essentials tier</a> or higher.</p>" |
| 3361 | + }, |
3358 | 3362 | "Username":{ |
3359 | 3363 | "shape":"UsernameType", |
3360 | 3364 | "documentation":"<p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>" |
|
6296 | 6300 | }, |
6297 | 6301 | "WebAuthnConfiguration":{ |
6298 | 6302 | "shape":"WebAuthnConfigurationType", |
6299 | | - "documentation":"<p>Shows user pool configuration for sign-in with passkey authenticators like biometric devices and security keys. Passkeys are not eligible MFA factors. They are instead an 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 <code>USER_AUTH</code> flow.</p>" |
| 6303 | + "documentation":"<p>Shows user pool configuration for sign-in with passkey authenticators such as biometric devices and security keys. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.</p>" |
6300 | 6304 | } |
6301 | 6305 | } |
6302 | 6306 | }, |
|
8327 | 8331 | "shape":"EmailMfaSettingsType", |
8328 | 8332 | "documentation":"<p>User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html\"> Essentials tier</a> or higher.</p>" |
8329 | 8333 | }, |
| 8334 | + "WebAuthnMfaSettings":{ |
| 8335 | + "shape":"WebAuthnMfaSettingsType", |
| 8336 | + "documentation":"<p>User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the <code>FactorConfiguration</code> of your user pool <code>WebAuthnConfiguration</code> must be <code>MULTI_FACTOR_WITH_USER_VERIFICATION</code>. 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\"> Essentials tier</a> or higher.</p>" |
| 8337 | + }, |
8330 | 8338 | "AccessToken":{ |
8331 | 8339 | "shape":"TokenModelType", |
8332 | 8340 | "documentation":"<p>A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for <code>aws.cognito.signin.user.admin</code>.</p>" |
|
8363 | 8371 | }, |
8364 | 8372 | "WebAuthnConfiguration":{ |
8365 | 8373 | "shape":"WebAuthnConfigurationType", |
8366 | | - "documentation":"<p>The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.</p>" |
| 8374 | + "documentation":"<p>The configuration of your user pool for passkey, or WebAuthn, authentication and registration. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.</p>" |
8367 | 8375 | } |
8368 | 8376 | } |
8369 | 8377 | }, |
|
8388 | 8396 | }, |
8389 | 8397 | "WebAuthnConfiguration":{ |
8390 | 8398 | "shape":"WebAuthnConfigurationType", |
8391 | | - "documentation":"<p>The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators like biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.</p>" |
| 8399 | + "documentation":"<p>The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators such as biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.</p>" |
8392 | 8400 | } |
8393 | 8401 | } |
8394 | 8402 | }, |
|
10355 | 10363 | "UserVerification":{ |
10356 | 10364 | "shape":"UserVerificationType", |
10357 | 10365 | "documentation":"<p>When <code>required</code>, users can only register and sign in users with passkeys that are capable of <a href=\"https://www.w3.org/TR/webauthn-2/#enum-userVerificationRequirement\">user verification</a>. When <code>preferred</code>, your user pool doesn't require the use of authenticators with user verification but encourages it.</p>" |
| 10366 | + }, |
| 10367 | + "FactorConfiguration":{ |
| 10368 | + "shape":"WebAuthnFactorConfigurationType", |
| 10369 | + "documentation":"<p>Sets whether passkeys can be used as multi-factor authentication (MFA). When set to <code>MULTI_FACTOR_WITH_USER_VERIFICATION</code>, passkey authentication with user verification satisfies MFA requirements. When set to <code>SINGLE_FACTOR</code> or not set, passkeys are a single authentication factor. 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\"> Essentials tier</a> or higher.</p>" |
10358 | 10370 | } |
10359 | 10371 | }, |
10360 | 10372 | "documentation":"<p>Settings for authentication (MFA) with passkey, or webauthN, biometric and security-key devices in a user pool. Configures the following:</p> <ul> <li> <p>Configuration for requiring user-verification support in passkeys.</p> </li> <li> <p>The user pool relying-party ID. This is the domain, typically your user pool domain, that user's passkey providers should trust as a receiver of passkey authentication.</p> </li> <li> <p>The providers that you want to allow as origins for passkey authentication.</p> </li> </ul>" |
|
10413 | 10425 | "max":20, |
10414 | 10426 | "min":0 |
10415 | 10427 | }, |
| 10428 | + "WebAuthnFactorConfigurationType":{ |
| 10429 | + "type":"string", |
| 10430 | + "documentation":"<p>The configuration of passkey authentication as a single factor or a multi-factor authentication (MFA) method. When set to <code>MULTI_FACTOR_WITH_USER_VERIFICATION</code>, your user pool requires passkey authenticators to perform <a href=\"https://www.w3.org/TR/webauthn-2/#user-verification\">user verification</a>, for example a biometric or PIN. User verification combined with the passkey constitutes multi-factor authentication. When set to <code>SINGLE_FACTOR</code>, passkeys are a single authentication factor.</p>", |
| 10431 | + "enum":[ |
| 10432 | + "SINGLE_FACTOR", |
| 10433 | + "MULTI_FACTOR_WITH_USER_VERIFICATION" |
| 10434 | + ] |
| 10435 | + }, |
| 10436 | + "WebAuthnMfaSettingsType":{ |
| 10437 | + "type":"structure", |
| 10438 | + "members":{ |
| 10439 | + "Enabled":{ |
| 10440 | + "shape":"BooleanType", |
| 10441 | + "documentation":"<p>Specifies whether passkey MFA is activated for a user. When activated, the user's passkey authentication requires user verification, and passkey sign-in is available when MFA is required. The user must also have at least one other MFA method such as SMS, TOTP, or email activated to prevent account lockout.</p>" |
| 10442 | + } |
| 10443 | + }, |
| 10444 | + "documentation":"<p>A user's preference for using passkey, or WebAuthn, multi-factor authentication (MFA). Turns passkey MFA on and off for the user. Unlike other MFA settings types, this type doesn't include a <code>PreferredMfa</code> option because passkey MFA applies only when passkey is the first authentication factor.</p>" |
| 10445 | + }, |
10416 | 10446 | "WebAuthnNotEnabledException":{ |
10417 | 10447 | "type":"structure", |
10418 | 10448 | "members":{ |
|
0 commit comments