kintone APIドキュメント

アプリのアクセス権の設定を変更する

目次

アプリのアクセス権の設定を変更する

固定リンクがコピーされました

アプリのアクセス権の設定を変更します。

URL

固定リンクがコピーされました

URLは、運用環境のアプリを更新する場合と、動作テスト環境のアプリを更新する場合とで異なります。

運用環境のアプリを更新する場合

このAPIを実行すると、アプリのアクセス権だけでなく、動作テスト環境のアプリのすべての設定が運用環境のアプリに反映されます。

通常のアプリ
https://sample.cybozu.com/k/v1/app/acl.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/acl.json
動作テスト環境のアプリを更新する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/acl.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/acl.json

本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI

HTTPメソッド

固定リンクがコピーされました

PUT

必要なアクセス権

固定リンクがコピーされました

  • アプリ管理権限

リクエスト

固定リンクがコピーされました

パラメーター

次のアクセス権を設定する場合には、関連する権限も許可する必要があります。

  • 「レコード編集」または「レコード削除」を許可する場合、「レコードの閲覧」も許可してください。
  • 「ファイルの読み込み」を許可する場合、「レコード追加」も許可してください。
パラメーター名 型 必須 説明
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」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
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
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号
レスポンスの例
1
2
3

{
  "revision": "3"
}

サンプルコード

固定リンクがコピーされました

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
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
      }
    ]
  }'
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);