阅读和查看 Automation Anywhere 文档

Automation 360

关闭内容

内容

打开内容

验证(用户名和 apiKey)

  • 已更新:2022/03/04
    • Automation 360 v.x
    • 管理
    • RPA Workspace
    • API 文档

验证(用户名和 apiKey)

使用此 API 来验证对您的访问 Control Room 使用 用户名apikey。成功完成的响应会生成 JSON Web 令牌。默认情况下,令牌的有效期为 20 分钟。此端点允许用户生成令牌,而无需使用用户密码,例如,对于使用单点登录 (SSO) 的组织。要生成令牌,您需要一个有效的 用户 apikeyControl Room.

要生成令牌,您需要满足以下条件:

  • 具有生成 API 密钥权限的自定义角色
  • 有效 的 用户名API 密钥Control Room.API-Key 是一个 40 个字符的字符串, 在 Control Room.

    创建和分配 API 密钥生成角色

请求

POST http://{{ControlRoomURL}}/v1/authentication
请求正文
{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}

请求参数

参数 类型 描述
用户名 字符串 输入您的用户名。
注: 如果用户启用了多个会话,则将生成一个多会话令牌。有关多次登录的更多信息,请参阅 多次登录用户
apikey 字符串 输入您的 apikey。
注: 确保将 API 密钥中的任何转义字符“\”替换为“\\”。

响应

{
   "token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
   "user":{
      "id":9,
      "email":"a@a.com",
      "username":"jdoe",
      "domain":null,
      "firstName":"j",
      "lastName":"doe",
      "version":9,
      "principalId":9,
      "deleted":false,
      "roles":[
         {
            "name":"API_Key_Generation",
            "id":23,
            "version":0
         },
         {
            "name":"AAE_Basic",
            "id":2,
            "version":0
         },
         {
            "name":"Docrole1",
            "id":18,
            "version":0
         }
      ],
      "sysAssignedRoles":[
         
      ],
      "groupNames":[
         
      ],
      "permissions":[
         ". . ."
      ],
      "licenseFeatures":[
         "RUNTIME"
      ],
      "emailVerified":true,
      "passwordSet":true,
      "questionsSet":true,
      "enableAutoLogin":false,
      "disabled":false,
      "clientRegistered":false,
      "description":"",
      "createdBy":1,
      "createdOn":"2022-03-10T13:39:56-05:00",
      "updatedBy":1,
      "updatedOn":"2022-03-13T02:09:38-05:00",
      "publicKey":null,
      "appType":null,
      "routingName":null,
      "appUrl":null
   }
}

响应参数

参数 类型 描述
令牌 字符串 生成的访问令牌,充当您的应用程序将用于发出请求的会话 ID。此令牌等效于用户凭据,并且必须受到保护。
用户 目的 用户对象与用户所有详细信息一起返回。
  • id - 用户的 ID。
  • email - 用户的电子邮件 ID。
  • username - 用户的用户名。
  • domain - 登录到的域。
  • firstname - 用户的名字。
  • lastname - 用户的姓氏。
  • roles - 分配给用户的角色。
  • sysAssignedRoles - 系统分配的角色。
  • permissions - 分配给用户的权限。
  • licenseFeatures - 分配给用户的许可证。

在后续 API 请求的请求标头中插入令牌。

发送反馈