Spec-Zone.ru › AWS CLI v2

[ aws . sso-oidc ]

зарегистрировать-клиента

Описание

Регистрирует публичного клиента в IAM Identity Center. Это позволяет клиентам выполнять авторизацию с использованием метода предоставления кода авторизации с Proof Key for Code Exchange (PKCE) или методом предоставления кода устройства.

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

Синтаксис

  register-client
--client-name <value>
--client-type <value>
[--scopes <value>]
[--redirect-uris <value>]
[--grant-types <value>]
[--issuer-url <value>]
[--entitled-application-arn <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-name (строка)

Дружественное имя клиента.

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

Тип клиента. Сервис поддерживает только public в качестве типа клиента. Любой тип, кроме public, будет отклонен сервисом.

--scopes (список)

Список областей, определенных клиентом. При авторизации этот список используется для ограничения разрешений при предоставлении токена доступа.

(строка)

Синтаксис:

"string" "string" ...

--redirect-uris (список)

Список URI перенаправления, определенных клиентом. По завершении авторизации этот список используется для ограничения мест, куда пользовательский агент может быть перенаправлен обратно.

(строка)

Синтаксис:

"string" "string" ...

--grant-types (список)

Список типов предоставления OAuth 2.0, определенных клиентом. Этот список используется для ограничения потоков выдачи токенов, доступных клиенту. Поддерживаются следующие типы предоставления OAuth 2.0: код авторизации, код устройства и токен обновления.

  • Код авторизации - authorization_code
  • Код устройства - urn:ietf:params:oauth:grant-type:device_code
  • Токен обновления - refresh_token

(строка)

Синтаксис:

"string" "string" ...

--issuer-url (строка)

URL издателя IAM Identity Center, связанный с экземпляром IAM Identity Center. Это значение необходимо для доступа пользователя к ресурсам через клиента.

--entitled-application-arn (строка)

Этот ARN приложения IAM Identity Center используется для определения администрируемой конфигурации для доступа публичного клиента к ресурсам. При авторизации области, предоставления и URI перенаправления, доступные этому клиенту, будут ограничены этим ресурсом приложения.

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

Вывод

clientId -> (строка)

Уникальный идентификатор каждой строки клиента. Этот клиент использует этот идентификатор для аутентификации у сервиса в последующих вызовах.

clientSecret -> (строка)

Сгенерированная для клиента секретная строка. Клиент будет использовать эту строку для аутентификации у сервиса в последующих вызовах.

clientIdIssuedAt -> (длинное целое число)

Указывает время выдачи clientId и clientSecret.

clientSecretExpiresAt -> (длинное целое число)

Указывает время, когда clientId и clientSecret станут недействительными.

authorizationEndpoint -> (строка)

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

tokenEndpoint -> (строка)

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

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

Spec-Zone.ru

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