orchestrator
latest
false
在 Swagger 中授权 API 调用
Orchestrator API 指南
Last updated 2024年10月23日
在 Swagger 中授权 API 调用
如果您使用 Swagger 试用我们的 API,只需在单独的选项卡中登录 Orchestrator 实例即可。
可以通过将
/swagger/ui/index#/
后缀添加到 Orchestrator URL 来访问 Orchestrator API Swagger 定义。例如,https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_ /swagger/ui/index#/
。
注意: 根据在 Orchestrator 实例中设置的参数,Swagger 身份验证是否过期。 默认情况下,该时间设置为 30 分钟。 您可以通过修改
Web.config
文件中 Auth.Cookie.Expire
参数的值来更改此参数。
要通过 Swagger 用户界面为 Orchestrator 服务授权 API 调用,请执行以下步骤:
-
在 Orchestrator API 页面的右上角找到“授权”按钮。如果锁是打开的,则表示您未经授权。
-
单击 “授权”。 系统将显示“ 可用权限 ” 窗口。
注意: 我们目前支持一种称为 OAuth2 的授权方案。 - 系统会预先选择所有作用域,以便您可以在 Orchestrator API 中试验所有端点。 如果要限制对某些 API 的访问,请清除它们。
- 单击 “授权”。 系统将显示一个新窗口,确认您已获得授权。
- 完成后,单击 “关闭” 或 X 以关闭“ 可用的授权 ” 窗口。 “ 授权 ”按钮显示关闭的锁,表示您已获得授权。
当访问令牌过期时,您会收到
401: You are not authenticated!
响应。 您的请求仍存在不记名授权标头,但访问令牌已过期。 发生这种情况时,您需要使过期的令牌失效并生成新的访问令牌: