uip エージェント リスト/共有

uip agent list と uip agent share はどちらも Studio Web ソリューション上で動作します。Studio Web ソリューションは 、エージェント プロジェクトのクラウド側での表現です。list は、現在のユーザーに表示されるソリューションを列挙します。 share は、1 つのソリューションへのユーザーとグループのアクセスを管理します。以下にグループ化したのは、どちらも純粋な Studio Web の管理動詞であり、 uip agent file でのファイル レベルの操作や [ deploy / run] での Orchestrator 側の操作とは異なるためです。

どちらの動詞にも、アクティブなCLIセッション(uip login)が必要です。

すべてのサブコマンドは、 グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を優先します。終了コードは 標準コントラクトに従います。

---

UIP エージェント リスト

Studio Web のソリューションのリストを取得します。必要に応じて、キーワードでフィルター処理します。

概要

uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]

引数

設定はありません。

オプション

フラグ	既定 (Default)	目的
-s, --search <query>	—	Studio Web SearchSolutionsAndProjects エンドポイントに適用されるキーワード フィルターです。
-l, --limit <n>	20	結果の最大数。pagingOptions.limitクエリ パラメーターとして送信されます。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

# Simplest — list up to 20 solutions
uip agent list

# Filter by keyword
uip agent list --search invoice

# Page through larger result sets
uip agent list --limit 100

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

{
  "Code": "AgentList",
  "Data": [
    {
      "Name": "Email Triage",
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Status": "Completed",
      "PublishStatus": "Published",
      "LastModified": "2025-04-10T14:30:00Z",
      "Projects": 2
    }
  ]
}

結果セットが空の場合、空の配列の代わりに Data: { "Message": "No solutions found" } が生成されます。Projects は、コンポーネントではなく、ソリューション内に入れ子になったプロジェクトの数です。

---

uip エージェント共有

Studio Web ソリューションへのユーザーとグループのアクセス権を管理する。3 つのサブコマンド: add、 list、および remove。

概要

uip agent share add    <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list   <solutionId>                                   [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId>                        [--group] [--login-validity <minutes>]

uipエージェント共有追加

ユーザーまたはグループにアクセス権を付与します。

引数

• <solutionId> (必須) — ソリューション UUID。
• <entityId> (必須) — ユーザーまたはグループの UUID。

オプション

フラグ	既定 (Default)	目的
--permission <perm>	write	権限レベル。none、read、write、publish、readWritePublishのいずれか。大文字 小文字;無効な値は検証エラーで失敗します。
--group	Off (ユーザー)	<entityId>ユーザーとしてではなくグループとして扱います。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

# Grant write access to a user
uip agent share add \
  a1b2c3d4-0000-0000-0000-000000000001 \
  a1b2c3d4-0000-0000-0000-000000000501 \
  --permission write

# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group

# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish

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

{
  "Code": "AgentShare",
  "Data": {
    "Status": "Solution shared successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
    "IsGroup": false,
    "Permission": "write"
  }
}

UIP エージェント共有リスト

ソリューションへのアクセス権を持つユーザーとグループのリストを取得します。

引数

• <solutionId> (必須) — ソリューション UUID。

オプション

--login-validityのみです。

例

uip agent share list a1b2c3d4-0000-0000-0000-000000000001

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

{
  "Code": "AgentShareList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000501",
      "Name": "Jane Doe",
      "Email": "[e-mail]",
      "IsGroup": false,
      "Permission": "write"
    }
  ]
}

空の応答は Data: { "Message": "No sharing permissions found for this solution" }を返します。

uipエージェント共有削除

ユーザーまたはグループのアクセス権を取り消す。

引数

• <solutionId> (必須) — ソリューション UUID。
• <entityId> (必須) — ユーザーまたはグループの UUID。

オプション

フラグ	既定 (Default)	目的
--group	Off (ユーザー)	<entityId>ユーザーとしてではなくグループとして扱います。
--login-validity <minutes>	10	トークンの有効期間は、最小時間 (分) です。

例

uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501

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

{
  "Code": "AgentShareRemove",
  "Data": {
    "Status": "Access removed successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
  }
}

---

関連

• uip agent push — プロジェクトをインポートし、ここで使用するSolutionIdを取得します。
• uip agent pull — listによってリストされたソリューションをダウンロードします。
• uip agent file — ソリューションのプロジェクト内のファイルを一覧表示、ダウンロード、アップロードします。

参照

• 認証 — セッション、テナント、および --login-validity。
• グローバル オプション、 終了コード。