kintone APIドキュメント

レコードのアクセス権の設定を変更する

目次

レコードのアクセス権の設定を変更する

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

レコードのアクセス権の設定を変更します。

URL

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

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

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

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

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

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

HTTPメソッド

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

PUT

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

パラメーター

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

  • 「レコード編集」または「レコード削除」を許可する場合、「レコードの閲覧」も許可してください。
パラメーター名 型 必須 説明
idまたはapp 数値または文字列 必須 アプリID
idまたはappを指定します。
どちらも指定すると、idの値が設定されます。
rights 配列 必須 アクセス権の設定の一覧
優先度が高い順に並べます。
rights[].filterCond 文字列 省略可 レコードの条件
クエリ形式で指定します。クエリ形式の詳細は次のページを参照してください。
クエリの書き方
指定できる条件には制限があります。
制限事項
省略した場合は「すべてのレコード」が対象となります。
rights[].entities 配列 必須 アクセス権の設定の対象の一覧
優先度が高い順に並べます。
「Everyone」（すべてのユーザー）に対して優先度を指定しても、他の設定に比べて優先度は最も低くなります。
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[].viewable 真偽値または文字列 省略可 レコードの閲覧が可能かどうか
  • true：閲覧を許可する
  • false：閲覧を許可しない
省略すると「false」が設定されます。
rights[].entities[].editable 真偽値または文字列 省略可 レコードの編集が可能かどうか
  • true：編集を許可する
  • false：編集を許可しない
省略した場合や閲覧が許可されていない場合は 「false」が設定されます。
rights[].entities[].deletable 真偽値または文字列 省略可 レコードの削除が可能かどうか
  • true：削除を許可する
  • false：削除を許可しない
省略した場合や閲覧が許可されていない場合は 「false」が設定されます。
rights[].entities[].includeSubs 真偽値または文字列 省略可 設定を下位組織に継承するかどうか
  • true：継承する場合
  • false：継承しない
省略すると「false」が設定されます。
revision 数値または文字列 省略可 期待しているリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、設定は変更されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
指定できるレコードの条件の制限事項

rights[].filterCondには、画面での操作で設定できる条件のみ指定できます。
そのため、次の制限があります。

  • order by limit offsetは使用できません。
  • andとorは混在できません。
  • 次の種類のフィールドでは、like not likeを使用できません。
    • 文字列1行
    • リンク
  • 次の種類のフィールドでは、in > <を使用できません。
    • レコード番号
    • 数値
    • 計算
  • 次の種類のフィールドでは、=を使用できません。
    • ステータス
  • 次の種類のフィールドは、条件の指定に使用できません。
    • 文字列（複数行）
    • リッチエディター
    • 添付ファイル
  • 次の関数は使用できません。
    • NOW()
    • TODAY()
    • YESTERDAY()
    • TOMORROW()
    • THIS_WEEK()
    • LAST_WEEK()
    • NEXT_WEEK()
    • LAST_MONTH()
    • NEXT_MONTH()
    • THIS_MONTH()
    • THIS_YEAR()
    • LAST_YEAR()
    • NEXT_YEAR()
リクエストの例
ヘッダー
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

{
  "app": 1,
  "rights": [
    {
      "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"",
      "entities": [
        {
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "viewable": false,
          "editable": false,
          "deletable": false,
          "includeSubs": true
        },
        {
          "entity": {
            "type": "FIELD_ENTITY",
            "code": "更新者"
          },
          "viewable": true,
          "editable": true,
          "deletable": 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

curl -X PUT 'https://sample.cybozu.com/k/v1/record/acl.json' \ 
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "app": 1,
      "rights": [
      {
        "filterCond": "更新日時 > \"2012-02-03T09:00:00Z\" and 更新日時 < \"2012-02-03T10:00:00Z\"", 
        "entities": [
          {
            "entity": {
              "type": "USER",
              "code": "user1"
            },
            "viewable": false,
            "editable": false,
            "deletable": false,
            "includeSubs": true
          },
          {
            "entity": {
              "type": "FIELD_ENTITY",
              "code": "更新者"
            },
            "viewable:" true,
            "editable": true,
            "deletable": 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

const body = {
  app: kintone.app.getId(),
  rights: [
    {
      filterCond: '更新日時 > "2012-02-03T09:00:00Z" and 更新日時 < "2012-02-03T10:00:00Z"',
      entities: [
        {
          entity: {
            type: 'USER',
            code: 'user1'
          },
          viewable: false,
          editable: false,
          deletable: false,
          includeSubs: true
        },
        {
          entity: {
            type: 'FIELD_ENTITY',
            code: '更新者'
          },
          viewable: true,
          editable: true,
          deletable: true
        }
      ]
    }
  ]
};

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