Automation Anywhere

Automation Anywhere

關閉內容

內容

開啟內容

用於管理認證保存庫的 API

  • 已更新:5/10/2019
    • 11.3.x
    • 建立
    • Enterprise
    • API 文件

用於管理認證保存庫的 API

身為具有 [管理我的認證和儲存櫃] 角色權限的Enterprise 控制室使用者,您可以使用認證保存庫 API 來管理Enterprise 控制室中的認證、屬性、儲存櫃和認證保存庫模式。

  1. 用於管理認證的 API 可用來建立、更新和刪除認證
  2. 用於管理認證屬性的 API 可用來建立、更新和刪除認證屬性及值。
  3. 用於管理儲存櫃的 API 可用來新增、編輯和移除包含取用者及成員的儲存櫃
  4. 用於管理認證保存庫模式的 API可用來設定 [連線模式],讓您能夠使用 [主金鑰] 連線至認證保存庫
註: 本文提供的範例僅供參考。

API End Point

使用下列端點來存取認證保存庫 API:<Enterprise 控制室 URL>/v2/credentialvault

例如,https://crdevenv.com:81/v2/credentialvault

用於管理認證的 API

使用這些 API 來管理您在Enterprise 控制室中的認證。

存取認證保存庫 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定認證保存庫 API。

  1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  2. 在 Headers 中提供以下要求承載:
    “X-Authorization” : “Authorization token” “Content-Type” : “application/json”
  3. 在本文中提供以下要求承載:
     { "username": "<Username>", "password": "<Password>" }
    例如,{

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. 建立認證

此 API 可讓您建立認證。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 POST 方法,在本文中提供以下要求承載:
    { "name": "<Credential Name>", "description": "<Credential Description>","attributes": [ { "name": "<Attribute Name>", "description": "<Attribute Description>", "userProvided": <true or false>, "masked": <true or false> } ] }
    例如,以下程式碼會建立有 "Username" 做為屬性的 "SharePoint Login" 認證:
    { "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "attributes": [ { "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true } ] }
  3. 按一下 [傳送]
  4. 當回應狀態為 [201 認證已建立] 時,表示動作成功。
  5. 您可以在本文資料中檢視回應。
    { "id": "10", "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "ownerId": "1", "attributes": [ { "id": "58", "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true, "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" } ], "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" }

參數說明

參數 說明
name 第一個實例中的認證名稱,以及第二個實例中的屬性名稱
description 第一個實例中的認證說明,以及第二個實例中的屬性值說明
userProvided 屬性類型為 [使用者提供的][標準]。如果類型是 [使用者提供的],則設為 true,而這也是預設參數。如需屬性值類型的詳細資料,請參閱建立認證
masked 屬性值是否為 [Masked]。如果屬性值已加密,則此參數設為 true。如需詳細資料,請參閱「建立認證」。

2. 認證清單

此 API 可讓您檢視使用者所擁有或使用者可透過儲存櫃存取的所有認證。如果使用者是儲存櫃管理員,則會列出系統中所有的認證。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取認證 API:http(s)://<hostname:port>/v2/credentialvault/credentials?consumed="<true or false>"&name or names="<filter credentials name(s) separated by comma>"

    例如,以下列出所有未取用的認證:

    https://crdevenv.com:81/v2/credentialvault/credentials?consumed=false

  3. 按一下 [傳送]
  4. 當回應狀態為 [200 找到認證] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:
    { "list": [ { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ], "completed": false }, { "id": 11, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SharePoint-User1", "description": "name of the SharePoint user", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 59, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SP-User1", "description": "name of the user", "userProvided": true, "masked": false }, { "id": 60, "createdBy": 1, "createdOn": "2018-06-21T13:00:22+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 0, "name": "Victor.Hugo", "description": null, "userProvided": true, "masked": false } ], "completed": false ] }

參數說明

參數 說明
consumed 如果認證是 [使用者提供的],並且已由目前的使用者取用,則依據事實篩選認證。
name 依據單一名稱篩選認證。
names 依據名稱的逗號分隔清單篩選認證。

3. 依據 ID 列出認證

此 API 可讓您檢視認證的詳細資料,而您要以參數方式提供認證的 ID。

提示: 您可以從使用「列出認證」API 所擷取的認證清單中找出認證的 ID
  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 GET 方法透過以下參數存取認證 API:http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    例如,以下用法可擷取 ID 為 12 的使用者認證:https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. 按一下 [傳送]。

    當回應狀態為 200 時,表示動作成功。您可以在本文資料中檢視回應:

    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ] }

