modify-saml-properties

Описание

Изменяет несколько свойств, связанных с аутентификацией SAML 2.0, включая состояние включения, URL-адрес доступа к пользователю и имя параметра relay state, используемые для настройки федерации с поставщиком удостоверений SAML 2.0.

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

Синтаксис

  modify-saml-properties
--resource-id <value>
[--saml-properties <value>]
[--properties-to-delete <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]

Параметры

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

Идентификатор каталога, для которого необходимо настроить свойства SAML.

--saml-properties (структура)

Свойства для настройки аутентификации SAML 2.0.

Status -> (строка)

Указывает состояние аутентификации SAML 2.0. Эти состояния включают следующие.

Если значение установлено в DISABLED, конечные пользователи будут перенаправлены на вход в систему с учетными данными своего каталога.
Если значение установлено в ENABLED, конечные пользователи будут перенаправлены на вход через URL-адрес доступа к пользователю. Пользователи, пытающиеся подключиться к WorkSpaces из клиентского приложения, которое не поддерживает аутентификацию SAML 2.0, не смогут подключиться.
Если значение установлено в ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, конечные пользователи будут перенаправлены на вход через URL-адрес доступа к пользователю в поддерживаемых клиентских приложениях, но это не помешает клиентам, которые не поддерживают аутентификацию SAML 2.0, подключаться так, как если бы аутентификация SAML 2.0 была отключена.

UserAccessUrl -> (строка)

URL-адрес доступа к пользователю поставщика удостоверений SAML 2.0 (IdP) — это URL-адрес, который пользователь переходит в браузере, чтобы выполнить федерацию от IdP и получить прямой доступ к приложению без каких-либо привязок поставщика SAML 2.0 (SP).

RelayStateParameterName -> (строка)

Имя параметра relay state, поддерживаемое поставщиком удостоверений SAML 2.0 (IdP). Когда конечный пользователь перенаправляется на URL-адрес доступа к пользователю из клиентского приложения WorkSpaces, это имя параметра relay state добавляется в качестве параметра запроса к URL вместе с точкой назначения relay state, чтобы вернуть пользователя в сеанс клиентского приложения.

Для использования аутентификации SAML 2.0 с WorkSpaces IdP должен поддерживать глубокую привязку, инициируемую IdP, для URL-адреса relay state. Для получения дополнительной информации см. документацию IdP.

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

Status=string,UserAccessUrl=string,RelayStateParameterName=string

Синтаксис JSON:

{
  "Status": "DISABLED"|"ENABLED"|"ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK",
  "UserAccessUrl": "string",
  "RelayStateParameterName": "string"
}

--properties-to-delete (список)

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

Укажите один из следующих вариантов:

SAML_PROPERTIES_USER_ACCESS_URL для удаления URL-адреса доступа к пользователю.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME для удаления имени параметра relay state.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SAML_PROPERTIES_USER_ACCESS_URL
  SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME

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

Вывод

Нет