Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

обновление-аутентификации-рабочей-области

Описание

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

Примечание

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

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

Синтаксис

  update-workspace-authentication
--authentication-providers <value>
[--saml-configuration <value>]
--workspace-id <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]

Параметры

--authentication-providers (список)

Указывает, использует ли эта рабочая область SAML 2.0, IAM Identity Center или оба для аутентификации пользователей для использования консоли Grafana в рамках рабочей области. Дополнительную информацию см. в разделе Аутентификация пользователей в Amazon Managed Grafana.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AWS_SSO
  SAML

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

Если рабочая область использует SAML, используйте эту структуру для сопоставления атрибутов утверждения SAML с информацией о пользователях рабочей области и определения, какие группы в атрибуте утверждения должны иметь роли Admin и Editor в рабочей области.

allowedOrganizations -> (список)

Перечисляет организации, определенные в утверждении SAML, которым разрешено использовать рабочую область Amazon Managed Grafana. Если список пуст, все организации в атрибуте утверждения имеют доступ.

(строка)

assertionAttributes -> (структура)

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

email -> (строка)

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

groups -> (строка)

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

login -> (строка)

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

name -> (строка)

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

org -> (строка)

Название атрибута в утверждении SAML, используемого в качестве полных «дружественных» имен для организаций пользователей.

role -> (строка)

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

idpMetadata -> (структура с метками)

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

Примечание

Это структура с метками. Может быть задан только один из следующих верхних ключей: url, xml.

url -> (строка)

URL расположения, содержащего метаданные IdP.

xml -> (строка)

Полные метаданные IdP в формате XML.

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

Время действия сеанса входа пользователя SAML, прежде чем пользователь должен войти снова.

roleValues -> (структура)

Структура, содержащая массивы, которые сопоставляют имена групп в утверждении SAML с ролями Admin и Editor Grafana в рабочей области.

admin -> (список)

Список групп из атрибута утверждения SAML, которым предоставляется роль Admin Grafana.

(строка)

editor -> (список)

Список групп из атрибута утверждения SAML, которым предоставляется роль Editor Grafana.

(строка)

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

allowedOrganizations=string,string,assertionAttributes={email=string,groups=string,login=string,name=string,org=string,role=string},idpMetadata={url=string,xml=string},loginValidityDuration=integer,roleValues={admin=[string,string],editor=[string,string]}

Синтаксис JSON:

{
  "allowedOrganizations": ["string", ...],
  "assertionAttributes": {
    "email": "string",
    "groups": "string",
    "login": "string",
    "name": "string",
    "org": "string",
    "role": "string"
  },
  "idpMetadata": {
    "url": "string",
    "xml": "string"
  },
  "loginValidityDuration": integer,
  "roleValues": {
    "admin": ["string", ...],
    "editor": ["string", ...]
  }
}

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

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

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

Отключить вывод пейджера CLI.

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

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

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

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

Вывод

authentication -> (структура)

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

awsSso -> (структура)

Структура, содержащая информацию о взаимодействии данного рабочего пространства с IAM Identity Center.

ssoClientId -> (строка)

Идентификатор приложения IAM Identity Center, управляемого Amazon Managed Grafana.

providers -> (список)

Указывает, использует ли данное рабочее пространство IAM Identity Center, SAML или оба метода для аутентификации пользователей для использования консоли Grafana в рабочем пространстве Amazon Managed Grafana.

(строка)

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

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

configuration -> (структура)

Структура, содержащая подробности о взаимодействии данного рабочего пространства с SAML.

allowedOrganizations -> (список)

Список организаций, определённых в утверждении SAML, которые разрешено использовать в рабочем пространстве Amazon Managed Grafana. Если список пуст, все организации в атрибуте утверждения имеют доступ.

(строка)

assertionAttributes -> (структура)

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

email -> (строка)

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

groups -> (строка)

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

login -> (строка)

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

name -> (строка)

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

org -> (строка)

Имя атрибута в утверждении SAML, используемого в качестве полных "дружественных" имён для организаций пользователей.

role -> (строка)

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

idpMetadata -> (структура помеченного объединения)

Структура, содержащая метаданные поставщика удостоверений (IdP), используемые для интеграции поставщика удостоверений с данным рабочим пространством.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: url, xml.

url -> (строка)

URL расположения, содержащего метаданные IdP.

xml -> (строка)

Полные метаданные IdP в формате XML.

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

Срок действия сеанса входа пользователя SAML, прежде чем пользователь должен снова войти.

roleValues -> (структура)

Структура, содержащая массивы, которые сопоставляют имена групп в утверждении SAML с ролями Grafana Admin и Editor в рабочем пространстве.

admin -> (список)

Список групп из атрибута утверждения SAML, которым предоставляется роль Grafana Admin.

(строка)

editor -> (список)

Список групп из атрибута утверждения SAML, которым предоставляется роль Grafana Editor.

(строка)

status -> (строка)

Указывает, завершена ли настройка SAML рабочего пространства.

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

Spec-Zone.ru

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