Amazon Cognito · Schema
SetUserPoolMfaConfigResponse
SetUserPoolMfaConfigResponse schema from Amazon Cognito
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC
Properties
| Name | Type | Description |
|---|---|---|
| SmsMfaConfiguration | object | |
| SoftwareTokenMfaConfiguration | object | |
| MfaConfiguration | object |
JSON Schema
{
"type": "object",
"properties": {
"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. 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 enabled.</p> </li> </ul>"
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-set-user-pool-mfa-config-response-schema.json",
"title": "SetUserPoolMfaConfigResponse",
"description": "SetUserPoolMfaConfigResponse schema from Amazon Cognito"
}