„uip ist Verbindungen“.

Syntax und Optionen für „Uip is Connections“, die OAuth-Sitzungen zwischen einem UiPath-Mandanten und externen Connectors verwaltet.

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 run und activities zur Runtime verwenden. Die Verben decken die Erkennung (list, export), Authentifizierung (create, edit), Zustandsprüfungen (ping) und Verwaltung (rename, set-default, update-polling-interval, base-url) ab }, delete). create und 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]

Verben

Verb	Zweck
list	Listen Sie Verbindungen auf, die optional auf einen Connector, Ordner oder BYOM-Status beschränkt sind.
export	Exportieren Sie jede Verbindung (über alle Ordner hinweg) zur Prüfung.
create	Erstellen Sie eine neue Verbindung über den OAuth-Flow des Connectors.
ping	Überprüfen Sie, ob derzeit eine Verbindung aktiviert und erreichbar ist.
edit	Authentifizieren Sie eine vorhandene Verbindung durch den OAuth-Flow erneut.
rename	Benennen Sie eine vorhandene Verbindung um.
set-default	Markieren Sie eine Verbindung als Standard für ihren Connector.
update-polling-interval	Ändern Sie das Abrufintervall einer Verbindung.
base-url	Rufen Sie die API-Basis-URL ab, über die eine Verbindung aufgelöst wird.
delete	Löschen einer Verbindung (destruktiv, erfordert -y/--yes).

UIP ist eine Verbindungsliste

Listen Sie Verbindungen im Standard-Scope des Mandanten auf. Optionale Positionsfilter <connector-key> filtert das Ergebnis auf einen Connector; Flags können nach Ordner, Verbindungs-ID oder BYOM-Status definiert werden.

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-key	UUID	–	Suchen Sie Verbindungen in einem bestimmten Ordner. Muss eine UUID sein. Sich gegenseitig mit --all-folders ausschließen.
–	--connection-id	id	–	Filtern Sie zu einer bestimmten Verbindungs-ID.
–	--byoa	Markieren	aus	Nur nach BYOM-Verbindungen (Bring Your Own Account) filtern.
–	--all-folders	Markieren	aus	Suchen Sie Verbindungen in allen Ordnern anstelle des Standard-Scope. Sich gegenseitig mit --folder-key ausschließen – die Kombination mit einem Failure schlägt fehl, bevor eine Anforderung gestellt wird.
–	--refresh	Markieren	aus	Erzwingen 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 --byoa --all-folders

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": "[e-mail]",
      "IsDefault": "No",
      "ByoaConnection": "No",
      "ElementInstanceId": 123456,
      "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 der Export von Verbindungen

Exportieren Sie jede Verbindung über alle Ordner hinweg für Prüfungszwecke. Akzeptiert keine Argumente oder Verbindungs-Scoping-Optionen – es deckt immer den vollständigen Mandanten ab.

Argumente

Keine.

Beispiel

uip is connections export

Datenform (--output json)

{
  "Code": "ConnectionExport",
  "Data": {
    "a1b2c3d4-0000-0000-0000-000000000001": {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Zoho Desk - Prod",
      "state": "Enabled"
    }
  }
}

Data ist eine Zuordnung mit Verbindungs-ID – kein Array. Wenn der Mandant überhaupt keine Verbindungen hat, ist die Antwort stattdessen {"Code": "Message", "Data": {"Message": "No connections found to export."}}.

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

Name	Erforderlich	Zweck
<connector-key>	ja	Connector-Schlüssel, z. B. uipath-zoho-desk.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--no-browser	Markieren	aus	Browser nicht automatisch öffnen; Drucken Sie die URL für die manuelle Navigation aus.
–	--no-wait	Markieren	aus	Geben Sie die ausstehenden Autorisierungsdetails (SessionId, AuthUrl) sofort zurück, anstatt den Abschluss abzurufen.

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

# Return immediately with the pending session instead of polling
uip is connections create uipath-zoho-desk --no-browser --no-wait

Datenform (--output json)

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "[e-mail]",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

Mit --no-wait ist die Antwort stattdessen die ausstehende Autorisierung:

{
  "Code": "ConnectionAuthorizationPending",
  "Data": {
    "Status": "AuthorizationPending",
    "SessionId": "s1000000-0000-0000-0000-000000000001",
    "AuthUrl": "https://.../authorize?...",
    "Instructions": "Open AuthUrl to authorize the connection, then run 'uip is connections list' or 'uip is connections ping <connection-id>' to verify the connection.",
    "Connector": "uipath-zoho-desk"
  }
}

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

Name	Erforderlich	Zweck
<connection-id>	ja	Verbindungs-ID (UUID), die von connections list oder connections create zurückgegeben wird.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--force-refresh	Markieren	aus	Erzwingen Sie eine Statusaktualisierung der Live-Verbindung, anstatt einen zwischengespeicherten Status zu verwenden.

Beispiele

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

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

Datenform (--output json)

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

