Spec-Zone.ru › AWS CLI v2

[ aws . cognito-identity ]

get-open-id-token-for-developer-identity

Описание

Регистрирует (или извлекает) токен Cognito IdentityId и токен OpenID Connect для пользователя, аутентифицированного процессом аутентификации на вашем бэкенде. Передача нескольких логинов создаст неявную связанную учётную запись. Вы можете указать только одного поставщика разработчиков в рамках карты Logins, которая связана с пулом идентификаторов. Поставщик разработчиков — это «область», по которой Cognito будет ссылаться на ваших пользователей.

Вы можете использовать GetOpenIdTokenForDeveloperIdentity для создания нового идентификатора и для связывания новых логинов (то есть, учётных данных пользователя, выпущенных публичным поставщиком или поставщиком разработчиков) с существующим идентификатором. Когда вы хотите создать новый идентификатор, IdentityId должен быть нулевым. Когда вы хотите связать новый логин с существующим аутентифицированным/неаутентифицированным идентификатором, вы можете сделать это, предоставив существующий IdentityId. Этот API создаст идентификатор в указанном IdentityPoolId.

Для вызова этой операции необходимо использовать учетные данные разработчика Amazon Web Services.

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

Синтаксис

  get-open-id-token-for-developer-identity
--identity-pool-id <value>
[--identity-id <value>]
--logins <value>
[--principal-tags <value>]
[--token-duration <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]

Параметры

--identity-pool-id (строка)

Идентификатор пула идентификаторов в формате REGION:GUID.

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

Уникальный идентификатор в формате REGION:GUID.

--logins (массив)

Набор необязательных пар имя-значение, которые сопоставляют имена поставщиков с токенами поставщиков. Каждая пара имя-значение представляет пользователя из публичного поставщика или поставщика разработчиков. Если пользователь принадлежит поставщику разработчиков, пара имя-значение будет следовать синтаксису "developer_provider_name": "developer_user_identifier". Поставщик разработчиков — это «область», по которой Cognito будет ссылаться на ваших пользователей; вы предоставили эту область при создании/обновлении пула идентификаторов. Идентификатор разработчика — это идентификатор из вашего бэкенда, который однозначно идентифицирует пользователя. При создании пула идентификаторов вы можете указать поддерживаемые логины.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--principal-tags (массив)

Используйте эту операцию для настройки сопоставлений атрибутов для пользовательских поставщиков.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--token-duration (целое число)

Время истечения срока действия токена в секундах. Вы можете указать пользовательское время истечения срока действия токена, чтобы вы могли его кэшировать. Если вы не укажете время истечения срока действия, токен будет действителен в течение 15 минут. Вы можете обменять токен с Amazon STS на временные учетные данные Amazon Web Services, которые действительны не более одного часа. Максимальная продолжительность токена, которую вы можете установить, составляет 24 часа. Необходимо быть внимательным при установке времени истечения срока действия токена, так как это имеет существенные последствия для безопасности: злоумышленник может использовать утечка токена для доступа к вашим ресурсам Amazon Web Services на протяжении всего срока действия токена.

Примечание

Пожалуйста, предоставьте небольшой временной запас, обычно не более 5 минут, для учёта разницы во времени.

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

Вывод

IdentityId -> (строка)

Уникальный идентификатор в формате REGION:GUID.

Token -> (строка)

Токен OpenID.

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

Spec-Zone.ru

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