セッションと資格情報

uip セッションとは、コマンドを特定の UiPath の組織およびテナントにバインドするステートです。これにより、呼び出しのたびにユーザーに確認メッセージを表示せずに、CLI に有効なアクセス トークンを提示できます。セッションは、対話型フローと外部アプリ フローではディスク上に保持され、環境変数フローでは環境変数から再構築されます。このページでは、そのステートが存在する場所、 uip ステートを見つける方法、およびテナントまたはマシン間を移動する際に予期される事項について説明します。

credentials フォルダー

uip login は、 .uipath/という名前のフォルダー内にセッションを保持します。その内容は不透明として扱います — それらは uip login、 uip login tenant set、および uip logoutによって管理され、ディスク上のレイアウトはリリース間で変更される可能性のある実装の詳細です。フォルダーは、アクセス トークン、更新トークン、およびアクティブな組織とテナントを保持します。

フォルダーを保護します。このフィードには、取り消されるまでセッションを偽装できるトークンが含まれています。マルチユーザー環境または共有環境では、内容に対する通常の 0600 権限でホームディレクトリに保持します。開発者のマシンでは、通常、置く場所に置いておくだけで十分です uip login 。プロジェクトローカル セッションが開発者ごとの場合は、.gitignoreに.uipath/を追加します。

場所の解決(ウォークアップ)

uipコマンドを実行すると、CLI は次の順序で credentials フォルダーを検索します。

1. 明示的なパス — コマンドが -f /path/to/folderで呼び出された場合、そのフォルダーが使用されます。パスは絶対パスでも相対パスでもかまいません。
2. 現在のディレクトリからステップ — cwdから始めて、CLI は ./.uipath/をチェックし、親チェーンをさかのぼって同じフォルダーを探します。最初に見つけたものが勝ちます。
3. ユーザーホーム —ウォークアップでプロジェクトローカルフォルダーが見つからなかった場合、CLIは ~/.uipath/にフォールバックします。

uip login 、次のコマンドで読み取られるパスに書き込みます。

• ウォークアップチェーンに既存の.uipath/があるディレクトリ内でuip loginを実行した場合、ログインによってそのセッションが更新されます。
• それ以外の場合は、ホーム ディレクトリに ~/.uipath/ が作成されます。

なぜウォークアップなのか?

cwdから上に移動すると、ホームディレクトリを変更せずにプロジェクトフォルダで独自のセッションを実行できます。リポジトリ ルートに .uipath/ フォルダーを配置すると、リポジトリ内から uip を実行するすべてのユーザーがそのプロジェクトのログインを取得するため、プロジェクトごとのクライアント資格情報、ステージング テナント、またはデモ環境に役立ちます。

場所を上書きする

ルックアップをオーバーライドする3つの方法:

• uip loginおよびuip logoutで-f, --file <folder> — このコマンドにのみ、指定したフォルダーを使用します。
• 別のホームディレクトリ — 共有ビルドサーバー上で、 HOME=/srv/build-home uip login を実行して /srv/build-home/.uipath/に書き込みます。
• uip completion およびその他のコマンドは -f フラグを立てず、常にウォークアップ+ホームフォールバックを使用します。

検査用:

# print the current session status (reads via walk-up)
uip login status

uip login status は常にウォークアップ+ホームフォールバックを介して読みます。 -fは受け付けません。既定以外のフォルダーのセッションを検査するには、 uip login statusを実行する前にそのディレクトリ (またはそのサブディレクトリ) に移動するか、 uip login tenant list -f /path/to/credsで利用可能なテナントのリストを表示します。

アクティブな組織とテナント

1 つのセッションでは、一度に 1 つの組織と 1 つのテナントが保存されます。テナントとは、フォルダー、ジョブ、キュー、リソースのスコープを設定する UiPath の概念であり、事実上、テナントを実行するたびに CLI が到達する「アカウント」 uip or …。

再認証を行わずにアクティブなテナントを変更する

uip login tenant list           # show all tenants this session can access
uip login tenant set MyTenant   # switch the active tenant

ユーザーの見えないところで、 uip login tenant set は新しいテナント用に新しいアクセス/更新トークンを作成し、保存されているセッションをその場で更新します。

uip or …呼び出しで--tenant <name>を渡し、ディスク上のセッションを変更することなく、セッションのアクティブなテナントを 1 つのコマンドで上書きします。

uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production

トークンを更新する

アクセス トークンの有効期間が短いCLI は、保存されているアクセストークンの有効期限が近づいていることを検出した場合、更新トークンを使用して新しいトークンを要求し、保存されているセッションをサイレントに更新します。以下のいずれかが発生しない限り、 uip login を再実行する必要はありません。

• 更新トークン自体の有効期限が切れるか、取り消されます (通常、何週間も操作されなかった後、または管理者が強制的にサインアウトした場合)。
• 組織を変更した。
• セッションの認証に使用されたスコープとは異なるスコープ セットが必要です。

uip login status は、更新に失敗すると Expired を報告します。これは、再び uip login を実行するための合図です。

環境変数フロー (ファイルなし)

3 番目の認証フローは UIPATH_CLI_ENABLE_ENV_AUTH=trueによって有効化され、資格情報フォルダーが完全にバイパスされます。すべての uip コマンドは、環境変数からトークンとテナントを読み取り、それらをそのまま使用し、ディスクには何も書き込みません。

これは、次の場合に適しています。

• 親パイプラインからトークンを受け取るコンテナー。
• ディスクへの資格情報の永続化が無駄であるか、禁止されているエフェメラル CI ランナー。
• 呼び出し間でCLIをステートレスにする必要がある環境。

ファイルベースのフローとの違い:

• 更新なし。トークンは uip に対して不透明であり、有効期限が切れている場合は、呼び出し元がトークンをローテーションする責任があります。
• uip logout は何もしません。削除するファイルはありません。環境変数の設定を解除して「サインアウト」します。
• ベース URL はトークンから派生します。JWTが伝えるiss主張が何であれ、権威あるものとして扱われます—UIPATH_URLUIPATH_CLI_AUTH_TOKENと並行して設定しないでください。

変数の完全なセットと GitHub Actions / コンテナーの例については、 認証 — フロー 3 を参照してください。

サインアウトする

ファイルベースのフロー:

uip logout                        # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds      # clear a specific credentials folder

logout 保存されているセッションをクリアします。後続の uip or … 呼び出しは、uip login を再度実行するまで AuthenticationError (終了コード 2) で失敗します。サーバー側でもセッションを無効にするには、Automation Cloud で外部アプリのシークレットを取り消すか、ユーザー アカウントからサインアウトします。

環境変数フロー: UIPATH_CLI_ENABLE_ENV_AUTH (および安全のためにトークン変数) の設定を解除します。

参照

• 認証 — credentials フォルダーを書き込むかバイパスする 3 つのフローです。
• 構成 — 環境変数の優先順位は、資格情報フォルダーの横にありますが、別の場所にあります。
• uip login reference、 uip login status reference、 uip logout reference — コマンドごとのフラグリストと例。
• UiPath CLI のインストール — 資格情報とデータの削除 — アンインストール後のクリーンアップ