UIP 登录

"uip Login" 的语法和选项，用于根据 UiPath Cloud 对 UiPath CLI 进行身份验证，并将会话在本地保留。

uip login针对 UiPath Cloud 对 CLI 进行身份验证，并将生成的会话保留在本地.uipath/文件夹中。成功后，CLI 具有访问令牌和选定的租户；后续命令运行的工具将自动选择这些命令。有关凭据模型，请参阅“身份验证” ；有关文件夹所在的位置，请参阅“会话和凭据” 。

有关检查状态的信息，请参阅uip login status 。要关闭会话，请参阅uip logout 。

大纲

uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]

所有uip login子命令均采用全局选项（ --output 、 --output-filter 、 --log-level 、 --log-file ）。退出代码遵循标准合同。

UIP 登录

通过浏览器以交互式方式进行身份验证，或使用外部应用程序客户端凭据以非交互式方式进行身份验证。

参数

无。

选项

• -f, --file <folder> — 凭据文件夹的路径。会话将保留在<folder>中。如果没有它，CLI 将使用默认位置（请参阅会话和凭据）。
• --authority <url> — 自定义授权 URL。用于非默认云。
• --client-id <id> — UiPath 外部应用程序的客户端 ID 或应用程序 ID。接受env.NAME以从环境变量中读取。
• --client-secret <secret> — 机密外部应用程序的客户端密码。接受env.NAME以从环境变量中读取。
• -s, --scope <scopes> — 以空格分隔的作用域（例如"OR.Folders OR.Jobs" ）。与外部应用程序凭据一起使用。
• -t, --tenant <name> — 租户名称（非交互模式）。如果省略，则与--interactive配对。
• --organization <name> — 组织逻辑名称，在浏览器登录期间预选。当您的用户属于多个组织时，绕过组织选取器。
• --it, --interactive — 身份验证后，以交互方式提示您从云返回的列表中选择租户。

凭据模式

• 交互式/用户凭据— 运行uip login （可以选择使用--interactive 、 --tenant或--organization ）。浏览器流程在 UiPath Cloud 授权上完成；生成的令牌将保留在凭据文件夹中。
• 外部应用程序（非交互式） — 传递--client-id 、 --client-secret和--scope ，并通常使用--tenant 。适用于 CI 运行者。使用--client-secret env.UIPATH_CLIENT_SECRET从环境变量中读取密码，以将其保留在 Shell 历史记录中。

示例

# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath

数据形状 ( --output json )

{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}

故障模式

• 非交互式登录后缺少租户会引发包含Message: "No tenant selected"的ConfigError ，并指示您使用--tenant <name>或--interactive重新运行。
• 来自授权机构的传输错误和非 2xx 响应显示为AuthenticationError ，原始 HTTP 状态为Context.httpStatus （如可用）。
• --client-id / --client-secret中格式错误的env.NAME引用会在任何网络调用之前生成ConfigError 。

UIP 登录租户列表

列出当前组织中对身份验证用户可见的所有租户。需要有效登录。

参数

无。

选项

• -f, --file <folder> — 凭据文件夹的路径。默认为上一个uip login使用的会话。

示例

uip login tenant list

数据形状 ( --output json )

{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}

如果会话未登录，该命令会发出AuthenticationError其中包含先运行uip login说明。

UIP 登录租户集

按名称选择活动租户。租户必须存在于login tenant list返回的列表中； CLI 使用新选择来更新存储的会话。

参数

• <name> （必填） — uip login tenant list返回的租户名称。

选项

• -f, --file <folder> — 凭据文件夹的路径。默认为上一个uip login使用的会话。

示例

uip login tenant set DefaultTenant

数据形状 ( --output json )

{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

故障模式

• 未知租户名称时会生成ValidationError其中Instructions会列出可用的租户，例如argument should be one of DefaultTenant, ProductionTenant 。
• 如果 CLI 无法更新存储的会话，错误将显示为Failure ，并带有与权限相关的提示。

相关内容

• uip login status — 显示当前会话而不刷新。
• uip logout — 清除存储的会话。
• 身份验证— 用户与外部应用程序流程。
• 会话和凭据— 凭据文件夹的定位和轮换方式。
• 配置— 凭据来源（环境变量、文件、标志）的优先级。