uip logout

uip logout removes the credentials written by uip login. The command clears the stored session; subsequent uip calls that need auth will fail with an authentication error until you log in again.

Synopsis

uip logout [-f <folder>]

All uip logout subcommands honor the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the standard contract.

引数

設定はありません。

オプション

• -f, --file <folder> — Path to the credentials folder to clear. If omitted, the default credentials folder is cleared (see Sessions and credentials).

例

# Remove the default session
uip logout

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

Data shape (--output json)

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

On failure — typically a filesystem permissions issue — the command emits a Failure result with Instructions: "Failed to logout. Check file permissions and try again.".

Idempotency and CI usage

Logging out when no session exists is not an error condition you need to guard against in scripts; the CLI emits a structured success message referencing the folder it cleaned up (or the fact that nothing was there). This is safe to use as a teardown step in CI.

Related

• uip login — start a new session.
• uip login status — inspect the current session without modifying it.
• Authentication — credential model and External Application flow.
• Sessions and credentials — where uip logout clears from.