4. 更新認證

此 API 可讓您更新現有認證。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 PUT 方法來存取認證 API:http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    例如,以下用法可更新 ID 為 12 的認證:https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. 在本文中提供以下要求承載:
    { "id": "<Credential id>", "version": <Version id>, "name": "<Credential Name>", "description": "<Credential Description>", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": <Attribute id>, "version": 0, "name": "<Updated attribute name >", "description": "<Updated attribute description>", "userProvided": <False or true>, - Attribute type "masked": <false or true> masking is true or false } ] }
    例如,若要更新認證說明,您可以提供以下要求參數:
    { "id": "12", "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": 61, "version": 0, "name": "<Updated attribute name >", "description": "SharePoint Username", "userProvided": <False or true>, - Attribute type "masked": true } ] }
    提示: 您只能輸入要更新的參數,並保持其他參數值不變 (即不做任何變更)。
  4. 按一下 [傳送]。
  5. 當回應狀態為 [200 認證已更新] 時,表示動作成功。
  6. 您可以在本文資料中檢視回應:
    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true } ] }

參數說明

參數 說明
id 第一個實例中的認證 ID,以及第二個實例中的屬性 ID。這可以使用「依據 ID 取得認證」API 來找出
version 第一個實例中認證的已更新版本 ID,以及第二個實例中的屬性。如果較早版本與目前版本有差異,則會顯示衝突錯誤
name 第一個實例中的已更新認證,以及第二個實例中的屬性值
description 第一個實例中的已更新認證說明,以及第二個實例中的屬性值說明
lockerId 儲存櫃 ID (如果有提供)。如果沒有提供儲存櫃 ID,則設為 null,這是預設值。這可以使用「依據 ID 取得認證」API 來找出
ownerId 認證擁有者的使用者 ID。這可以使用「依據 ID 取得認證」API 來找出
userProvided 屬性類型為 [使用者提供的][標準]。如果類型是 [使用者提供的],則設為 true,而這也是預設參數。如需屬性值類型的詳細資料,請參閱「建立認證」。
masked 屬性值是否為 [Masked]。如果屬性值已加密,則此參數設為 true。如需詳細資料,請參閱「建立認證」。

5. 更新認證的所有權

此 API 可讓您更新認證的所有權。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 PUT 方法來存取認證 API

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/owner/<credentialOwnerId>

    例如,以下用法可變更 ID 為 12 的認證,將其所有權從擁有者 1 轉移到 2

    https://crdevenv.com:81/v2/credentialvault/credentials/12/owner/2
  3. 按一下 [傳送]
  4. 當回應狀態為 [200 成功更新認證所有權] 時,表示動作成功。
  5. 您可以在本文資料中檢視回應:

    {

    "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1,

    "attributes":

    [

    { "id": 61, "createdBy": 1, "createdOn":"2018-06-25T14:13:58+05:30", "updatedBy":1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId":1, "version":0, "name":"Username", "description": "SharePoint Username", "userProvided": true, "masked": true }

    ]

    }

參數說明

參數 說明
id 認證的 ID。這可以使用「依據 ID 取得認證」API 來找出
credentialOwnerId 新認證擁有者的 ID。這可以使用「依據 ID 取得認證」API 來找出

6. 刪除認證

此 API 可讓您刪除認證,而您要以參數方式提供認證的 ID

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法透過以下參數存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    例如,以下用法可刪除 ID 為 11 的認證

    https://crdevenv.com:81/v2/credentialvault/credentials/11

  3. 按一下 [傳送]。

    當回應狀態為 [204 成功刪除] 時,表示動作成功。

用於管理認證屬性的 API

您身為具有 [檢視與編輯所有認證屬性值] 權限的Enterprise 控制室使用者,可以使用認證屬性 API 來管理Enterprise 控制室中的認證屬性及其值。因此,請透過此 API 建立、編輯和移除使用者所建立之認證的屬性值。

存取認證保存庫 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定認證保存庫 API。

  1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  2. 使用 POST 方法來存取認證 API

    例如,GET https://crdevenv.com:81/v2/credentialvault/credentials

  3. 在標頭中提供以下要求承載

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

1.建立屬性值

此 API 可讓您建立認證的屬性值,而您要以參數方式提供認證的 ID

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 POST 方法來存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue

    例如,以下用法可為 ID 為 12 的認證建立 username 屬性

    https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. 在本文中提供要求承載:
    [ { "credentialAttributeId": "<Attribute Id>", "value": "<attribute value>" } ]

    例如,在先前範例所建立 ID 為 "12""SharePoint Login" 認證中,您可以針對 ID 為 "30" 的 "username" 屬性新增其值,如下所示:

    [

    {

    "credentialAttributeId": "30",

    "value": "Jane.Smith"

    }

    ]

  4. 按一下 [傳送]
  5. 當回應狀態為 [201 認證屬性值已建立] 時,表示動作成功
  6. 您可以在本文資料中檢視回應:

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:18:13+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:18:13+05:30","tenantId":1,"version":0,"userId":null,"value":"Jane.Smith","credentialAttributeId":62

    }

    ]

