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

Edge для частного облака v4.19.01

Модуль Edge SSO поддерживает два типа учетных записей:

  • администратор
  • пользователь машины (только SAML)

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

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

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

О пользователях-администраторах

Для управления свойствами модуля необходима учетная запись администратора модуля Edge SSO.

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

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

О пользователях машины

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

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

  • Настройка портала Apigee 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 , как описано в разделе Установка утилиты Edge apigee-setup .
  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 delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • 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