API Docs

Get App Permissions

Gets the App permissions of an App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app/acl.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/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/app/acl.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/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 Type 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/app/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
15

var url = 'https://{subdomain}.kintone.com/k/v1/app/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
rights Array An array of objects that contain data of App permissions, in order of priority.
rights[].entity Object An object containing data of the entity the permission is granted to.
rights[].entity.type String The type of the entity the permission is granted to.
  • USER: User
  • GROUP: Group
  • ORGANIZATION: Department
  • CREATOR: The creator of the App
rights[].entity.code String The code of the entity the permission is granted to.
This depends on the value of the entity.type
  • USER: Login name
  • GROUP: Group code
  • ORGANIZATION: Department code
  • CREATOR: null
If the user is a guest, guest/ is prefixed to the login name.
rights[].includeSubs Boolean The permission inheritance settings of the department the permission is granted to.
  • true: Permissions are inherited.
  • false: Permissions are not inherited.
true is returned only when the entity.type is ORGANIZATION, or the department selection field is specified in FIELD_ENTITY.
rights[].appEditable Boolean The App management permission of the entity.
Entities with this permission are able to access and edit the App's settings.
  • true: The App's settings are accessible.
  • false: The App's settings are not accessible.
rights[].recordViewable Boolean The record view permission of the entity.
  • true: Records are viewable.
  • false: Records are not viewable.
rights[].recordAddable Boolean The record add permission of the entity
  • true: Records can be added.
  • false: Records cannot be added.
rights[].recordEditable Boolean The record edit permission of the entity.
  • true: Records are editable.
  • false: Records are not editable.
rights[].recordDeletable Boolean The record delete permission of the entity.
  • true: Records are deletable.
  • false: Records are not deletable.
rights[].recordImportable Boolean The file import permission of the entity.
  • true: Files are importable
  • false: Files are not importable
rights[].recordExportable Boolean The file export permission of the entity.
  • true: Files are exportable
  • false: Files are not exportable
revision String The revision number of the App settings.

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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

{
  "rights": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "includeSubs": false,
      "appEditable": true,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    },
    {
      "entity": {
        "type": "GROUP",
        "code": "group1"
      },
      "includeSubs": false,
      "appEditable": false,
      "recordViewable": false,
      "recordAddable": false,
      "recordEditable": false,
      "recordDeletable": false,
      "recordImportable": false,
      "recordExportable": false
    },
    {
      "entity": {
        "type": "ORGANIZATION",
        "code": "org1"
      },
      "includeSubs": true,
      "appEditable": false,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    },
    {
      "entity": {
        "type": "CREATOR",
        "code": null
      },
      "includeSubs": false,
      "appEditable": true,
      "recordViewable": true,
      "recordAddable": true,
      "recordEditable": true,
      "recordDeletable": true,
      "recordImportable": true,
      "recordExportable": true
    }
  ],
  "revision": "2"
}