使用 API 配置具有屬性值的憑據

Automation 360

關閉內容

內容

開啟內容

下載 PDF

使用 API 配置具有屬性值的憑據

創建具有標準屬性的憑證並添加兩個具有用戶輸入值的附加屬性。

先決條件

註: 您可以查看 Control Room APIs 在裡面 Community Edition，但 API 功能有限。你需要一個許可 Automation 360 版本以訪問 API 的全部功能。

所有 API 調用都必須包含來自驗證 API （生成 JSON Web 令牌）或來自 OAuth 服務的不記名令牌。您不能在 API 中同時使用兩者。
所有角色都具有配置憑據和屬性所需的管理我的憑據和儲物櫃使用此端點不需要額外的權限。

在此示例中，您配置了一個具有三個屬性的憑據，以保存電子郵件主機名、用戶名和密碼。

程序

將身份驗證令牌或承載令牌添加到請求標頭。您不能在同一 API 中同時使用兩者。

創建憑證：

使用 POST 方法和端點 URL：<your_control_room_url>/v2/credentialvault/credentials。
請求正文：此示例請求包括以下必需參數：
- userProvided：一個布爾值，用於配置屬性是需要用戶輸入 (true) 還是對所有用戶都是標準的 (false)。
- masked：一個布爾值，用於配置屬性值是用星號 (true) 屏蔽還是對用戶可見 (false)。
```
{
  "name": "Email",
  "attributes": [
  	{
      "name": "hostname",
      "userProvided": false,
      "masked": false
    } 	
  ]
}
```

發送請求。

響應正文：在成功的請求中，此端點返回以下數據：

id：憑證的唯一數字標識符。
attributes: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響應代碼.

將標準值分配給憑證的主機名屬性：

使用 POST 方法和端點 URL：<your_control_room_url>/v2/credentialvault/credentials/{credentialId}/attributevalues。
```
{
  "list": [
    {
      "credentialAttributeId": "3335",
      "value": "mail.example.com"
    }
  ]
}
```

發送請求。

響應正文：

{
  "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"
    }
  ]
}

將 用戶名 和 密碼 屬性添加到 電子郵件 憑據。使用 PUT 方法和端點 URL：<your_control_room_url>/v2/credentialvault/credentials/{credentialId}。
註: 您必須在請求中包含現有屬性和新屬性，否則當前屬性將被覆蓋。
請求正文：由於您在請求 URL 中指定了憑證 ID，因此不需要在請求正文中包含憑證 ID 或名稱。在此示例請求正文中， 用戶名 和 密碼 屬性配置為接受來自每個用戶的不同輸入的值。此外，密碼屬性被配置為用星號屏蔽輸入的值。
```
{
    "attributes": [
  	{
      "name": "username",
      "userProvided": true,
      "masked": false
    },
     {
      "name": "password",
      "userProvided": true,
      "masked": true
    },
     {
      "name": "hostname",
      "userProvided": false,
      "masked": false
    } 		
  ]
}
```

發送請求。

響應正文：響應正文返回帶有三個屬性詳細信息的憑證。

{
    "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。

傳送意見反饋

Automation 360

使用 API 配置具有屬性值的憑據

先決條件

程序

後續步驟

意見回饋