kintone API文件

更新空間的成員

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 方法

連結已複製

PUT

所需存取權限

連結已複製

  • 空間管理員

請求

連結已複製

參數
參數名稱 類型 必須 說明
id 數值或字串 必須 要更新其成員信息的空間的空間ID
members 陣列 必須 獲取空間成員的資訊
如果您沒有至少一個空間管理員，或者您指定了以下使用者之一，則會出現錯誤。
  • 不使用kintone的使用者
  • 停用中的使用者
  • 刪除使用者
members[].entity 物件 必須 空間的成員資訊
無法指定訪客成員。
members[].entity.type 字串 必須 空間的成員類型
您可以指定以下值：
  • USER：使用者
  • GROUP：群組
  • ORGANIZATION：組織
members[].entity.code 字串 必須 空間成員的代碼
members[].isAdmin 布爾值或字串 條件必填項 是否將成員設為空間管理員
  • true：如果您想成為空間管理員
  • false：如果您不想成為空間管理員
如果省略，則設置「false」。
如果未指定至少一個空間管理員，則會收到錯誤。
members[].includeSubs 布爾值或字串 可省略 是否包括子組織
  • true：如果要包含子組織
  • false：如果您不想包含子組織
僅當entity.type 為「ORGANIZATION」時有效。
如果省略，則設置「false」。
示例請求
標頭
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

正文
 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

{
  "id": 1,
  "members": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "isAdmin": true
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "isAdmin": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "isAdmin": false,
      "includeSubs": true
    }
  ]
}

回應

連結已複製

1

{}

樣本

連結已複製

使用 curl 的請求
 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

curl -X PUT 'https://sample.cybozu.com/k/v1/space/members.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1",
    "members": [
      {
        "entity": {
          "type": "USER",
          "code": "user1"
        },
        "isAdmin": "true"
      },
      {
        "entity": {
          "type": "GROUP",
          "code": "group1"
        },
        "isAdmin": "false"
      },
      {
        "entity": {
          "type": "ORGANIZATION",
          "code": "org1"
        },
        "isAdmin": "false",
        "includeSubs": "true"
      }
    ]
  }'
kintone.api()請求使用

有關詳細的kintone.api()，請參閱以下頁面。
發送kintone REST API請求 

 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

const body = {
  id: 1,
  members: [
    {
      entity: {
        type: 'USER',
        code: 'user1'
      },
      isAdmin: true
    },
    {
      entity: {
        type: 'GROUP',
        code: 'group1'
      },
      isAdmin: false
    },
    {
      entity: {
        type: 'ORGANIZATION',
        code: 'org1'
      },
      isAdmin: false,
      includeSubs: true
    }
  ]
};

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