Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v2.0/storage/spaces/dentries/{dentryUuid}/permissions/inheritances |
| HTTP Method | PUT |
| Supported app types | appType-Internal app |
| Permissions required | permission-Storage.Permission.Write-Write permission for organization storage authorization information |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it by calling the Get the access token of an internal app API. |
Path parameter
| Name | Type | Required | Description |
|---|---|---|---|
| dentryUuid | String | Yes | The file UUID. Obtain the value of the dentryUuid response parameter by calling the File Search or Get dentryUuid information API. |
Query parameter
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the user. Obtain the value of the unionid parameter by calling the Query user details API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| inheritance | String | Yes | The permission inheritance mode. Enum values: - PASS_ON: Pass on. The current file or folder inherits the permissions of all parent nodes, which are then combined with the permissions on the current file or folder. For the same user, the highest permission is applied. - BREAK: Break. The permission inheritance is interrupted at the current node. - Break is not supported for OWNER and MANAGER. - This is the default permission inheritance mode. |
Request example
HTTPPUT /v2.0/storage/spaces/dentries/EpGBaxxxxxR35y/permissions/inheritances?unionId=tXguxxxxlLURAiEiE HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
{
"inheritance" : "PASS_ON"
}
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.SetPermissionInheritanceHeaders setPermissionInheritanceHeaders = new com.aliyun.dingtalkstorage_2_0.models.SetPermissionInheritanceHeaders();
setPermissionInheritanceHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_2_0.models.SetPermissionInheritanceRequest setPermissionInheritanceRequest = new com.aliyun.dingtalkstorage_2_0.models.SetPermissionInheritanceRequest()
.setUnionId("tXguxxxxlLURAiEiE")
.setInheritance("PASS_ON");
try {
client.setPermissionInheritanceWithOptions("EpGBaxxxxxR35y", setPermissionInheritanceRequest, setPermissionInheritanceHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains code and message properties to help you troubleshoot 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)) {
// The err contains code and message properties to help you troubleshoot the issue
}
}
}
}
# -*- 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()
set_permission_inheritance_headers = dingtalkstorage__2__0_models.SetPermissionInheritanceHeaders()
set_permission_inheritance_headers.x_acs_dingtalk_access_token = '<your access token>'
set_permission_inheritance_request = dingtalkstorage__2__0_models.SetPermissionInheritanceRequest(
union_id='tXguxxxxlLURAiEiE',
inheritance='PASS_ON'
)
try:
client.set_permission_inheritance_with_options('EpGBaxxxxxR35y', set_permission_inheritance_request, set_permission_inheritance_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message properties to help you troubleshoot the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
set_permission_inheritance_headers = dingtalkstorage__2__0_models.SetPermissionInheritanceHeaders()
set_permission_inheritance_headers.x_acs_dingtalk_access_token = '<your access token>'
set_permission_inheritance_request = dingtalkstorage__2__0_models.SetPermissionInheritanceRequest(
union_id='tXguxxxxlLURAiEiE',
inheritance='PASS_ON'
)
try:
await client.set_permission_inheritance_with_options_async('EpGBaxxxxxR35y', set_permission_inheritance_request, set_permission_inheritance_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains code and message properties to help you troubleshoot 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\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\SetPermissionInheritanceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_2_0\Models\SetPermissionInheritanceRequest;
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();
$setPermissionInheritanceHeaders = new SetPermissionInheritanceHeaders([]);
$setPermissionInheritanceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$setPermissionInheritanceRequest = new SetPermissionInheritanceRequest([
"unionId" => "tXguxxxxlLURAiEiE",
"inheritance" => "PASS_ON"
]);
try {
$client->setPermissionInheritanceWithOptions("EpGBaxxxxxR35y", $setPermissionInheritanceRequest, $setPermissionInheritanceHeaders, 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)) {
// The err contains code and message properties to help you troubleshoot 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));
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
}
setPermissionInheritanceHeaders := &dingtalkstorage_2_0.SetPermissionInheritanceHeaders{}
setPermissionInheritanceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
setPermissionInheritanceRequest := &dingtalkstorage_2_0.SetPermissionInheritanceRequest{
UnionId: tea.String("tXguxxxxlLURAiEiE"),
Inheritance: tea.String("PASS_ON"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SetPermissionInheritanceWithOptions(tea.String("EpGBaxxxxxR35y"), setPermissionInheritanceRequest, setPermissionInheritanceHeaders, &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)) {
// The err contains code and message properties to help you troubleshoot the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'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 setPermissionInheritanceHeaders = new dingtalkstorage_2_0.SetPermissionInheritanceHeaders({ });
setPermissionInheritanceHeaders.xAcsDingtalkAccessToken = '<your access token>';
let setPermissionInheritanceRequest = new dingtalkstorage_2_0.SetPermissionInheritanceRequest({
unionId: 'tXguxxxxlLURAiEiE',
inheritance: 'PASS_ON',
});
try {
await client.setPermissionInheritanceWithOptions('EpGBaxxxxxR35y', setPermissionInheritanceRequest, setPermissionInheritanceHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// The err contains code and message properties to help you troubleshoot the issue
}
}
}
}
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>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.SetPermissionInheritanceHeaders setPermissionInheritanceHeaders = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SetPermissionInheritanceHeaders();
setPermissionInheritanceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SetPermissionInheritanceRequest setPermissionInheritanceRequest = new AlibabaCloud.SDK.Dingtalkstorage_2_0.Models.SetPermissionInheritanceRequest
{
UnionId = "tXguxxxxlLURAiEiE",
Inheritance = "PASS_ON",
};
try
{
client.SetPermissionInheritanceWithOptions("EpGBaxxxxxR35y", setPermissionInheritanceRequest, setPermissionInheritanceHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains code and message properties to help you troubleshoot 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))
{
// The err contains code and message properties to help you troubleshoot the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether this operation succeeded. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : 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 | paramError | %s | Parameter error |
| 400 | paramError.dentryUuid | %s | Parameter error - dentryUuid |
| 400 | paramError.permissionInheritance | %s | Parameter error - permissionInheritance |
| 400 | permissionInheritanceUnsupportedForRootDentry | %s | Permission inheritance is not supported for the root directory |
| 404 | spaceNotExist | %s | The space does not exist |
| 404 | dentryNotExist | %s | The file does not exist |
| 500 | systemError | %s | System error |
| 500 | unknownError | Unknown Error | Unknown error |
| 503 | operationTimeout | %s | Request timed out |