Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/acls |
| HTTP Method | GET |
| Supported app types | appType-Internal app appType-Third-party personal app |
| Permission requirement | permission-Calendar.Acl.Read-Calendar app access control read permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call Get the access token of an internal app. - For a third-party personal app, call Get user token. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | The unionId of the event organizer. - For an internal app, call Query user details to obtain the unionid value. - For a third-party personal app, call Get user profile from contacts to obtain the unionId value. |
| calendarId | String | Yes | The ID of the calendar that the event belongs to. The value is always primary, which indicates the user’s primary calendar. |
Request example
HTTPGET /v1.0/calendar/users/i87juyyxxx/calendars/primary/acls HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json
// 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.dingtalkcalendar_1_0.*;
import com.aliyun.dingtalkcalendar_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkcalendar_1_0.Client createClient() throws Exception {
Config config = new Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkcalendar_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient();
ListAclsHeaders listAclsHeaders = new ListAclsHeaders();
listAclsHeaders.xAcsDingtalkAccessToken = "<your access token>";
try {
client.listAclsWithOptions("i87juyyxxx", "primary", listAclsHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains the code and message attributes, which help developers 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)) {
// The err contains the code and message attributes, which help developers locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.calendar_1_0.client import Client as dingtalkcalendar_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.calendar_1_0 import models as dingtalkcalendar__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() -> dingtalkcalendar_1_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 dingtalkcalendar_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
list_acls_headers = dingtalkcalendar__1__0_models.ListAclsHeaders()
list_acls_headers.x_acs_dingtalk_access_token = '<your access token>'
try:
client.list_acls_with_options('i87juyyxxx', 'primary', list_acls_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which help developers locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_acls_headers = dingtalkcalendar__1__0_models.ListAclsHeaders()
list_acls_headers.x_acs_dingtalk_access_token = '<your access token>'
try:
await client.list_acls_with_options_async('i87juyyxxx', 'primary', list_acls_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which help developers locate 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\Vcalendar_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\ListAclsHeaders;
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();
$listAclsHeaders = new ListAclsHeaders([]);
$listAclsHeaders->xAcsDingtalkAccessToken = "<your access token>";
try {
$client->listAclsWithOptions("i87juyyxxx", "primary", $listAclsHeaders, 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 the code and message attributes, which help developers 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));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkcalendar_1_0 "github.com/alibabacloud-go/dingtalk/calendar_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkcalendar_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkcalendar_1_0.Client{}
_result, _err = dingtalkcalendar_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
listAclsHeaders := &dingtalkcalendar_1_0.ListAclsHeaders{}
listAclsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListAclsWithOptions(tea.String("i87juyyxxx"), tea.String("primary"), listAclsHeaders, &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 the code and message attributes, which help developers locate the issue
}
}
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 dingtalkcalendar_1_0, * as $dingtalkcalendar_1_0 from '@alicloud/dingtalk/calendar_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkcalendar_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkcalendar_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let listAclsHeaders = new $dingtalkcalendar_1_0.ListAclsHeaders({ });
listAclsHeaders.xAcsDingtalkAccessToken = "<your access token>";
try {
await client.listAclsWithOptions("i87juyyxxx", "primary", listAclsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// The err contains the code and message attributes, which help developers locate the issue
}
}
}
}
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
{
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.ListAclsHeaders listAclsHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.ListAclsHeaders();
listAclsHeaders.XAcsDingtalkAccessToken = "<your access token>";
try
{
client.ListAclsWithOptions("i87juyyxxx", "primary", listAclsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains the code and message attributes, which help developers 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))
{
// The err contains the code and message attributes, which help developers locate the issue
}
}
}
}
}
// This file is auto-generated, don't edit it. Thanks.
#include <alibabacloud/dingtalkcalendar__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
using namespace std;
Alibabacloud_Dingtalkcalendar_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_Dingtalkcalendar_1_0::Client(config);
}
int main(int argc, char *args[]) {
args;
shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcalendar_1_0::Client>(createClient());
shared_ptr<Alibabacloud_Dingtalkcalendar_1_0::ListAclsHeaders> listAclsHeaders = make_shared<Alibabacloud_Dingtalkcalendar_1_0::ListAclsHeaders>();
listAclsHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
try {
client->listAclsWithOptions(make_shared<string>("i87juyyxxx"), make_shared<string>("primary"), listAclsHeaders, 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)) {
// The err contains the code and message attributes, which help developers locate the issue
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| acls | Array | The access control list. |
| privilege | String | The permission information. Valid values: - free_busy_reader: Check free/busy. - title_reader: View the title. - reader: View details. - writer: Create and edit. |
| aclId | String | The permission resource ID. |
| scope | Object | The permission scope. |
| userId | String | The user ID. When scopeType is set to user, the value is the user’s unionId. |
| scopeType | String | The permission type. Currently, only user is supported, which indicates a user. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"acls" : [ {
"privilege" : "reader",
"aclId" : "VS4yJgnNiiiSRmsqKttYXXXXXX",
"scope" : {
"userId" : "U5KXX3QjgiG",
"scopeType" : "user"
}
} ]
}
Error codes
If an error is returned 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 | invalidParameter | forwardErrorMessage | Invalid parameter |