Usa apigee-ssoadminapi.sh

Edge para la nube privada v4.18.01

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

  • administrador
  • usuario de máquina

La utilidad apigee-ssoadminapi.sh te permite administrar el administrador y los usuarios de máquinas asociados con el módulo de SSO de Edge.

Usa la utilidad apigee-ssoadminapi.sh para realizar las siguientes acciones:

  • 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 requiere una cuenta de administrador en el módulo de SSO de Edge para administrar las propiedades del módulo. También necesitas credenciales de cuenta de administrador a fin de configurar la API BaaS o el portal para conectarte al módulo.

De forma predeterminada, cuando instalas el módulo de SSO de Edge, 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 perimetral. 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 perimetral.

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:

  • Configura el portal de servicios para desarrolladores a fin de 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 integración continua/implementación continua (CI/CD).

Consulta Usa SAML con tareas automatizadas para obtener más información.

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 Edge. Por lo general, instalas la utilidad apigee-ssoadminapi.sh cuando instalas el módulo de SSO perimetral.

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 con el fin de administrar usuarios de máquinas y administradores para el SSO Edge módulo:
    >
    /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.

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

Los comandos disponibles para la utilidad son los siguientes:

  • agregar administrador
  • borrar administrador
  • lista de administradores
  • administrador setpassword
  • saml machineuser add
  • borrar usuario de máquina de saml
  • lista de usuarios de máquinas aaml
  • 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" en cada comando para ver la información de uso. Por ejemplo, usa el siguiente comando:

> apigee-ssoadminapi.sh admin list -h

devuelve:

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 si pasas todas las propiedades como argumentos de línea de comandos o en modo interactivo si respondes los mensajes.

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

devuelve:

[
  {
    "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 para --port y --ssl porque el módulo de SSO perimetral 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