Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/staffAttributes/visibilitySettings |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Required permissions | permission-Contact.ReachableRule.ReadWrite-Management permission for Contacts data visibility |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential used to call this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an enterprise authorized to a third-party app API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| id | Long | No | Setting ID. - Leave it empty when adding a new setting. - Pass the ID of the setting to be modified when updating. |
| name | String | No | Name of the setting. |
| description | String | No | Description of the setting. |
| objectStaffIds | Array of String | No | The userId of employees for whom the fields are hidden. Obtain the userid parameter value by calling Get the user ID by using the silent login code. |
| objectDeptIds | Array of Long | No | The deptId of departments for which the fields are hidden. Obtain the dept_id parameter value by calling Get the department list. |
| objectTagIds | Array of Long | No | The roleId of roles for which the fields are hidden. Obtain the id parameter value by calling Get the list of organization roles. |
| hideFields | Array of String | No | The list of user attribute IDs to be hidden. - When the user attribute to be hidden is a custom organization attribute, pass the attribute ID. - When the user attribute to be hidden is a system default attribute, pass the system default attribute list. The system default attribute list is as follows: - name: Name - department: Department - email: Mail - manager: Direct manager - title: Job Title - mobile: Mobile number - ext_number: Extension number - work_station: Work Location - remark: Alias - hire_date: Hire date - job_number: Employee ID |
| excludeStaffIds | Array of String | No | The userId of employees who can view the hidden fields. |
| excludeDeptIds | Array of Long | No | The deptId of departments that can view the hidden fields. |
| excludeTagIds | Array of Long | No | The roleId of roles that can view the hidden fields. |
| active | Boolean | No | Whether the setting takes effect. - true: Takes effect. - false: Does not take effect. |
Request example
HTTPPOST /v1.0/contact/staffAttributes/visibilitySettings HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:aec2bd0xxx
Content-Type:application/json
{
"id" : 12364,
"name" : "Hide Field1",
"description" : "Hide Field1 for members of Department A",
"objectStaffIds" : [ "123456" ],
"objectDeptIds" : [ 111 ],
"objectTagIds" : [ 222 ],
"hideFields" : [ "12837","name" ],
"excludeStaffIds" : [ "userId" ],
"excludeDeptIds" : [ 111 ],
"excludeTagIds" : [ 222 ],
"active" : true
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkcontact_1_0.*;
import com.aliyun.dingtalkcontact_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* Initialize the account Client using the Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkcontact_1_0.Client createClient() throws Exception {
Config config = new Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkcontact_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
UpdateEmpAttrbuteVisibilitySettingHeaders updateEmpAttrbuteVisibilitySettingHeaders = new UpdateEmpAttrbuteVisibilitySettingHeaders();
updateEmpAttrbuteVisibilitySettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
UpdateEmpAttrbuteVisibilitySettingRequest updateEmpAttrbuteVisibilitySettingRequest = new UpdateEmpAttrbuteVisibilitySettingRequest()
.setId(12364L)
.setName("Hide Field1")
.setDescription("Hide Field1 for members of Department A")
.setObjectStaffIds(java.util.Arrays.asList(
"123456"
))
.setObjectDeptIds(java.util.Arrays.asList(
111L
))
.setObjectTagIds(java.util.Arrays.asList(
222L
))
.setHideFields(java.util.Arrays.asList(
"12837"
))
.setExcludeStaffIds(java.util.Arrays.asList(
"userId"
))
.setExcludeDeptIds(java.util.Arrays.asList(
111L
))
.setExcludeTagIds(java.util.Arrays.asList(
222L
))
.setActive(true);
try {
client.updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkcontact_1_0Client:
"""
Initialize the account Client using the Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkcontact_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
update_emp_attrbute_visibility_setting_headers = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingHeaders()
update_emp_attrbute_visibility_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_emp_attrbute_visibility_setting_request = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingRequest(
id=12364,
name='Hide Field1',
description='Hide Field1 for members of Department A',
object_staff_ids=[
'123456'
],
object_dept_ids=[
111
],
object_tag_ids=[
222
],
hide_fields=[
'12837'
],
exclude_staff_ids=[
'userId'
],
exclude_dept_ids=[
111
],
exclude_tag_ids=[
222
],
active=True
)
try:
client.update_emp_attrbute_visibility_setting_with_options(update_emp_attrbute_visibility_setting_request, update_emp_attrbute_visibility_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains the code and message properties, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
update_emp_attrbute_visibility_setting_headers = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingHeaders()
update_emp_attrbute_visibility_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_emp_attrbute_visibility_setting_request = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingRequest(
id=12364,
name='Hide Field1',
description='Hide Field1 for members of Department A',
object_staff_ids=[
'123456'
],
object_dept_ids=[
111
],
object_tag_ids=[
222
],
hide_fields=[
'12837'
],
exclude_staff_ids=[
'userId'
],
exclude_dept_ids=[
111
],
exclude_tag_ids=[
222
],
active=True
)
try:
await client.update_emp_attrbute_visibility_setting_with_options_async(update_emp_attrbute_visibility_setting_request, update_emp_attrbute_visibility_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err object contains the code and message properties, which help locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateEmpAttrbuteVisibilitySettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateEmpAttrbuteVisibilitySettingRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using the Token
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$updateEmpAttrbuteVisibilitySettingHeaders = new UpdateEmpAttrbuteVisibilitySettingHeaders([]);
$updateEmpAttrbuteVisibilitySettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
$updateEmpAttrbuteVisibilitySettingRequest = new UpdateEmpAttrbuteVisibilitySettingRequest([
"id" => 12364,
"name" => "Hide Field1",
"description" => "Hide Field1 for members of Department A",
"objectStaffIds" => [
"123456"
],
"objectDeptIds" => [
111
],
"objectTagIds" => [
222
],
"hideFields" => [
"12837"
],
"excludeStaffIds" => [
"userId"
],
"excludeDeptIds" => [
111
],
"excludeTagIds" => [
222
],
"active" => true
]);
try {
$client->updateEmpAttrbuteVisibilitySettingWithOptions($updateEmpAttrbuteVisibilitySettingRequest, $updateEmpAttrbuteVisibilitySettingHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// The err object contains the code and message properties, which help locate the issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkcontact_1_0 "github.com/alibabacloud-go/dingtalk/contact_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client using the Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkcontact_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkcontact_1_0.Client{}
_result, _err = dingtalkcontact_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
updateEmpAttrbuteVisibilitySettingHeaders := &dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingHeaders{}
updateEmpAttrbuteVisibilitySettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
updateEmpAttrbuteVisibilitySettingRequest := &dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingRequest{
Id: tea.Int64(12364),
Name: tea.String("Hide Field1"),
Description: tea.String("Hide Field1 for members of Department A"),
ObjectStaffIds: []*string{tea.String("123456")},
ObjectDeptIds: []*int64{tea.Int(111)},
ObjectTagIds: []*int64{tea.Int(222)},
HideFields: []*string{tea.String("12837")},
ExcludeStaffIds: []*string{tea.String("userId")},
ExcludeDeptIds: []*int64{tea.Int(111)},
ExcludeTagIds: []*int64{tea.Int(222)},
Active: tea.Bool(true),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// The err object contains the code and message properties, which help locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using the Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkcontact_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkcontact_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let updateEmpAttrbuteVisibilitySettingHeaders = new $dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingHeaders({ });
updateEmpAttrbuteVisibilitySettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
let updateEmpAttrbuteVisibilitySettingRequest = new $dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingRequest({
id: 12364,
name: "Hide Field1",
description: "Hide Field1 for members of Department A",
objectStaffIds: [
"123456"
],
objectDeptIds: [
111
],
objectTagIds: [
222
],
hideFields: [
"12837"
],
excludeStaffIds: [
"userId"
],
excludeDeptIds: [
111
],
excludeTagIds: [
222
],
active: true,
});
try {
await client.updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Initialize the account Client using the Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkcontact_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingHeaders updateEmpAttrbuteVisibilitySettingHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingHeaders();
updateEmpAttrbuteVisibilitySettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingRequest updateEmpAttrbuteVisibilitySettingRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingRequest
{
Id = 12364,
Name = "Hide Field1",
Description = "Hide Field1 for members of Department A",
ObjectStaffIds = new List<string>
{
"123456"
},
ObjectDeptIds = new List<long?>
{
111
},
ObjectTagIds = new List<long?>
{
222
},
HideFields = new List<string>
{
"12837"
},
ExcludeStaffIds = new List<string>
{
"userId"
},
ExcludeDeptIds = new List<long?>
{
111
},
ExcludeTagIds = new List<long?>
{
222
},
Active = true,
};
try
{
client.UpdateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err object contains the code and message properties, which help locate the issue
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err object contains the code and message properties, which help locate the issue
}
}
}
}
}
// This file is auto-generated, don't edit it. Thanks.
#include <alibabacloud/dingtalkcontact__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>
using namespace std;
Alibabacloud_Dingtalkcontact_1_0::Client createClient() {
shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
config->protocol = make_shared<string>("https");
config->regionId = make_shared<string>("central");
return Alibabacloud_Dingtalkcontact_1_0::Client(config);
}
int main(int argc, char *args[]) {
args;
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcontact_1_0::Client>(createClient());
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingHeaders> updateEmpAttrbuteVisibilitySettingHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingHeaders>();
updateEmpAttrbuteVisibilitySettingHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingRequest> updateEmpAttrbuteVisibilitySettingRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingRequest>(map<string, boost::any>({
{"id", boost::any(12364)},
{"name", boost::any(string("Hide Field1"))},
{"description", boost::any(string("Hide Field1 for members of Department A"))},
{"objectStaffIds", boost::any(vector<string>({
"123456"
}))},
{"objectDeptIds", boost::any(vector<long>({
111
}))},
{"objectTagIds", boost::any(vector<long>({
222
}))},
{"hideFields", boost::any(vector<string>({
"12837"
}))},
{"excludeStaffIds", boost::any(vector<string>({
"userId"
}))},
{"excludeDeptIds", boost::any(vector<long>({
111
}))},
{"excludeTagIds", boost::any(vector<long>({
222
}))},
{"active", boost::any(true)}
}));
try {
client->updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
}
catch (std::exception &err) {
if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
// The err object contains the code and message properties, which help locate the issue
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| result | Long | Setting ID. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : 10001
}
Error codes
If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | parameter.error | Parameter error | Parameter error |
| 400 | ruleNum.exceed.limit | The number of visibility rules of this type has reached the upper limit | The number of rules has reached the upper limit |
| 400 | forbid.add.rule | The number of visibility rules for the current organization has exceeded the limit. Adding new rules is not allowed | Adding new rules is not allowed |
| 400 | directory.invalid | The rule directory is unavailable | The rule directory is unavailable |
| 500 | system.error | Update error | Update error |