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

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

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

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ドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足