Skip to main content
Call this API to force the sign-out of a specified Enterprise Account.

API call description

In specific scenarios where you need to urgently force the sign-out of an Enterprise Account, call this API to perform the forced sign-out. After sign-out, DingTalk on the user’s side displays as shown below:

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/contact/orgAccounts/signOut
HTTP MethodPOST
Supported app typeappType-Internal app
Permissions requiredpermission-Contact.OrgAccountSecurity.ReadWrite-Read and write permissions for Contacts Enterprise Account security data

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling Get the access token of an internal app.

Request body

NameTypeRequiredDescription
userIdStringYesThe user ID of the Enterprise Account. Obtain it through one of the following four methods: - Get the user ID by mobile phone number - Create an SSO Enterprise Account - Create a DingTalk-created Enterprise Account - Invite Enterprise Accounts from other organizations to join
reasonStringNoThe reason for forcing the sign-out of the Enterprise Account (displayed in the audit log of the DingTalk admin console).
reasonI18nForEmployeeMap<String, String>No- The reason for forcing the sign-out of the Enterprise Account (displayed to the employee). - Example: {"zh_CN":"Reason for logging out","en_US":"Reason for logging out"} - Supported languages refer to the current language of the DingTalk client. For example: zh_CN, zh_HK, zh_TW, en_US, ja_JP, vi_VN, fr_FR, ru_RU, ko_KR, es_LA, tr_TR, pt_BR, ms_MY, id_ID, th_TH.

Request example

HTTP
POST /v1.0/contact/orgAccounts/signOut HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json

{
  "userId" : "user123",
  "reason" : "Account deactivated",
  "reasonI18nForEmployee" : {
    {"zh_CN":"The administrator has signed you out. If you have any questions, contact the administrator."}
  }
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkcontact_1_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.dingtalkcontact_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkcontact_1_0.models.SignOutHeaders signOutHeaders = new com.aliyun.dingtalkcontact_1_0.models.SignOutHeaders();
        signOutHeaders.xAcsDingtalkAccessToken = "<your access token>";
        java.util.Map<String, String> reasonI18nForEmployee = TeaConverter.buildMap(
            new TeaPair("key", "-")
        );
        com.aliyun.dingtalkcontact_1_0.models.SignOutRequest signOutRequest = new com.aliyun.dingtalkcontact_1_0.models.SignOutRequest()
                .setUserId("user123")
                .setReason("Account deactivated")
                .setReasonI18nForEmployee(reasonI18nForEmployee)
                .setOpenDeviceId("-");
        try {
            client.signOutWithOptions(signOutRequest, signOutHeaders, 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 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)) {
                // err contains the code and message attributes, which help developers 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.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 using 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()
        sign_out_headers = dingtalkcontact__1__0_models.SignOutHeaders()
        sign_out_headers.x_acs_dingtalk_access_token = '<your access token>'
        reason_i18n_for_employee = {
            'key': '-'
        }
        sign_out_request = dingtalkcontact__1__0_models.SignOutRequest(
            user_id='user123',
            reason='Account deactivated',
            reason_i18n_for_employee=reason_i18n_for_employee,
            open_device_id='-'
        )
        try:
            client.sign_out_with_options(sign_out_request, sign_out_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # 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()
        sign_out_headers = dingtalkcontact__1__0_models.SignOutHeaders()
        sign_out_headers.x_acs_dingtalk_access_token = '<your access token>'
        reason_i18n_for_employee = {
            'key': '-'
        }
        sign_out_request = dingtalkcontact__1__0_models.SignOutRequest(
            user_id='user123',
            reason='Account deactivated',
            reason_i18n_for_employee=reason_i18n_for_employee,
            open_device_id='-'
        )
        try:
            await client.sign_out_with_options_async(sign_out_request, sign_out_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help developers 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\SignOutHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\SignOutRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $signOutHeaders = new SignOutHeaders([]);
        $signOutHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $reasonI18nForEmployee = [
            "key" => "-"
        ];
        $signOutRequest = new SignOutRequest([
            "userId" => "user123",
            "reason" => "Account deactivated",
            "reasonI18nForEmployee" => $reasonI18nForEmployee,
            "openDeviceId" => "-"
        ]);
        try {
            $client->signOutWithOptions($signOutRequest, $signOutHeaders, 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 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));
Go
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkcontact_1_0  "github.com/alibabacloud-go/dingtalk/contact_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client using 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
  }

  signOutHeaders := &dingtalkcontact_1_0.SignOutHeaders{}
  signOutHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  reasonI18nForEmployee := map[string]*string{
    "key": tea.String("-"),
  }
  signOutRequest := &dingtalkcontact_1_0.SignOutRequest{
    UserId: tea.String("user123"),
    Reason: tea.String("Account deactivated"),
    ReasonI18nForEmployee: reasonI18nForEmployee,
    OpenDeviceId: tea.String("-"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SignOutWithOptions(signOutRequest, signOutHeaders, &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 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)
  }
}
Node.js
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkcontact_1_0 = require('@alicloud/dingtalk/contact_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkcontact_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let signOutHeaders = new dingtalkcontact_1_0.SignOutHeaders({ });
    signOutHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let reasonI18nForEmployee = {
      key: '-',
    };
    let signOutRequest = new dingtalkcontact_1_0.SignOutRequest({
      userId: 'user123',
      reason: 'Account deactivated',
      reasonI18nForEmployee: reasonI18nForEmployee,
      openDeviceId: '-',
    });
    try {
      await client.signOutWithOptions(signOutRequest, signOutHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help developers 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 using Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// 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.SignOutHeaders signOutHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutHeaders();
            signOutHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, string> reasonI18nForEmployee = new Dictionary<string, string>
            {
                {"key", "-"},
            };
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutRequest signOutRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutRequest
            {
                UserId = "user123",
                Reason = "Account deactivated",
                ReasonI18nForEmployee = reasonI18nForEmployee,
                OpenDeviceId = "-",
            };
            try
            {
                client.SignOutWithOptions(signOutRequest, signOutHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // 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))
                {
                    // err contains the code and message attributes, which help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanWhether the sign-out succeeded. true indicates success.

Response body example

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

{
  "result" : true
}

Error codes

If the API call returns an error, refer to the Global error codes document and find a solution based on the error message.
HttpCodeError codeError messageDescription
400invalid.paramInvalid parameterInvalid parameter
400user.not.existUser does not existUser does not exist
400exclusive.account.onlyOnly dedicated accounts belonging to this organization can be operated onOnly dedicated accounts belonging to this organization can be operated on
500system.busySystem busySystem busy