Spec-Zone.ru › AWS CLI v2

[ aws . cognito-idp ]

get-tokens-from-refresh-token

Описание

На основе токена обновления выдаёт новые токены идентификатора, доступа и, по желанию, обновления для пользователя, которому принадлежит переданный токен. Данная операция выдаёт новый токен обновления и делает исходный токен обновления недействительным после необязательного периода ожидания, когда включено вращение токенов обновления. Если вращение токенов обновления отключено, выдаются только новые токены идентификатора и доступа.

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

Синтаксис

  get-tokens-from-refresh-token
--refresh-token <value>
--client-id <value>
[--client-secret <value>]
[--device-key <value>]
[--client-metadata <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]

Параметры

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

Действительный токен обновления, который может авторизовать запрос новых токенов. Когда вращение токенов обновления включено в запрошенном клиенте приложения, этот токен делает недействительным после завершения запроса.

--client-id (строка)

Клиент приложения, который выдал токен обновления пользователю, желающему запросить новые токены.

--client-secret (строка)

Секретный ключ клиента запрошенного приложения, если у клиента есть секрет.

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

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

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

--client-metadata (массив)

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

Вы создаёте пользовательские рабочие процессы, назначая Lambda-функции триггерам пула пользователей. При использовании действия API GetTokensFromRefreshToken Amazon Cognito вызывает Lambda-функцию триггера предварительной генерации токена.

Для получения дополнительной информации, см. Использование триггеров Lambda в руководстве разработчика Amazon Cognito.

Примечание

При использовании параметра ClientMetadata обратите внимание, что Amazon Cognito не будет:

  • Хранить значение ClientMetadata. Эти данные доступны только триггерам Lambda, назначенным пулу пользователей для поддержки пользовательских рабочих процессов. Если в конфигурации вашего пула пользователей нет триггеров, параметр ClientMetadata бесполезен.
  • Проверять значение ClientMetadata.
  • Шифровать значение ClientMetadata. Не передавайте конфиденциальную информацию в этом параметре.

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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-просмотрщика для вывода.

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

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

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

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

Вывод

AuthenticationResult -> (структура)

Объект, который получает ваше приложение после аутентификации. Содержит токены и информацию для аутентификации устройства.

AccessToken -> (строка)

Токен доступа вашего пользователя.

ExpiresIn -> (целое число)

Срок действия результата аутентификации в секундах.

TokenType -> (строка)

Предполагаемое использование токена, например Bearer.

RefreshToken -> (строка)

Токен обновления вашего пользователя.

IdToken -> (строка)

Токен идентификации вашего пользователя.

NewDeviceMetadata -> (структура)

Новые метаданные устройства из результата аутентификации.

DeviceKey -> (строка)

Ключ устройства, идентификатор, используемый для генерации DEVICE_PASSWORD_VERIFIER для аутентификации SRP устройства.

DeviceGroupKey -> (строка)

Ключ группы устройств, идентификатор, используемый для генерации DEVICE_PASSWORD_VERIFIER для аутентификации SRP устройства.

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

Spec-Zone.ru

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