API Docs

Get Field Permissions

Gets the Field permission settings of an App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/field/acl.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/field/acl.json
Authentication Password Authentication , API Token Authentication , Session Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Pre-live settings

Apps may hold pre-live settings that have not yet been deployed to the live App.
Access the pre-live settings with the below URL.

URL https://{subdomain}.kintone.com/k/v1/preview/field/acl.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/field/acl.json

Permissions

  • App Management Permissions are needed when obtaining information of live Apps.
  • App Management Permissions are needed when obtaining information of pre-live settings.

Request Parameters

Parameter Value Required Description
app Integer or String Yes The App ID.

Sample Request

JavaScript using kintone.api() 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/field/acl.json', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

var url = 'https://{subdomain}.kintone.com/k/v1/field/acl.json?app=1';
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Response Parameters

Parameter Type Description
revision String The revision number of the App settings.
rights Array An array of objects that contain data of permission settings.
rights[].code String The field code of a field that has permission settings.
rights[].entities Array An array listing the entities the permissions are granted to, in order of priority.
rights[].entities[].accessibility String The permission granted to the entity.
  • READ: Permissions to view only.
  • WRITE: Permissions to view and edit.
  • NONE: No permissions to view or edit.
rights[].entities[].entity Object An object containing data of the entity the permission is granted to.
rights[].entities[].entity.code String The code of the entity the permission is granted to.
rights[].entities[].entity.type String The type of the entity the permission is granted to.
  • USER: User
  • GROUP: Group
  • ORGANIZATION: Department
  • FIELD_ENTITY: User field
rights[].entities[].includeSubs Boolean or String The permission inheritance settings of the department the permission is granted to.
  • true: Permissions are inherited.
  • false: Permissions are not inherited.

Sample Response 

 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": "Text__single_line_",
      "entities": [
        {
          "accessibility": "WRITE",
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        },
        {
          "accessibility": "READ",
          "entity": {
            "type": "GROUP",
            "code": "group1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "code": "Number",
      "entities": [
        {
          "accessibility": "NONE",
          "entity": {
            "type": "ORGANIZATION",
            "code": "org1"
          },
          "includeSubs": true
        }
      ]
    }
  ],
  "revision": "2"
}