kintone API ドキュメント

API を実行したユーザーのレコードのアクセス権の設定を取得する

目次

API を実行したユーザーのレコードのアクセス権限を取得する

API を実行したユーザーについて、レコードやフィールドのアクセス権の設定を取得します。

URL

通常のアプリ
https://sample.cybozu.com/k/v1/records/acl/evaluate.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/records/acl/evaluate.json

HTTP メソッド

GET

必要なアクセス権

次のいずれかの権限が必要です。

  • アプリのレコード閲覧権限
  • アプリのレコード追加権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
ids 配列（数値） 必須 アクセス権を取得するレコードのレコード ID
最大で 100 件のレコード ID を指定できます。
存在しないレコード ID が含まれているとエラーになります。
リクエストの例（URLにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/records/acl/evaluate.json?app=8&ids[0]=1&ids[1]=2

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

リクエストの例（リクエストボディにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/records/acl/evaluate.json

ヘッダー
1
2
3
4

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

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ
1
2
3
4

{
  "app": "1",
  "ids": [1, 2]
}

レスポンス

プロパティ
プロパティ名 型 説明
rights 配列 アクセス権の設定の一覧
rights[].id 文字列 レコード ID
rights[].record オブジェクト 指定したレコードのアクセス権の設定
rights[].record.viewable 真偽値 レコードの閲覧が可能かどうか
  • true：閲覧できる
  • false：閲覧できない
rights[].record.editable 真偽値 レコードの編集が可能かどうか
  • true：編集できる
  • false：編集できない
rights[].record.deletable 真偽値 レコードの削除が可能かどうか
  • true：削除できる
  • false：削除できない
rights[].fields オブジェクト レコードに存在するフィールドのアクセス権
レコードを更新する API で操作できるフィールドのアクセス権が返ります。
API を実行するユーザーに閲覧権限のないフィールドや、アクセス権を設定していないフィールドも含まれます。
テーブル内のフィールドでも通常に配置したフィールドと同じ階層で返ります。
rights[].fields.フィールドコード.viewable 真偽値 フィールドの閲覧が可能かどうか
  • true：閲覧できる
  • false：閲覧できない
rights[].fields.フィールドコード.editable 真偽値 フィールドの編集が可能かどうか
  • true：編集できる
  • false：編集できない
レスポンスの例
 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

{
  "rights": [
    {
      "id": "1",
      "record": {
        "viewable": true,
        "editable": false,
        "deletable": false
      },
      "fields": {
        "文字列1行_0": {
          "viewable": true,
          "editable": false
        },
        "文字列複数行_0": {
          "viewable": false,
          "editable": false
        }
      }
    },
    {
      "id": "2",
      "record": {
        "viewable": true,
        "editable": true,
        "deletable": true
      },
      "fields": {
        "文字列1行_0": {
          "viewable": true,
          "editable": true
        },
        "文字列複数行_0": {
          "viewable": true,
          "editable": true
        }
      }
    }
  ]
}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/records/acl/evaluate.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": kintone.app.getId(),
    "ids": [1, 2]
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  ids: [1, 2]
};

await kintone.api(kintone.api.url('/k/v1/records/acl/evaluate.json', true), 'GET', body);

制限事項

  • API トークンは使用できません。
  • 次のフィールドに関するアクセス権は、この API で取得できません。
    • レコード番号 *1
    • ラベル *1
    • 罫線 *1
    • スペース *1
    • テーブル *1
    • グループ
    • 関連レコード一覧
    • 作成者
    • 作成日時
    • 更新者
    • 更新日時
  • フィールドの閲覧権限や編集権限は、レコードの権限で上書きされます。

*1 「フィールドのアクセス権」で設定できないフィールドです。 ^