获取权限列表

调用本接口，根据指定id（文件uuid、知识库rootNodeId、知识库节点nodeId)和操作者id，查询用户文件权限列表。

请求

基本信息

字段	值
HTTP URL	`https://api.dingtalk.io/v2.0/storage/spaces/dentries/{dentryUuid}/permissions/query`
HTTP Method	POST
支持的应用类型	appType-企业内部应用
权限要求	permission-Storage.Permission.Read-企业存储授权信息读权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，可调用获取企业内部应用的accessToken接口获取。

路径参数

名称	类型	是否必填	描述
dentryUuid	String	是	文件uuid，可调用搜索文件接口或获取dentryUuid信息接口，获取返回参数dentryUuid字段。

查询参数

名称	类型	是否必填	描述
unionId	String	是	用户unionId，调用查询用户详情接口获取。

请求体

名称	类型	是否必填	描述
option	Object	否	可选参数。
nextToken	String	否	分页游标。
maxResults	Integer	否	分页大小，默认值30。
filterRoleIds	Array of String	否	过滤角色。

请求示例

HTTP

POST /v2.0/storage/spaces/dentries/EpGxxxxN7R35y/permissions/query?unionId=tXgxxxxRAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{
  "option" : {
    "nextToken" : "next_token",
    "maxResults" : 30,
    "filterRoleIds" : [ "role_id" ],
    "filterMemberTypes" : [ ]
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用 Token 初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkstorage_2_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkstorage_2_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkstorage_2_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_2_0.models.ListPermissionsHeaders listPermissionsHeaders = new com.aliyun.dingtalkstorage_2_0.models.ListPermissionsHeaders();
        listPermissionsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_2_0.models.ListPermissionsRequest.ListPermissionsRequestOption option = new com.aliyun.dingtalkstorage_2_0.models.ListPermissionsRequest.ListPermissionsRequestOption()
                .setNextToken("next_token")
                .setMaxResults(30)
                .setFilterRoleIds(java.util.Arrays.asList(
                    "role_id"
                ));
        com.aliyun.dingtalkstorage_2_0.models.ListPermissionsRequest listPermissionsRequest = new com.aliyun.dingtalkstorage_2_0.models.ListPermissionsRequest()
                .setUnionId("tXgxxxxRAiEiE")
                .setOption(option);
        try {
            client.listPermissionsWithOptions("EpGxxxxN7R35y", listPermissionsRequest, listPermissionsHeaders, new com.aliyun.teautil.models.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 属性，可帮助开发定位问题
            }

        }        
    }
}

Python

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

