アプリのアクセス権の変更 – cybozu developer network

アプリのアクセス権の設定を変更します。

URI

URIは、運用環境のアプリを更新する場合と、テスト環境のアプリを更新する場合とで異なります。

運用環境のアプリを更新する場合

https://(サブドメイン名).cybozu.com/k/v1/app/acl.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/acl.json

このAPIを実行すると、アプリのアクセス権だけでなく、テスト環境のアプリのすべての設定が運用環境のアプリに反映されます。

テスト環境のアプリを更新する場合

https://(サブドメイン名).cybozu.com/k/v1/preview/app/acl.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/acl.json

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

指定するパラメータの一覧です。指定するアクセス権は、次の依存関係を満たす必要があります。

レコードの編集、または削除を許可する場合、レコードの閲覧も許可する必要があります。
ファイルの読み込みを許可する場合、レコードの追加も許可する必要があります。

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。
rights	配列	必須	アクセス権の設定を表すオブジェクトの配列です。優先度が高い設定から順に並べます。ただし、ここで指定した順に関わらず、「Everyone」（すべてのユーザー）に対して指定した設定は、常に優先度が最低です。
rights[].entity	オブジェクト	必須	アクセス権の設定の対象を表すオブジェクトです。
rights[].entity.type	文字列	必須	アクセス権の設定対象の種類を指定します。ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION アプリの作成者の場合：CREATOR
rights[].entity.code	文字列	条件必須	アクセス権の設定対象のコードを指定します。「rights[].entity.type」パラメータに「CREATOR」を指定する場合、このパラメータは不要です。アクセス権の設定対象に「Everyone」（すべてのユーザー）を指定しない場合、「Everyone」はすべての操作が許可されません。ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
rights[].includeSubs	真偽値又は文字列		設定を下位組織に継承するかどうかを指定します。継承する場合：true 継承しない場合（初期設定）：false rights[].entity.typeがORGANIZATIONの場合のみ有効。省略した場合はfalse。
rights[].appEditable	真偽値又は文字列		アプリの管理が可能かどうかを指定します。アプリの管理を許可する場合：true アプリの管理を許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordViewable	真偽値又は文字列		レコードの閲覧が可能かどうかを指定します。レコードの閲覧を許可する場合：true レコードの閲覧を許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordAddable	真偽値又は文字列		レコードの追加が可能かどうかを指定します。レコードの追加を許可する場合：true レコードの追加を許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordEditable	真偽値又は文字列		レコードの編集が可能かどうかを指定します。レコードの編集を許可する場合：true レコードの編集を許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordDeletable	真偽値又は文字列		レコードの削除が可能かどうかを指定します。レコードの削除を許可する場合：true レコードの削除を許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordImportable	真偽値又は文字列		ファイルの読み込みが可能かどうかを指定します。ファイルの読み込みを許可する場合：true ファイルの読み込みを許可しない場合（初期設定）：false 省略した場合はfalse。
rights[].recordExportable	真偽値又は文字列		ファイルの書き出しが可能かどうかを指定します。ファイルの書き出しを許可する場合：true ファイルの書き出しを許可しない場合（初期設定）：false 省略した場合はfalse。
revision	数値又は文字列		アプリの設定を変更する前のリビジョン番号を指定します。previewの場合のみ、指定されたリビジョン番号を検証します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

PUT /k/v1/app/acl.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンスパラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

URI