设置用户属性可见性

POST

http://127.0.0.1/v1.0/contact/staffAttributes/visibilitySettings

新版服务端API（DingTalk OpenAPI）/通讯录/员工管理

最后修改时间：2022-08-30 09:19:23

责任人：未设置

说明

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

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	parameter.error	参数错误	参数错误
500	system.error	更新错误	更新错误

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

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

Body 参数application/json

integer

可选

更新的时候需要指定ID，新增的时候不需要指定。

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

是否生效。

可选

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/v1.0/contact/staffAttributes/visibilitySettings' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

result

integer

设置的ID。

可选

示例

{
  "result": 0
}

获取用户属性可见性设置

根据迁移后的dingId查询原dingId

设置用户属性可见性

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码