Automation Anywhere

Automation Anywhere Automation 360

關閉內容

內容

開啟內容

使用 API 設定具有屬性值的認證

  • 已更新:1/31/2021
    • Automation 360 v.x
    • 探索
    • RPA 工作區

使用 API 設定具有屬性值的認證

使用標準屬性創建憑據,並使用用戶輸入值添加兩個附加屬性。

先決條件

註: 您可以在中查看, Control Room APIs Community Edition但 API 功能受限。您需要授權 Automation 360 版本才能存取 API 的完整功能。
  • 使用 驗證 API 來產生 JSON Web Token 。
  • 所有角色都具有 設定認證和屬性所需的「管理我的認證和置物櫃」權限。使用此端點不需要其他權限。
在此範例中、您可以設定具有三個屬性的認證、以保留電子郵件主機名稱、使用者名稱和密碼。

程序

  1. 將驗證令牌添加到請求標頭。
  2. 建立認證。使用 POST 方法和端點 URL : <your _control_room _url>/v2/credentialvault/credentials
    要求本文:此示例請求包括以下必需參數:
    • userProvided:布爾值,用於配置屬性是否需要用戶輸入 (true) 或是否爲所有用戶的標準值 (false) 。
    • 掩碼:布爾值,用於配置屬性值是用星號(true)屏蔽還是對用戶可見(false)。
    {
      "name": "Email",
      "attributes": [
      	{
          "name": "hostname",
          "userProvided": false,
          "masked": false
        } 	
      ]
    }
  3. 發送請求。
    回應本文:在成功的請求中,此端點返回以下數據:
    • ID:憑據的唯一數字標識符。
    • 屬性 :id:屬性的唯一數字標識符。
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:04:41.366464Z",
        "version": "0"
    }
    REST API 會以 HTTP 回應碼回應每個要求。有關響應代碼,請參閱 API 回應碼
  4. 將標準值指派給 認證的主機名稱屬性。 使用 POST 方法和端點 URL :<your _control_room _url>/v2/credentialvault/credentialId/{credentialId}/AttributeValues
    {
      "list": [
        {
          "credentialAttributeId": "3335",
          "value": "mail.example.com"
        }
      ]
    }
  5. 發送請求。
    回應本文:
    {
      "list": [
        {
          "id": "1630",
          "credentialAttributeId": "3335",
          "value": "mail.example.com",
          "userId": "1508",
          "createdBy": "1508",
          "createdOn": "2020-12-28T22:04:41.366460Z",
          "updatedBy": "1508",
          "updatedOn": "2020-12-28T22:04:41.366464Z",
          "version": "0"
        }
      ]
    }
  6. 使用者名稱 和密碼屬性新增至 電子郵件 認證。 使用 PUT 方法和端點 URL :<your _control_room _url>/v2/credentialvault/credentials/{credentialId}
    要求本文:由於您已在要求 URL 中指定認證識別碼,因此不需要在要求本文中包含認證識別碼或名稱。在此示例中,請求主體中 ,用戶名和密碼屬性配置爲接受來自每個用戶的不同輸入的值。此外,密碼屬性配置爲用星號屏蔽輸入的值。
    {
        "attributes": [
      	{
          "name": "username",
          "userProvided": true,
          "masked": false
        },
         {
          "name": "password",
          "userProvided": true,
          "masked": true
        }	
      ]
    }
  7. 發送請求。
    回應本文:回應本文會傳回包含三個屬性詳細資料的認證。
    {
        "id": "1630",
        "name": "Email",
        "description": "",
        "ownerId": "1508",
        "attributes": [
            {
                "id": "3335",
                "name": "hostname",
                "description": "",
                "userProvided": false,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366448Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3336",
                "name": "username",
                "description": "",
                "userProvided": true,
                "masked": false,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            },
            {
                "id": "3337",
                "name": "password",
                "description": "",
                "userProvided": true,
                "masked": true,
                "createdBy": "1508",
                "createdOn": "2020-12-28T22:04:41.366450Z",
                "updatedBy": "1508",
                "updatedOn": "2020-12-28T22:04:41.366450Z",
                "version": "0",
                "passwordFlag": false
            }
        ],
        "createdBy": "1508",
        "createdOn": "2020-12-28T22:04:41.366460Z",
        "updatedBy": "1508",
        "updatedOn": "2020-12-28T22:06:35.366464Z",
        "version": "2"
    }

後續步驟

如果您按照步驟配置 Credential Vault,請執行以下操作:指派認證給 locker API
傳送意見反饋