Name	Erforderlich	Zweck
<connection-id>	ja	Verbindungs-ID zur erneuten Authentifizierung.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--no-browser	Markieren	aus	Browser nicht automatisch öffnen; Drucken Sie die URL für die manuelle Navigation aus.
–	--no-wait	Markieren	aus	Geben Sie die ausstehenden Autorisierungsdetails sofort zurück, anstatt den Abschluss abzurufen.

Beispiele

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

Bei --no-wait hat die Antwort dieselbe Form für ausstehende Autorisierung wie unter create oben.

UIP ist eine Umbenennung für Verbindungen

Benennen Sie eine vorhandene Verbindung um.

Argumente

Name	Erforderlich	Zweck
<connection-id>	ja	Verbindungs-ID, die umbenannt werden soll.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--name	text	–	Erforderlich. Neuer Verbindungsname. Darf nicht leer sein.

Beispiel

uip is connections rename a1b2c3d4-0000-0000-0000-000000000001 \
    --name "Zoho Desk - Production"

Datenform (--output json)

{
  "Code": "ConnectionRenamed",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Zoho Desk - Production"
  }
}

Ein widersprüchlicher oder ungültiger neuer Name schlägt mit Failure fehl und verweist auf connections list, um die ID zu überprüfen und einen nicht widersprüchlichen Namen auszuwählen.

uip ist eine standardmäßig festgelegte Verbindung

Markieren Sie eine Verbindung als Standardverbindung für ihren Connector – die automatisch ausgewählte Verbindung, bei der ein Connector nur einen aktiven Standard zulässt.

Argumente

Name	Erforderlich	Zweck
<connection-id>	ja	Verbindungs-ID, die als Standard festgelegt werden soll.

Beispiel

uip is connections set-default a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "ConnectionSetDefault",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection set as default."
  }
}

uip ist das Update-Polling-Intervall der Verbindungen

Ändern Sie, wie oft die Verbindung nach Ereignissen abfragt (wird von ereignisgesteuerten Aktivitäten/Triggern verwendet, die auf dieser Verbindung basieren).

Argumente

Name	Erforderlich	Zweck
<connection-id>	ja	Zu aktualisierende Verbindungs-ID.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--polling-interval	Minuten	–	Erforderlich. Neues Abrufintervall in Minuten. Muss ein positiver Integer sein.

Beispiel

uip is connections update-polling-interval a1b2c3d4-0000-0000-0000-000000000001 \
    --polling-interval 15

Datenform (--output json)

{
  "Code": "ConnectionPollingIntervalUpdated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "PollingIntervalInMinutes": 15
  }
}

Ein nicht ganzzahliger oder nicht positiver Wert schlägt auf der Clientseite fehl, bevor eine Anforderung gesendet wird. Wenn die Verbindung kein konfigurierbares Abrufintervall unterstützt, weist der Server die Anforderung zurück – überprüfen Sie die Verbindungs-ID mit connections list --refresh und bestätigen Sie, dass der Connector Abrufe unterstützt.

UIP ist Verbindungs-Basis-URL

Rufen Sie die API-Basis-URL ab, auf die eine Verbindung derzeit aufgelöst wird – nützlich beim Erstellen einer unformatierten HTTP-Anforderung für die zugrunde liegende API des Connectors.

Argumente

Name	Erforderlich	Zweck
<connection-id>	ja	Zu überprüfende Verbindungs-ID.

Beispiel

uip is connections base-url a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "ConnectionBaseUrl",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "BaseUrl": "https://api.example.com/v2"
  }
}

Fehlerpunkte bei connections list zur Überprüfung der ID und zur Bestätigung, dass die Verbindung Enabled ist.

UIP ist Verbindungen löschen

Eine Verbindung löschen. Dies kann nicht rückgängig gemacht werden – die CLI fordert Sie nie auf.

Argumente

Name	Erforderlich	Zweck
<connection-id>	ja	Zu löschende Verbindungs-ID.

Optionen

Short	Long	Wert	Standard	Beschreibung
-y	--yes	Markieren	–	Erforderlich. Bestätigt diesen Vorgang, wenn er nicht rückgängig gemacht werden kann.

Beispiel

uip is connections delete a1b2c3d4-0000-0000-0000-000000000001 --yes

Datenform (--output json)

{
  "Code": "ConnectionDeleted",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection deleted successfully."
  }
}

Eine unbekannte Verbindungs-ID schlägt fehl, da Failure auf connections list --all-folders verweist. Sie wurde nicht gefunden.

Zugehörig

• uip is connectors – Connector-Schlüssel für create erkennen.
• uip is resources – resources run erfordert --connection-id von einer Verbindung hier.
• uip is activities – listet die Vorgänge auf, die die Verbindung ausführen kann.
• uip is triggers – Ereignis-Hooks wurden über eine Verbindung aktiviert.

Siehe auch

• Übersicht über das Integration Service-Tool
• Globale Optionen
• Exitcodes