権限リストの取得

本インターフェースを呼び出し、指定した 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	はい	本インターフェースを呼び出す際のアクセス認証情報。社内アプリの access_token を取得するインターフェースを呼び出して取得できます。

パスパラメータ

名前	タイプ	必須	説明
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>トークンを使用してアカウント 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:
        """
        トークンを使用してアカウント 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 {

    /**
     * トークンを使用してアカウント 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:
// 
// トークンを使用してアカウント 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 {

  /**
   * トークンを使用してアカウント 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>トークンを使用してアカウント 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：カスタムタグ - 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 Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード