- Información general
- Comience ya
- Conceptos
- Información general
- Cómo está organizada la UiPath CLI
- Herramientas (complementos)
- Aptitudes
- Sesiones y credenciales
- Uso de UiPath CLI
- UiPath para agentes de codificación
- Guías prácticas
- Recetas de CI/CD
- Referencia de los comandos
- Información general
- Códigos de salida
- Opciones globales
- agente de código UIP
- UIP Docsai
- añadir-entidad-de-datos-de-prueba
- añadir-cola-de-datos-de-prueba
- añadir-variación-de-datos-de-prueba
- Analizar
- Crear
- Crear proyecto
- Diferencia
- Buscar actividades
- obtener-reglas-del-analizador
- obtener-predeterminado-actividad-xaml
- obtener-errores
- obtener-casos-de-prueba-manual
- obtener-pasos-de-prueba-manual
- obtener versiones
- get-workflow-example
- indicar-aplicación
- indicar-elemento
- inspeccionar-paquete
- install-data-fabric-entities
- instalar-o-actualizar-paquetes
- enumerar-data-fabric-entities
- ejemplos-de-flujo-de-trabajo-de-lista
- Paquete
- restore
- archivo de ejecución
- plantillas-de-búsqueda
- iniciar-studio
- detener la ejecución
- UIA
- Seguimientos de UIP
- Migración
- Referencia y soporte
Guía del usuario de UiPath CLI
Una uip sesión es el estado que vincula un comando a una organización y un tenant de UiPath específicos, y que permite a la CLI presentar un token de acceso válido sin preguntar al usuario en cada llamada. Las sesiones se conservan en el disco para los flujos de aplicación interactiva y externa, y se reconstruyen a partir de variables de entorno para el flujo env-var. Esta página explica dónde reside ese estado, cómo lo encuentra uip y qué esperar cuando te mueves entre tenants o máquinas.
La carpeta de credenciales
uip login persiste la sesión dentro de una carpeta llamada .uipath/. Trata sus contenidos como opacos: son gestionados por uip login, uip login tenant set y uip logout, y el diseño en disco es un detalle de implementación que puede cambiar entre versiones. La carpeta contiene un token de acceso, un token de actualización y la organización y el tenant activos.
Protege la carpeta. Contiene tokens que pueden suplantar tu sesión hasta que se revoquen. En entornos multiusuario o compartidos, mantenlo en un directorio de inicio con los permisos habituales 0600 sobre su contenido. En una máquina de desarrollador, suele ser suficiente dejarlo donde uip login lo puso. Añade .uipath/ a .gitignore si una sesión local del proyecto es por desarrollador.
Resolución de ubicación (visualización)
Cuando se ejecuta cualquier comando uip , la CLI busca la carpeta de credenciales en este orden:
- Ruta explícita : si se invocó un comando con
-f /path/to/folder, se utiliza esa carpeta. La ruta puede ser absoluta o relativa. - Sube desde el directorio actual : a partir de
cwd, CLI comprueba./.uipath/y luego sube por la cadena principal buscando la misma carpeta. El primero que encuentra gana. - Inicio de usuario : si no se encuentra ninguna carpeta local del proyecto en el acceso directo, la CLI recurre a
~/.uipath/.
uip login escribe en la ruta que sería leída por el siguiente comando:
- Si ejecutaste
uip logindentro de un directorio con un.uipath/existente en la cadena de acceso directo, el inicio de sesión actualiza esa sesión en su lugar. - De lo contrario, crea
~/.uipath/en tu directorio de inicio.
¿Por qué sin cita previa?
Subir desde cwd permite que una carpeta de proyecto lleve su propia sesión sin modificar tu directorio de inicio. Coloca una carpeta .uipath/ en la raíz de un repositorio, y todos los que ejecuten uip desde el repositorio obtendrán el inicio de sesión de ese proyecto, lo que es útil para las credenciales de cliente por proyecto, los tenants de preparación o los entornos de demostración.
Anular la ubicación
Tres formas de anular la búsqueda:
-f, --file <folder>enuip loginyuip logout: utiliza la carpeta especificada solo para este comando.- Un directorio de inicio independiente: en un servidor de compilación compartido, ejecuta
HOME=/srv/build-home uip loginpara escribir en/srv/build-home/.uipath/. uip completiony otros comandos no toman un marcador-fy siempre utilizan la alternativa de acceso directo + inicio.
Para inspección:
# print the current session status (reads via walk-up)
uip login status
# print the current session status (reads via walk-up)
uip login status
uip login status siempre lee a través de la alternativa de acceso directo + inicio; no acepta -f. Para inspeccionar una sesión en una carpeta no predeterminada, cambia a ese directorio (o a un subdirectorio del mismo) antes de ejecutar uip login status, o enumera los tenants disponibles con uip login tenant list -f /path/to/creds.
Organización y tenant activos
Una sesión almacena una organización y un tenant a la vez. El tenant es el concepto de UiPath que delimita el ámbito de las carpetas, los trabajos, las colas y los recursos: en realidad, la "cuenta" a la que llega la CLI cada vez que se ejecuta uip or ….
Cambia el tenant activo sin volver a autenticar:
uip login tenant list # show all tenants this session can access
uip login tenant set MyTenant # switch the active tenant
uip login tenant list # show all tenants this session can access
uip login tenant set MyTenant # switch the active tenant
En segundo plano, uip login tenant set acuña nuevos tokens de acceso/actualización para el nuevo tenant y actualiza la sesión almacenada en su lugar.
Pasa --tenant <name> en cualquier llamada uip or … para anular el tenant activo de la sesión para un solo comando, sin cambiar la sesión en disco:
uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production
uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production
Actualizando tokens
Los tokens de acceso son de corta duración. Cuando CLI detecta que el token de acceso almacenado está a punto de caducar, utiliza el token de actualización para solicitar uno nuevo y actualiza silenciosamente la sesión almacenada. No es necesario volver a ejecutar uip login a menos que ocurra una de las siguientes situaciones:
- El propio token de actualización caduca o se revoca (normalmente después de semanas de inactividad o cuando un administrador fuerza un cierre de sesión).
- Ha cambiado de organización.
- Necesitas un conjunto de ámbitos diferente de aquel con el que se autenticó la sesión.
uip login status informa Expired cuando la actualización ha fallado; esa es la señal para ejecutar uip login de nuevo.
El flujo env-var (sin archivo)
El tercer flujo de autenticación, habilitado UIPATH_CLI_ENABLE_ENV_AUTH=true, omite la carpeta de credenciales por completo. Cada comando uip lee el token y el tenant de las variables de entorno, los utiliza tal cual y no escribe nada en el disco.
Esta es la opción correcta para:
- Contenedores que reciben un token de un proceso principal.
- Ejecutores de CI efímeros en los que persistir las credenciales en el disco es un desperdicio o está prohibido.
- Cualquier entorno en el que la CLI deba ser sin estado entre invocaciones.
Diferencias con los flujos basados en archivos:
- Sin actualización. El token es opaco a
uip: si ha caducado, la persona que llama es responsable de rotarlo. uip logoutno hace nada. No hay ningún archivo que eliminar. Anule la configuración de las variables de entorno para "cerrar sesión".- La URL base se deriva del token. Cualquiera que sea la reclamación
issque lleva el JWT se trata como autorizada: no establezcasUIPATH_URLjunto conUIPATH_CLI_AUTH_TOKENo se desincronizará.
Consulta Autenticación: flujo 3 para ver el conjunto completo de variables y ejemplos de acciones/contenedores de GitHub.
Cierre de sesión
Flujos basados en archivos:
uip logout # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds # clear a specific credentials folder
uip logout # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds # clear a specific credentials folder
logout borra la sesión almacenada. Las llamadas uip or … posteriores fallarán con AuthenticationError (código de salida 2) hasta que vuelvas a ejecutar uip login . Para invalidar la sesión también en el lado del servidor, revoca el secreto de la aplicación externa en Automation Cloud o cierra sesión en tu cuenta de usuario.
Flujo Env-var: unset UIPATH_CLI_ENABLE_ENV_AUTH (y las variables de token, para estar seguros).
Ver también
- Autenticación : los tres flujos que escriben u omiten la carpeta de credenciales.
- Configuración : precedencia de variables de entorno, que se encuentra junto a la carpeta de credenciales, pero separada de ella.
- referencia de inicio de sesión de uip, referencia de estado de inicio de sesión de uip, referencia de cierre de sesión de uip : listas de marcadores por comando y ejemplos.
- Instalar UiPath CLI: eliminar credenciales y datos : limpieza después de la desinstalación.