Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

list-web-authn-credentials

Описание

Генерирует список зарегистрированных ключей-паролей текущего пользователя, или учетных данных WebAuthn.

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

Примечание

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

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

Синтаксис

  list-web-authn-credentials
--access-token <value>
[--next-token <value>]
[--max-results <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 .

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

Эта API-операция возвращает ограниченное количество результатов. Токен постраничной навигации — это идентификатор, который вы можете представить в дополнительном запросе API с теми же параметрами. При включении токена постраничной навигации Amazon Cognito возвращает следующий набор элементов после текущего списка. Последующие запросы возвращают новый токен постраничной навигации. С помощью этого токена вы можете выполнить постраничный просмотр всего списка элементов.

--max-results (целое число)

Максимальное количество ключей-паролей пользователя, которые вы хотите вернуть.

--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.

Для вывода ключей-паролей

Следующий list-web-authn-credentials пример выводит ключи-пароли, или учетные данные WebAuthn, для текущего пользователя. У них зарегистрировано одно устройство.

aws cognito-idp list-web-authn-credentials \
    --access-token eyJra456defEXAMPLE

Вывод:

{
    "Credentials": [
        {
            "AuthenticatorAttachment": "cross-platform",
            "CreatedAt": 1736293876.115,
            "CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE",
            "FriendlyCredentialName": "Roaming passkey",
            "RelyingPartyId": "auth.example.com"
        }
    ]
}

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

Вывод

Учетные данные -> (список)

Список зарегистрированных ключей-паролей пользователя.

(структура)

Подробная информация о ключе-пароле, или биометрическом или ключе-учетной записи аутентификации WebAuthn для пользователя.

CredentialId -> (строка)

Уникальный идентификатор учетных данных ключа-пароля.

FriendlyCredentialName -> (строка)

Автоматически сгенерированное имя ключа-пароля.

RelyingPartyId -> (строка)

Идентификатор доверенной стороны поставщика учетных данных ключа-пароля.

AuthenticatorAttachment -> (строка)

Общая категория аутентификатора ключа-пароля. Может быть платформа, или аутентификатор на устройстве, например встроенный сканер отпечатков пальцев, или кроссплатформенное устройство, которое не привязано к устройству, например ключ безопасности Bluetooth.

AuthenticatorTransports -> (список)

Информация о способах передачи учетных данных ключа-пароля, например USB или Bluetooth Low Energy.

(строка)

CreatedAt -> (временная метка)

Дата и время создания элемента. Amazon Cognito возвращает эту временную метку в формате эпохи Unix. Ваш SDK может отображать вывод в удобочитаемом формате, например ISO 8601, или объект Java Date.

NextToken -> (строка)

Идентификатор, возвращенный Amazon Cognito в предыдущем запросе к данной операции. При включении токена постраничной навигации в вашем запросе Amazon Cognito возвращает следующий набор элементов в списке. С помощью этого токена вы можете выполнить постраничный просмотр всего списка элементов.

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

Spec-Zone.ru

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