from typing import List

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

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_permissions_headers = dingtalkstorage__2__0_models.ListPermissionsHeaders()
        list_permissions_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__2__0_models.ListPermissionsRequestOption(
            next_token='next_token',
            max_results=30,
            filter_role_ids=[
                'role_id'
            ]
        )
        list_permissions_request = dingtalkstorage__2__0_models.ListPermissionsRequest(
            union_id='tXgxxxxRAiEiE',
            option=option
        )
        try:
            client.list_permissions_with_options('EpGxxxxN7R35y', list_permissions_request, list_permissions_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()
        list_permissions_headers = dingtalkstorage__2__0_models.ListPermissionsHeaders()
        list_permissions_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__2__0_models.ListPermissionsRequestOption(
            next_token='next_token',
            max_results=30,
            filter_role_ids=[
                'role_id'
            ]
        )
        list_permissions_request = dingtalkstorage__2__0_models.ListPermissionsRequest(
            union_id='tXgxxxxRAiEiE',
            option=option
        )
        try:
            await client.list_permissions_with_options_async('EpGxxxxN7R35y', list_permissions_request, list_permissions_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

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\ListPermissionsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\ListPermissionsRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\ListPermissionsRequest;
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();
        $listPermissionsHeaders = new ListPermissionsHeaders([]);
        $listPermissionsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "nextToken" => "next_token",
            "maxResults" => 30,
            "filterRoleIds" => [
                "role_id"
            ]
        ]);
        $listPermissionsRequest = new ListPermissionsRequest([
            "unionId" => "tXgxxxxRAiEiE",
            "option" => $option
        ]);
        try {
            $client->listPermissionsWithOptions("EpGxxxxN7R35y", $listPermissionsRequest, $listPermissionsHeaders, 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));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkstorage_2_0  "github.com/alibabacloud-go/dingtalk/storage_2_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

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

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

  listPermissionsHeaders := &dingtalkstorage_2_0.ListPermissionsHeaders{}
  listPermissionsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_2_0.ListPermissionsRequestOption{
    NextToken: tea.String("next_token"),
    MaxResults: tea.Int32(30),
    FilterRoleIds: []*string{tea.String("role_id")},
  }
  listPermissionsRequest := &dingtalkstorage_2_0.ListPermissionsRequest{
    UnionId: tea.String("tXgxxxxRAiEiE"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListPermissionsWithOptions(tea.String("EpGxxxxN7R35y"), listPermissionsRequest, listPermissionsHeaders, &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)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_2_0 = require('@alicloud/dingtalk/storage_2_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

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

  static async main(args) {
    let client = Client.createClient();
    let listPermissionsHeaders = new dingtalkstorage_2_0.ListPermissionsHeaders({ });
    listPermissionsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let option = new dingtalkstorage_2_0.ListPermissionsRequestOption({
      nextToken: 'next_token',
      maxResults: 30,
      filterRoleIds: [
        'role_id'
      ],
    });
    let listPermissionsRequest = new dingtalkstorage_2_0.ListPermissionsRequest({
      unionId: 'tXgxxxxRAiEiE',
      option: option,
    });
    try {
      await client.listPermissionsWithOptions('EpGxxxxN7R35y', listPermissionsRequest, listPermissionsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
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 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用 Token 初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkstorage_2_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_2_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsHeaders listPermissionsHeaders = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsHeaders();
            listPermissionsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsRequest.ListPermissionsRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsRequest.ListPermissionsRequestOption
            {
                NextToken = "next_token",
                MaxResults = 30,
                FilterRoleIds = new List<string>
                {
                    "role_id"
                },
            };
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsRequest listPermissionsRequest = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.ListPermissionsRequest
            {
                UnionId = "tXgxxxxRAiEiE",
                Option = option,
            };
            try
            {
                client.ListPermissionsWithOptions("EpGxxxxN7R35y", listPermissionsRequest, listPermissionsHeaders, 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 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
permissions	Array	权限列表分页数据，最多显示30个。
dentryUuid	String	文件uuid。
member	Object	权限成员。
type	String	权限成员类型，枚举值： - ORG：企业 - DEPT：部门 - TAG：自定义tag - CONVERSATION：会话 - USER：用户
id	String	权限成员id： - `type=ORG`时，id为企业id - `type=DEPT`时，id为部门id - `type=TAG`时，id为标签id - `type=CONVERSATION`时，id为会话id - `type=USER`时，id为员工userId
corpId	String	权限归属的企业。 - 如果存在企业id，对应member离职的时候会自动清理权限。 - 如果memberType是dept类型，必须要有企业id。
name	String	成员名字。
role	Object	权限角色。
id	String	角色id，枚举值： - OWNER：拥有者，具有以下权限点： - PermissionPrivilegeEnum.INFO - PermissionPrivilegeEnum.LIST - PermissionPrivilegeEnum.PREVIEW - PermissionPrivilegeEnum.READ - PermissionPrivilegeEnum.WRITE - PermissionPrivilegeEnum.DOWNLOAD - PermissionPrivilegeEnum.ADD - PermissionPrivilegeEnum.DELETE - PermissionPrivilegeEnum.MODIFY - PermissionPrivilegeEnum.COPY - PermissionPrivilegeEnum.RENAME - PermissionPrivilegeEnum.READ_PERMISSION - PermissionPrivilegeEnum.WRITE_PERMISSION - PermissionPrivilegeEnum.ASSIGN - MANAGER：管理者，具有以下权限点： - PermissionPrivilegeEnum.INFO - PermissionPrivilegeEnum.LIST - PermissionPrivilegeEnum.PREVIEW - PermissionPrivilegeEnum.READ - PermissionPrivilegeEnum.WRITE - PermissionPrivilegeEnum.DOWNLOAD - PermissionPrivilegeEnum.ADD - PermissionPrivilegeEnum.DELETE - PermissionPrivilegeEnum.MODIFY - PermissionPrivilegeEnum.COPY - PermissionPrivilegeEnum.RENAME - PermissionPrivilegeEnum.READ_PERMISSION - PermissionPrivilegeEnum.WRITE_PERMISSION - EDITOR：编辑者，具有以下权限点： - PermissionPrivilegeEnum.INFO - PermissionPrivilegeEnum.LIST - PermissionPrivilegeEnum.PREVIEW - PermissionPrivilegeEnum.READ - PermissionPrivilegeEnum.WRITE - PermissionPrivilegeEnum.DOWNLOAD - PermissionPrivilegeEnum.ADD - DOWNLOADER：查看下载者，具有以下权限点： - PermissionPrivilegeEnum.INFO - PermissionPrivilegeEnum.LIST - PermissionPrivilegeEnum.PREVIEW - PermissionPrivilegeEnum.READ - PermissionPrivilegeEnum.DOWNLOAD - READER: 仅可查看者，具有以下权限点： - PermissionPrivilegeEnum.INFO - PermissionPrivilegeEnum.LIST - PermissionPrivilegeEnum.PREVIEW
name	String	角色名称。
duration	Long	有效时间。 `duration`为空表示授权没有时效限制。
nextToken	String	分页游标。 `nextToken`不为空表示有更多数据。

响应体示例

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

{
  "permissions" : [ {
    "dentryUuid" : "EpGBxxxxgN7R35y",
    "member" : {
      "type" : "USER",
      "id" : "01472xxxx041",
      "corpId" : "ding16b241fd05********288",
      "name" : "member_name"
    },
    "role" : {
      "id" : "MANAGER",
      "name" : "MANAGER"
    },
    "duration" : 3600
  } ],
  "nextToken" : "next_token"
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	paramError	%s	参数错误
400	paramError.dentryUuid	%s	参数错误-dentryUuid
400	paramError.roleId	%s	参数错误-roleId
403	permissionDenied	%s	用户缺少获取权限列表的权限
404	spaceNotExist	%s	空间不存在
404	dentryNotExist	%s	文件不存在
500	systemError	%s	系统错误
500	unknownError	Unknown Error	未知错误
503	operationTimeout	%s	请求超时

API 调用指南

认证与授权

通讯录管理

日程

音视频

AI 表格

文档/文件

即时通信

请求

基本信息

请求头

路径参数

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码

​请求

​基本信息

​请求头

​路径参数

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

路径参数

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码