uip login

「uip login」の構文とオプション - UiPath CLI を UiPath Cloud に対して認証し、セッションをローカルに保持します。

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

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

概要

uip login [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--client-assertion <jwt>] [--scope <scopes>] [--no-browser] [-f <folder>]
uip login status
uip login refresh [--login-validity <minutes>]
uip login which
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip login profiles list [--all-fields]
uip login profiles delete [profile-name] [--all] -y

すべての uip login サブコマンドは、 グローバル オプション (--output、 --output-filter、 --log-level、 --log-file、 --profile、 --interactive/--no-interactive) を受け入れます。終了コードは 標準契約に従います。

uip login

ブラウザーを介して対話的に認証するか、外部アプリケーションのクライアント資格情報またはフェデレーション (ワークロード ID) OIDC トークンを使用して非対話的に認証します。

引数

設定はありません。

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。セッションは <folder>内に保持されます。指定しない場合、CLI はデフォルトの場所を使用します ( 「セッションと資格情報」を参照)。グローバル --profile フラグと相互に排他的です。
• --authority <url> — カスタム機関の URL です (例: https://cloud.uipath.com (既定)、 https://govcloud.uipath.us (公共部門向け)、Automation Suite ホスト)。https://プレフィックスは省略できます (cloud.uipath.com機能します)。
• --client-id <id> — UiPath 外部アプリケーションのクライアント ID またはアプリケーション ID。環境変数から読み取る env.NAME を受け入れます。
• --client-secret <secret> — 機密の外部アプリケーションのクライアント シークレットです。環境変数から読み取る env.NAME を受け入れます。--client-assertionと相互に排他的です。
• --client-assertion <jwt> — フェデレーション ログイン (ワークロード ID) 用の OIDC トークン (JWT) で、クライアント シークレットの代わりに使用されます。環境変数から読み取る env.NAME (推奨) を受け入れます — 生のトークンをリテラル値として渡すと警告が出力されます。そうしないと、シェル履歴、プロセス リスト、CI ログに記録されるためです。--client-idが必要です。--client-secretと相互に排他的です。
• -s, --scope <scopes> — コンマまたはスペースで区切られたスコープです (例: "OR.Folders OR.Jobs")。外部アプリケーション資格情報またはフェデレーション資格情報とともに使用します。
• -t, --tenant <name> — テナント名です (非対話型モード)。省略する場合は、グローバル --interactive フラグと組み合わせて、CLI でプロンプトを出せるようにします。
• --organization <name> — ブラウザーのログイン時に事前に選択される組織の論理名です。ユーザーが複数の組織に属している場合、組織の選択をバイパスします。クライアント資格情報またはフェデレーション ログインを使用する場合は無視されます (警告あり)。これらのフローでは組織が --client-id によって修正されます。
• --no-browser — ブラウザーを開かないAuthorize URL を stderr に出力し (Automation のプレフィックス UIPATH_AUTH_URL <url> を grep) に出力し、サインイン コールバックが到着するまでブロックします。ヘッドレス/オートメーション ドリブンなログインの場合。UIPATH_CLI_NO_BROWSER=trueでも設定できます。クライアント資格情報またはフェデレーション ログインを使用する場合は効果がありません (警告が表示されて無視されます)。どちらの方法でも、これらのフローではブラウザーは開かれません。ユーザーがサインインを行うときに、自分のターミナルでコマンドを実行してもらいます - エージェントのシェル ツールで実行すると、印刷された URL が非表示になります。

このページでは、ログイン固有 ではない 2 つのフラグについても説明します。完全な動作については、「 グローバル オプション 」をご覧ください。

• --interactive / --no-interactive — 認証後、クラウドによって返されるリストからテナントを選択するよう、対話型プロンプトに強制的 (または抑制) します。--it短縮形はありません。
• --profile <name> — 既定の資格情報の場所ではなく、名前付きで保存されているログイン プロファイルを使用します。-f, --fileと相互に排他的です。

資格情報モード

• 対話型/ユーザー資格情報 — uip login を実行します (必要に応じて --interactive、 --tenant、または --organizationを使用)。UiPath Cloud の認証でブラウザー フローが完了します。生成されたトークンは credentials フォルダー内に保持されます。
• 外部アプリケーション (クライアント資格情報、非対話型) — --client-id、 --client-secret、 --scopeを渡します。通常は --tenantを使用します。CI ランナーに適しています。--client-secret env.UIPATH_CLIENT_SECRETを使用して環境変数からシークレットを読み取り、シェル履歴に留まないようにします。
• フェデレーション/ワークロード ID (非対話型) — クライアント シークレットの代わりに --client-id と --client-assertion (前の手順で CI プロバイダーまたはワークロード ID ブローカーから取得した OIDC JWT) を渡します。--client-secret と --client-assertion を組み合わせることはできません。

例

# 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

# Log in to a non-default authority, e.g. an Automation Suite host
uip login --authority automation.acme-corp.com --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

# Federated login (workload identity) — the OIDC token comes from your CI provider
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-assertion env.CI_OIDC_TOKEN \
  --tenant DefaultTenant

# Headless / automation-driven login: print the authorize URL instead of opening a browser
uip login --no-browser --tenant DefaultTenant

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

データシェイプ (--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 ログインの更新

アクセス トークンを事前に更新し、機械判読可能なセッション ペイロード (アクセス トークン、組織/テナント ID、有効期限) を出力します。これは、今後数分間保証された有効なトークンを必要とするプログラムによるコンシューマー (IDE 拡張機能など) を対象としています。ステータス レポートである uip login statusとは異なり、トークンの有効期限がすでに切れているときに偶発的にのみトークンをローテーションします。 refresh は、必要に応じて事前にローテーションを強制します。

引数

設定はありません。

オプション

• --login-validity <minutes> — 現在のアクセス トークンの有効期限がこの分以内に切れた場合にのみ更新します。既定 5です。0渡すと、プロアクティブなチェックはスキップされ、トークンの有効期限が切れている場合にのみローテーションされます。範囲 0–525600 (1 年間)

例

# Refresh and print a token guaranteed valid for the next 5 minutes (the default)
uip login refresh --output json

# Require at least 10 minutes of validity, forcing a refresh if the token expires sooner
uip login refresh --login-validity 10 --output json

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

{
  "Code": "LoginRefresh",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant",
    "Expiration Date": "2026-04-18T10:30:00Z",
    "BaseUrl": "https://cloud.uipath.com",
    "OrganizationId": "00000000-0000-0000-0000-000000000001",
    "OrganizationName": "my-org",
    "TenantId": "00000000-0000-0000-0000-000000000002",
    "TenantName": "DefaultTenant",
    "AccessToken": "<jwt>"
  }
}

重要:

AccessTokenは、--output json有効で、--output明示的に渡されたか、標準出力が非対話型 (パイプ/リダイレクト) の場合にのみ含まれます。ターミナル内の裸の対話型 uip login refresh ではトークンが出力されることはありません — これは意図的なものであるため、トークンが誤ってスクロールバックに着地することはありません。更新されたトークンをディスクに永続化できなかった場合 (呼び出し元は現在のプロセスに対して有効で使用可能なトークンを取得します) LoginRefreshではなくCodeがLoginRefreshPartialされます。

故障モード

• ログインしていないか、更新に失敗したか、トークンの有効期限が切れて更新トークンがありません ( AuthenticationError、終了コード 2、 と、具体的な原因を示す Instructions 。

uip ログイン

現在の作業ディレクトリの認証 uip 読み元を出力します。これは、「セッションが選択されない理由」の正確な診断です。オプションはありません。常に、「 セッションと資格情報」に記載されているウォークアップ + ホーム フォールバックの解決について報告します。

引数

設定はありません。

オプション

設定はありません。

例

uip login which --output json

データシェイプ — ファイルベースのセッション (--output json)

{
  "Code": "AuthFile",
  "Data": {
    "Path": "/Users/me/projects/foo/.uipath/.auth",
    "Exists": true,
    "Source": "ancestor"
  }
}

Source 、ウォークアップ チェーンのどこでファイルが見つかったか (たとえば、 ancestor とホーム ディレクトリのフォールバックなど) を報告します。グローバル --profile フラグがアクティブなプロファイルに名前を付けると、応答には Profile フィールドも含まれます。

データシェイプ — 環境変数セッション (--output json)

を UIPATH_CLI_ENABLE_ENV_AUTH=trueすると、 which ファイルではなく env-var モードが報告されます。

{
  "Code": "AuthEnv",
  "Data": {
    "EnableVar": "UIPATH_CLI_ENABLE_ENV_AUTH",
    "AllVarsPresent": true,
    "MissingVars": [],
    "Vars": [
      "UIPATH_CLI_AUTH_TOKEN",
      "UIPATH_CLI_ORGANIZATION_NAME",
      "UIPATH_CLI_ORGANIZATION_ID",
      "UIPATH_CLI_TENANT_NAME",
      "UIPATH_CLI_TENANT_ID"
    ]
  }
}

MissingVars には値は含まれません。設定されていない変数名または空の変数名のみが含まれるため、応答は常に安全にチケットやチャットに貼り付けることができます。

故障モード

• ウォークアップ チェーンのどこにも資格情報ファイルが見つかりません ( AuthenticationError、終了コード 2、 uip login実行するための指示。
• 解決された資格情報ファイル パスは存在しますが使用できません (たとえば、ディレクトリがそのパスにある、またはファイルの権限によって読み取りがブロックされているなど)。 Failure、終了コード 1 — ホスト/ファイルシステムの問題であり、「再ログイン」の問題ではありません。

uip login tenant list

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

引数

設定はありません。

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。既定では、直前の uip loginで使用されたセッションが使用されます。グローバル --profile フラグと相互に排他的です。

例

uip login tenant list

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

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

引数

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

オプション

• -f, --file <folder> — 資格情報フォルダーへのパスです。既定では、直前の uip loginで使用されたセッションが使用されます。グローバル --profile フラグと相互に排他的です。

例

uip login tenant set DefaultTenant

データシェイプ (--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 ログイン プロファイルのリスト

~/.uipath/profiles (グローバル --profile フラグを参照) の下に格納されているすべての名前付きログイン プロファイルと、default資格情報の場所を一覧表示します。

オプション

• --all-fields — 各プロファイルの認証 URL、トークンの有効期限、資格情報ファイル パスも含めます。

例

uip login profiles list

{
  "Code": "ProfileList",
  "Data": [
    { "Name": "default", "Active": true, "OrganizationName": "acme", "TenantName": "DefaultTenant", "Status": "Logged in" },
    { "Name": "staging", "Active": false, "OrganizationName": "acme-staging", "TenantName": "QA", "Status": "Expired" }
  ]
}

uip login profiles list --all-fields

Url、 ExpiresAt、および Path は にのみ含まれ --all-fields。対話型の表では、 Status が Logged in されていないプロファイルが強調表示されます。

UIP ログイン プロファイルの削除

指定ログイン プロファイルとそこに保存されている資格情報を削除します。これはディスク上のファイルの実際の削除であり、元に戻すことはできません。

引数

• [profile-name] — 削除するプロファイルの名前です。を使用する場合は省略します --all。

オプション

• --all — 名前付きプロファイルを 1 つではなく、すべての名前付きプロファイルを削除します。
• -y, --yes — 削除を確定します。必須 — このコマンドでは対話形式でプロンプトは表示されません。

例

uip login profiles delete staging --yes

{ "Code": "Message", "Data": { "Message": "Deleted profile 'staging'. Removed /home/alice/.uipath/profiles/staging" } }

uip login profiles delete --all --yes

{
  "Code": "DeleteResult",
  "Data": [
    { "Name": "staging", "Status": "deleted" },
    { "Name": "prod", "Status": "deleted" }
  ]
}

故障モード

• プロファイル名と --allの両方を渡すか、両方を渡さないと、ディスクに触れる前に ValidationError で失敗します。
• この方法では削除できません。default は ~/.uipath/profilesに保存されないためdefault、代わりに uip logout を指すValidationErrorで失敗します。
• 同じ呼び出しで --profile <name> によって現在選択されているプロファイルを削除すると、 ValidationError で失敗します (そのフラグなしで再実行)。
• --allを使用すると、アクティブなプロファイル (存在する場合) は削除されるのではなく自動的にスキップされ、応答で Status: "skipped"で報告されます。スキップすると、削除するものが他に何も残らない場合、コマンドはサイレントに成功するのではなく、 ValidationError で失敗します。
• 不明なプロファイル名は、 を指す Code: "not_found"で失敗 login profiles list。

関連

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