批量删除来宾用户

从kintone里删除来宾用户。

• 不管是否启用空间功能，都可以执行。

• 不管是否启用来宾空间功能，都可以执行。

• 不是退出来宾空间，而是直接删除。

HTTP 方法

DELETE

URI

https://(子域名).cybozu.cn/k/v1/guests.json

必要的访问权限

kintone系统管理员

请求参数

请求范例

以下是在HTTP请求的请求正文中设置JSON数据的范例。

请求头部

DELETE /k/v1/guests.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

正文

{    
    "id": 1,    
    "guests": [    
        "guest1@example.com",    
        "guest2@example.com",    
        "guest3@example.com"    
    ]    
}

• Content-Type里请指定application/json。如不指定，JSON 无法解析，执行时会报错。

• JSON字符串写在请求正文里发送。

应答

处理成功时返回空的JSON数据。

{}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {    
    "id": 1001,    
    "guests": [    
        "guest1@example.com",    
        "guest2@example.com",    
        "guest3@example.com"    
    ]    
}    
kintone.api(kintone.api.url('/k/v1/guests', true), 'DELETE', body, function(resp) {   
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var body = {    
    "id": 1001,    
    "guests": [    
        "guest1@example.com",    
        "guest2@example.com",    
        "guest3@example.com"    
    ],    
    // CSRF TOKEN: 从kintone里执行API(POST, PUT, DELETE)时需要设置    
    "__REQUEST_TOKEN__": kintone.getRequestToken()    
}

var url = 'https://{subdomain}.cybozu.cn/k/v1/guests.json';    
var xhr = new XMLHttpRequest();    
xhr.open('PUT', url);    
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');    
xhr.setRequestHeader('Content-Type', 'application/json');    
xhr.onload = function() {    
    if (xhr.status === 200) {    
        // success    
        console.log(JSON.parse(xhr.responseText));    
    } else {    
        // error    
        console.log(JSON.parse(xhr.responseText));    
    }    
};    
xhr.send(JSON.stringify(body));