Skip to main content

uip login status

uip login status reports the current authentication state: whether you are logged in, which organization and tenant are selected, and when the access token expires. It is a read-only inspection of the stored session — no tokens are refreshed by this command.

Use it in scripts to gate follow-on work, or interactively to confirm which tenant a subsequent uip call will target.

Synopsis​

uip login status

This command honors the global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the standard contract.

Arguments​

None.

Options​

None.

note

login status does not accept -f, --file <folder> — it always reads the default credentials location. If you use a non-default credentials folder, re-run the corresponding uip login ... command in that folder before checking status.

Examples​

# Human-readable (default table output)
uip login status

# JSON for scripts
uip login status --output json

Data shape (--output json)​

{
  "Code": "LogIn",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant",
    "Expiration Date": "2026-04-18T10:30:00Z"
  }
}
  • Status — one of Logged in or Not logged in. When not logged in, Organization and Tenant fall back to N/A.
  • Organization — organization name when available; otherwise the organization ID.
  • Tenant — tenant name when available; otherwise the tenant ID. N/A if no tenant is selected.
  • Expiration Date — ISO-8601 timestamp of the access token's expiration. This is not refreshed here; a later tool invocation will refresh the token if needed.
  • Hint (optional) — advisory text when the auth layer has something to surface (for example, "token is close to expiry").

Error behavior​

When the stored session is unreadable or the environment-variable fallback (UIPATH_CLI_*) is incomplete, the CLI emits a ConfigError. The Instructions field steers you to the correct root cause:

  • If environment variables are being used but are misconfigured, instructions read "Check the UIPATH_CLI_* environment variables and re-run."
  • Otherwise, instructions point at the credentials folder on disk.