Как использовать apigee-ssoadminapi.sh

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

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

Утилита apigee-ssoadminapi.sh позволяет:

  • Как посмотреть список пользователей с правами администратора или пользователей машин
  • Как добавлять и удалять пользователей с правами администратора или пользователей машин
  • Как изменить пароль администратора или пользователя устройства

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

Для управления свойствами модуля требуется аккаунт администратора в модуле Apigee SSO.

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

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

Пользователи компьютеров

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

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

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

Подробнее о том, как автоматизировать задачи для внешних поставщиков идентификационной информации…

Как установить apigee-ssoadminapi.sh

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

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

  1. Войдите в узел сервера управления. На этом узле уже должна быть установлена утилита apigee-service, как описано в разделе Установка утилиты Edge apigee-setup.
  2. Установите утилиту apigee-ssoadminapi.sh, которая используется для управления администраторами и пользователями машин для модуля Apigee 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 для всех поставщиков идентификационной информации, включая LDAP и SAML).
  • 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, поскольку модуль Apigee 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