Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

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

Описание

Отображает информацию об методах аутентификации, используемых в одном рабочем пространстве Amazon Managed Grafana.

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

Синтаксис

  describe-workspace-authentication
--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]

Параметры

--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
  • текст
  • таблица
  • 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.

Вывод

аутентификация -> (структура)

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

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