フィールドのアクセス権の設定を取得する

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

フィールドのアクセス権の設定を取得します。

HTTPメソッド	GET
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（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

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

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID

レスポンスプロパティ

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

プロパティ名	型	説明
rights	配列	アクセス権の設定の一覧
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」の場合：「フォームのフィールドを追加」で指定したフィールドのフィールドコードゲストユーザーを指定する場合、ログイン名の前に「guest/」が付きます。
rights[].entities[].includeSubs	真偽値	設定を下位組織に継承するかどうか `true`：継承する `false`：継承しない `entity.type`が「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ、「true」が返ります。
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

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

1

https\://sample.cybozu.com/k/v1/field/acl.json?app=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

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

1

https\://sample.cybozu.com/k/v1/field/acl.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

リクエストボディ

1
2
3


{
  "app": 1
}

サンプルレスポンス

 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


{
  "rights": [
    {
      "code": "文字列1行_0",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "code": "数値_0",
      "entities": [
        {
          "accessibility": "NONE",
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "includeSubs": true
        }
      ]
    }
  ],
  "revision": "2"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  app: kintone.app.getId()
};

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

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/field/acl.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1
  }'

kintone API

kintone APIドキュメント

フィールドのアクセス権の設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル