set-user-mfa-preference

Описание

Устанавливает предпочтение метода многофакторной аутентификации (MFA) пользователя, включая активированные факторы MFA и, при необходимости, предпочтительные. Только один фактор может быть установлен как предпочтительный. Предпочтительный фактор MFA будет использован для аутентификации пользователя, если активировано несколько факторов. Если активировано несколько опций, и предпочтение не установлено, во время входа в систему будет возвращён запрос на выбор метода MFA. Если для пользователя активирован тип MFA, пользователь будет запрошен о MFA при всех попытках входа, если отслеживание устройств не включено или устройство не было доверено. Если вы хотите, чтобы MFA применялась выборочно на основе оценки уровня риска попыток входа, отключите MFA для пользователей и включите адаптивную аутентификацию для пула пользователей.

Авторизуйте этот действие с помощью токена доступа вошедшего пользователя. Он должен включать область aws.cognito.signin.user.admin .

См. также: Документация API AWS

Синтаксис

  set-user-mfa-preference
[--sms-mfa-settings <value>]
[--software-token-mfa-settings <value>]
[--email-mfa-settings <value>]
--access-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--sms-mfa-settings (структура)

Сокращённый синтаксис:

Enabled=boolean,PreferredMfa=boolean

Синтаксис JSON:

{
  "Enabled": true|false,
  "PreferredMfa": true|false
}

--software-token-mfa-settings (структура)

Сокращённый синтаксис:

Enabled=boolean,PreferredMfa=boolean

Синтаксис JSON:

{
  "Enabled": true|false,
  "PreferredMfa": true|false
}

--email-mfa-settings (структура)

Сокращённый синтаксис:

Enabled=boolean,PreferredMfa=boolean

Синтаксис JSON:

{
  "Enabled": true|false,
  "PreferredMfa": true|false
}

--access-token (строка)

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения будут переопределять значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команд и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

• json
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

• on
• off
• auto

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от cli-binary-format настройки. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (булево)

Отключить тулбар страницы CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы входных параметров CLI.

Примеры

Установить предпочтение MFA пользователя

Следующий set-user-mfa-preference пример настраивает текущего пользователя для использования TOTP MFA и отключает все остальные факторы MFA.

aws cognito-idp set-user-mfa-preference \
    --access-token eyJra456defEXAMPLE \
    --software-token-mfa-settings Enabled=true,PreferredMfa=true \
    --sms-mfa-settings Enabled=false,PreferredMfa=false \
    --email-mfa-settings Enabled=false,PreferredMfa=false

Эта команда не выводит ничего.

Дополнительную информацию см. в разделе Добавление MFA в Руководстве разработчика Amazon Cognito.

Вывод

Нет