Evaluate Record Permissions
Evaluates the API user's permissions for records and fields within an App.
Method | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/records/acl/evaluate.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/records/acl/evaluate.json |
Authentication | Password Authentication , Session Authentication |
Content-Type | application/json (not needed if specifying the query with a query string) |
Permissions
Permission to view the App is needed.
API Tokens cannot be used with this API.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer or String | Yes | The App ID. |
ids | Array | Yes | An array of record IDs that will be evaluated. The maximum limit is 100 IDs. |
Example of parameters in the URL
|
|
Example of parameters in the request body
|
|
Sample Request
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
rights | Array | An array of objects that contain permission settings of the specified records. |
rights[].id | String | The record ID. |
rights[].record | Object | An object consisting of record permissions of the specified record ID. |
rights[].record.viewable | Boolean | The view permissions of the specified record ID. If the Kintone App is in maintenance mode, the returned value is false . |
rights[].record.editable | Boolean | The edit permissions of the specified record ID. If the Kintone App is in maintenance mode, the returned value is false . |
rights[].record.deletable | Boolean | The delete permissions of the specified record ID. If the Kintone App is in maintenance mode, the returned value is false . |
rights[].fields | Object | An object consisting of field permissions of the specified record ID. The following are also included in the response:
|
rights[].fields.(fieldcode).viewable | Boolean | The view permissions of the field of the specified record ID. If the user has no view permissions of the record or the Kintone App is in maintenance mode, the returned value is false . |
rights[].fields.(fieldcode).editable | Boolean | The edit permissions of the field of the specified record ID. If the Kintone App is in maintenance mode, the returned value is false . |
Sample Response
|
|