跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
权限集

权限集

URL 端点

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
版本：v1
种类
数据更新
描述
为 Adaptive Planning 用户指定权限集。
调用所需的权限
具有管理员访问权限的
用户
、
权限集
通过权限集指定 API，您可以检索和指定用户权限集。

支持的 HTTPS VERB：

HTTP 谓词
单一资源
收款资源
描述
GET
不支持
支持
检索所有用户及其指定的权限集。
POST
支持
支持
为用户添加权限集或更新现有权限集。

GET

申请
/users/permissionSets
检索指定给用户的权限集集合。
检索所有用户及其指定的权限集。您可以按 instanceCode 进行筛选。如果缺少 instanceCode 查询参数，则该 API 将检索您的默认实例中的所有用户及其权限集。如果您未指定这些查询参数，则分页将使用 limit 或offset 的默认值。
请求 URI 示例：
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
查询参数：
名称
描述
必填
instanceCode
定义实例上下文的实例的唯一标识符。
否
limit
单个响应中的最大对象数。默认值为 500。最大值为 500。
否
offset
回复集合中第一个用户的索引（从零开始）。默认值为 0。
将 offset 与 limit 参数结合使用，可控制回复集合的分页。
否
示例回复
来自实例用户且与 Workday 同步的示例回复
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

发布：

请求：
/users/permissionSets:
为用户指定或更新权限集。
为用户添加权限集或更新现有权限集。您可以按 instanceCode 进行筛选。如果缺少 instanceCode 查询参数，则 API 会将相应的权限集指定给默认实例中的所有用户。在请求正文中，指定以下必填查询字段：<userIdentifier> 和permissionSet。要提交批量请求以将相应的权限集指定给多个用户，请指定一个包含每个权限指定的数组。
查询参数：
名称
描述
必填
instanceCode
定义实例上下文的实例的唯一标识符。
否
userIdentifier
用户识别号，用于确定唯一的 Adaptive Planning 用户编号。可能的值：userName、wid、userGuid。
是
请求示例：
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
请求正文示例
POST 请求正文示例
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
负载参数
名称
描述
必填
wid
用户的 Workday 编号。
否
userName
用户的用户名（登录名）。
否
userGuid
用户的全局唯一编号，由系统在创建时指定。
否
名称
编号
权限集的名称。
权限集编号。
权限集的名称或编号为必填项。
是