Uso de las utilidades y las API de administrador de Edge después de habilitar SAML

Edge para la nube privada v. 4.17.09

En esta sección, se describe cómo ejecutar herramientas y comandos de administración del sistema de Edge después de habilitar SAML. Muchas tareas en Edge requieren credenciales de administración del sistema, como las siguientes:

  • Cómo crear organizaciones y entornos
  • Cómo agregar y quitar componentes de Edge
  • Comandos Runngin apigee-adminapi.sh
  • muchas otras tareas

Sin embargo, después de habilitar SAML en Edge, por lo general, se inhabilita la autenticación básica para que la única forma de autenticar sea a través del IdP de SAML. Por lo tanto, debes asegurarte de haber agregado la cuenta de administrador del sistema a tu IDP de SAML.

Cómo llamar a las APIs de administración de Edge como el administrador del sistema

Muchas llamadas a la API de Edge requieren que pases credenciales de administrador del sistema. Cómo usar SAML con la API de administración de Edge contiene instrucciones para obtener y actualizar tokens cuando se realizan llamadas a la API de administración de Edge.

Cómo usar la utilidad apigee-adminapi.sh con la autenticación de SAML

Usa la utilidad apigee-adminapi.sh para realizar las mismas tareas de configuración de Edge que realizas con llamadas a la API de administración de Edge. La ventaja de la utilidad apigee-adminapi.sh es que hace lo siguiente:

  • Usa una interfaz de línea de comandos simple
  • Implementa el autocompletado de comandos basado en pestañas
  • Proporciona información de ayuda y uso
  • Puede mostrar la llamada a la API correspondiente si decides probar la API.

Para obtener más información, consulta Cómo usar apigee-ssoadminapi.sh.

Después de habilitar la autenticación de SAML, tienes varias formas de pasar las credenciales del administrador del sistema a la utilidad apigee-adminapi.sh.

Puedes ver todas las opciones de cualquier comando apigee-adminapi.sh, incluidas las opciones para especificar credenciales de SAML, si usas la opción "-h" en el comando. Por ejemplo:

> apigee-adminapi.sh orgs list -h

Por ejemplo, puedes pasar las credenciales de administrador del sistema:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant --admin adminEmail --oauth-password adminPword 

Donde:

  • sso-url especifica la URL del módulo de SSO de Edge. Modifica el puerto o el protocolo si los cambiaste de 9099 y HTTP.
  • oauth-flow especifica passcode o password_grant. En este ejemplo, especificas password_grant.
  • adminEmail es la dirección de correo electrónico del administrador del sistema.
  • oauth-password especifica la contraseña del administrador del sistema.

Como alternativa, puedes usar un código de acceso cuando llames al comando:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-passcode passcode 

Donde:

  • oauth-flow especifica la contraseña.
  • oauth-passcode especifica la contraseña que se obtuvo de http://edge_sso_IP_DNS:9099/passcode.

Por último, puedes usar un token cuando llames al comando:

> apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode --admin adminEmail --oauth-token token 

Donde:

  • oauth-flow especifica passcode o password_grant, según cómo obtuviste el token originalmente. En este ejemplo, especificas passcode porque, originalmente, obtuviste el token con get_token. Consulta Cómo usar SAML con la API de administración de Edge.
  • oauh_token contiene el token.

Cómo usar las utilidades de Edge con la autenticación de SAML

Muchas utilidades de Edge requieren credenciales de administrador del sistema, como las siguientes:

  • apigee-provision se usa para crear organizaciones, entornos y hosts virtuales
  • setup.sh se usa para agregar nodos a un sistema existente.
  • Cualquier otra utilidad en la que debas especificar las credenciales de administrador del sistema en un archivo de configuración

Estas utilidades toman como entrada un archivo de configuración que especifica las credenciales del administrador del sistema mediante las siguientes propiedades:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Si omites la contraseña, se te solicitará.

Después de habilitar SAML, usa diferentes propiedades para especificar las credenciales del administrador del sistema. Por ejemplo, puedes pasar las credenciales de administrador del sistema:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

Donde:

  • SSO_LOGIN_URL especifica la URL del módulo de SSO de Edge. Modifica el puerto o el protocolo si los cambiaste de 9099 y HTTP.
  • OAUTH_FLOW especifica passcode o password_grant. En este ejemplo, especificas password_grant porque pasas la contraseña del administrador del sistema.
  • OAUTH_ADMIN_PASSWORD especifica la contraseña del administrador del sistema.

Como alternativa, puedes usar las siguientes propiedades para especificar las credenciales como parte de un flujo de contraseña:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

Donde:

  • OAUTH_FLOW especifica una contraseña.
  • OAUTH_ADMIN_PASSCODE especifica la contraseña obtenida de http://edge_sso_IP_DNS:9099/passcode.

Por último, puedes usar un token

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

Donde:

  • OAUTH_FLOW especifica passcode o password_grant, según cómo hayas obtenido el token originalmente. En este ejemplo, especificas passcode porque, en primer lugar, obtuviste el token con get_token. Consulta Cómo usar SAML con la API de administración de Edge.
  • OAUTH_BEARER_TOKEN contiene el token.