UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

UIP-Anmeldung

uip login authentifiziert die CLI bei der UiPath Cloud und behält die resultierende Sitzung in einem lokalen .uipath/ -Ordner bei. Bei Erfolg verfügt die CLI über ein Zugriffstoken und einen ausgewählten Mandanten; Tools, die von nachfolgenden Befehlen ausgeführt werden, übernehmen diese automatisch. Siehe Authentifizierung für das Anmeldeinformationsmodell und Sitzungen und Anmeldeinformationen für den Ordner.

Informationen zum Überprüfen des Status finden Sie unter uip login status. Informationen zum Entfernen einer Sitzung finden Sie unter uip logout.

Zusammenfassung

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>]

Alle uip login -Unterbefehle berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag.

UIP-Anmeldung

Authentifiziert sich interaktiv über den Browser oder nicht interaktiv mit Client-Anmeldeinformationen für externe Anwendungen.

Argumente

Keine.

Optionen

  • -f, --file <folder> – Der Pfad zu einem Anmeldeinformationsordner. Die Sitzung wird in <folder> beibehalten. Ohne diesen verwendet die CLI den Standardspeicherort (siehe Sitzungen und Anmeldeinformationen).
  • --authority <url> – Benutzerdefinierte Autoritäts-URL. Für nicht standardmäßige Clouds verwenden.
  • --client-id <id> – Client-ID oder Anwendungs-ID für eine externe UiPath-Anwendung. Akzeptiert env.NAME , um aus einer Umgebungsvariablen zu lesen.
  • --client-secret <secret> – Geheimer Clientschlüssel für vertrauliche externe Anwendung. Akzeptiert env.NAME , um aus einer Umgebungsvariablen zu lesen.
  • -s, --scope <scopes> – Durch Leerzeichen getrennte Scopes (z. B. "OR.Folders OR.Jobs"). Verwendung mit Anmeldeinformationen für externe Anwendungen.
  • -t, --tenant <name> – Mandantenname (nicht interaktiver Modus). Wenn weggelassen, koppeln Sie sie mit --interactive.
  • --organization <name> – Der logische Name der Organisation, der während der Browser-Anmeldung vorab ausgewählt wurde. Umgeht die Organisationsauswahl, wenn sich Ihr Benutzer in mehreren Organisationen befindet.
  • --it, --interactive – Nach der Authentifizierung werden Sie aufgefordert, interaktiv einen Mandanten aus der von der Cloud zurückgegebenen Liste auszuwählen.

Credential modes

  • Interaktive/Benutzeranmeldeinformationen – Führen Sie uip login aus (optional mit --interactive, --tenant oder --organization). Der Browser-Flow wird mit der UiPath Cloud-Stelle abgeschlossen; Die resultierenden Token werden im Anmeldeinformationsordner beibehalten.
  • Externe Anwendung (nicht interaktiv) – Übergeben Sie --client-id, --client-secret und --scope, in der Regel mit --tenant. Geeignet für CI-Ausführungen. Lesen Sie das Geheimnis aus einer Umgebungsvariablen mit --client-secret env.UIPATH_CLIENT_SECRET , um es aus Ihrem Shell-Verlauf herauszuhalten.

Beispiele

# 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"
  }
}

Fehlermodi

  • Ein fehlender Mandant nach einer nicht interaktiven Anmeldung löst ConfigError mit Message: "No tenant selected" aus und weist Sie an, mit --tenant <name> oder --interactive erneut auszuführen.
  • Transportieren Sie Fehler und Nicht-2xx-Antworten von der Autoritätsoberfläche als AuthenticationError mit dem ursprünglichen HTTP-Status in Context.httpStatus , wenn verfügbar.
  • Eine falsch formatierte env.NAME -Referenz in --client-id / --client-secret erzeugt vor jedem Netzwerkaufruf eine ConfigError .

UIP-Anmeldung auf der Mandantenliste

Listen Sie alle Mandanten auf, die für den authentifizierten Benutzer in der aktuellen Organisation sichtbar sind. Erfordert eine aktive Anmeldung.

Argumente

Keine.

Optionen

  • -f, --file <folder> – Der Pfad zum Anmeldeinformationsordner. Standardmäßig die Sitzung, die vom letzten uip login verwendet wurde.

Beispiel

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"
    }
  ]
}

Wenn die Sitzung nicht angemeldet ist, gibt der Befehl AuthenticationError mit Anweisungen zum Ausführen von uip login aus.

UIP-Anmeldemandantensatz

Wählen Sie den aktiven Mandanten nach Namen aus. Der Mandant muss in der von login tenant list zurückgegebenen Liste vorhanden sein; Die CLI aktualisiert die gespeicherte Sitzung mit der neuen Auswahl.

Argumente

  • <name> (erforderlich) – Mandantenname, wie von uip login tenant list zurückgegeben.

Optionen

  • -f, --file <folder> – Der Pfad zum Anmeldeinformationsordner. Standardmäßig die Sitzung, die vom letzten uip login verwendet wurde.

Beispiel

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"
  }
}

Fehlermodi

  • Unbekannter Mandantenname erzeugt ValidationError mit Instructions , das die verfügbaren Mandanten auflistet, z. B. argument should be one of DefaultTenant, ProductionTenant.
  • Wenn die CLI die gespeicherte Sitzung nicht aktualisieren kann, wird der Fehler als Failure mit einem berechtigungsbezogenen Hinweis angezeigt.

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben