驗證（用戶名和 apiKey）

使用此 API 對訪問權限進行身份驗證 Control Room 使用 用戶名 和 apikey。成功的響應會生成一個 JSON Web 令牌。生成的令牌有效期為 20 分鐘。您可以在不需要用戶密碼的情況下生成令牌，例如對於使用單點登錄 (SSO) 的組織。

若要產生權杖，您需要下列項目：

具有「產生 API 金鑰」權限的自訂角色
有效的 用戶名 和 API 密鑰Control Room.API 密鑰由 40 個字符組成的字符串，在 Control Room.
創建和分配 API 密鑰生成角色

要求

POST http://{{ControlRoomURL}}/v1/authentication

要求本文：

{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}

註: 使用 apiKey ，您將生成一個多會話令牌。apiKey 登錄時，multipleLogin 參數不適用。

註: apiKey 或 password 用於生成有效令牌。兩者（apiKey 和 password）不能在請求正文中一起使用。

要求參數


參數	類型	說明
使用者名稱	字串	輸入您的使用者名稱。
apikey	字串	輸入您的 apikey。註: 對於 .24 或更早版本，您必須將 API 密鑰中的任何轉義字符“\”替換為“\\”。對於 .25 或更高版本，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 要求的要求標頭中插入權杖。

Automation 360