获取用户属性可见性设置

说明

调用本接口获取企业员工属性字段隐藏设置。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	通讯录可触达规则读写权限	API Explorer
第三方企业应用	支持	通讯录可触达规则读写权限	API Explorer
第三方个人应用	暂不支持	通讯录可触达规则读写权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	parameter.error	参数错误	参数错误
500	system.error	获取配置出错	获取配置出错

请求参数

Query 参数

nextToken

string

可选

下一页的token，第一次请求时传-1，后面请求时传前一次请求返回的nextToken值。

maxResults

string

可选

分页大小，最大支持100。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

hasMore

boolean

是否还有更多数据。

可选

nextCursor

integer

可选

下一次拉取时的token。

list

array [object {13}]

设置列表。

可选

integer

设置的ID。

可选

gmtCreate

string

设置创建的时间。

可选

gmtModified

string

可选

设置最后修改的时间。

name

string

设置的名称。

可选

description

string

设置的描述信息。

可选

objectStaffIds

array[string]

可选

需要隐藏的字段的用户userid列表。

objectDeptIds

array[integer]

可选

需要隐藏的字段的部门ID列表。

objectTagIds

array[integer]

可选

需要隐藏的字段的角色ID列表。

hideFields

array[string]

可选

隐藏的字段ID列表。

excludeStaffIds

array[string]

可选

白名单用户userid列表。

excludeDeptIds

array[integer]

可选

白名单部门ID列表。

excludeTagIds

array[integer]

可选

白名单角色ID列表。

active

boolean

是否生效。

可选

示例

{
  "hasMore": true,
  "nextCursor": 0,
  "list": [
    {
      "id": 0,
      "gmtCreate": "string",
      "gmtModified": "string",
      "name": "string",
      "description": "string",
      "objectStaffIds": [
        "string"
      ],
      "objectDeptIds": [
        0
      ],
      "objectTagIds": [
        0
      ],
      "hideFields": [
        "string"
      ],
      "excludeStaffIds": [
        "string"
      ],
      "excludeDeptIds": [
        0
      ],
      "excludeTagIds": [
        0
      ],
      "active": true
    }
  ]
}

获取用户属性可见性设置

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码