阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

Enterprise Control Room身份验证 API

  • 已更新:5/24/2019
    • 11.3.x
    • 探索
    • Enterprise
    • API 文档

Enterprise Control Room身份验证 API

身份验证 API 优先于其他所有 API,在此情况下,调用第三方应用程序的用户必须进行身份验证才能使用下游 API。

Enterprise Control Room v.11.x 公开了公共 API,以便用户在外部系统中处理 Control Room 数据和部署机器人。这使第三方应用程序能够根据事件使用 RPA、协调机器人和管理 RPA 数据。例如,在 SAP 系统中创建用户后立即创建 Automation Anywhere 用户,或在域控制器中轮换密码后立即在 Automation Anywhere 中更新登录凭证。

身份验证 API

API:v1/身份验证

如果 Enterprise Control Room URL 为 https://<your-control-room-url>,则该 API 将为 https://<your-control-room-url>/v1/authentication

该 API 接受两个必需参数和一个可选参数作为 JSON 格式的输入:

  • Automation Anywhere 用户的 username
  • Automation Anywhere 用户的 password
  • 仅在 Enterprise Control Room 配置使用单一登录 (SSO) 时需要 apiKey。如果 Enterprise Control Room 不使用 SSO,请删除此字段。
{ "username": "string", "password": "string", "apiKey": "string" } 

例如:

  • Automation Anywhere 用户名为 mike_williams
  • Automation Anywhere 密码为 abc123
以下 JSON 请求格式用于未启用 SSO 的 Enterprise Control Room
{ "username": "mike_williams", "password": "abc123" }

如果身份验证成功,Enterprise Control Room 会发放需要传递到其他 Enterprise Control Room API 作为标头信息的身份验证令牌。

注: 身份验证令牌从发放时间开始只有 15 分钟的有效期。

身份验证 API 响应代码

Http 状态代码 响应 描述
200
{ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJ1c2VyIjoiMSIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Qvd2ViY3 JzdmMvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC93ZWJjcnN2Yy8iLCJle HAiOjE0OTUwOTAwOTksIm5iZiI6MTQ5NTA4OTE5OX0.qPPhpti0j7 LGAmWkj3XFymFfJXzA1P4zPehIjVYfulc" }
成功的身份验证返回令牌。
401
{ "message": "Invalid credentials." }
  • 密码无效。
  • 用户不存在。
  • Acitive Directory (AD) 身份验证凭证无效
401
{ "message": "Verify your email by clicking on the email verification link. This is mandatory as you will be able to login post verification only." }
已启用电子邮件通知,而用户尚未验证其电子邮件地址。
402
{ "message": "License expired." }
一个或多个许可证已过期。
403
 { "message": "Your account is not activated. Contact the admin." }
用户账户已停用。
发送反馈