Skip to main content
Call this API to get the permission inheritance mode based on the file UUID and the operator’s unionId.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v2.0/storage/spaces/dentries/{dentryUuid}/permissions/inheritances
HTTP MethodGET
Supported app typesappType-Internal app
Permissionspermission-Storage.Permission.Read-Read permission for organization storage authorization information

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. To obtain it, call the Get the access token of an internal app API.

Path parameter

NameTypeRequiredDescription
dentryUuidStringYesThe file UUID. To obtain it, call the File Search or Get dentryUuid information API and get the value of the dentryUuid field from the response.

Query parameter

NameTypeRequiredDescription
unionIdStringYesThe user’s unionId. To obtain it, call the Query user details API and get the value of the unionid parameter.

Request example

HTTP
GET /v2.0/storage/spaces/dentries/EpGxxxxR35y/permissions/inheritances?unionId=tXguN3xxxxAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json

{ }
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</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.GetPermissionInheritanceHeaders getPermissionInheritanceHeaders = new com.aliyun.dingtalkstorage_2_0.models.GetPermissionInheritanceHeaders();
        getPermissionInheritanceHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_2_0.models.GetPermissionInheritanceRequest getPermissionInheritanceRequest = new com.aliyun.dingtalkstorage_2_0.models.GetPermissionInheritanceRequest()
                .setUnionId("tXguN3xxxxAiEiE");
        try {
            client.getPermissionInheritanceWithOptions("EpGxxxxR35y", getPermissionInheritanceRequest, getPermissionInheritanceHeaders, 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 contains code and message attributes that help you 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 you locate the issue
            }

        }        
    }
}
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:
        """
        Initialize the account Client with a Token
        @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()
        get_permission_inheritance_headers = dingtalkstorage__2__0_models.GetPermissionInheritanceHeaders()
        get_permission_inheritance_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_permission_inheritance_request = dingtalkstorage__2__0_models.GetPermissionInheritanceRequest(
            union_id='tXguN3xxxxAiEiE'
        )
        try:
            client.get_permission_inheritance_with_options('EpGxxxxR35y', get_permission_inheritance_request, get_permission_inheritance_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 you locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_permission_inheritance_headers = dingtalkstorage__2__0_models.GetPermissionInheritanceHeaders()
        get_permission_inheritance_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_permission_inheritance_request = dingtalkstorage__2__0_models.GetPermissionInheritanceRequest(
            union_id='tXguN3xxxxAiEiE'
        )
        try:
            await client.get_permission_inheritance_with_options_async('EpGxxxxR35y', get_permission_inheritance_request, get_permission_inheritance_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 you locate the issue
                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\GetPermissionInheritanceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\GetPermissionInheritanceRequest;
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();
        $getPermissionInheritanceHeaders = new GetPermissionInheritanceHeaders([]);
        $getPermissionInheritanceHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getPermissionInheritanceRequest = new GetPermissionInheritanceRequest([
            "unionId" => "tXguN3xxxxAiEiE"
        ]);
        try {
            $client->getPermissionInheritanceWithOptions("EpGxxxxR35y", $getPermissionInheritanceRequest, $getPermissionInheritanceHeaders, 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 you 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));
Go
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:
// 
// Initialize the account Client with a Token
// 
// @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
  }

  getPermissionInheritanceHeaders := &dingtalkstorage_2_0.GetPermissionInheritanceHeaders{}
  getPermissionInheritanceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getPermissionInheritanceRequest := &dingtalkstorage_2_0.GetPermissionInheritanceRequest{
    UnionId: tea.String("tXguN3xxxxAiEiE"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetPermissionInheritanceWithOptions(tea.String("EpGxxxxR35y"), getPermissionInheritanceRequest, getPermissionInheritanceHeaders, &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 you locate the issue
    }

  }
  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 {

  /**
   * Initialize the account Client with a Token
   * @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 getPermissionInheritanceHeaders = new dingtalkstorage_2_0.GetPermissionInheritanceHeaders({ });
    getPermissionInheritanceHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getPermissionInheritanceRequest = new dingtalkstorage_2_0.GetPermissionInheritanceRequest({
      unionId: 'tXguN3xxxxAiEiE',
    });
    try {
      await client.getPermissionInheritanceWithOptions('EpGxxxxR35y', getPermissionInheritanceRequest, getPermissionInheritanceHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that help you locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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>Initialize the account Client with a Token</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.GetPermissionInheritanceHeaders getPermissionInheritanceHeaders = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.GetPermissionInheritanceHeaders();
            getPermissionInheritanceHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.GetPermissionInheritanceRequest getPermissionInheritanceRequest = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.GetPermissionInheritanceRequest
            {
                UnionId = "tXguN3xxxxAiEiE",
            };
            try
            {
                client.GetPermissionInheritanceWithOptions("EpGxxxxR35y", getPermissionInheritanceRequest, getPermissionInheritanceHeaders, 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 you 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 you locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
inheritanceStringThe permission inheritance mode. Enum values: - PASS_ON: Pass on. The current file (folder) inherits permissions from all parent nodes and combines them with the permissions set on the current file (folder). For the same user, the highest permission level applies. - BREAK: Break. Permission inheritance is broken at the current node. - Break is not supported for OWNER and MANAGER. - This is the default permission inheritance mode.

Response body example

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

{
  "inheritance" : "PASS_ON"
}

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error
400paramError.dentryUuid%sParameter error - dentryUuid
404spaceNotExist%sSpace does not exist
404dentryNotExist%sFile does not exist
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timed out