參數說明

參數 說明
credentialAttributeId 屬性的 ID。這可以使用「依據 ID 取得認證」API 來找出
value 您要提供的屬性值

2.認證屬性值的清單

此 API 可讓您列出特定認證的所有標準值和使用者指定值。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalues

    例如,在 ID 為 "12""SharePoint Login" 認證中,您可以針對 ID 為 "30""username" 屬性新增其值,如下所示:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues

  3. 按一下 [傳送]。

    當回應狀態為 [200 已找到認證屬性值] 時,表示動作成功。

  4. 您可以在本文資料中檢視回應:

    { "list":[

    {

    "id":30, "createdBy": 1, "createdOn":"2018-06-27T14:16:20+05:30", "updatedBy": 1, "updatedOn":"2018-06-27T14:16:20+05:30", "tenantId": 1, "version":0, "userId": null, "value": "Jane.Smith", "credentialAttributeId": 62

    }

    ]}

參數說明

參數 說明
id 認證的 ID。這可以使用「依據 ID 取得認證」API 來找出
credentialAttributeId 屬性的 ID。這可以使用「依據 ID 取得認證」API 來找出
userId Enterprise 控制室使用者的 ID

3.更新認證屬性值

此 API 可讓您更新指定認證的屬性值。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 PUT 方法透過以下參數存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault//credentials/<id>/attributevalues/<attributeValueId>

    例如,在 ID 為 "12""SharePoint Login" 認證中,您可以針對 ID 為 "30""username" 屬性更新其值,如下所示:

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues/30

  3. 在本文中提供要求承載:

    [

    {

    "id":"<Attribute value id>", "version": 0, "value": "<Attribute value>", "credentialAttributeId": "<Attribute ID>"

    }

    ]

  4. 按一下 [傳送]。

    當回應狀態為 [200 認證屬性值已更新] 時,表示動作成功。

  5. 您可以在本文資料中檢視回應:

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:47:55+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:47:55+05:30","tenantId":1,"version":0,"userId":null,"value":"","credentialAttributeId":62

    }

    ]

參數說明

參數 說明
id 屬性值的 ID。這可以使用「依據 ID 取得認證」API 來找出
version 已更新之屬性值的版本號碼
credentialAttributeId 屬性的 ID。這可以使用「依據 ID 取得認證」API 來找出

刪除認證屬性值

此 API 可讓您刪除特定認證的屬性值

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法,透過具有以下參數的認證 API 來刪除認證屬性值:

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/values/<attributeValueId>

    例如,https://crdevenv.com:81/v2/credentialvault/credentials/12/values/30
  3. 按一下 [傳送]
  4. 當回應狀態為 [204 成功刪除] 時,表示動作成功

用於管理儲存櫃的 API

身為具有 [管理所有儲存櫃] 權限的Enterprise 控制室管理員,或具有 [管理我的儲存櫃] 權限的Enterprise 控制室使用者,可以使用「管理儲存櫃」API 來建立、更新和刪除Enterprise 控制室中的儲存櫃、取用者及成員。

