Update App Permissions
Updates the App permissions of an App.
All settings of the pre-live App (not just the permission settings) will be deployed to the live App by using this API.
Method | PUT |
---|---|
URL | https://{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-Type | application/json |
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.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
app | Integer or String | Yes | The App ID. |
rights | Array | Yes | An array listing data of App permissions, in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. |
rights[].entity | Object | Yes | An object containing data of the entity the permission is granted to. |
rights[].entity.type | String | Yes | The type of the entity the permission will be granted to.
|
rights[].entity.code | String | Conditional | The code of the entity the permission is granted to. To specify guest space users, add the string "guest/" before the guest's log in name. If the "Everyone" group is not specified, the "Everyone" group will have no permissions to view/edit/delete. If "CREATOR" is specified for the rights[].entity.type parameter, ignore this parameter. Otherwise, this parameter is required. |
rights[].includeSubs | Boolean or String | The permission inheritance settings of the department the permission is granted to. This parameter is available if "ORGANIZATION" is specified for the rights[].entity.type parameter.
|
|
rights[].appEditable | Boolean or String | The App management permission of the entity.
|
|
rights[].recordViewable | Boolean or String | The record view permission of the entity.
|
|
rights[].recordAddable | Boolean or String | The record add permission of the entity
|
|
rights[].recordEditable | Boolean or String | The record edit permission of the entity. The record view permissions must also be enabled to set this value as true.
|
|
rights[].recordDeletable | Boolean or String | The record delete permission of the entity. The record view permissions must also be enabled to set this value as true.
|
|
rights[].recordImportable | Boolean or String | The file import permission of the entity. The record add permissions must also be enabled to set this value as true.
|
|
rights[].recordExportable | Boolean or String | The file export permission of the entity.
|
|
revision | Integer or String | Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. |
Sample Request
JavaScript (using Kintone REST API Request)
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
revision | String | The revision number of the App settings. |
Sample Response
|
|