- 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
uip login status
Syntax and options for `uip login status`, which reports the current authentication state without refreshing tokens.
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
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.
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
# Human-readable (default table output)
uip login status
# JSON for scripts
uip login status --output json
Data shape (--output json)
{
"Code": "LoginStatus",
"Data": {
"Status": "Logged in",
"Identity": "[email protected]",
"IdentityType": "User",
"AuthFlow": "Interactive",
"CredentialSource": "SavedLogin",
"Organization": "my-org",
"OrganizationId": "00000000-0000-0000-0000-000000000001",
"Tenant": "DefaultTenant",
"TenantId": "00000000-0000-0000-0000-000000000002",
"Expiration Date": "2026-04-18T10:30:00Z"
}
}
{
"Code": "LoginStatus",
"Data": {
"Status": "Logged in",
"Identity": "[email protected]",
"IdentityType": "User",
"AuthFlow": "Interactive",
"CredentialSource": "SavedLogin",
"Organization": "my-org",
"OrganizationId": "00000000-0000-0000-0000-000000000001",
"Tenant": "DefaultTenant",
"TenantId": "00000000-0000-0000-0000-000000000002",
"Expiration Date": "2026-04-18T10:30:00Z"
}
}
Status— one ofLogged inorNot logged in. When not logged in, most fields below are omitted andOrganization/Tenantfall back toN/A.Identity— who is acting: a user's email for interactive sessions, or"External application <clientId>"for a client-credentials/federated session. Omitted when it can't be determined.IdentityType—"User"or the External App's type. Present wheneverIdentityis.AuthFlow— how the identity was proven:"Interactive","ClientCredentials", or"FederatedCredentials". Present when known.CredentialSource— where the session came from:"Robot","EnvironmentVariables","SavedLogin", or"N/A".UserId/UserEmail/UserName/ClientId— additional identity detail, each present only when the underlying session actually carries that field.Profile— the active named profile, when one is set and the session is file-based.Organization— organization name when available; otherwise the organization ID.OrganizationId— present alongsideOrganizationwhen the ID is known separately from the name.Tenant— tenant name when available; otherwise the tenant ID.N/Aif no tenant is selected.TenantId— present alongsideTenantwhen the ID is known separately from the name.BaseUrl— the resolved identity/API base URL, when known.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, an opaque PAT session reports"Token is opaque (not a JWT) - expiration and identity cannot be determined locally. Commands will fail with 401 once it is revoked or expired."instead of an expiration date.Provider(deprecated) — a legacy, lower-fidelity version ofCredentialSource("Robot"/"Environment"/"File"/"N/A"), kept for one release for existing scripts. ReadCredentialSourceinstead;Providerwill be removed.
Exactly which fields appear depends on the auth flow — a PAT/environment-variable session, for example, has no Identity/AuthFlow (the token carries no claims to derive them from) but does carry CredentialSource and BaseUrl.
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.
Related
uip login— authenticate and pick a tenant.uip logout— clear the stored session.- Authentication — what
Statusreflects and how tokens are refreshed. - Sessions and credentials — folder location and override rules.