Использование apigee-ssoadminapi.sh

Edge for Private Cloud v4.18.01

Модуль Edge SSO поддерживает два типа аккаунтов:

  • administrator
  • пользователь компьютера

Утилита apigee-ssoadminapi.sh позволяет управлять администраторами и пользователями компьютеров, связанными с модулем Edge SSO.

Используйте утилиту apigee-ssoadminapi.sh, чтобы:

  • Просмотр списка администраторов и пользователей компьютеров
  • Добавление и удаление администраторов и пользователей компьютеров
  • Изменение пароля администратора или пользователя компьютера

Администраторы

Для управления свойствами модуля SSO Edge требуется аккаунт администратора. Вам также потребуются учетные данные аккаунта администратора, чтобы настроить API BaaS или портал для подключения к модулю.

По умолчанию при установке модуля SSO Edge создается аккаунт администратора со следующими учетными данными:

  • username – определяется свойством SSO_ADMIN_NAME в файле конфигурации, который используется для настройки модуля Edge SSO. Значение по умолчанию – ssoadmin.
  • password – определяется свойством SSO_ADMIN_SECRET в файле конфигурации, который используется для настройки модуля Edge SSO.

О пользователях компьютеров

Пользователь-машина может получить токены OAuth2 без указания кода доступа. Это означает, что вы можете полностью автоматизировать процесс получения и обновления токенов OAuth2 с помощью Edge Management API.

Обычно пользователи-машины используются для:

  • Настройка портала Developer Services для связи с Edge
  • Когда среда разработки поддерживает автоматизацию распространенных задач разработки, таких как автоматизация тестирования или непрерывная интеграция/непрерывное развертывание (CI/CD).

Подробнее об использовании SAML с автоматизированными задачами…

Установка apigee-ssoadminapi.sh

Установите утилиту apigee-ssoadminapi.sh на узел Edge Management Server, на котором вы установили модуль Edge SSO. Обычно утилита apigee-ssoadminapi.sh устанавливается вместе с модулем Edge SSO.

Если вы ещё не установили утилиту apigee-ssoadminapi.sh:

  1. Войдите в узел сервера управления. На этом узле уже должен быть установлен компонент apigee-service, как описано в разделе Установка утилиты apigee-setup для Edge.
  2. Установите утилиту apigee-ssoadminapi.sh, которая используется для управления администраторами и пользователями компьютеров в модуле Edge SSO:
    >     /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Выйдите из оболочки и снова войдите в нее, чтобы добавить утилиту apigee-ssoadminapi.sh в путь.

Просмотр справочной информации для apigee-ssoadminapi.sh

Для утилиты доступны следующие команды:

  • admin add
  • удаление администратором;
  • список администраторов
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • Список пользователей компьютеров AAML
  • saml machineuser setpassword

Информацию об этих командах можно найти в файле /opt/apigee/apigee-ssoadminapi/README.md. Кроме того, вы можете добавить параметр -h к каждой команде, чтобы посмотреть информацию об использовании. Например, следующая команда:

> apigee-ssoadminapi.sh admin list -h

возвращает:

admin list 
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Вызов утилиты apigee-ssoadminapi.sh

Вы можете вызвать утилиту apigee-ssoadminapi.sh, передав все свойства в качестве аргументов командной строки, или в интерактивном режиме, отвечая на запросы.

Например, чтобы указать в командной строке всю необходимую информацию для просмотра списка администраторов, введите:

> apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

возвращает:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

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

В этом примере вы опускаете значения для --port и --ssl, поскольку модуль Edge SSO использует значения по умолчанию: 9099 для --port и http для --ssl. Если в вашей установке не используются эти значения по умолчанию, укажите их:

> apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184 --port 9443 --ssl https

Вы также можете воспользоваться интерактивной формой, в которой вам будет предложено указать всю необходимую информацию:

> apigee-ssoadminapi.sh admin list

Затем вам будет предложено указать всю необходимую информацию:

SSO admin name (current): ssoadmin
SSO Admin secret (current): 
SSO host: 35.197.94.184