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 de máquina y administrador que están asociadas con el módulo de SSO de Apigee.

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

  • Ver la lista de usuarios administradores o de máquinas
  • Agregar o borrar administradores o usuarios de máquinas
  • Cambiar la contraseña del administrador o los usuarios de la máquina

Acerca de los usuarios administradores

Se necesita 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 mediante 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 mediante 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 completamente el proceso de obtención y actualización de tokens de OAuth2 con la API de Edge Management.

Por lo general, usas usuarios de máquinas para lo siguiente:

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

Para obtener más información, consulta Cómo automatizar tareas para IdP externos.

Instala apigee-ssoadminapi.sh

Instala la utilidad apigee-ssoadminapi.sh en el nodo de Edge Management Server en el que instalaste el módulo de SSO de Apigee. Por lo general, se instala la utilidad apigee-ssoadminapi.sh cuando se instala el módulo de SSO de Apigee.

Si aún no instalaste la utilidad apigee-ssoadminapi.sh, haz lo siguiente:

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

Ver 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 obtener información sobre estos comandos en el archivo /opt/apigee/apigee-ssoadminapi/README.md. Además, puedes especificar la opción "-h" en cada comando para ver la información de uso.

Por ejemplo, usa 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 la línea de comandos o en modo interactivo respondiendo a las solicitudes.

Por ejemplo, para especificar toda la información obligatoria en la línea de comandos a fin de 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á.

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

También puedes usar 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 necesaria:

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