存取這些 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定認證保存庫 API。

  1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  2. 使用 POST 方法來存取認證 API

    例如,GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. 在標頭中提供以下要求承載

    “X-Authorization” :“Authorization token”

    “Content-Type” :“application/json”

1.儲存櫃清單

此 API 會擷取儲存櫃的清單,已登入的使用者則是這些儲存櫃的成員 (擁有者、管理者或參與者),或具有其使用權限。如果使用者是儲存櫃管理員,則會擷取系統中所有儲存櫃的清單。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取儲存櫃 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers?consumed="<true or false>"

    例如,以下列出所有未取用的儲存櫃名稱:

    https://crdevenv.com:81/v2/credentialvault/lockers?consumed=false

  3. 按一下 [傳送]。
  4. 當回應狀態為 [200 找到儲存櫃] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    { "list":

    [

    {

    "id":2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:41:04.682Z", "tenantId": 1, "version":1

    },

    {

    "id":3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn":"2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn":"2018-07-04T09:47:33.532Z", "tenantId": 1, "version":0

    }

    ]}

參數說明

參數 說明
id 儲存櫃 ID
name 儲存櫃的名稱
description 針對儲存櫃提供的說明
consumed 是否已由登入的使用者取用。這可以是 True 或 False

2.建立儲存櫃

