修改角色可见性

调用本接口修改角色标签可见性。

角色的标签如下图所示:

权限

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

应用类型

是否支持

权限

API Explorer调试

企业内部应用

支持

伙伴钉部门信息写权限

API Explorer

第三方企业应用

支持

伙伴钉部门信息写权限

API Explorer

第三方个人应用

暂不支持

伙伴钉部门信息写权限

暂不支持

请求方法

PUT /v1.0/exclusive/partnerDepartments/visibilityRoles HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:String
Content-Type:application/json

{
  "labelId" : Long,
  "deptIds" : [ Long ],
  "userIds" : [ "String" ]
}

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证,通过以下获取:

Body参数

名称

类型

是否必填

描述

labelId

Long

标签iID。

deptIds

Array of Long

可见的部门ID列表。

userIds

Array of String

可见的员工userid列表。

返回参数

名称

类型

描述

Boolean

调用是否成功。

示例

请求示例

PUT /v1.0/exclusive/partnerDepartments/visibilityRoles HTTP/1.1
Host:api.dingtalk.com
x-acs-dingtalk-access-token:8eef0xxx
Content-Type:application/json

{
  "labelId" : 1312312,
  "deptIds" : [ 1111212 ],
  "userIds" : [ "user123" ]
}
// 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.dingtalkexclusive_1_0.*;
import com.aliyun.dingtalkexclusive_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkexclusive_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkexclusive_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkexclusive_1_0.Client client = Sample.createClient();
        UpdateRoleVisibilityHeaders updateRoleVisibilityHeaders = new UpdateRoleVisibilityHeaders();
        updateRoleVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
        UpdateRoleVisibilityRequest updateRoleVisibilityRequest = new UpdateRoleVisibilityRequest()
                .setLabelId(1312312L)
                .setDeptIds(java.util.Arrays.asList(
                    1111212L
                ))
                .setUserIds(java.util.Arrays.asList(
                    "user123"
                ));
        try {
            client.updateRoleVisibilityWithOptions(updateRoleVisibilityRequest, updateRoleVisibilityHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性,可帮助开发定位问题
            }

        } 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 中含有 code 和 message 属性,可帮助开发定位问题
            }

        }        
    }
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.exclusive_1_0.client import Client as dingtalkexclusive_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.exclusive_1_0 import models as dingtalkexclusive__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() -> dingtalkexclusive_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkexclusive_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_role_visibility_headers = dingtalkexclusive__1__0_models.UpdateRoleVisibilityHeaders()
        update_role_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_role_visibility_request = dingtalkexclusive__1__0_models.UpdateRoleVisibilityRequest(
            label_id=1312312,
            dept_ids=[
                1111212
            ],
            user_ids=[
                'user123'
            ]
        )
        try:
            client.update_role_visibility_with_options(update_role_visibility_request, update_role_visibility_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性,可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_role_visibility_headers = dingtalkexclusive__1__0_models.UpdateRoleVisibilityHeaders()
        update_role_visibility_headers.x_acs_dingtalk_access_token = '<your access token>'
        update_role_visibility_request = dingtalkexclusive__1__0_models.UpdateRoleVisibilityRequest(
            label_id=1312312,
            dept_ids=[
                1111212
            ],
            user_ids=[
                'user123'
            ]
        )
        try:
            await client.update_role_visibility_with_options_async(update_role_visibility_request, update_role_visibility_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性,可帮助开发定位问题
                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\Vexclusive_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vexclusive_1_0\Models\UpdateRoleVisibilityHeaders;
use AlibabaCloud\SDK\Dingtalk\Vexclusive_1_0\Models\UpdateRoleVisibilityRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @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();
        $updateRoleVisibilityHeaders = new UpdateRoleVisibilityHeaders([]);
        $updateRoleVisibilityHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $updateRoleVisibilityRequest = new UpdateRoleVisibilityRequest([
            "labelId" => 1312312,
            "deptIds" => [
                1111212
            ],
            "userIds" => [
                "user123"
            ]
        ]);
        try {
            $client->updateRoleVisibilityWithOptions($updateRoleVisibilityRequest, $updateRoleVisibilityHeaders, 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 中含有 code ��� message 属性,可帮助开发定位问题
            }
        }
    }
}
$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"
  dingtalkexclusive_1_0  "github.com/alibabacloud-go/dingtalk/exclusive_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)


