阅读和查看 Automation Anywhere 文档

Automation Anywhere Automation 360

关闭内容

内容

打开内容

使用 API 配置具有属性值的凭证

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

使用 API 配置具有属性值的凭证

创建具有标准属性的凭证,并使用用户输入值添加两个附加属性。

先决条件

注: 您可以在 Control Room APIs 中查看 Community Edition,但 API 功能有限。您需要获得许可证的 Automation 360 Edition 才能访问 API 的全部功能。
  • 使用身份验证 API 生成 JSON Web 令牌。请参阅身份验证 API
  • 所有角色都具有配置凭证和属性所需的管理我的凭证和储物柜权限。不需要其他权限即可使用此端点。
在此示例中,您将配置包含三个属性的凭证以保存电子邮件主机名、用户名和密码。

过程

  1. 将认证令牌添加到请求标头。
  2. 创建凭证。使用 POST 方法和端点 URL:<your_control_room_url>/v2/credentialvault/credentials
    请求正文:此示例请求包括以下必需参数:
    • userProvided:一个布尔值,用于配置属性是否需要用户输入 (true) 还是针对所有用户的标准值 (false)。
    • masked:布尔值,用于配置属性值是用星号 (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/credentials/{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 中指定了凭证 ID,因此不需要在请求正文中包含凭证 ID 或名称。在此实例请求主体中,用户名密码属性所配置的值接受来自每个用户的不同输入。此外,密码属性配置为用星号掩盖输入的值。
    {
        "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
发送反馈