- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Syntax and options for `uip logout`, which removes the stored credentials written by `uip login`.
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>]
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.
Arguments
None.
Options
-f, --file <folder>— Path to the credentials folder to clear. If omitted, the default credentials folder is cleared (see Sessions and credentials). Mutually exclusive with the global--profileflag — passing both fails withValidationError: option '--profile' cannot be used with option '--file'.
Examples
# Remove the default session
uip logout
# Remove credentials from a project-scoped folder
uip logout -f ./.uipath
# 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"
}
}
{
"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 logoutclears from.