Skip to main content
Call this API to check whether an Organization Admin has management permissions for an app.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/microApp/apps/{agentId}/users/{userId}/adminAccess
HTTP MethodGET
Supported app typeappType-Third-party enterprise app
Permission requirementpermission-qyapi_get_member-Read permission for user information

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an authorized organization for a third-party app API.

Path parameters

NameTypeRequiredDescription
agentIdLongYesThe agentId assigned when the authorized organization installs the third-party app. Obtain the value by calling the Get the authorization information after an organization activates an app API.
userIdStringYesThe user ID of the Organization Admin of the authorized organization. Obtain the value by calling the Get the admin list API.

Request example

HTTP
GET /v1.0/microApp/apps/111/users/manager1123/adminAccess HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx
Content-Type:application/json
Java
// 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.dingtalkmicro_app_1_0.*;
import com.aliyun.dingtalkmicro_app_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.dingtalkmicro_app_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkmicro_app_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkmicro_app_1_0.Client client = Sample.createClient();
        GetMicroAppUserAccessHeaders getMicroAppUserAccessHeaders = new GetMicroAppUserAccessHeaders();
        getMicroAppUserAccessHeaders.xAcsDingtalkAccessToken = "<your access token>";
        try {
            client.getMicroAppUserAccessWithOptions("111", "manager1123", getMicroAppUserAccessHeaders, new 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, which help 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, which help locate the issue
            }

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

from typing import List

from alibabacloud_dingtalk.microApp_1_0.client import Client as dingtalkmicroApp_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.microApp_1_0 import models as dingtalkmicro_app__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() -> dingtalkmicroApp_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 dingtalkmicroApp_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_micro_app_user_access_headers = dingtalkmicro_app__1__0_models.GetMicroAppUserAccessHeaders()
        get_micro_app_user_access_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            client.get_micro_app_user_access_with_options('111', 'manager1123', get_micro_app_user_access_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, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_micro_app_user_access_headers = dingtalkmicro_app__1__0_models.GetMicroAppUserAccessHeaders()
        get_micro_app_user_access_headers.x_acs_dingtalk_access_token = '<your access token>'
        try:
            await client.get_micro_app_user_access_with_options_async('111', 'manager1123', get_micro_app_user_access_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, which help 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\Vmicro_app_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vmicro_app_1_0\Models\GetMicroAppUserAccessHeaders;
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();
        $getMicroAppUserAccessHeaders = new GetMicroAppUserAccessHeaders([]);
        $getMicroAppUserAccessHeaders->xAcsDingtalkAccessToken = "<your access token>";
        try {
            $client->getMicroAppUserAccessWithOptions("111", "manager1123", $getMicroAppUserAccessHeaders, 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, which help 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
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkmicroapp_1_0  "github.com/alibabacloud-go/dingtalk/microApp_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 *dingtalkmicroapp_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkmicroapp_1_0.Client{}
  _result, _err = dingtalkmicroapp_1_0.NewClient(config)
  return _result, _err
}

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

  getMicroAppUserAccessHeaders := &dingtalkmicroapp_1_0.GetMicroAppUserAccessHeaders{}
  getMicroAppUserAccessHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetMicroAppUserAccessWithOptions(tea.String("111"), tea.String("manager1123"), getMicroAppUserAccessHeaders, &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, which help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkmicroApp_1_0, * as $dingtalkmicroApp_1_0 from '@alicloud/dingtalk/microApp_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(): dingtalkmicroApp_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkmicroApp_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let getMicroAppUserAccessHeaders = new $dingtalkmicroApp_1_0.GetMicroAppUserAccessHeaders({ });
    getMicroAppUserAccessHeaders.xAcsDingtalkAccessToken = "<your access token>";
    try {
      await client.getMicroAppUserAccessWithOptions("111", "manager1123", getMicroAppUserAccessHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes, which help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// 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.Dingtalkmicro_app_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkmicro_app_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkmicro_app_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkmicro_app_1_0.Models.GetMicroAppUserAccessHeaders getMicroAppUserAccessHeaders = new AlibabaCloud.SDK.Dingtalkmicro_app_1_0.Models.GetMicroAppUserAccessHeaders();
            getMicroAppUserAccessHeaders.XAcsDingtalkAccessToken = "<your access token>";
            try
            {
                client.GetMicroAppUserAccessWithOptions("111", "manager1123", getMicroAppUserAccessHeaders, 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, which help 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, which help locate the issue
                }
            }
        }

    }
}
C
// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkmicro_app__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>

using namespace std;

Alibabacloud_Dingtalkmicro_app_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_Dingtalkmicro_app_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkmicro_app_1_0::Client> client = make_shared<Alibabacloud_Dingtalkmicro_app_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkmicro_app_1_0::GetMicroAppUserAccessHeaders> getMicroAppUserAccessHeaders = make_shared<Alibabacloud_Dingtalkmicro_app_1_0::GetMicroAppUserAccessHeaders>();
  getMicroAppUserAccessHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  try {
    client->getMicroAppUserAccessWithOptions(make_shared<string>("111"), make_shared<string>("manager1123"), getMicroAppUserAccessHeaders, 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)) {
      // err contains code and message attributes, which help locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
resultBooleanThe result. - true: Has management permissions. - false: Does not have management permissions.

Response body example

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

{
  "result" : true
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document to find a solution based on the error message.
HttpCodeError codeError messageDescription
400invalidUserIdInvalid userIdInvalid userId
400invalidAgentIdInvalid agentIdInvalid agentId
500systemErrorSystem busySystem busy