Deskripsi panggilan API
Akun Perusahaan tipe Single Sign-On saat ini hanya dapat dikelola melalui API. Untuk Akun Perusahaan yang dibuat oleh DingTalk, Anda juga dapat mengelolanya di konsol admin Organisasi, seperti yang ditunjukkan di bawah ini:Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/contact/orgAccounts/disable |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Internal app appType-Third-party enterprise app |
| Izin yang diperlukan | permission-Contact.OrgAccountSecurity.ReadWrite-Izin baca dan tulis untuk data keamanan Akun Perusahaan Kontak |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Memperoleh access token dari aplikasi internal. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| userId | String | Ya | ID pengguna Akun Perusahaan. Anda dapat memperolehnya melalui salah satu dari empat cara berikut: - Cari pengguna Akun Perusahaan berdasarkan nomor telepon - Buat Akun Perusahaan SSO - Buat Akun Perusahaan yang dibuat oleh DingTalk - Undang Akun Perusahaan dari organisasi lain untuk bergabung |
| reason | String | Tidak | Alasan menonaktifkan Akun Perusahaan. |
Contoh permintaan
HTTPPOST /v1.0/contact/orgAccounts/disable HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json
{
"userId" : "user123",
"reason" : "Akun telah kedaluwarsa."
}
// 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 {
/**
* Inisialisasi klien akun menggunakan 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();
SetDisableHeaders setDisableHeaders = new SetDisableHeaders();
setDisableHeaders.xAcsDingtalkAccessToken = "<your access token>";
SetDisableRequest setDisableRequest = new SetDisableRequest()
.setUserId("user123")
.setReason("Akun telah kedaluwarsa.");
try {
client.setDisableWithOptions(setDisableRequest, setDisableHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err berisi atribut code dan message yang membantu menemukan masalah
}
} 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 berisi atribut code dan message yang membantu menemukan masalah
}
}
}
}
# -*- 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:
"""
Inisialisasi klien akun menggunakan 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()
set_disable_headers = dingtalkcontact__1__0_models.SetDisableHeaders()
set_disable_headers.x_acs_dingtalk_access_token = '<your access token>'
set_disable_request = dingtalkcontact__1__0_models.SetDisableRequest(
user_id='user123',
reason='Akun telah kedaluwarsa.'
)
try:
client.set_disable_with_options(set_disable_request, set_disable_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message yang membantu menemukan masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
set_disable_headers = dingtalkcontact__1__0_models.SetDisableHeaders()
set_disable_headers.x_acs_dingtalk_access_token = '<your access token>'
set_disable_request = dingtalkcontact__1__0_models.SetDisableRequest(
user_id='user123',
reason='Akun telah kedaluwarsa.'
)
try:
await client.set_disable_with_options_async(set_disable_request, set_disable_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message yang membantu menemukan masalah
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\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\SetDisableHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\SetDisableRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Inisialisasi klien akun menggunakan 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();
$setDisableHeaders = new SetDisableHeaders([]);
$setDisableHeaders->xAcsDingtalkAccessToken = "<your access token>";
$setDisableRequest = new SetDisableRequest([
"userId" => "user123",
"reason" => "Akun telah kedaluwarsa."
]);
try {
$client->setDisableWithOptions($setDisableRequest, $setDisableHeaders, 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 berisi atribut code dan message yang membantu menemukan masalah
}
}
}
}
$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"
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"
)
/**
* Inisialisasi klien akun menggunakan 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
}
setDisableHeaders := &dingtalkcontact_1_0.SetDisableHeaders{}
setDisableHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
setDisableRequest := &dingtalkcontact_1_0.SetDisableRequest{
UserId: tea.String("user123"),
Reason: tea.String("Akun telah kedaluwarsa."),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SetDisableWithOptions(setDisableRequest, setDisableHeaders, &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 berisi atribut code dan message yang membantu menemukan masalah
}
}
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 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 {
/**
* Inisialisasi klien akun menggunakan 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 setDisableHeaders = new $dingtalkcontact_1_0.SetDisableHeaders({ });
setDisableHeaders.xAcsDingtalkAccessToken = "<your access token>";
let setDisableRequest = new $dingtalkcontact_1_0.SetDisableRequest({
userId: "user123",
reason: "Akun telah kedaluwarsa.",
});
try {
await client.setDisableWithOptions(setDisableRequest, setDisableHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message yang membantu menemukan masalah
}
}
}
}
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
{
/**
* Inisialisasi klien akun menggunakan 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.SetDisableHeaders setDisableHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SetDisableHeaders();
setDisableHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SetDisableRequest setDisableRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SetDisableRequest
{
UserId = "user123",
Reason = "Akun telah kedaluwarsa.",
};
try
{
client.SetDisableWithOptions(setDisableRequest, setDisableHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message yang membantu menemukan masalah
}
}
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 berisi atribut code dan message yang membantu menemukan masalah
}
}
}
}
}
// 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::SetDisableHeaders> setDisableHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::SetDisableHeaders>();
setDisableHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::SetDisableRequest> setDisableRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::SetDisableRequest>(map<string, boost::any>({
{"userId", boost::any(string("user123"))},
{"reason", boost::any(string("Akun telah kedaluwarsa."))}
}));
try {
client->setDisableWithOptions(setDisableRequest, setDisableHeaders, 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 berisi atribut code dan message yang membantu menemukan masalah
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Boolean | Hasil dari operasi penonaktifan. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : true
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalid.param | Invalid parameter | Parameter tidak valid |
| 400 | user.not.exist | User does not exist | Pengguna tidak ada |
| 400 | exclusive.account.only | Only dedicated accounts that belong to this organization can be operated on | Hanya akun khusus yang termasuk dalam organisasi ini yang dapat dioperasikan |
| 500 | system.busy | System busy | Sistem sibuk |