uip is connections

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

uip is connections は、コネクタに対するテナントの OAuth セッションを管理します。コネクションは、UiPath テナント フォルダーと外部アカウント間の認証されたリンクです。実行時に resources run および activities 使用するトークンを保持します。動詞は、検出 (list、 export)、認証 (create、 edit)、健全性チェック (ping)、管理 (rename、 set-default、 update-polling-interval、 base-url、 delete) を対象としています。create して edit ブラウザーでコネクタの OAuth URL を開き、サーバーにポーリングを行って完了します (5 秒間隔、合計 5 分のタイムアウト)。

概要

uip is connections <verb> [options]

動詞

動詞	目的
list	コネクションのリストを表示します。任意で、コネクタ、フォルダー、または BYOA ステータスにスコープを設定します。
export	監査のためにすべての接続を (すべてのフォルダーにまたがって) エクスポートします。
create	コネクタの OAuth フローを使用して新しい接続を作成します。
ping	コネクションが現在有効化されていて、到達可能かどうかを確認します。
edit	OAuth フローを使用して既存の接続を再認証します。
rename	既存のコネクションの名前を変更します。
set-default	コネクションをコネクタの既定として指定します。
update-polling-interval	接続のポーリング間隔を変更する
base-url	接続が解決される API ベース URL を取得します。
delete	接続を削除します (破壊的、 -y/--yesが必要)。

uip is connections list

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--folder-key	UUID	—	特定のフォルダー内のコネクションを検索します。UUID である必要があります。--all-foldersと相互に排他的です。
—	--connection-id	id	—	フィルターを適用して特定のコネクション ID に絞り込みます。
—	--byoa	フラグ	無効	フィルターを適用し、BYOA (自分のアカウントを使用) のコネクションのみに絞り込む。
—	--all-folders	フラグ	無効	既定のスコープではなく、すべてのフォルダーにわたってコネクションを検索します。--folder-key と相互に排他的です。それらを結合すると、要求が行われる前にFailureで結合が失敗します。
—	--refresh	フラグ	無効	キャッシュを無視して、API からの再取得を強制します。

例

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

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

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

uip is コネクションのエクスポート

監査のために、すべてのフォルダーのすべての接続をエクスポートします。引数やコネクションのスコープ設定オプションを受け取らず、常にテナント全体をカバーします。

引数

設定はありません。

例

uip is connections export

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

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

Data は、配列ではなくコネクション ID によってキーとなるマップです。テナントにコネクションがまったくない場合は、代わりに {"Code": "Message", "Data": {"Message": "No connections found to export."}}応答になります。

uip is connections create

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--no-browser	フラグ	無効	ブラウザを自動的に開かないでください。手動ナビゲーション用の URL を出力します。
—	--no-wait	フラグ	無効	完了をポーリングするのではなく、保留中の認可の詳細 (SessionId、 AuthUrl) をすぐに返します。

例

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

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

--no-waitの場合、応答は保留中の認可になります。

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

失敗モード:

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

uip is connections ping

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--force-refresh	フラグ	無効	キャッシュされたステータスを使用する代わりに、ライブ接続ステータスの更新を強制します。

例

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

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

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

{
  "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 is connections edit

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

引数

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

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--no-browser	フラグ	無効	ブラウザを自動的に開かないでください。手動ナビゲーション用の URL を出力します。
—	--no-wait	フラグ	無効	完了をポーリングするのではなく、保留中の認可の詳細をすぐに返します。

例

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

--no-waitの場合、応答は上記の create に示したのと同じ [保留中の認可] の形状になります。

uip はコネクションの名前変更です

既存のコネクションの名前を変更します。

引数

名前	Required	目的
<connection-id>	○	名前を変更するコネクション ID です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--name	text	—	必須。新しいコネクション名。空にすることはできません。

例

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

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

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

競合する新しい名前や無効な新しい名前は、 を Failureして失敗し、 connections list をポイントして ID を確認し、競合しない名前を選択します。

uip は connections set-default

コネクションをコネクタの既定のコネクションとしてマークします。コネクタでアクティブな既定のコネクションが 1 つしか許可されない場合に、自動的に選択されるコネクションです。

引数

名前	Required	目的
<connection-id>	○	既定として設定するコネクション ID です。

例

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

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

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

uip は接続 update-polling-interval です。

コネクションがイベントをポーリングする頻度 (このコネクション上に構築されたイベント ドリブンなアクティビティ/トリガーで使用) を変更します。

引数

名前	Required	目的
<connection-id>	○	更新するコネクション ID です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
—	--polling-interval	分	—	必須。新しいポーリング間隔 (分)正の整数である必要があります。

例

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

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

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

整数以外の値または非正の値は、要求が送信される前にクライアント側で失敗します。接続で設定可能なポーリング間隔がサポートされていない場合、サーバーは要求を拒否します。 connections list --refresh でコネクション ID を確認し、コネクタがポーリングをサポートしていることを確認します。

uip はコネクションのベース URL です。

接続が現在解決される API ベース URL を取得します。これは、コネクタの基盤となる API に対する生の HTTP 要求を構築する場合に便利です。

引数

名前	Required	目的
<connection-id>	○	検査するコネクション ID です。

例

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

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

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

ID を確認し、接続がEnabledであることを確認するための connections list に失敗ポイントを示します。

uip はコネクションです delete

コネクションを削除します。これは元 に戻せません 。CLI はプロンプトを表示しません。

引数

名前	Required	目的
<connection-id>	○	削除するコネクション ID です。

オプション

Short	長押し	値 (Value)	既定 (Default)	説明
-y	--yes	フラグ	—	必須。この元に戻せない操作を確認します。

例

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

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

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

不明なコネクション ID を使用すると、 Failure が connections list --all-folders をポイントして検索できません。

関連

• uip is connectors — createのコネクタ キーを検出します。
• uip is resources — resources run はここでコネクションからの--connection-idが必要です。
• uip is activities — 接続で実行できる操作を一覧表示します。
• uip is triggers — 接続によってアクティブ化されるイベント フック。

参照

• Integration Service ツールの概要
• グローバル オプション
• 終了コード