Gets the Field permission settings of an App.
| Method |
GET |
| URL |
https://{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 |
| Content-Type |
|
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
- Permission to view records are needed when obtaining information of live Apps.
- App Management Permissions are needed when obtaining information of pre-live settings.
- API Tokens cannot be used with this API.
Request Parameters
| Parameter |
Value |
Required |
Description |
| app |
Integer or String |
Yes |
The App ID. |
Sample Request
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
