Spec-Zone.ru › AWS CLI v2

[ aws . appfabric ]

создание-авторизации-приложения

Описание

Создает авторизацию приложения внутри пакета приложений, что позволяет AppFabric подключаться к приложению.

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

Синтаксис

  create-app-authorization
--app-bundle-identifier <value>
--app <value>
--credential <value>
--tenant <value>
--auth-type <value>
[--client-token <value>]
[--tags <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]

Параметры

--app-bundle-identifier (строка)

Amazon Resource Name (ARN) или универсальный уникальный идентификатор (UUID) пакета приложений для использования в запросе.

--app (строка)

Имя приложения.

Допустимые значения:

  • SLACK
  • ASANA
  • JIRA
  • M365
  • M365AUDITLOGS
  • ZOOM
  • ZENDESK
  • OKTA
  • GOOGLE
  • DROPBOX
  • SMARTSHEET
  • CISCO

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

Содержит учетные данные для приложения, такие как ключ API или идентификатор и секрет клиента OAuth2.

Укажите учетные данные, соответствующие типу авторизации для вашего запроса. Например, если тип авторизации для вашего запроса — OAuth2 (oauth2 ), то вы должны предоставить только данные учетных данных OAuth2.

Примечание

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

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

Содержит информацию об учетных данных клиента OAuth2.

clientId -> (строка)

Идентификатор клиента клиентского приложения.

clientSecret -> (строка)

Секрет клиента клиентского приложения.

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

Содержит информацию об учетных данных ключа API.

apiKey -> (строка)

Ключ API для приложения.

Синтаксис сокращенного формата:

oauth2Credential={clientId=string,clientSecret=string},apiKeyCredential={apiKey=string}

Синтаксис JSON:

{
  "oauth2Credential": {
    "clientId": "string",
    "clientSecret": "string"
  },
  "apiKeyCredential": {
    "apiKey": "string"
  }
}

--tenant (структура)

Содержит информацию об арендаторе приложения, такую как отображаемое имя и идентификатор приложения.

tenantIdentifier -> (строка)

Идентификатор арендатора приложения.

tenantDisplayName -> (строка)

Отображаемое имя арендатора.

Синтаксис сокращенного формата:

tenantIdentifier=string,tenantDisplayName=string

Синтаксис JSON:

{
  "tenantIdentifier": "string",
  "tenantDisplayName": "string"
}

--auth-type (строка)

Тип авторизации для авторизации приложения.

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

  • oauth2
  • apiKey

--client-token (строка)

Указывает уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы гарантировать идемпотентность запроса. Это позволяет вам безопасно повторно отправлять запрос без случайного выполнения той же операции второй раз. Для передачи того же значения в последующий вызов операции требуется, чтобы вы также передавали то же значение для всех других параметров. Мы рекомендуем использовать значение типа UUID.

Если вы не предоставите это значение, Amazon Web Services сгенерирует случайное для вас.

Если вы повторно отправляете операцию с тем же ClientToken, но с разными параметрами, повторение завершается с ошибкой IdempotentParameterMismatch.

--tags (список)

Карта пар ключ-значение тега или тегов, которые необходимо назначить ресурсу.

(структура)

Ключ или ключи пар ключ-значение для тега или тегов, назначенных ресурсу.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

Синтаксис сокращенного формата:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

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

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

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

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

Вывод

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

Содержит информацию об авторизации приложения.

appAuthorizationArn -> (строка)

Amazon Resource Name (ARN) авторизации приложения.

appBundleArn -> (строка)

Amazon Resource Name (ARN) пакета приложений для авторизации приложения.

app -> (строка)

Имя приложения.

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

Содержит информацию об арендаторе приложения, такую как отображаемое имя и идентификатор приложения.

tenantIdentifier -> (строка)

Идентификатор арендатора приложения.

tenantDisplayName -> (строка)

Отображаемое имя арендатора.

authType -> (строка)

Тип авторизации.

status -> (строка)

Состояние авторизации приложения.

Возможны следующие состояния:

  • PendingConnect : Начальное состояние авторизации приложения. Авторизация приложения создана, но еще не подключена.
  • Connected : Авторизация приложения подключена к приложению и готова к использованию.
  • ConnectionValidationFailed : Авторизация приложения получила исключение проверки при попытке подключения к приложению. Если авторизация приложения находится в этом состоянии, проверьте настроенные учетные данные и попробуйте подключить авторизацию приложения снова.
  • TokenAutoRotationFailed : AppFabric не смог обновить токен доступа. Если авторизация приложения находится в этом состоянии, попробуйте повторно подключить авторизацию приложения.

createdAt -> (метка времени)

Дата и время создания авторизации приложения.

updatedAt -> (метка времени)

Дата и время последнего обновления авторизации приложения.

persona -> (строка)

Роль пользователя авторизации приложения.

Это поле всегда должно быть admin .

authUrl -> (строка)

URL приложения для потока OAuth.

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

Spec-Zone.ru

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