變更應用存取權限的設置

連結已複製

變更應用程式的存取權限設定。

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

請求參數

連結已複製

如果設置了以下存取權限，則還必須允許相關權限。

如果允許「編輯記錄」或「刪除記錄」則還必須允許「查看記錄」。
如果允許「檔案的匯入」則還必須允許「新增記錄」。

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
rights	陣列	必須	存取權限清單按優先順序排序。即使您為「Everyone」（所有使用者）指定了優先順序，與其他設置相比，它的優先順序也是最低的。
rights[].entity	物件	必須	設置存取權限的內容
rights[].entity.type	字串	必須	存取權限的設置對象的類型 `USER`：使用者 `GROUP`：群組 `ORGANIZATION`：組織 `CREATOR`：建立應用程式
rights[].entity.code	字串	條件必填項	要為其設置許可權的代碼因`entity.type`的值而異。對於「USER」：用戶的登入名稱對於「GROUP」：群組代碼對於「ORGANIZATION」：組織代碼對於「CREATOR」：不需要規範。如果未指定「everyone」，則不允許對Everyone（所有使用者）進行所有操作。如果要指定訪客，請在登入名稱前加上「guest/」。
rights[].includeSubs	布爾值或字串	可省略	設置是否繼承給下級組織 `true`：繼承時 `false`：不繼承僅當`entity.type`在中指定了「ORGANIZATION」時才有效。如果省略，則設置「false」。
rights[].appEditable	布爾值或字串	可省略	是否可以管理應用 `true`：允許應用管理 `false`：不允許應用程式管理如果省略，則設置「false」。
rights[].recordViewable	布爾值或字串	可省略	是否可以查看記錄 `true`：允許查看 `false`：不允許查看如果省略，則設置「false」。
rights[].recordAddable	布爾值或字串	可省略	是否可以新增記錄 `true`：允許新增紀錄 `false`：不允許添加如果省略，則設置「false」。
rights[].recordEditable	布爾值或字串	可省略	是否可以編輯記錄 `true`：允許編輯 `false`：不允許編輯如果省略，則設置「false」。
rights[].recordDeletable	布爾值或字串	可省略	是否可以刪除記錄 `true`：允許刪除 `false`：不允許刪除如果省略，則設置「false」。
rights[].recordImportable	布爾值或字串	可省略	是否可以檔案的匯入 `true`：允許讀取檔 `false`：不允許讀取檔如果省略，則設置「false」。
rights[].recordExportable	布爾值或字串	可省略	是否可以檔案的匯出 `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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58


{
  "app": 1,
  "rights": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "appEditable": true,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "appEditable": false,
      "recordViewable": false,
      "recordAddable": false,
      "recordEditable": false,
      "recordDeletable": false,
      "recordImportable": false,
      "recordExportable": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "includeSubs": true,
      "appEditable": false,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    },
    {
      "entity": {
        "type": "CREATOR"
      },
      "appEditable": true,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    }
  ],
  "revision": 2
}

範例回應

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43


const body = {
  app: kintone.app.getId(),
  rights: [
    {
      entity: {
        type: 'USER',
        code: 'user1'
      },
      appEditable: true,
      recordViewable: true,
      recordAddable: true,
      recordEditable: true,
      recordDeletable: true,
      recordImportable: true,
      recordExportable: true
    }, {
      entity: {
        type: 'GROUP',
        code: 'everyone'
      },
      includeSubs: true,
      appEditable: true,
      recordViewable: true,
      recordAddable: true,
      recordEditable: true,
      recordDeletable: true,
      recordImportable: false,
      recordExportable: false
    }, {
      entity: {
        type: 'CREATOR'
      },
      appEditable: true,
      recordViewable: true,
      recordAddable: true,
      recordEditable: true,
      recordDeletable: true,
      recordImportable: true,
      recordExportable: true
    }
  ]
};
await kintone.api(kintone.api.url('/k/v1/app/acl.json', true), '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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


curl -X PUT 'https://sample.cybozu.com/k/v1/app/acl.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "rights": [
      {
        "entity": {
          "type": "USER",
          "code": "user1"
        },
        "appEditable": true,
        "recordViewable": true,
        "recordAddable": true,
        "recordEditable": true,
        "recordDeletable": true,
        "recordImportable": true,
        "recordExportable": true
      }, {
        "entity": {
          "type": "GROUP",
          "code": "everyone"
        },
        "includeSubs": true,
        "appEditable": true,
        "recordViewable": true,
        "recordAddable": true,
        "recordEditable": true,
        "recordDeletable": true,
        "recordImportable": false,
        "recordExportable": false
      }, {
        "entity": {
          "type": "CREATOR"
        },
        "appEditable": true,
        "recordViewable": true,
        "recordAddable": true,
        "recordEditable": true,
        "recordDeletable": true,
        "recordImportable": true,
        "recordExportable": true
      }
    ]
  }'

補充

連結已複製

在更新正式環境的應用程式時，如執行此API，會將測試環境裡的所有設定套用至正式環境，而不只是應用程式的存取權限。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用程式設置反映到正式環境的API。
將應用程式設置套用到正式環境API

kintone API

kintone API文件

變更應用存取權限的設置

目錄

請求參數

回應屬性

所需存取權限

範例

補充