Usa apigee-ssoadminapi.sh

Edge para la nube privada v4.18.01

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

  • administrador
  • usuario de la máquina

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

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

  • Ver la lista de usuarios administradores/máquina
  • Agregar o borrar usuarios administradores o de máquinas
  • Cambia la contraseña de los usuarios administradores o de la máquina

Acerca de los usuarios administradores

Se necesita 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 para configurar el BaaS de la API o el portal a fin de 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: definido por la propiedad SSO_ADMIN_NAME en el archivo de configuración que se usa para configurar el módulo de SSO de Edge. El valor predeterminado es ssoadmin.
  • password: definido por 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 la 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, 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 para tareas comunes de desarrollo, como la automatización de pruebas o la integración continua/implementación continua (CI/CD).

Para obtener más información, consulta Usa SAML con tareas automáticas.

Cómo instalar apigee-ssoadminapi.sh

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

Si aún no instaló la utilidad apigee-ssoadminapi.sh:

  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 de Apigee de Setup de Edge.
  2. Instala la utilidad apigee-ssoadminapi.sh para administrar a los usuarios administradores y de máquinas del SSO de Edge en el módulo:
    >
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Sal del shell y, luego, vuelve a acceder para agregar la utilidad apigee-ssoadminapi.sh a tu ruta de acceso.

Ver información de ayuda de apigee-ssoadminapi.sh

Los comandos disponibles para la utilidad son los siguientes:

  • Agregar administrador
  • borrar del administrador
  • lista de administradores
  • admin_password
  • Agregar máquina de anuncios saml
  • Borrar máquina user saml
  • lista de usuarios de aaml
  • setpassword de contraseña de saml

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, el siguiente comando:

> apigee-ssoadminapi.sh admin list -h

muestra:

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

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

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

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

muestra:

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

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

En este ejemplo, omites los valores de --port y --ssl porque el módulo Edge SSO usa los valores predeterminados de 9099 para --port y http de --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 utilizar el formulario interactivo donde 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