UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP 登录状态

“uip Login status”的语法和选项,可在不刷新令牌的情况下报告当前身份验证状态。

uip login status报告当前的身份验证状态:您是否已登录、选择了哪个组织和租户,以及访问令牌的过期时间。这是对存储会话的只读检查 — 此命令不会刷新令牌。

在脚本中使用它来控制后续工作,或以交互方式使用,以确认后续uip调用将针对哪个租户。

大纲​

uip login status
uip login status

此命令采用全局选项( --output 、 --output-filter 、 --log-level 、 --log-file )。退出代码遵循标准合同。

参数​

无。

选项​

无。

备注:

login status不接受-f, --file <folder> — 它始终读取默认凭据位置。如果使用非默认凭据文件夹,请在检查状态之前在该文件夹中重新运行相应的uip login ...命令。

示例​

# 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

数据形状(--输出 json)​

{
  "Code": "LoginStatus",
  "Data": {
    "Status": "Logged in",
    "Identity": "jane.doe@example.com",
    "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": "jane.doe@example.com",
    "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 — Logged in 或 Not logged in 之一。未登录时,以下大多数字段都会被省略,并且 Organization/Tenant 会回退为 N/A。
  • Identity — 正在执行操作的用户:用户的电子邮件(对于交互式会话),或 "External application <clientId>"(对于客户端凭据/联合会话)。无法确定时可省略。
  • IdentityType — "User" 或外部应用程序的类型。只要存在 Identity,就会显示。
  • AuthFlow — 如何证明身份:"Interactive"、"ClientCredentials" 或 "FederatedCredentials"。已知时存在。
  • CredentialSource — 会话的来源地:"Robot"、"EnvironmentVariables"、"SavedLogin" 或 "N/A"。
  • UserId / UserEmail / UserName / ClientId — 其他身份详细信息,仅当基础会话实际携带该字段时才会显示。
  • Profile — 活动的命名配置文件(如果已设置)并且会话基于文件。
  • Organization — 组织名称(如果可用);否则为组织 ID。
  • OrganizationId — 当 ID 与名称分开时,与 Organization 一起显示。
  • Tenant — 租户名称(如果可用);否则为租户 ID。如果未选择任何租户,则为N/A 。
  • TenantId — 当 ID 与名称分开时,与 Tenant 一起显示。
  • BaseUrl — 已解析的身份/API 基本 URL(如果已知)。
  • Expiration Date — 访问令牌过期的 ISO-8601 时间戳。此处未刷新;稍后的工具调用将根据需要刷新令牌。
  • Hint (可选) — 当身份验证层要显示某些内容时的咨询文本,例如,不透明的 PAT 会话报告"Token is opaque (not a JWT) - expiration and identity cannot be determined locally. Commands will fail with 401 once it is revoked or expired."而不是到期日期。
  • Provider (已弃用) — CredentialSource ( "Robot" / "Environment" / "File" / "N/A" )的低保真旧版,为现有脚本保留一个版本。改为读取 CredentialSource;系统将删除 Provider。

确切会显示哪些字段取决于身份验证流程 - 例如,PAT/环境变量会话没有 Identity/AuthFlow(令牌不包含可派生的声明),但确实包含 CredentialSource 和 BaseUrl。

错误行为​

当存储的会话无法读取或回退环境变量 ( UIPATH_CLI_* ) 不完整时,CLI 会发出ConfigError异常。Instructions字段将引导您找到正确的根本原因:

  • 如果正在使用环境变量但配置不正确,则说明为"Check the UIPATH_CLI_* environment variables and re-run."
  • 否则,说明将指向磁盘上的“凭据”文件夹。

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新