Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

создать-провайдер-saml

Описание

Создаёт ресурс IAM, описывающий поставщика идентификации (IdP), поддерживающий SAML 2.0.

Ресурс поставщика SAML, созданный с помощью этой операции, может использоваться в качестве принципала в политике доверия роли IAM. Такая политика может разрешить федеративным пользователям, которые вошли в систему с использованием IdP SAML, принять роль. Вы можете создать роль IAM, которая поддерживает веб-авторизацию (SSO) на консоли управления Amazon Web Services или поддерживает доступ к API Amazon Web Services.

При создании ресурса поставщика SAML вы загружаете документ метаданных SAML, который вы получаете от своего IdP. Этот документ содержит имя издателя, информацию о сроке действия и ключи, которые могут использоваться для проверки ответа на аутентификацию SAML (утверждения), отправляемого IdP. Вы должны сгенерировать документ метаданных, используя программное обеспечение управления идентификацией, которое используется в качестве IdP вашей организации.

Примечание

Эта операция требует версии подписи 4.

Дополнительную информацию можно найти в разделе Включение федеративных пользователей SAML 2.0 для доступа к консоли управления Amazon Web Services и О федерации на основе SAML 2.0 в руководстве пользователя IAM.

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

Синтаксис

  create-saml-provider
--saml-metadata-document <value>
--name <value>
[--tags <value>]
[--assertion-encryption-mode <value>]
[--add-private-key <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]

Параметры

--saml-metadata-document (строка)

Документ XML, сгенерированный поставщиком идентификации (IdP), поддерживающим SAML 2.0. Документ содержит имя издателя, информацию о сроке действия и ключи, которые могут использоваться для проверки ответа на аутентификацию SAML (утверждений), полученных от IdP. Вы должны сгенерировать документ метаданных, используя программное обеспечение управления идентификацией, которое используется в качестве IdP вашей организации.

Дополнительную информацию см. в разделе О федерации на основе SAML 2.0 в руководстве пользователя IAM.

--name (строка)

Имя создаваемого поставщика.

Этот параметр позволяет (через свой шаблон регулярных выражений) строку символов, состоящую из буквенно-цифровых символов верхнего и нижнего регистра без пробелов. Вы также можете включить любые из следующих символов: _+=,.@-

--tags (список)

Список тегов, которые вы хотите прикрепить к новому поставщику SAML IAM. Каждый тег состоит из имени ключа и соответствующего значения. Дополнительную информацию о тегах см. в разделе Использование тегов для ресурсов IAM в руководстве пользователя IAM.

Примечание

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

(структура)

Структура, представляющая предоставляемые пользователем метаданные, которые можно связать с ресурсом IAM. Дополнительную информацию о тегах см. в разделе Использование тегов для ресурсов IAM в руководстве пользователя IAM.

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

Имя ключа, которое можно использовать для поиска или извлечения соответствующего значения. Например, Department или Cost Center — распространённые варианты.

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

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, которые состоят из числа, связанного с различными центрами затрат в вашей компании. Обычно у многих ресурсов есть теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно хранить массив, вы можете хранить значения, разделённые запятыми, в строке. Однако вам необходимо интерпретировать значение в вашем коде.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--assertion-encryption-mode (строка)

Устанавливает параметры шифрования для поставщика SAML.

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

  • Required
  • Allowed

--add-private-key (строка)

Закрытый ключ, сгенерированный вашим внешним поставщиком удостоверений. Закрытый ключ должен быть файлом .pem, использующим алгоритм шифрования AES-GCM или AES-CBC для дешифрования утверждений SAML.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, все примеры используют правила цитирования, аналогичные UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Создание поставщика SAML

В этом примере создаётся новый поставщик SAML в IAM под именем MySAMLProvider. Он описывается документом метаданных SAML, найденным в файле SAMLMetaData.xml.

aws iam create-saml-provider \
    --saml-metadata-document file://SAMLMetaData.xml \
    --name MySAMLProvider

Вывод:

{
    "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/MySAMLProvider"
}

Дополнительную информацию см. в разделе Создание поставщиков удостоверений SAML IAM в руководстве пользователя AWS IAM.

Вывод

SAMLProviderArn -> (строка)

Amazon Resource Name (ARN) нового ресурса поставщика SAML в IAM.

Теги -> (список)

Список тегов, прикреплённых к новому поставщику SAML IAM. Возвращённый список тегов отсортирован по ключу тега. Дополнительную информацию о тегах см. в разделе Использование тегов для ресурсов IAM в руководстве пользователя IAM.

(структура)

Структура, представляющая предоставляемые пользователем метаданные, которые можно связать с ресурсом IAM. Дополнительную информацию о тегах см. в разделе Использование тегов для ресурсов IAM в руководстве пользователя IAM.

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

Имя ключа, которое можно использовать для поиска или извлечения соответствующего значения. Например, Department или Cost Center — распространённые варианты.

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

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, которые состоят из числа, связанного с различными центрами затрат в вашей компании. Обычно у многих ресурсов есть теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно хранить массив, вы можете хранить значения, разделённые запятыми, в строке. Однако вам необходимо интерпретировать значение в вашем коде.

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

Spec-Zone.ru

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