/**
 * 使用 Token 初始化账号Client
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkexclusive_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkexclusive_1_0.Client{}
  _result, _err = dingtalkexclusive_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  updateRoleVisibilityHeaders := &dingtalkexclusive_1_0.UpdateRoleVisibilityHeaders{}
  updateRoleVisibilityHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  updateRoleVisibilityRequest := &dingtalkexclusive_1_0.UpdateRoleVisibilityRequest{
    LabelId: tea.Int64(1312312),
    DeptIds: []*int64{tea.Int(1111212)},
    UserIds: []*string{tea.String("user123")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateRoleVisibilityWithOptions(updateRoleVisibilityRequest, updateRoleVisibilityHeaders, &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 中含有 code 和 message 属性,可帮助开发定位问题
    }

  }
  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 dingtalkexclusive_1_0, * as $dingtalkexclusive_1_0 from '@alicloud/dingtalk/exclusive_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkexclusive_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkexclusive_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let updateRoleVisibilityHeaders = new $dingtalkexclusive_1_0.UpdateRoleVisibilityHeaders({ });
    updateRoleVisibilityHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let updateRoleVisibilityRequest = new $dingtalkexclusive_1_0.UpdateRoleVisibilityRequest({
      labelId: 1312312,
      deptIds: [
        1111212
      ],
      userIds: [
        "user123"
      ],
    });
    try {
      await client.updateRoleVisibilityWithOptions(updateRoleVisibilityRequest, updateRoleVisibilityHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err 中含有 code 和 message 属性,可帮助开发定位问题
      }

    }    
  }

}

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 
    {

        /**
         * 使用 Token 初始化账号Client
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkexclusive_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkexclusive_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkexclusive_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.UpdateRoleVisibilityHeaders updateRoleVisibilityHeaders = new AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.UpdateRoleVisibilityHeaders();
            updateRoleVisibilityHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.UpdateRoleVisibilityRequest updateRoleVisibilityRequest = new AlibabaCloud.SDK.Dingtalkexclusive_1_0.Models.UpdateRoleVisibilityRequest
            {
                LabelId = 1312312,
                DeptIds = new List<long?>
                {
                    1111212
                },
                UserIds = new List<string>
                {
                    "user123"
                },
            };
            try
            {
                client.UpdateRoleVisibilityWithOptions(updateRoleVisibilityRequest, updateRoleVisibilityHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性,可帮助开发定位问题
                }
            }
            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 中含有 code 和 message 属性,可帮助开发定位问题
                }
            }
        }


    }
}
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkexclusive__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_Dingtalkexclusive_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_Dingtalkexclusive_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args++;
  shared_ptr<Alibabacloud_Dingtalkexclusive_1_0::Client> client = make_shared<Alibabacloud_Dingtalkexclusive_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkexclusive_1_0::UpdateRoleVisibilityHeaders> updateRoleVisibilityHeaders = make_shared<Alibabacloud_Dingtalkexclusive_1_0::UpdateRoleVisibilityHeaders>();
  updateRoleVisibilityHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkexclusive_1_0::UpdateRoleVisibilityRequest> updateRoleVisibilityRequest = make_shared<Alibabacloud_Dingtalkexclusive_1_0::UpdateRoleVisibilityRequest>(map<string, boost::any>({
    {"labelId", boost::any(1312312)},
    {"deptIds", boost::any(vector<long>({
      1111212
    }))},
    {"userIds", boost::any(vector<string>({
      "user123"
    }))}
  }));
  try {
    client->updateRoleVisibilityWithOptions(updateRoleVisibilityRequest, updateRoleVisibilityHeaders, 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 中含有 code 和 message 属性,可帮助开发定位问题
    }
  }
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : true
}

错误码

HttpCode

错误码

错误信息

说明

400

parameter.invalid

参数错误

参数漏填或者格式错误

500

system.busy

系统繁忙

内部服务发生的异常情况