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 ist Verbindungen“.

uip is connections verwaltet die OAuth-Sitzungen des Mandanten für Connectors. Eine Verbindung ist die authentifizierte Verknüpfung zwischen einem UiPath-Mandantenordner und einem externen Konto; Es enthält die Token, die resources execute und activities zur Runtime verwenden. Die Verben decken die Erkennung (list), Authentifizierung (create, edit) und Zustandsprüfungen (ping) ab. Sowohl create als auch edit öffnen die OAuth-URL des Connectors in einem Browser und fragen den Server zur Fertigstellung ab (5-Sekunden-Intervall, 5-Minuten-Gesamttimeout).

Zusammenfassung

uip is connections <verb> [options]
uip is connections <verb> [options]

Verben

VerbZweck
listListen Sie Verbindungen auf, die optional auf einen Connector oder Ordner beschränkt sind.
createErstellen Sie eine neue Verbindung über den OAuth-Flow des Connectors.
pingÜberprüfen Sie, ob derzeit eine Verbindung aktiviert und erreichbar ist.
editAuthentifizieren Sie eine vorhandene Verbindung durch den OAuth-Flow erneut.

UIP ist eine Verbindungsliste

Listen Sie Verbindungen im Mandanten auf. Optionale Positionsfilter <connector-key> filtert das Ergebnis auf einen Connector; Flags können nach Ordner oder einer einzelnen Verbindungs-ID angepasst werden.

Argumente

NameErforderlichZweck
[connector-key]neinConnectorschlüssel, nach dem gefiltert werden soll (z. B. uipath-zoho-desk). Lassen Sie die Liste über alle Connectors weg.

Optionen

ShortLongWertStandardBeschreibung
--folder-keyUUIDOrdnerschlüssel, nach dem gefiltert werden soll. Muss eine UUID sein.
--connection-ididFiltern Sie zu einer bestimmten Verbindungs-ID.
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--refreshMarkierenausErzwingen Sie den erneuten Abruf über die API und ignorieren Sie den Cache.

Beispiele

uip is connections list

uip is connections list uipath-zoho-desk

uip is connections list uipath-zoho-desk --refresh \
    --output-filter 'Data[].{id:Id, state:State}'
uip is connections list

uip is connections list uipath-zoho-desk

uip is connections list uipath-zoho-desk --refresh \
    --output-filter 'Data[].{id:Id, state:State}'

Datenform (--output json)

{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "IsDefault": "No",
      "Folder": "Shared",
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "Created": "2026-01-10T10:00:00.000Z",
      "Updated": "2026-01-10T10:00:00.000Z"
    }
  ]
}
{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "IsDefault": "No",
      "Folder": "Shared",
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "Created": "2026-01-10T10:00:00.000Z",
      "Updated": "2026-01-10T10:00:00.000Z"
    }
  ]
}

Wenn einige Verbindungen deaktiviert sind, enthält die Antwort ein Warning -Feld neben Data. Ein ungültiges --folder-key , das keine UUID ist, wird im Voraus abgelehnt.

UIP ist Verbindungen erstellen

Erstellen Sie eine neue Verbindung über den OAuth-Flow des Connectors. Die CLI öffnet die Authentifizierungs-URL in Ihrem Browser (es sei denn, Sie übergeben --no-browser) und fragt den Server nach Abschluss ab. Abfrageintervall: 5 Sekunden. Gesamt-Timeout: 5 Minuten.

Argumente

NameErforderlichZweck
<connector-key>jaConnector-Schlüssel, z. B. uipath-zoho-desk.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--no-browserMarkierenausBrowser nicht automatisch öffnen; Drucken Sie die URL für die manuelle Navigation aus.

Beispiele

uip is connections create uipath-zoho-desk

# Headless / CI-friendly — print the URL instead of launching a browser
uip is connections create uipath-zoho-desk --no-browser
uip is connections create uipath-zoho-desk

# Headless / CI-friendly — print the URL instead of launching a browser
uip is connections create uipath-zoho-desk --no-browser

Datenform (--output json)

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}
{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

Fehlermodi:

  • Der Benutzer lehnt ab oder die Authentifizierung schlägt fehl: Failure mit der Nachricht des Servers; 1 beenden.
  • Abfrage-Timeout (5 Minuten): Failure: "Authentication timed out after 5 minutes"; 2 beenden.
  • Fehler beim Abruftransport: Failure; 1 beenden.
  • Unterbrochen/abgebrochen (Strg+C): Failure; 1 beenden.

UIP ist Verbindungs-Ping

Überprüfen Sie, ob derzeit eine Verbindung aktiviert und erreichbar ist.

Argumente

NameErforderlichZweck
<connection-id>jaVerbindungs-ID (UUID), die von connections list oder connections create zurückgegeben wird.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.

Beispiele

uip is connections ping a1b2c3d4-0000-0000-0000-000000000001
uip is connections ping a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "ConnectionPing",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Enabled",
    "Message": "Connection is active."
  }
}
{
  "Code": "ConnectionPing",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Enabled",
    "Message": "Connection is active."
  }
}

Eine deaktivierte oder nicht erreichbare Verbindung gibt Failure mit Instructions: "Run 'uip is connections edit <id>' to re-authenticate." aus.

uip ist Verbindungen bearbeiten

Authentifizieren Sie eine vorhandene Verbindung erneut. Der gleiche OAuth-Flow wie create, der auf eine vorhandene Verbindungs-ID ausgerichtet ist, anstatt eine neue auszustellen. Der gleiche Abrufvertrag und die gleichen Austrittscodes.

Argumente

NameErforderlichZweck
<connection-id>jaVerbindungs-ID zur erneuten Authentifizierung.

Optionen

ShortLongWertStandardBeschreibung
-t--tenantnameSitzungsstandardÜberschreiben Sie den Mandanten.
--no-browserMarkierenausBrowser nicht automatisch öffnen; Drucken Sie die URL für die manuelle Navigation aus.

Beispiele

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001 --no-browser
uip is connections edit a1b2c3d4-0000-0000-0000-000000000001

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001 --no-browser

Datenform (--output json)

{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}
{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}

Siehe auch

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