變更欄位的存取權限設置

連結已複製

變更欄位的存取權限設置。

HTTP 方法	PUT
URL	https://sample.cybozu.com/k/v1/field/acl.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/field/acl.json
URL（操作測試環境）	https://sample.cybozu.com/k/v1/preview/field/acl.json
URL（測試環境中的訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/field/acl.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json

請求參數

連結已複製

參數名稱	類型	必須	說明
ID或APP	數值或字串	必須	應用程式ID 指定`id`或`app`。如果兩者都指定，則設定`id`的值。
rights	陣列	必須	存取權限清單按優先順序排序。即使您為「Everyone」（所有使用者）指定了優先順序，與其他設置相比，它的優先順序也是最低的。
rights[].code	字串	必須	要設置存取權限的欄位的域代碼
rights[].entities	陣列	必須	要設置存取權限的對象按優先順序排序。
rights[].entities[].accessibility	字串	必須	可對欄位執行的操作 `READ`：僅查看 `WRITE`：查看和編輯 `NONE`：無法查看或編輯
rights[].entities[].entity	物件	必須	要設置存取權限的對象
rights[].entities[].entity.type	字串	必須	存取權限的設置對象的類型 `USER`：使用者 `GROUP`：群組 `ORGANIZATION`：組織 `FIELD_ENTITY`：在「選擇表單中的欄位」中指定的欄位
rights[].entities[].entity.code	字串	必須	要設置存取權限的對象的代碼因`entity.type`的值而異。對於「USER」：登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼 FIELD_ENTITY',在「選擇表單中的欄位」中指定的欄位如果未指定「everyone」，則不允許Everyone（所有使用者）進行所有操作。如果要指定訪客，請在登入名稱前加上「guest/」。
rights[].entities[].includeSubs	布爾值或字串	可省略	設置是否繼承給下級組織 `true`：繼承 `false`：不繼承如果省略，則設置「false」。
revision	數值或字串	可省略	預期修訂號如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。如果指定值「-1」或未指定值，則不會驗證修訂號。

應答屬性

連結已複製

屬性名稱	類型	說明
revision	字串	變更應用程式設置后的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求標頭

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "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


{
  "app": 1,
  "rights": [
    {
      "code": "單行文字方塊_0",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          }
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          }
        }
      ]
    }
  ]
}

範例回應

1
2
3


{
  "revision": "3"
}

範例程式碼

使用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


const body = {
  app: 1,
  rights: [
    {
      code: '單行文字方塊_0',
      entities: [
        {
          accessibility: 'WRITE',
          entity: {
            type: 'USER',
            code: 'user1'
          }
        },
        {
          accessibility: 'READ',
          entity: {
            type: 'GROUP',
            code: 'group1'
          }
        }
      ]
    }
  ]
};

await kintone.api(kintone.api.url('/k/v1/field/acl.json'), 'PUT', body);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行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


curl -X PUT 'https://sample.cybozu.com/k/v1/field/acl.json' \
-H 'X-Cybozu-API-Token: API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
  "app": 1,
  "rights": [
    {
      "code": "單行文字方塊_0",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          }
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          }
        }
      ]
    }
  ]
}'

補充

連結已複製

變更存取權的設定時，先完成變更處理的先套用至正式環境。
詳情請參閱以下頁面。
顯示「正在將存取權限設定的變更結果反映至各記錄」時
更新正式環境的應用程式時，如執行此API，則會套用測試環境中的所有設定，而不只是應用程式的存取權限。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用程式設置反映到正式環境的API。
將應用程式設置套用到正式環境API

kintone API

kintone API文件

變更欄位的存取權限設置

目錄

請求參數

應答屬性

所需存取權限

範例

補充