UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

uip はコネクションです。

UiPath テナントと外部コネクタ間の OAuth セッションを管理する「uip is connections」の構文とオプション。

コネクタに対するテナントの OAuth セッションを uip is connections で管理します。コネクションとは、UiPath のテナント フォルダーと外部アカウント間の認証されたリンクです。実行時に resources execute および activities 使用するトークンを運びます。動詞は、検出 (list)、認証 (createedit)、および健全性チェック (ping) をカバーします。createedit はどちらも、ブラウザーでコネクタの OAuth URL を開き、サーバーの完了をポーリングします (5 秒間隔、合計 5 分のタイムアウト)。

概要

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

動詞

動詞目的
list接続のリストを取得します。必要に応じて、スコープをコネクタまたはフォルダーに設定します。
createコネクタの OAuth フローを使用して新しい接続を作成します。
pingコネクションが現在有効化されていて、到達可能かどうかを確認します。
editOAuth フローを使用して既存の接続を再認証します。

uip はコネクション リストです。

テナント内のコネクションのリストを取得します。オプションの位置指定 <connector-key> では、結果をフィルター処理して 1 つのコネクタに絞り込みます。フラグのスコープは、フォルダー ID または 1 つのコネクション ID で設定できます。

引数

名前Required目的
[connector-key]×フィルター処理に使用するコネクタ キー (例: [ uipath-zoho-desk] を選択します。すべてのコネクタのリストを省略します。

オプション

Short長押し値 (Value)既定 (Default)説明
--folder-keyUUIDフィルター処理に使用するフォルダー キーです。UUID である必要があります。
--connection-ididフィルターを適用して特定のコネクション ID に絞り込みます。
-t--tenantnameセッションの既定値テナントを上書きします。
--refreshフラグ無効キャッシュを無視して、API からの再取得を強制します。

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

データシェイプ(--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"
    }
  ]
}

一部の接続が無効化されている場合、応答には Warning フィールドと Dataが含まれます。UUID ではない無効な --folder-key は、事前に拒否されます。

uip は接続を作成します。

コネクタの OAuth フローを使用して新しい接続を作成します。CLI はブラウザで認証 URL を開き ( --no-browserを渡さない限り)、サーバーの完了をポーリングします。ポーリング間隔: 5 秒。合計タイムアウト: 5 分。

引数

名前Required目的
<connector-key>コネクタ キー (例: uipath-zoho-desk

オプション

Short長押し値 (Value)既定 (Default)説明
-t--tenantnameセッションの既定値テナントを上書きします。
--no-browserフラグ無効ブラウザを自動的に開かないでください。手動ナビゲーション用の URL を出力します。

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

データシェイプ(--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"
  }
}

失敗モード:

  • ユーザーが拒否または認証に失敗する: サーバーのメッセージで Failure します。 1を終了します。
  • ポーリング タイムアウト (5 分): Failure: "Authentication timed out after 5 minutes"; 2を終了します。
  • ポーリングの転送エラー: Failure; 1を終了します。
  • 中断/中止 (Ctrl+C): Failure; 1を終了します。

uipは接続pingです

コネクションが現在有効化されていて、到達可能かどうかを確認します。

引数

名前Required目的
<connection-id>connections list または connections createによって返される接続 ID (UUID)。

オプション

Short長押し値 (Value)既定 (Default)説明
-t--tenantnameセッションの既定値テナントを上書きします。

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

データシェイプ(--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."
  }
}

無効または到達不能な接続は、Instructions: "Run 'uip is connections edit <id>' to re-authenticate."とのFailureを出力します。

uipは接続編集です

既存のコネクションを再認証します。createと同じ OAuth フローで、新しいコネクション ID を発行するのではなく、既存のコネクション ID を対象とするものです。ポーリングコントラクトと終了コードは同じです。

引数

名前Required目的
<connection-id>再認証するコネクション ID。

オプション

Short長押し値 (Value)既定 (Default)説明
-t--tenantnameセッションの既定値テナントを上書きします。
--no-browserフラグ無効ブラウザを自動的に開かないでください。手動ナビゲーション用の URL を出力します。

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

データシェイプ(--output json)

{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}
{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}
  • uip is connectorscreateのコネクタ キーを検出します。
  • uip is resourcesexecute動詞には、ここでの接続からの--connection-idが必要です。
  • uip is activities — 接続で実行できる操作を一覧表示します。
  • uip is triggers — 接続によってアクティブ化されるイベント フック。

参照

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得