阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

使用用户名和 apiKey API 进行身份验证

  • 已更新:1/06/2021
    • Automation 360 v.x
    • 管理
    • RPA 工作区
    • API 文档

使用用户名和 apiKey API 进行身份验证

使用您的 Control Room 用户名apikey 生成 JSON Web 令牌。此端点允许用户生成令牌,而无需使用用户密码,例如,对于使用单点登录 (SSO) 的组织。默认情况下,令牌的有效期为 20 分钟。

先决条件

注: 您可以在 Control Room APIs 中查看 Community Edition,但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。

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

  • 具有生成 API 密钥权限的自定义角色
  • 对于 Control Room 的有效用户名API 密钥API 密钥是在 Control Room 中生成的 40 个字符的字符串。

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

过程

  1. 使用 POST 方法和端点 URL:<your_control_room_url>/v1/authentication
    请求正文:
    {
    "username": "jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
    带域的请求正文:根据您的 Control Room 配置方式,用户名可能需要域。
    {
    "username": "your-domain\\jdoe",
    "apiKey":  "3/.Z)8:P`+yVJq . . . *fTk.i>|VOOl&:"
    }
  2. 发送请求。
    响应正文:成功响应会将令牌返回为 703 个字符的字符串。
    {
      "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": "",
        "lastName": "",
        "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": "2019-10-10T13:39:56-05:00",
        "updatedBy": 1,
        "updatedOn": "2019-10-13T02:09:38-05:00",
        "publicKey": null,
        "appType": null,
        "routingName": null,
        "appUrl": null
      }
    }

后续步骤

在后续 API 请求的请求标头中插入令牌。
发送反馈