Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

confirm-device

Описание

Подтверждает устройство, которое пользователь хочет запомнить. Запомненное устройство — это опция «Запомнить меня на этом устройстве» для пулов пользователей, которые выполняют аутентификацию с ключом устройства доверенного устройства на сервере вместо предоставленного пользователем кода MFA. Дополнительную информацию об аутентификации по устройству см. в разделе Работа с устройствами пользователей в вашем пуле пользователей .

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

Примечание

Amazon Cognito не оценивает политики Identity and Access Management (IAM) в запросах для этой операции API. Для этой операции вы не можете использовать учетные данные IAM для авторизации запросов и не можете предоставлять разрешения IAM в политиках. Дополнительную информацию об моделях авторизации в Amazon Cognito см. в разделе Использование API пулов пользователей Amazon Cognito и конечных точек пулов пользователей .

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

Синтаксис

  confirm-device
--access-token <value>
--device-key <value>
[--device-secret-verifier-config <value>]
[--device-name <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]

Параметры

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

Действительный токен доступа, выданный Amazon Cognito текущему авторизованному пользователю. Должен содержать утверждение области для aws.cognito.signin.user.admin .

--device-key (строка)

Уникальный идентификатор или ключ устройства, для которого вы хотите обновить статус.

--device-secret-verifier-config (структура)

Настройка секретного верификатора устройства.

PasswordVerifier -> (строка)

Верификатор пароля для устройства пользователя. Используется в аутентификации SRP.

Salt -> (строка)

Соль, которую вы хотите использовать в аутентификации SRP с устройством пользователя.

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

PasswordVerifier=string,Salt=string

Синтаксис JSON:

{
  "PasswordVerifier": "string",
  "Salt": "string"
}

--device-name (строка)

Дружественное имя для устройства, например MyMobilePhone .

--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
  • текст
  • таблица
  • yaml
  • yaml-потоковый

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в Руководстве пользователя AWS CLI .

Для подтверждения устройства пользователя

Следующий confirm-device пример добавляет новое запомненное устройство для текущего пользователя.

aws cognito-idp confirm-device \
   --access-token eyJra456defEXAMPLE \
   --device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
   --device-secret-verifier-config PasswordVerifier=TXlWZXJpZmllclN0cmluZw,Salt=TXlTUlBTYWx0

Вывод:

{
     "UserConfirmationNecessary": false
}

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

Вывод

UserConfirmationNecessary -> (логическое значение)

Когда true , ваш пользователь должен подтвердить, что он хочет запомнить устройство. Запросите у пользователя ответ.

Когда false , сразу устанавливает устройство как запомненное и подходящее для аутентификации по устройству.

Вы можете настроить свой пул пользователей так, чтобы он всегда запоминал устройства, в этом случае этот ответ false , или разрешать пользователям включать эту функцию, в этом случае этот ответ true . Настройте этот параметр в разделе Отслеживание устройств в меню Вход вашего пула пользователей.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API