閱讀及檢閱 Automation Anywhere 文件

Automation 360

關閉內容

內容

開啟內容

以使用者名稱和 apiKey API 進行驗證

  • 已更新:2022/03/04
    • Automation 360 v.x
    • 管理
    • RPA 工作區
    • API 文件

以使用者名稱和 apiKey API 進行驗證

使用此 API 以 usernameapikey 來驗證您對 Control Room 的存取權。成功完成的回應會產生 JSON 網頁權杖。依預設,權杖的有效時間為 20 分鐘。此端點可讓使用者產生權杖時不需要使用者密碼,例如針對使用單一登入 (SSO) 的組織。若要產生權杖,您需要到 Control Room 的有效 usernameapikey

若要產生權杖,您需要下列項目:

  • 具有「產生 API 金鑰」權限的自訂角色
  • Control Room 的有效 usernameAPI-keyAPI-Key 是在 Control Room 中產生的 40 個字元字串。

    建立並指派 API 金鑰產生角色

要求

POST http://{{localhost}}/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。
  • 電子郵件 - 使用者的電子郵件。
  • 使用者名稱 - 使用者的使用者名稱。
  • 網域 - 已登入的網域。
  • 名字 - 使用者的名字。
  • 姓氏 - 使用者的姓氏。
  • 角色 - 指派給使用者的角色。
  • sysAssignedRoles - 系統指派的角色。
  • 權限 - 指派給使用者的權限。
  • licenseFeatures - 指派給使用者的授權。

在後續 API 要求的要求標頭中插入權杖。

傳送意見反饋