Spec-Zone.ru › AWS CLI v2

[ aws . sso-oidc ]

create-token

Описание

Создаёт и возвращает токены доступа и обновления для клиентов, авторизованных с помощью секретов клиента. Токен доступа может использоваться для получения краткосрочных учетных данных для назначенных AWS-аккаунтов или для доступа к API приложений с использованием bearer аутентификации.

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

Синтаксис

  create-token
--client-id <value>
--client-secret <value>
--grant-type <value>
[--device-code <value>]
[--code <value>]
[--refresh-token <value>]
[--scope <value>]
[--redirect-uri <value>]
[--code-verifier <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]

Параметры

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

Уникальный идентификатор строки для клиента или приложения. Это значение взято из результата API RegisterClient.

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

Секретная строка, сгенерированная для клиента. Это значение должно быть взято из сохранённого результата API RegisterClient.

--grant-type (строка)

Поддерживает следующие типы OAuth-разрешений: Authorization Code, Device Code и Refresh Token. Укажите одно из следующих значений в зависимости от требуемого типа разрешения:

  • Authorization Code - authorization_code
  • Device Code - urn:ietf:params:oauth:grant-type:device_code
  • Refresh Token - refresh_token

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

Используется только при вызове этого API для типа разрешения Device Code. Этот краткосрочный код используется для идентификации этого запроса авторизации. Он получен из результата API StartDeviceAuthorization.

--code (строка)

Используется только при вызове этого API для типа разрешения Authorization Code. Краткосрочный код используется для идентификации этого запроса авторизации.

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

Используется только при вызове этого API для типа разрешения Refresh Token. Этот токен используется для обновления краткосрочных токенов, таких как токен доступа, которые могут истечь.

Дополнительную информацию о функциях и ограничениях текущей реализации IAM Identity Center OIDC см. в разделе Considerations for Using this Guide в справочнике API IAM Identity Center OIDC.

--scope (список)

Список областей, для которых запрашивается авторизация. Токен доступа, который выдаётся, ограничен предоставленными областями. Если это значение не указано, IAM Identity Center авторизует все области, настроенные для клиента во время вызова RegisterClient.

(строка)

Синтаксис:

"string" "string" ...

--redirect-uri (строка)

Используется только при вызове этого API для типа разрешения Authorization Code. Это значение указывает расположение клиента или приложения, зарегистрированного для получения кода авторизации.

--code-verifier (строка)

Используется только при вызове этого API для типа разрешения Authorization Code. Это значение генерируется клиентом и предоставляется для проверки исходного значения кода вызова, переданного клиентом во время авторизации.

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

Отключить кли pager для вывода.

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

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

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

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

Вывод

accessToken -> (строка)

Токен для доступа к аккаунтам и приложениям Amazon Web Services, назначенным пользователю.

tokenType -> (строка)

Используется для уведомления клиента, что возвращённый токен — токен доступа. Поддерживаемый тип токена — Bearer .

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

Указывает время в секундах, когда токен доступа истечёт.

refreshToken -> (строка)

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

Дополнительную информацию о функциях и ограничениях текущей реализации IAM Identity Center OIDC см. в разделе Considerations for Using this Guide в справочнике API IAM Identity Center OIDC.

idToken -> (строка)

idToken не реализован или не поддерживается. Дополнительную информацию о функциях и ограничениях текущей реализации IAM Identity Center OIDC см. в разделе Considerations for Using this Guide в справочнике API IAM Identity Center OIDC.

JSON Web Token (JWT), который идентифицирует пользователя, связанного с выданным токеном доступа.

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

Spec-Zone.ru

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