獲取有關空間成員和空間管理員的資訊

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取有關空間成員和空間管理員的資訊

獲取有關空間成員和空間管理員的資訊。

  • 在訪客空間中,只能選取成員。
  • 如果不使用空間功能,則會發生錯誤。
  • 如果關閉了訪客空間功能,則在嘗試選取訪客空間資訊時將發生錯誤。

URL

https://sample.cybozu.com/k/v1/space/members.json

訪客空間時

https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space/members.json

HTTP 方法

GET

所需存取權限

  • 查看空間的許可權
    在非公開空間的情況下,只有空間參加者才能做到。

請求

參數
參數名稱 類型 必須 說明
id 數值或字串 必須 要選取其成員信息的空間的空間ID
範例請求(如果在網址中包含參數 )
URL

https://sample.cybozu.com/k/v1/space/members.json?app=1

標頭
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

關於請求標頭,請參見 kintone REST API的通用規範

範例要求(如果要在要求內文中包含參數)
標頭
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

關於請求標頭,請參見 kintone REST API的通用規範

內文
1
2
3
{
  "id": "1"
}

回應

屬性
屬性名稱 類型 說明
members 陣列 空間的成員資訊
回應中不包括以下使用者:
  • 訪客
  • 不使用kintone的使用者
  • 停用中的使用者
  • 刪除使用者
members[].entity 物件 空間的成員資訊
members[].entity.type 字串 空間的成員類型
傳回以下值之一:
  • USER:使用者
  • GROUP:群組
  • ORGANIZATION:組織
members[].entity.code 字串 空間成員的代碼
members[].isAdmin 布爾值 空間成員是否為空間管理員
  • true:空間管理
  • false:您不是空間管理員
members[].isImplicit 布爾值 您是否已被添加為使用者
  • true:未添加為使用者(屬於群組/組織的所屬使用者)
  • false:您已被添加為使用者
即使使用者屬於成員的組織,如果用戶註冊為使用者,也會返回“false”。
entity.type 是“USER”以外的任何內容,則此屬性不存在。
members[].includeSubs 布爾值 是否包括子組織
  • true:包括子組織
  • false:不包括子組織
entity.type 是“USER”以外的任何內容,則此屬性不存在。
示例回應
 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
26
27
28
29
30
31
32
33
34
35
{
  "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
    }
  ]
}

示例代碼

使用 curl 的請求
1
2
3
4
5
6
curl -X GET 'https://sample.cybozu.com/k/v1/space/members.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'
使用 發送kintone REST API請求的API發送的請求
1
2
3
4
5
const body = {
  id: 1
};

await kintone.api(kintone.api.url('/k/v1/space/members.json', true), 'GET', body);