uip ログアウト

uip logout、uip loginによって書き込まれた資格情報を削除します。このコマンドは、保存されているセッションをクリアします。それ以降に認証が必要な uip 呼び出しは、再度ログインするまで認証エラーが発生して失敗します。

概要

uip logout [-f <folder>]

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

引数

設定はありません。

オプション

• -f, --file <folder> — クリアする資格情報フォルダーへのパスです。省略すると、既定の資格情報フォルダーはクリアされます ( 「セッションと資格情報」を参照)。

例

# Remove the default session
uip logout

# Remove credentials from a project-scoped folder
uip logout -f ./.uipath

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

{
  "Code": "Message",
  "Data": {
    "Message": "Logged out successfully. Removed /path/to/.uipath"
  }
}

失敗した場合(通常はファイルシステムのアクセス許可の問題)、コマンドは Failure 結果を出力します Instructions: "Failed to logout. Check file permissions and try again."。

べき等性と CI の使用

セッションが存在しないときにログアウトすることは、スクリプトで注意する必要があるエラー状態ではありません。CLI は、クリーンアップしたフォルダー (または何もなかったこと) を参照する構造化された成功メッセージを出力します。これは、CIのティアダウンステップとして使用しても安全です。

関連

• uip login — 新しいセッションを開始します。
• uip login status — 現在のセッションを変更せずに検査します。
• 認証 — 資格情報モデルと外部アプリケーションのフロー
• セッションと資格情報 — uip logout のクリア元。