uip ログイン

uip login は UiPath Cloud に対して CLI を認証し、結果のセッションをローカルの .uipath/ フォルダー内に保持します。成功すると、CLI にはアクセス トークンと選択されたテナントがあります。後続のコマンドによって実行されるツールは、これらを自動的に取得します。資格情報モデルについては「 認証 」を、フォルダーが存在する場所については 「セッションと資格情報 」をご覧ください。

ステータスを確認するには、「 uip login status」をご覧ください。セッションを破棄するには、「 uip logout」をご覧ください。

概要

uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]

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

uip ログイン

ブラウザーを介して対話的に認証するか、外部アプリケーションのクライアント資格情報を使用して非対話的に認証します。

引数

設定はありません。

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。セッションは <folder>内で保持されます。指定しない場合、CLI はデフォルトのロケーションを使用します( セッションとクレデンシャルを参照)。
• --authority <url> — カスタム認証局の URL。既定以外のクラウドに使用します。
• --client-id <id> — UiPath 外部アプリケーションのクライアント ID またはアプリケーション ID。環境変数から読み取る env.NAME を受け入れます。
• --client-secret <secret> — 機密の外部アプリケーションのクライアント シークレットです。環境変数から読み取る env.NAME を受け入れます。
• -s, --scope <scopes> — スペースで区切られたスコープ (例: "OR.Folders OR.Jobs")。外部アプリケーションの資格情報と併用します。
• -t, --tenant <name> — テナント名 (非対話モード)。省略した場合は、 --interactiveとペアにします。
• --organization <name> — ブラウザーのログイン時に事前に選択された組織の論理名です。ユーザーが複数の組織に属している場合に、組織ピッカーをバイパスします。
• --it, --interactive — 認証後、クラウドから返されたリストからテナントを選択するよう対話形式でプロンプトを表示します。

Credential modes

• 対話型/ユーザー資格情報 — uip login を実行します (必要に応じて --interactive、 --tenant、または --organizationを使用)。UiPath Cloud の認証でブラウザー フローが完了します。生成されたトークンは credentials フォルダー内に保持されます。
• 外部アプリケーション (非対話型) — --client-id、 --client-secret、および --scopeを渡します。通常は --tenantを使用します。CIランナーに適しています。--client-secret env.UIPATH_CLIENT_SECRET を使用して環境変数からシークレットを読み取り、シェル履歴から除外します。

例

# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath

Data shape (--output json)

{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}

故障モード

• 非対話型ログイン後にテナントが見つからない場合、Message: "No tenant selected"を含むConfigErrorが発生し、--tenant <name>または--interactiveで再実行するように指示します。
• 機関からのトランスポート エラーと 2xx 以外の応答は AuthenticationErrorとして表示され、元の HTTP ステータスは Context.httpStatus になります。
• --client-id / --client-secret の env.NAME 参照の形式が正しくないと、ネットワーク呼び出しの前にConfigErrorが生成されます。

uip ログイン テナント リスト

現在の組織の認証済みユーザーに表示されるすべてのテナントのリストを取得します。アクティブなログインが必要です。

引数

設定はありません。

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。既定値は、直近の uip loginで使用されるセッションです。

例

uip login tenant list

Data shape (--output json)

{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}

セッションがログインしていない場合、コマンドは AuthenticationError を出力し、最初に uip login を実行するように指示します。

uip login テナント セット

アクティブなテナントを名前で選択します。login tenant listによって返されるリストにテナントが存在する必要があります。CLI は、保存したセッションを新しい選択で更新します。

引数

• <name> (必須) — uip login tenant listによって返されるテナント名。

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。既定値は、直近の uip loginで使用されるセッションです。

例

uip login tenant set DefaultTenant

Data shape (--output json)

{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

故障モード

• テナント名が不明な場合は、利用可能なテナントをInstructionsにリストしたValidationErrorが生成されます (例: argument should be one of DefaultTenant, ProductionTenant)。
• CLI が保存されたセッションを更新できない場合、エラーは権限に関連するヒントとともに Failure として表示されます。

関連

• uip login status — 現在のセッションを更新せずに表示します。
• uip logout — 保存済みセッションをクリアします。
• 認証 — ユーザーフローと外部アプリケーションフロー。
• セッションと資格情報 — 資格情報フォルダーの配置方法とローテーション方法。
• 構成 — 資格情報ソースの優先順位 (環境変数、ファイル、フラグ)。