automation-suite
2023.10
false
- 入门指南
- 身份验证
- 身份验证方法
- 外部应用程序 (OAuth)
- ROPC(不推荐)
- 作用域和权限
- 平台管理 API
Automation Suite API 指南
上次更新日期 2024年11月11日
ROPC(不推荐)
重要提示:
我们支持通过(资源所有者密码凭据)ROPC 进行身份验证,以便为已从独立部署迁移到 Automation Suite 部署的 Orchestrator 实例提供向后兼容性。
只有主机管理员才能使用
/api/account/authenticate/
端点进行身份验证。
企业用户应使用外部应用程序进行身份验证。
要检索访问令牌,请使用以下负载向
/api/account/authenticate
端点发出 POST 请求:
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
{
"TenancyName": "{account_tenant_name}",
"UsernameOrEmailAddress": "{account_username}",
"Password": "{account_password}"
}
其中:
{account_tenant_name}
- 是 Automation Suite 帐户中租户的名称{account_username}
- 是 Automation Suite 帐户的用户名{account_password}
- 是用于登录 Automation Suite 帐户的密码
提示:
要查找 Orchestrator 实例的“租户名称”值,请向
/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser
发出 GET 请求。
响应正文返回持有者令牌,您的应用程序使用该令牌来授权进一步的 API 调用。 因此,在 API 调用的“授权”标头中,附加
Bearer xxxx
并将 xxxx
替换为 {access_token}
值(例如 Authorization: Bearer eyJhbG ... LnVxjA
)。
{
"result": "{access_token}",
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}
{
"result": "{access_token}",
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}
重要提示:
- 默认情况下,访问令牌的有效期为 30 分钟。 要生成新端点,请再次调用
api/account/authenticate
端点。 - 如果您的 Automation Suite 组织使用 Azure Active Directory 模型,则必须在 Automation Suite 中注册外部应用程序并使用该外部应用程序。