此 API 可讓您建立儲存櫃。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 POST 方法來存取儲存櫃 API: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • 例如,以下用法可為 ID 為 12 的認證建立 username 屬性:https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. 在本文中提供要求承載:
    { "name":"<Locker name>" , "description":"<Locker description>" }
    • 例如,以下用法可建立一個 "SalesForce" 儲存櫃:
      { "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application" }
  4. 按一下 [傳送]。
  5. 當回應狀態為 [201 儲存櫃已建立] 時,表示動作成功
  6. 您可以在本文資料中檢視回應:
    { "id": 4, "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0 }

參數說明

參數 說明
name 儲存櫃管理員所提供的儲存櫃名稱
description 儲存櫃的說明

3.所有儲存櫃的清單並包含其他欄位

此 API 會擷取儲存櫃的清單,已登入的使用者則是這些儲存櫃的成員 (擁有者、管理者或參與者),或具有其使用權限。如果使用者是儲存櫃管理員,則會擷取系統中所有儲存櫃的清單。回應會包含儲存櫃的成員以及每個儲存櫃內的認證計數。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取儲存櫃 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers/advanced

    • 例如,以下用法可列出所有儲存櫃名稱與其他欄位

      https://crdevenv.com:81/v2/credentialvault/lockers/advanced

  3. 按一下 [傳送]
  4. 當回應狀態為 [200 找到儲存櫃] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    { "list":[

    { "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy":2, "updatedOn":"2018-07-04T10:10:04.163Z", "tenantId": 1, "version":2, "members": [ { "id":1, "permissions": [ "participate", "manage" ] }, { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 1 },

    { "id": 3, "name":"Outlook Locker", "description": "", "createdBy": 2, "createdOn":"2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn":"2018-07-04T09:47:33.532Z", "tenantId":1, "version":0, "members": [ { "id":2, "permissions":[ "participate", "own", "manage" ] } ], "countOfCredentials": 0 },

    { "id": 4, "name": "SalesForce Locker", "description": "-", "createdBy": 2, "createdOn":"2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn":"2018-07-04T09:55:04.045Z", "tenantId": 1, "version":0, "members":[ { "id":2, "permissions":[ "participate", "own", "manage" ] } ], "countOfCredentials": 0 }

    ]}

4.依據 ID 列出儲存櫃

此 API 可讓您依據儲存櫃的 ID 擷取其詳細資料。
提示: 您可以從使用「列出儲存櫃」API 所擷取的儲存櫃清單中找出儲存櫃的 ID
  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 GET 方法透過以下參數存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • 例如,以下用法可擷取 ID 為 2 的儲存櫃:

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 按一下 [傳送]。
  4. 當回應狀態為 [200 儲存櫃] 時,表示動作成功。
  5. 您可以在本文資料中檢視回應:

    {

    "id":2, "name":"SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy":2, "updatedOn":"2018-07-04T10:10:04.163Z", "tenantId":1, "version":2

    }

5.更新儲存櫃

此 API 可讓您更新特定儲存櫃的值

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 PUT 方法透過以下參數存取認證 API:

    http(s)://<hostname:port>/v2/credentialvault//lockers/<id>

    • 例如,您可以針對 ID 為 "2""SharePoint Locker" 儲存櫃更新其值,如下所示:

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 在本文中提供要求承載:

    {

    "id":"<locker id>", "name": "<updated lockername>", "description": "<updated description>", "version": 0

    }

  4. 按一下 [傳送]
  5. 當回應狀態為 [200 儲存櫃已更新] 時,表示動作成功
  6. 您可以在本文資料中檢視回應:

    {

    "id":2, "createdBy": 8, "createdOn": "2018-06-16T10:59:33Z", "updatedBy": 8, "updatedOn": "2018-06-16T10:59:37Z", "version": 1, "name": "SharePoint-Locker", "description": "Locker to manage SharePoint credentials"

    }

參數說明

參數 說明
id 儲存櫃的 ID。這可以使用「依據 ID 取得儲存櫃」API 來找出
version 已更新之儲存櫃值的版本號碼
name 儲存櫃的已更新名稱
description 儲存櫃的已更新說明

6.刪除儲存櫃

此 API 可讓您刪除儲存櫃,而您要以參數方式提供儲存櫃的 ID

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法,透過具有以下參數的儲存櫃 API 來移除儲存櫃的認證:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • 例如,以下用法可刪除 ID 為 4 的認證

      https://crdevenv.com:81/v2/credentialvault/lockers/4

  3. 按一下 [傳送]
  4. 當回應狀態為 [204 成功刪除] 時,表示動作成功

7. 列出所有儲存櫃取用者

此 API 可讓您擷取可使用儲存櫃中之認證的角色清單

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取儲存櫃 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • 例如,以下用法可針對 ID 為 2 的儲存櫃來擷取可使用其中認證的角色

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers

  3. 按一下 [傳送]
  4. 當回應狀態為 [204 成功] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    {

    "list":

    [

    { "id": "14" }

    ]

    }

8. 新增儲存櫃取用者

此 API 可讓您將取用者新增至指定的儲存櫃

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 PUT 方法透過以下參數存取儲存櫃 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • 例如,以下用法可讓您連線至 ID 為 2 的儲存櫃,而在其中,您想要新增取用者 ID 為 14 的角色

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. 在本文中提供要求承載:

    {

    "id":"<consumer id>"

    }
    • 例如,

      {

      "id":14

      }

  4. 按一下 [傳送]
  5. 當回應狀態為 [204 成功建立儲存櫃取用者] 時,表示動作成功

參數說明

參數 說明
id 儲存櫃取用者的 ID。這可以使用「依據 ID 取得儲存櫃」API 來找出

9. 移除儲存櫃取用者

此 API 可讓您從指定的儲存櫃移除取用者

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法,透過具有以下參數的儲存櫃 API 來移除儲存櫃取用者:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/consumers/<roleId>

    • 例如,以下用法可刪除 ID 為 2 的認證

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers/14

  3. 按一下 [傳送]。
  4. 當回應狀態為 [204 成功刪除] 時,表示動作成功。

10. 列出所有儲存櫃成員

此 API 可讓您擷取所有可於指定儲存櫃中新增/移除認證或編輯儲存櫃設定之使用者的清單。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取儲存櫃 API:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members

    • 例如,以下用法可擷取可於 ID 為 2 的儲存櫃中新增/移除使用者的使用者

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members

  3. 按一下 [傳送]
  4. 當回應狀態為 [200 儲存櫃成員] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    {

    "list":

    [

    {

    "id":1, "permissions":[ "participate", "manage" ]

    },

    {

    "id":2, "permissions":[ "participate", "own", "manage" ]

    }

    ]

    }

11. 新增或更新儲存櫃成員

此 API 可讓您新增可於儲存櫃中新增/移除認證或編輯儲存櫃設定的使用者。

  1. 在 Headers 中提供 "X-Authorization" 和 "Content Type" 參數。
  2. 使用 PUT 方法,透過具有以下參數的儲存櫃 API 來新增/更新使用者:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • 例如,以下用法可讓您連線至 ID 為 2 的儲存櫃,而在其中,您想要新增成員 ID 為 3 的使用者

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. 在本文中提供要求承載:

    {

    "permissions":

    ["permission type"]

    }

    • 例如,

      {

      "permissions":

      ["participate", "manage"]

      }

  4. 按一下 [傳送]
  5. 當回應狀態為 [204 成功建立/更新儲存櫃成員] 時,表示動作成功

參數說明

參數 說明
permissions 授與使用者的權限。可以是 [擁有][參與] 和/或 [管理者]

12. 移除儲存櫃成員

此 API 可讓您從指定的儲存櫃移除儲存櫃使用者或成員

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法,透過具有以下參數的儲存櫃 API 來移除儲存櫃取用者:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • 例如,以下用法可刪除 ID 為 3 的儲存櫃使用者

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. 按一下 [傳送]
  4. 當回應狀態為 [204 成功移除儲存櫃成員] 時,表示動作成功

13. 將認證新增至儲存櫃

此 API 可讓您將自己的認證新增至您有擁有者、管理者或參與者權限的儲存櫃。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 PUT 方法,透過具有以下參數的認證 API 將認證新增至儲存櫃:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • 例如,以下用法可將認證新增至 ID 為 2 的儲存櫃:https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/58
  3. 按一下 [傳送]
  4. 當回應狀態為 [200 認證已成功新增至儲存櫃] 時,表示動作成功。

14. 列出所有儲存櫃認證

此 API 可讓您在您有擁有者、管理者或參與者權限的儲存櫃中擷取認證清單。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法,透過具有以下參數的認證 API 來擷取認證清單:
    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/
    • 例如,以下用法可列出所有已新增至 ID 為 2 之儲存櫃的認證

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/

  3. 按一下 [傳送]
  4. 當回應狀態為 [200 儲存櫃認證] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    { "list": [

    {

    "id":10, "name": "SharePoint Credentials", "description": "", "completed": false, "lockerId": 2, "ownerId": 2, "attributes":

    [

    {

    "id":58, "name": "username", "description": "", "userProvided": true, "masked": false, "createdBy": 2, "createdOn":"2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn":"2018-07-04T10:09:32.854Z", "tenantId": 1, "version":0

    },

    {

    "id":59, "name": "password", "description": "", "userProvided": true, "masked": true, "createdBy": 2, "createdOn":"2018-07-04T10:09:32.854Z", "updatedBy":2, "updatedOn":"2018-07-04T10:09:32.854Z", "tenantId":1, "version":0

    }

    ],

    "createdBy": 2, "createdOn":"2018-07-04T10:09:32.854Z", "updatedBy":2, "updatedOn":"2018-07-04T10:10:04.316Z", "tenantId": 1, "version":1

    }

    ]}

15. 從儲存櫃移除認證

此 API 可讓您從指定的儲存櫃移除儲存櫃使用者或成員

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 DELETE 方法,透過具有以下參數的儲存櫃 API 來移除儲存櫃取用者:

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • 例如,以下用法可從 ID 為 2 的儲存櫃刪除 ID 為 59 的認證

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/59

  3. 按一下 [傳送]
  4. 當回應狀態為 [204 已從儲存櫃移除認證] 時,表示動作成功

用於管理認證保存庫模式的 API

身為具有 [檢視與管理設定] 權限的Enterprise 控制室管理員,可以使用「管理認證保存庫模式」API 來管理Enterprise 控制室認證保存庫模式。

存取這些 API 之前,必須先使用驗證 API 並傳遞它做為權杖,才能使用特定認證保存庫 API。

  1. 使用 POST 方法可透過 http(s)://<hostname:port>/v1/authentication 端點來產生權杖。為此,請提供Enterprise 控制室執行個體當做 [伺服器名稱] / [主機名稱] / [IP][連接埠號碼]

    例如,https://crdevenv.com:81/v1/authentication

  2. 使用 POST 方法來存取認證 API

    例如,GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. 在標頭中提供以下要求承載

    “X-Authorization” :“Authorization token”

    “Content-Type” :“application/json”

檢視目前的認證保存庫模式

此 API 可讓您檢視目前用來連線至認證保存庫的模式。這可以是 [快速] 或 [手動]

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取認證保存庫 API:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 例如,以下用法可顯示目前用來連線至認證保存庫的模式:

      https://crdevenv.com:81/v2/credentialvault/mode

  3. 按一下 [傳送/執行]
  4. 當回應狀態為 [200 CV 模式已成功擷取] 時,表示動作成功
  5. 您可以在本文資料中檢視回應:

    {

    "name": "Express"

    }

更新認證保存庫模式

此 API 可讓您變更用來連線至認證保存庫的模式。這可以是 [快速] 或 [手動]

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 PUT 方法透過以下參數存取認證保存庫 API:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 例如,以下用法可顯示目前用來連線至認證保存庫的模式:

      https://crdevenv.com:81/v2/credentialvault/mode

  3. 在本文中提供要求承載:

    {

    "name": "<mode>",

    "privatekey": "<CV Key>"

    }
    • 例如,

      {

      "name": "Manual",

      "privatekey": "ABC123"

      }

  4. 按一下 [傳送/執行]
  5. 當回應狀態為 [204 模式已成功設定] 時,表示動作成功

參數說明

參數 說明
name 連線類型:[快速] 或 [手動]。這是在最初設定Enterprise 控制室組態時所指定。請參閱Enterprise 控制室設定,以了解如何從Enterprise 控制室 UI 中更新此設定。
key 用於連線至認證保存庫的主金鑰。

檢查是否已套用主金鑰

此 API 可讓您確認是否已套用連線至認證保存庫Enterprise 控制室主金鑰。用來檢查認證保存庫狀態。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 GET 方法透過以下參數存取認證保存庫 API:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • 例如,

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. 按一下 [傳送/執行]
  4. 當回應狀態為 [200 私密金鑰狀態] 時,表示動作成功。
  5. 您可以在本文資料中檢視回應:

    {

    "applied": true

    }
    註: 如果沒有套用私密金鑰,則值會顯示為 false

使用手動模式重新啟動Enterprise 控制室之後,套用主金鑰以解除鎖定認證保存庫

此 API 可讓您在使用連線的 [手動] 模式重新啟動Enterprise 控制室之後,將認證保存庫解除鎖定。用來確認認證保存庫是否已連線。

  1. 在 Headers 中提供 "X-Authorization" 參數。
  2. 使用 PUT 方法透過以下參數存取認證保存庫 API:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • 例如,

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. 在本文中提供要求承載:

    {

    "privateKey": "<CV Key>"

    }

  4. 按一下 [傳送/執行]
  5. 當回應狀態為 [200 私密金鑰已成功套用] 時,表示動作成功

參數說明

參數 說明
privateKey 用於連線至認證保存庫的主金鑰。這是在最初設定Enterprise 控制室組態時所指定。您也可以藉由提供此金鑰,從Enterprise 控制室設定中變更模式。

API 回應碼

Http(s) 狀態碼 回應 - 說明 更正動作
200/204 已成功完成動作 不適用
304 未套用任何變更 視需要更新
400 錯誤的要求參數 使用有效參數重試
401 需要驗證 提供驗證參數。例如,X-Authorization 金鑰
403 未經授權的存取 確定您有權存取Enterprise 控制室
404 找不到 請確定Enterprise 控制室中有提供要求承載
409 發生衝突 請確定提供的參數正確無誤
500 內部伺服器錯誤 請確定伺服器已啟動並執行
501 權限錯誤 請確認您具有必要權限

稽核記錄

所有 API 活動都會記錄在Enterprise 控制室 [稽核記錄] 頁面。身為Enterprise 控制室管理員或具有 [檢視每個人的稽核記錄動作] 權限的使用者,您可以檢視稽核項目,如下所示:

已擷取 API 活動的 [稽核記錄] 頁面

以下插圖是有關使用儲存櫃 API 建立儲存櫃的稽核記錄詳細資料頁面範例:

稽核記錄詳細資料頁面,包含有關新增儲存櫃活動的資訊

傳送意見反饋