阅读和查看 Automation Anywhere 文档

Automation Anywhere

关闭内容

内容

打开内容

用于管理凭证保管库的 API

  • 已更新:5/10/2019
    • 11.3.x
    • 版本
    • Enterprise
    • API 文档

用于管理凭证保管库的 API

作为具有管理我的凭证和存储柜角色权限的Enterprise Control Room用户,使用Credential Vault API 可以管理Enterprise Control Room中的凭证、属性、存储柜和Credential Vault模式。

  1. 用于管理凭证的 API 可用于创建、更新和删除凭证
  2. 用于管理凭证属性的 API 可用于创建、更新和删除凭证属性和值。
  3. 用于管理存储柜的 API 可用于添加、编辑和删除存储柜(包括使用者和成员)
  4. 用于管理凭证保管库模式的 API 可用于配置连接模式,以允许您使用主密钥连接到Credential Vault
注: 本文中提供的示例仅供参考。

API 端点

使用以下端点访问Credential Vault API:<Enterprise Control Room URL>/v2/credentialvault

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

用于管理凭证的 API

使用这些 API 管理Enterprise Control Room中的凭证。

访问Credential Vault API 之前,必须首先使用身份验证 API 并将其作为令牌传递以使用特定Credential Vault API。

  1. 使用 POST 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

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

  2. 在标头中提供以下请求有效负载:
    “X-Authorization” : “Authorization token” “Content-Type” : “application/json”
  3. 在正文中提供以下请求有效负载:
     { "username": "<Username>", "password": "<Password>" }
    例如,{

    "usename":"Ellie.Brown",

    "password":"12345678"

    }

1.创建凭证

此 API 允许您创建凭证。

  1. 在标头中提供“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. 在标头中提供“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 如果凭证为 userProvided 并由当前用户使用,则按事实筛选凭证。
name 按单个名称筛选凭证。
names 按逗号分隔的名称列表筛选凭证。

3.按 ID 列出凭证

此 API 允许您查看其 ID 作为参数提供的凭证的详细信息。

提示: 您可以从使用“列出凭证”API 获取的凭证列表中标识凭证的 ID
  1. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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 Control Room用户,使用凭证属性 API 可以在Enterprise Control Room中管理凭证属性及其值。这样,可以使用此 API 创建、编辑和删除用户创建的凭证的属性值。

访问Credential Vault API 之前,必须首先使用身份验证 API 并将其作为令牌传递以使用特定Credential Vault API。

  1. 使用 POST 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

    例如,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. 在标头中提供“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. 在标头中提供“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 Control Room用户的 ID

3.更新凭证属性值

此 API 允许您更新指定凭证的属性值。

  1. 在标头中提供“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. 在标头中提供“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 Control Room管理员或具有管理我的存储柜权限Enterprise Control Room用户,可以使用管理存储柜 API 在Enterprise Control Room中创建、更新和删除存储柜、使用者和成员。

访问这些 API 之前,必须首先使用身份验证 API 并将其作为令牌传递以使用特定Credential Vault API。

  1. 使用 POST 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

    例如,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. 在标头中提供“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. 在标头中提供“X-Authorization”和“Content Type”参数。
  2. 使用 POST 方法访问存储柜 API: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • 例如,通过以下参数可创建凭证 ID 为 12 的属性 usernamehttps://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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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 向用户授予的权限。权限可以是 ownparticipate 和/或 manager

12.删除存储柜成员

此 API 允许您从指定的存储柜中删除存储柜用户或成员

  1. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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. 在标头中提供“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 Control Room管理员,可以使用“管理Credential Vault模式”API 来管理Enterprise Control RoomCredential Vault模式。

访问这些 API 之前,必须首先使用身份验证 API 并将其作为令牌传递以使用特定Credential Vault API。

  1. 使用 POST 方法生成使用端点 http(s)://<hostname:port>/v1/authentication 的令牌。为此,请以服务器名称/主机名/IP端口号的形式提供Enterprise Control Room实例。

    例如,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 允许您查看用于连接到Credential Vault的当前模式。此模式可以是“快速”或“手动”

  1. 在标头中提供“X-Authorization”参数。
  2. 使用 GET 方法通过以下参数访问Credential Vault API:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 例如,通过以下参数可显示用于连接到Credential Vault的当前模式:

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

  3. 单击“发送/执行”
  4. 响应状态为 200 CV 模式已成功收到时,操作成功
  5. 您可以在正文数据中查看响应:

    {

    "name":"Express"

    }

更新凭证保管库模式

此 API 允许您更改用于连接到Credential Vault的模式。此模式可以是“快速”或“手动”

  1. 在标头中提供“X-Authorization”参数。
  2. 使用 PUT 方法通过以下参数访问Credential Vault API:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • 例如,通过以下参数可显示用于连接到Credential Vault的当前模式:

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

  3. 在正文中提供请求有效负载:

    {

    "name":"<mode>",

    "privatekey":"<CV Key>"

    }
    • 例如,

      {

      "name":"Manual",

      "privatekey":"ABC123"

      }

  4. 单击发送/执行
  5. 响应状态为 204 模式已成功设置时,操作成功

参数描述

参数 描述
name 连接类型 -“手动”或“快速”。这是在Enterprise Control Room的初始配置期间指定的。请参考Enterprise Control Room设置,以便从Enterprise Control Room UI 更新此项。
key 用于连接到Credential Vault的主密钥。

检查是否已应用主密钥

此 API 允许您验证是否已应用连接到Credential VaultEnterprise Control Room主密钥。使用此项可检查Credential Vault状态。

  1. 在标头中提供“X-Authorization”参数。
  2. 使用 GET 方法通过以下参数访问Credential Vault 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 Control Room后应用主密钥以解锁凭证保管库

此 API 允许您在重新启动使用“手动”连接模式的Enterprise Control Room后,解锁Credential Vault。使用此项可验证是否已连接Credential Vault

  1. 在标头中提供“X-Authorization”参数。
  2. 使用 PUT 方法通过以下参数访问Credential Vault 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 用于连接到Credential Vault的主密钥。这是在Enterprise Control Room的初始配置期间指定的。您也可以通过提供此密钥,从Enterprise Control Room设置更改模式。

API 响应代码

Http(s) 状态代码 响应 - 描述 纠正措施
200/204 操作已成功完成 不适用
304 未应用任何更改 根据需要进行更新
400 请求参数错误 使用有效参数重试
401 需要身份验证 提供身份验证参数。例如,X-Authorization 密钥
403 未经授权访问 确保您有权访问Enterprise Control Room
404 未找到 确保Enterprise Control Room中提供了请求有效负载
409 冲突 确保提供的参数正确
500 内部服务器错误 确保服务器已启动并且正在运行
501 权限错误 确保您具有所需的权限

审核日志

所有 API 活动都记录在“Enterprise Control Room审核日志”页面中。作为Enterprise Control Room管理员或具有“查看每个人的审核日志操作”权限的用户,您可以按以下所示查看审核条目:

“审核日志”页面,包含已捕获的 API 活动

下图是用于使用存储柜 API 创建存储柜的示例审核日志详细信息页面:

审核日志详细信息页面,包含有关添加存储柜活动的信息

发送反馈