kintone API ドキュメント

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

目次

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

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

URL

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

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

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

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

HTTP メソッド

PUT

必要なアクセス権

  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
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」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例
ヘッダー
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"
          }
        }
      ]
    }
  ]
}

レスポンス

プロパティ
プロパティ名 型 説明
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

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"
          }
        }
      ]
    }
  ]
}'
kintone REST API リクエストを送信する 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);