获取空间的成员
获取空间成员和空间管理员的信息。
未使用空间功能、来宾空间功能时，将报错。
来宾空间中，仅可获取成员。
HTTP 方法
GET
URI
https://(子域名).cybozu.cn/k/v1/space/members.json
来宾空间
https://(子域名).cybozu.cn/k/guest/<来宾空间的ID>/v1/space/members.json
必要的访问权限
空间的查看权限
※非公开空间，仅空间成员可执行。
请求参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| id | 字符串 | 必须 | 指定要获取成员信息的空间ID。 |
请求的范例
(1) 用HTTP的查询字符串发送参数时
"id"的参数作为HTTP的查询字符串发送。
包含请求头部的字符串
GET /k/v1/space/members.json?id=1 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type头部不需要。
(2) 用JSON形式发送参数时（在HTTP请求的请求正文中设置JSON数据时）
请求头部
GET /k/v1/space/members.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
Content-Type里请指定application/json。如不指定，JSON 无法解析，执行时会报错。
正文
{
"id": "1"
}JSON字符串写在请求正文里发送。
应答
| 参数名称 | 值的类型 | 说明 |
|---|---|---|
| members | 数组 | 空间的成员信息。 ※应答中不会包含以下用户。
|
| members[].entity | 对象 | 空间的成员的实体信息。 |
| members[].entity.type | 字符串 | 空间的成员的实体类型。 可指定USER、GROUP、ORGANIZATION 的其中一个。 |
| members[].entity.code | 字符串 | 空间成员的实体的代码。 |
| members[].isAdmin | 布尔值 | 指定空间的成员是否作为管理员。 true: 空间的管理员 false: 非空间管理员 |
| members[].isImplicit | 布尔值 | 指定是否已添加为用户。 ※entity的type为SER时，该值不存在。 |
| members[].includeSubs | 布尔值 | 指定是否包含下级组织。 true: 包含下级组织 false: 不包含下级组织 ※entity的type为USER之外时，不存在该值。 |
{
"members": [
{
"entity": {
"type": "USER",
"code": "user1"
},
"isAdmin": false,
"isImplicit": true
},
{
"entity": {
"type": "USER",
"code": "user2"
},
"isAdmin": true,
"isImplicit": false
},
{
"entity": {
"type": "GROUP",
"code": "group1"
},
"isAdmin": false
},
{
"entity": {
"type": "ORGANIZATION",
"code": "org1"
},
"isAdmin": false,
"includeSubs": true
}
]
}JavaScript范例
使用API请求发送 kintone REST API 请求
var body = {
"id": 1
};
kintone.api(kintone.api.url('/k/v1/space/members', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var url = 'https://{subdomain}.cybozu.cn/k/v1/space/members.json?id=1';
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
if (xhr.status === 200) {
// success
console.log(JSON.parse(xhr.responseText));
} else {
// error
console.log(JSON.parse(xhr.responseText));
}
};
xhr.send();