Deletes users from a Kintone environment.
Method | DELETE |
URL | https://{subdomain}.kintone.com/v1/users.json |
Authentication |
Password Authentication |
Content-Type | application/json |
Permissions
Only
Administrators
can use this API.
Request Parameters
Parameter |
Value |
Required |
Description |
codes |
Array |
Yes |
An array of user codes of users to be deleted. Up to 100 codes can be specified.
|
Sample Request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
var body = {
'codes': [
'user1',
'user2',
'user3'
]
};
kintone.api(kintone.api.url('/v1/users', true), 'DELETE', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});
|
XMLHttpRequest
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
var body = {
'codes': [
'user1',
'user2',
'user3'
],
// CSRF TOKEN: Needs to be set when using API (POST, PUT, DELETE) from Kintone
'__REQUEST_TOKEN__': kintone.getRequestToken()
};
var url = 'https://{subdomain}.kintone.com/v1/users.json';
var xhr = new XMLHttpRequest();
xhr.open('DELETE', 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));
|
Response Parameters
An empty JSON object will be returned.
Sample Response