Amazon Cognito · Schema

SetUserSettingsRequest

Represents the request to set user settings.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
AccessToken object
MFAOptions object
View JSON Schema on GitHub

JSON Schema

user-pools-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-set-user-settings-request-schema.json",
  "title": "SetUserSettingsRequest",
  "description": "Represents the request to set user settings.",
  "type": "object",
  "properties": {
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose user settings you want to configure."
        }
      ]
    },
    "MFAOptions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MFAOptionListType"
        },
        {
          "description": "You can use this parameter only to set an SMS configuration that uses SMS for delivery."
        }
      ]
    }
  },
  "required": [
    "AccessToken",
    "MFAOptions"
  ]
}