Seleccionar página

Tokens de acceso personal

  • Los tokens de acceso personal son un enfoque alternativo para autenticar solicitudes de API en Elasticserver PaaS, que, en comparación con el método predeterminado basado en sesión, proporciona una mayor versatilidad y confiabilidad.Entre las ventajas de los tokens, se pueden destacar las siguientes:
    • Se pueden generar múltiples tokens a la vez para soportar diferentes tareas.
    • la autenticación simplificada con tokens (no es necesario realizar solicitudes adicionales para obtener una sesión) garantiza una base de código más pequeña y una respuesta más rápida cuando se utilizan scripts de automatización
    • sus credenciales (nombre de usuario y contraseña) no están expuestas dentro de los scripts
    • Los tokens pueden autenticar solo una parte específica de la funcionalidad de la cuenta, por lo que puede compartirlos con compañeros de trabajo y asistentes externos sin crear una brecha de seguridad.
    • los tokens se pueden complementar con la fecha de vencimiento o revocarlos manualmente en cualquier momento

    Elasticserver proporciona una interfaz visual completamente funcional para la administración de tokens directamente en el tablero (comenzando con la versión 5.5), lo que la convierte en la forma preferible de autenticar cualquier integración de API (especialmente en cuentas con la autenticación de dos factores habilitada):

Administrar tokens de acceso

A continuación, describiremos el proceso de administración de tokens de acceso personal mediante la interfaz de usuario del panel:

1. Vaya a la sección Configuración haciendo clic en el botón del mismo nombre en la esquina superior derecha del tablero.

2. En el marco abierto, seleccione la pestaña Tokens de acceso para ver la lista de todos los tokens de la cuenta. El panel de herramientas encima de la lista proporciona acceso a los siguientes botones:

  • Creando : crea un nuevo token proporcionando la descripción, la fecha de vencimiento y seleccionando los métodos API requeridos (ya sea de conjuntos predefinidos o manualmente)
  • Editar : ajusta el token existente o lo regenera (es decir, establece un nuevo nombre, manteniendo todos los demás parámetros)
  • Copiar : crea un nuevo token utilizando parámetros del existente como base
  • Mover : elimina el token seleccionado
  • Actualizar : muestra los cambios más recientes en la lista.

3. Mientras se crea un token nuevo o se ajusta el existente, se muestra el siguiente marco, que permite ajustar:

  • Descripción : descripción personalizada proporcionada para el token
  • Vence en : la fecha en elformato dd-mm-aaaa este token es válido hasta (se puede volver a generar después del vencimiento)
  • API : el nombre del conjunto de solicitudes de API: predefinido ( acceso extendido  complementos IDE , Marketplace , complemento Maven ) o personalizado (con métodos seleccionados manualmente)
  • use el campo de búsqueda , el filtro Solo marcado y los enlaces a los documentos de API (que se muestran al pasar el mouse sobre el método en particular) para configurar los permisos requeridos para el token

4. Todos los cambios de token en cuenta requieren una confirmación obligatoria con la contraseña antes de ser aplicados.

5. A continuación, verá el valor del token de acceso. Asegúrese de haberlo guardado (use los botones Descargar / Copiar ), ya que nunca más se mostrará en ningún lugar.

Nota: Si olvida o pierde el valor de su token, es posible generar uno nuevo accediendo al marco Editar token de acceso y haciendo clic en el enlace correspondiente en la parte inferior.

Por lo tanto, el valor anterior deja de ser válido, por lo que se debe actualizar cualquier automatización existente con este token.

6. Puede Eliminar los tokens que ya no necesita (use Shift y Ctrl para seleccionar varios) con el botón Mover en el panel de herramientas.

Confirme en una ventana emergente y proporcione la contraseña para continuar. Ahora, sabe cómo administrar los tokens de acceso personal en la cuenta y puede usarlos en sus solicitudes de API.

Usar tokens de acceso

El uso de tokens de acceso simplifica en gran medida la autenticación de solicitudes de API, ya que permite omitir el paso de generación de sesiones y garantiza una mayor confiabilidad en comparación con la validez a corto plazo de las sesiones.

1. Simplemente ejecute el método API requerido, especificando su token dentro del   parámetro de sesión .

Por ejemplo, puede detener un ambiente ingresando la siguiente URL en un navegador:

https://app.${platformDomain}/1.0/environment/control/rest/stopenv?envName=${envName}&session=${token} 

aquí:

  • $ {platformDomain} : URL de la plataforma (nombre de dominio)
  • $ {envName} : nombre del entorno de destino (por ejemplo, mi proyecto )
  • $ {token} : valor del token (asegúrese de que tenga permiso para la operación llamada)

Para que la operación sea exitosa, debe obtener un “resultado”: ​​0 en respuesta (cualquier valor distinto de cero significa error).

2. Ahora, si regresa al tablero, verá que el ambiente apropiado se detuvo.

¡Eso es! ¡La gestión de API con tokens es así de simple!