Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-web ]

обновить-источник-аутентификации

Описание

Обновляет источник аутентификации.

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

Синтаксис

  update-identity-provider
[--client-token <value>]
--identity-provider-arn <value>
[--identity-provider-details <value>]
[--identity-provider-name <value>]
[--identity-provider-type <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-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Идемпотентность гарантирует, что запрос API выполняется только один раз. При идемпотентном запросе, если исходный запрос выполняется успешно, последующие повторные запросы с тем же токеном клиента возвращают результат от исходного успешного запроса.

Если вы не укажете токен клиента, он автоматически сгенерируется Amazon Web Services SDK.

--identity-provider-arn (строка)

Уникальный идентификатор ресурса (ARN) источника аутентификации.

--identity-provider-details (массив)

Детали источника аутентификации. Следующий список описывает ключи деталей провайдера для каждого типа источника аутентификации.

  • Для Google и Login with Amazon:
    • client_id
    • client_secret
    • authorize_scopes
  • Для Facebook:
    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • Для Sign in with Apple:
    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • Для провайдеров OIDC:
    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url если недоступно из URL открытия, указанного ключом ``oidc_issuer``
    • token_url если недоступно из URL открытия, указанного ключом ``oidc_issuer``
    • attributes_url если недоступно из URL открытия, указанного ключом ``oidc_issuer``
    • jwks_uri если недоступно из URL открытия, указанного ключом ``oidc_issuer``
  • Для провайдеров SAML:
    • MetadataFile ИЛИ MetadataURL
    • IDPSignout (логический тип) необязательно
    • IDPInit (логический тип) необязательно
    • RequestSigningAlgorithm (строка) необязательно - Принимает только rsa-sha256
    • EncryptedResponses (логический тип) необязательно

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

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

Укороченный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--identity-provider-name (строка)

Название источника аутентификации.

--identity-provider-type (строка)

Тип источника аутентификации.

Возможные значения:

  • SAML
  • Facebook
  • Google
  • LoginWithAmazon
  • SignInWithApple
  • OIDC

--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 (строка)

Переопределяет адрес по умолчанию команды заданным адресом.

--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 ввода.

Вывод

источник_аутентификации -> (структура)

Источник аутентификации.

identityProviderArn -> (строка)

Уникальный идентификатор ресурса (ARN) источника аутентификации.

identityProviderDetails -> (массив)

Детали источника аутентификации. Следующий список описывает ключи деталей провайдера для каждого типа источника аутентификации.

  • Для Google и Login with Amazon:
    • client_id
    • client_secret
    • authorize_scopes
  • Для Facebook:
    • client_id
    • client_secret
    • authorize_scopes
    • api_version
  • Для Sign in with Apple:
    • client_id
    • team_id
    • key_id
    • private_key
    • authorize_scopes
  • Для провайдеров OIDC:
    • client_id
    • client_secret
    • attributes_request_method
    • oidc_issuer
    • authorize_scopes
    • authorize_url если недоступно из URL открытия, указанного ключом oidc_issuer
    • token_url если недоступно из URL открытия, указанного ключом oidc_issuer
    • attributes_url если недоступно из URL открытия, указанного ключом oidc_issuer
    • jwks_uri если недоступно из URL открытия, указанного ключом oidc_issuer
  • Для провайдеров SAML:
    • MetadataFile ИЛИ MetadataURL
    • IDPSignout (логический тип) необязательно
    • IDPInit (логический тип) необязательно
    • RequestSigningAlgorithm (строка) необязательно - Принимает только rsa-sha256
    • EncryptedResponses (логический тип) необязательно

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

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

identityProviderName -> (строка)

Название источника аутентификации.

identityProviderType -> (строка)

Тип источника аутентификации.

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

Spec-Zone.ru

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