Container for the parameters to the GetUserPoolMfaConfig operation. Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following:
The WebAuthn relying party (RP) ID and user-verification settings.
The required, optional, or disabled state of MFA for all user pool users.
The message templates for email and SMS MFA.
The enabled or disabled state of time-based one-time password (TOTP) MFA.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.GetUserPoolMfaConfigRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class GetUserPoolMfaConfigRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The GetUserPoolMfaConfigRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetUserPoolMfaConfigRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to query WebAuthn and MFA configuration. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5