SetUserPoolMfaConfigRequest is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-set-user-pool-mfa-config-request-structure.json",
"name": "SetUserPoolMfaConfigRequest",
"description": "SetUserPoolMfaConfigRequest schema from Amazon Cognito API",
"type": "object",
"properties": {
"UserPoolId": {
"allOf": [
{
"$ref": "#/components/schemas/UserPoolIdType"
},
{
"description": "The user pool ID."
}
]
},
"SmsMfaConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/SmsMfaConfigType"
},
{
"description": "The SMS text message MFA configuration."
}
]
},
"SoftwareTokenMfaConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/SoftwareTokenMfaConfigType"
},
{
"description": "The software token MFA configuration."
}
]
},
"MfaConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/UserPoolMfaType"
},
{
"description": "<p>The MFA configuration. If you set the MfaConfiguration value to \u2018ON\u2019, only users who have set up an MFA factor can sign in. To learn more, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html\">Adding Multi-Factor Authentication (MFA) to a user pool</a>. Valid values include:</p> <ul> <li> <p> <code>OFF</code> MFA won't be used for any users.</p> </li> <li> <p> <code>ON</code> MFA is required for all users to sign in.</p> </li> <li> <p> <code>OPTIONAL</code> MFA will be required only for individual users who have an MFA factor activated.</p> </li> </ul>"
}
]
}
},
"required": [
"UserPoolId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.