Amazon Cognito · Schema

AdminSetUserSettingsRequest

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
Username object
MFAOptions object
View JSON Schema on GitHub

JSON Schema

user-pools-admin-set-user-settings-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-admin-set-user-settings-request-schema.json",
  "title": "AdminSetUserSettingsRequest",
  "description": "You can use this parameter to set an MFA configuration that uses the SMS delivery medium.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The ID of the user pool that contains the user whose options you're setting."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name of the user whose options you're setting."
        }
      ]
    },
    "MFAOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MFAOptionListType"
        },
        {
          "description": "You can use this parameter only to set an SMS configuration that uses SMS for delivery."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "MFAOptions"
  ]
}