Usa apigee-ssoadminapi.sh

El módulo de SSO de Apigee admite dos tipos de cuentas:

La utilidad apigee-ssoadminapi.sh te permite administrar las cuentas de usuario administrador y de máquina que están asociadas con el módulo de SSO de Apigee.

Usa la utilidad apigee-ssoadminapi.sh para lo siguiente:

  • Consulta la lista de usuarios administradores o de máquinas
  • Agrega o borra usuarios administradores o de máquina
  • Cambia la contraseña de los usuarios administradores o de máquina

Acerca de los usuarios administradores

Se requiere una cuenta de administrador en el módulo de SSO de Apigee para administrar las propiedades del módulo.

De forma predeterminada, cuando instalas el módulo de SSO de Apigee, se crea una cuenta de administrador con las siguientes credenciales:

  • username: Se define con la propiedad SSO_ADMIN_NAME en el archivo de configuración que se usa para configurar el módulo de SSO de Apigee. El valor predeterminado es ssoadmin..
  • password: Se define con la propiedad SSO_ADMIN_SECRET en el archivo de configuración que se usa para configurar el módulo de SSO de Apigee.

Acerca de los usuarios de máquinas

Un usuario de máquina puede obtener tokens de OAuth2 sin tener que especificar una contraseña. Esto significa que puedes automatizar por completo el proceso de obtención y actualización de tokens de OAuth2 con la API de administración de Edge.

Por lo general, los usuarios de máquinas se usan para lo siguiente:

  • Configura el portal de servicios para desarrolladores de Apigee (o simplemente, el portal) para que se comunique con Edge
  • Cuando el entorno de desarrollo admite la automatización de tareas de desarrollo comunes, como la automatización de pruebas o la CI/CD.

Para obtener más información, consulta Automatiza tareas para IdP externos.

Instala apigee-ssoadminapi.sh

Instala la utilidad apigee-ssoadminapi.sh en el nodo del servidor de administración de Edge en el que instalaste el módulo de SSO de Apigee. Por lo general, instalas la utilidad apigee-ssoadminapi.sh cuando instalas el módulo de SSO de Apigee.

Si aún no instalaste la utilidad apigee-ssoadminapi.sh, sigue estos pasos:

  1. Accede al nodo del servidor de administración. Ese nodo ya debería tener instalado apigee-service, como se describe en Instala la utilidad apigee-setup de Edge.
  2. Instala la utilidad apigee-ssoadminapi.sh que se usa para administrar los usuarios administradores y de máquina del módulo de SSO de Apigee ejecutando el siguiente comando: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Sal de la shell y, luego, vuelve a acceder para agregar la utilidad apigee-ssoadminapi.sh a tu ruta de acceso.

Consulta la información de ayuda de apigee-ssoadminapi.sh

Los comandos disponibles para la utilidad son los siguientes:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add (usa el comando saml para todos los IDP, incluidos LDAP y SAML)
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Puedes ver información sobre estos comandos en el archivo /opt/apigee/apigee-ssoadminapi/README.md. Además, puedes especificar la opción "-h" para cada comando para ver la información de uso.

Por ejemplo, el siguiente comando:

apigee-ssoadminapi.sh admin list -h

Se muestra lo siguiente:

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

Invoca la utilidad apigee-ssoadminapi.sh

Puedes invocar la utilidad apigee-ssoadminapi.sh pasando todas las propiedades como argumentos de línea de comandos o en modo interactivo respondiendo a las indicaciones.

Por ejemplo, para especificar toda la información requerida en la línea de comandos y ver la lista de usuarios administradores, haz lo siguiente:

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

Se muestra lo siguiente:

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

Si omites alguna información obligatoria, como la contraseña de administrador, se te solicitará que la ingreses.

En este ejemplo, se omiten los valores de --port y --ssl porque el módulo de SSO de Apigee usa los valores predeterminados de 9099 para --port y http para --ssl. Si tu instalación no usa estos valores predeterminados, especifícalos:

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

Como alternativa, usa el formulario interactivo en el que se te solicita toda la información:

apigee-ssoadminapi.sh admin list

Luego, se te solicitará toda la información requerida:

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