API call description
After your organization calls the API to set user attribute visibility, call this API to get the hidden settings of employee attribute fields.Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/staffAttributes/visibilitySettings |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permissions required | permission-Contact.ReachableRule.ReadWrite-Management permissions for Contacts data visibility |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Get 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 organization that has authorized a third-party app API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| nextToken | Long | No | The pagination cursor. - For the first call, set this parameter to -1. - For subsequent calls, set this parameter to the nextToken returned by the previous call. |
| maxResults | Integer | No | The page size. The maximum value is 100. |
Request example
HTTPGET /v1.0/contact/staffAttributes/visibilitySettings?nextToken=-1&maxResults=10 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:aec2bd0xxx
Content-Type:application/json
// 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 with a 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();
ListEmpAttributeVisibilityHeaders listEmpAttributeVisibilityHeaders = new ListEmpAttributeVisibilityHeaders();
listEmpAttributeVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
ListEmpAttributeVisibilityRequest listEmpAttributeVisibilityRequest = new ListEmpAttributeVisibilityRequest()
.setNextToken(-1L)
.setMaxResults(10);
try {
client.listEmpAttributeVisibilityWithOptions(listEmpAttributeVisibilityRequest, listEmpAttributeVisibilityHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err contains code and message attributes that 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)) {
// err contains code and message attributes that 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 with a 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()
list_emp_attribute_visibility_headers = dingtalkcontact__1__0_models.ListEmpAttributeVisibilityHeaders()
list_emp_attribute_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
list_emp_attribute_visibility_request = dingtalkcontact__1__0_models.ListEmpAttributeVisibilityRequest(
next_token=-1,
max_results=10
)
try:
client.list_emp_attribute_visibility_with_options(list_emp_attribute_visibility_request, list_emp_attribute_visibility_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_emp_attribute_visibility_headers = dingtalkcontact__1__0_models.ListEmpAttributeVisibilityHeaders()
list_emp_attribute_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
list_emp_attribute_visibility_request = dingtalkcontact__1__0_models.ListEmpAttributeVisibilityRequest(
next_token=-1,
max_results=10
)
try:
await client.list_emp_attribute_visibility_with_options_async(list_emp_attribute_visibility_request, list_emp_attribute_visibility_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains code and message attributes that 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\ListEmpAttributeVisibilityHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListEmpAttributeVisibilityRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a 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();
$listEmpAttributeVisibilityHeaders = new ListEmpAttributeVisibilityHeaders([]);
$listEmpAttributeVisibilityHeaders->xAcsDingtalkAccessToken = "<your access token>";
$listEmpAttributeVisibilityRequest = new ListEmpAttributeVisibilityRequest([
"nextToken" => -1,
"maxResults" => 10
]);
try {
$client->listEmpAttributeVisibilityWithOptions($listEmpAttributeVisibilityRequest, $listEmpAttributeVisibilityHeaders, 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)) {
// err contains code and message attributes that 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 with a 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
}
listEmpAttributeVisibilityHeaders := &dingtalkcontact_1_0.ListEmpAttributeVisibilityHeaders{}
listEmpAttributeVisibilityHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
listEmpAttributeVisibilityRequest := &dingtalkcontact_1_0.ListEmpAttributeVisibilityRequest{
NextToken: tea.Int64(-1),
MaxResults: tea.Int32(10),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListEmpAttributeVisibilityWithOptions(listEmpAttributeVisibilityRequest, listEmpAttributeVisibilityHeaders, &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)) {
// err contains code and message attributes that 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 with a 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 listEmpAttributeVisibilityHeaders = new $dingtalkcontact_1_0.ListEmpAttributeVisibilityHeaders({ });
listEmpAttributeVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
let listEmpAttributeVisibilityRequest = new $dingtalkcontact_1_0.ListEmpAttributeVisibilityRequest({
nextToken: -1,
maxResults: 10,
});
try {
await client.listEmpAttributeVisibilityWithOptions(listEmpAttributeVisibilityRequest, listEmpAttributeVisibilityHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains code and message attributes that 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 with a 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.ListEmpAttributeVisibilityHeaders listEmpAttributeVisibilityHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpAttributeVisibilityHeaders();
listEmpAttributeVisibilityHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpAttributeVisibilityRequest listEmpAttributeVisibilityRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpAttributeVisibilityRequest
{
NextToken = -1,
MaxResults = 10,
};
try
{
client.ListEmpAttributeVisibilityWithOptions(listEmpAttributeVisibilityRequest, listEmpAttributeVisibilityHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains code and message attributes that 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))
{
// err contains code and message attributes that 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::ListEmpAttributeVisibilityHeaders> listEmpAttributeVisibilityHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::ListEmpAttributeVisibilityHeaders>();
listEmpAttributeVisibilityHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::ListEmpAttributeVisibilityRequest> listEmpAttributeVisibilityRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::ListEmpAttributeVisibilityRequest>(map<string, boost::any>({
{"nextToken", boost::any(-1)},
{"maxResults", boost::any(10)}
}));
try {
client->listEmpAttributeVisibilityWithOptions(listEmpAttributeVisibilityRequest, listEmpAttributeVisibilityHeaders, 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)) {
// err contains code and message attributes that help locate the issue
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| hasMore | Boolean | Whether more data is available. - true: Yes - false: No |
| nextCursor | Long | The token for the next pull. |
| list | Array | The list of settings. |
| id | Long | The ID of the setting. |
| gmtCreate | String | The time when the setting was created. |
| gmtModified | String | The time when the setting was last modified. |
| name | String | The name of the setting. |
| description | String | The description of the setting. |
| objectStaffIds | Array of String | The userId of users for whom the fields are hidden. |
| objectDeptIds | Array of Long | The deptId of departments for which the fields are hidden. |
| objectTagIds | Array of Long | The roleId of roles for which the fields are hidden. |
| hideFields | Array of String | The IDs of the hidden fields. |
| excludeStaffIds | Array of String | The userId of users in the allowlist. |
| excludeDeptIds | Array of Long | The deptId of departments in the allowlist. |
| excludeTagIds | Array of Long | The roleId of roles in the allowlist. |
| active | Boolean | Whether the setting is in effect. - true: Yes - false: No |
Response example
HTTP/1.1 200 OK
Content-Type:application/json
{
"hasMore" : true,
"nextCursor" : -1,
"list" : [ {
"id" : 10001,
"gmtCreate" : "2021-06-18 00:00:00",
"gmtModified" : "2021-06-18 00:00:00",
"name" : "Setting name",
"description" : "Setting description",
"objectStaffIds" : [ "“1111“" ],
"objectDeptIds" : [ 111 ],
"objectTagIds" : [ 222 ],
"hideFields" : [ "11334" ],
"excludeStaffIds" : [ "userId" ],
"excludeDeptIds" : [ 111 ],
"excludeTagIds" : [ 222 ],
"active" : true
} ]
}
Error codes
If an error occurs 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 |
| 500 | system.error | Failed to get the configuration | Failed to get the configuration |