Skip to main content
Call this API to get the authentication information of an organization.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/contact/organizations/authInfos
HTTP MethodGET
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Contact.Org.Read-Read permission for basic information of Contacts organization

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Get it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of the authorized organization for a third-party app API.

Query parameters

NameTypeRequiredDescription
targetCorpIdStringNoThe organization ID (corpId) of the organization whose authentication information you want to get. For details, see Basic concepts - CorpId.

Request example

HTTP
GET /v1.0/contact/organizations/authInfos?targetCorpId=dingxxxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxxx
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.dingtalkcontact_1_0.*;
import com.aliyun.dingtalkcontact_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.dingtalkcontact_1_0.Client createClient() throws Exception {
        Config config = new Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkcontact_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
        GetOrgAuthInfoHeaders getOrgAuthInfoHeaders = new GetOrgAuthInfoHeaders();
        getOrgAuthInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetOrgAuthInfoRequest getOrgAuthInfoRequest = new GetOrgAuthInfoRequest()
                .setTargetCorpId("dingxxxxxxx");
        try {
            client.getOrgAuthInfoWithOptions(getOrgAuthInfoRequest, getOrgAuthInfoHeaders, 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 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 sys

from typing import List

from alibabacloud_dingtalk.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__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() -> dingtalkcontact_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 dingtalkcontact_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_org_auth_info_headers = dingtalkcontact__1__0_models.GetOrgAuthInfoHeaders()
        get_org_auth_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_org_auth_info_request = dingtalkcontact__1__0_models.GetOrgAuthInfoRequest(
            target_corp_id='dingxxxxxxx'
        )
        try:
            client.get_org_auth_info_with_options(get_org_auth_info_request, get_org_auth_info_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_org_auth_info_headers = dingtalkcontact__1__0_models.GetOrgAuthInfoHeaders()
        get_org_auth_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_org_auth_info_request = dingtalkcontact__1__0_models.GetOrgAuthInfoRequest(
            target_corp_id='dingxxxxxxx'
        )
        try:
            await client.get_org_auth_info_with_options_async(get_org_auth_info_request, get_org_auth_info_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\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\GetOrgAuthInfoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\GetOrgAuthInfoRequest;
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();
        $getOrgAuthInfoHeaders = new GetOrgAuthInfoHeaders([]);
        $getOrgAuthInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getOrgAuthInfoRequest = new GetOrgAuthInfoRequest([
            "targetCorpId" => "dingxxxxxxx"
        ]);
        try {
            $client->getOrgAuthInfoWithOptions($getOrgAuthInfoRequest, $getOrgAuthInfoHeaders, 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
// This file is auto-generated, don't edit it. Thanks.
package main

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

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

  getOrgAuthInfoHeaders := &dingtalkcontact_1_0.GetOrgAuthInfoHeaders{}
  getOrgAuthInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getOrgAuthInfoRequest := &dingtalkcontact_1_0.GetOrgAuthInfoRequest{
    TargetCorpId: tea.String("dingxxxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetOrgAuthInfoWithOptions(getOrgAuthInfoRequest, getOrgAuthInfoHeaders, &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
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_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(): dingtalkcontact_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcontact_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let getOrgAuthInfoHeaders = new $dingtalkcontact_1_0.GetOrgAuthInfoHeaders({ });
    getOrgAuthInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getOrgAuthInfoRequest = new $dingtalkcontact_1_0.GetOrgAuthInfoRequest({
      targetCorpId: "dingxxxxxxx",
    });
    try {
      await client.getOrgAuthInfoWithOptions(getOrgAuthInfoRequest, getOrgAuthInfoHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes that help you 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.Dingtalkcontact_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetOrgAuthInfoHeaders getOrgAuthInfoHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetOrgAuthInfoHeaders();
            getOrgAuthInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetOrgAuthInfoRequest getOrgAuthInfoRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetOrgAuthInfoRequest
            {
                TargetCorpId = "dingxxxxxxx",
            };
            try
            {
                client.GetOrgAuthInfoWithOptions(getOrgAuthInfoRequest, getOrgAuthInfoHeaders, 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
                }
            }
        }

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

#include <alibabacloud/dingtalkcontact__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkcontact_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_Dingtalkcontact_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcontact_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::GetOrgAuthInfoHeaders> getOrgAuthInfoHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetOrgAuthInfoHeaders>();
  getOrgAuthInfoHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::GetOrgAuthInfoRequest> getOrgAuthInfoRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetOrgAuthInfoRequest>(map<string, boost::any>({
    {"targetCorpId", boost::any(string("dingxxxxxxx"))}
  }));
  try {
    client->getOrgAuthInfoWithOptions(getOrgAuthInfoRequest, getOrgAuthInfoHeaders, 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 that help you locate the issue
    }
  }
}

Response

Response body

NameTypeDescription
orgNameStringThe name of the organization in DingTalk Contacts.
licenseOrgNameStringThe organization name on the business license submitted during organization authentication.
registrationNumStringThe business license registration number (usually 15 digits).
unifiedSocialCreditStringThe unified social credit code (fixed at 18 digits).
organizationCodeStringThe organization code certificate number (format: 11111111-1).
legalPersonStringThe legal representative.
licenseUrlStringThe URL of the business license.
authLevelLongThe authentication level. Valid values: - 0: No authentication. Only the authLevel and orgName fields are returned. - 1: Premium authentication. - 2: Intermediate authentication.

Response body example

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

{
  "orgName" : "Test",
  "licenseOrgName" : "Test Co., Ltd.",
  "registrationNum" : "1233",
  "unifiedSocialCredit" : "123566788",
  "organizationCode" : "2456677",
  "legalPerson" : "xxx",
  "licenseUrl" : "https://XXX.XX",
  "authLevel" : 1
}

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.
HttpCodeError codeError messageDescription
400invalidParameter.system.paramInvalid organization targetCorpIdThrown when the organization to query does not exist.
400permission.deniedNo permission to get the organization authentication informationThrown when the organization has not granted authorization to the custom app.
400invalidParameter.system.paramSystem parameter is emptyReturned when a system parameter is empty.
400invalidParameter.appKey.blankappKey is emptyThe appKey of the custom app is empty.
500service.system.errorSystem errorThrown when a call to a dependent service fails.