UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

Inicio de sesión de UIP

uip login autentica la CLI en UiPath Cloud y mantiene la sesión resultante dentro de una carpeta local .uipath/ . En caso de éxito, la CLI tiene un token de acceso y un tenant seleccionado; las herramientas ejecutadas por comandos posteriores los recogen automáticamente. Consulta Autenticación para el modelo de credenciales y Sesiones y credenciales para el lugar donde reside la carpeta.

Para comprobar el estado, consulta uip login status. Para eliminar una sesión, consulta uip logout.

Sinopsis

uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]

Todos los subcomandos uip login respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

Inicio de sesión de UIP

Se autentica de forma interactiva a través del navegador o de forma no interactiva utilizando las credenciales de cliente de la aplicación externa.

Argumentos

Nada.

Opciones

  • -f, --file <folder> — Ruta a una carpeta de credenciales. La sesión persiste dentro de <folder>. Sin ella, la CLI utiliza la ubicación predeterminada (consulta Sesiones y credenciales).
  • --authority <url> — URL de autoridad personalizada. Utilízalo para nubes no predeterminadas.
  • --client-id <id> : ID de cliente o ID de aplicación para una aplicación externa de UiPath. Acepta env.NAME para leer desde una variable de entorno.
  • --client-secret <secret> — Secreto de cliente para una aplicación externa confidencial. Acepta env.NAME para leer desde una variable de entorno.
  • -s, --scope <scopes> — Ámbitos separados por espacios (por ejemplo, "OR.Folders OR.Jobs"). Utilízalo con credenciales de aplicación externa.
  • -t, --tenant <name> — Nombre del tenant (modo no interactivo). Si se omite, empareja con --interactive.
  • --organization <name> — Nombre lógico de la organización, preseleccionado durante el inicio de sesión del navegador. Omite el selector de la organización cuando tu usuario está en varias organizaciones.
  • --it, --interactive Después de la autenticación, solicita de forma interactiva seleccionar un tenant de la lista devuelta por la nube.

Credential modes

  • Credenciales interactivas/de usuario : ejecuta uip login (opcionalmente con --interactive, --tenant o --organization). El flujo del navegador se completa en la autoridad de UiPath Cloud; los tokens resultantes se conservan dentro de la carpeta de credenciales.
  • Aplicación externa (no interactiva) : pasa --client-id, --client-secret y --scope, normalmente con --tenant. Adecuado para ejecutores CI. Lee el secreto de una variable de entorno con --client-secret env.UIPATH_CLIENT_SECRET para mantenerlo fuera de tu historial de shell.

Ejemplos

# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath
# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath

Data shape (--output json)

{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}
{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}

Modos de fallo

  • Falta un tenant después de un inicio de sesión no interactivo que genera un ConfigError con Message: "No tenant selected" y te indica que vuelvas a ejecutar con --tenant <name> o --interactive.
  • Transporte los errores y las respuestas que no sean 2xx de la superficie de autoridad como AuthenticationError, con el estado HTTP original en Context.httpStatus cuando esté disponible.
  • Una referencia env.NAME mal formada en --client-id / --client-secret produce un ConfigError antes de cualquier llamada de red.

lista de tenants de inicio de sesión de uip

Enumera todos los tenants visibles para el usuario autenticado en la organización actual. Requiere un inicio de sesión activo.

Argumentos

Nada.

Opciones

  • -f, --file <folder> — Ruta a la carpeta de credenciales. El valor predeterminado es la sesión utilizada por el último uip login.

Ejemplo

uip login tenant list
uip login tenant list

Data shape (--output json)

{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}
{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}

Si la sesión no ha iniciado sesión, el comando emite AuthenticationError con instrucciones para ejecutar uip login primero.

conjunto de tenant de inicio de sesión de UIP

Selecciona el tenant activo por nombre. El tenant debe existir en la lista devuelta por login tenant list; la CLI actualiza la sesión almacenada con la nueva selección.

Argumentos

  • <name> (obligatorio) : nombre del tenant tal como lo devuelve uip login tenant list.

Opciones

  • -f, --file <folder> — Ruta a la carpeta de credenciales. El valor predeterminado es la sesión utilizada por el último uip login.

Ejemplo

uip login tenant set DefaultTenant
uip login tenant set DefaultTenant

Data shape (--output json)

{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Modos de fallo

  • Nombre de tenant desconocido produce ValidationError con Instructions enumerando los tenants disponibles, por ejemplo argument should be one of DefaultTenant, ProductionTenant.
  • Si CLI no puede actualizar la sesión almacenada, el error aparece como Failure con una sugerencia relacionada con los permisos.

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado