アプリのアクセス権の取得 – cybozu developer network

アプリのアクセス権の設定を取得します。

URI

URIは、運用環境の設定を取得する場合と、テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合

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

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

テスト環境の設定を取得する場合

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

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

HTTPメソッド

GET

必要なアクセス権

アプリ管理権限

※このAPIの実行には、APIトークンは使用できません。

リクエストパラメータ

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」を指定したリクエストの例は、次のとおりです。

URLにパラメータを含める場合

GET /k/v1/app/acl.json?app=8 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディにパラメーターを含める場合
ヘッダ

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

ボディ

レスポンスパラメータ

パラメータ名	値の種類	説明
rights	配列	アクセス権の設定を表すオブジェクトの配列です。設定の優先度が高いものから順に並びます。
rights[].entity	オブジェクト	アクセス権の設定の対象を表すオブジェクトです。
rights[].entity.type	文字列	アクセス権の設定対象の種類です。 USER：ユーザー GROUP：グループ ORGANIZATION：組織 CREATOR：アプリの作成者
rights[].entity.code	文字列	アクセス権の設定対象のコードです。
rights[].includeSubs	真偽値	設定を下位組織に継承するかどうかの設定です。 true：継承する false：継承しない
rights[].appEditable	真偽値	アプリの管理が可能かどうかの設定です。 true：アプリを管理できる false：アプリを管理できない
rights[].recordViewable	真偽値	レコードの閲覧が可能かどうかの設定です。 true：レコードを閲覧できる false：レコードを閲覧できない
rights[].recordAddable	真偽値	レコードの追加が可能かどうかの設定です。 true：レコードを追加できる false：レコードを追加できない
rights[].recordEditable	真偽値	レコードの編集が可能かどうかの設定です。 true：レコードを編集できる false：レコードを編集できない
rights[].recordDeletable	真偽値	レコードの削除が可能かどうかの設定です。 true：レコードを削除できる false：レコードを削除できない
rights[].recordImportable	真偽値	ファイルの読み込みが可能かどうかの設定です。 true：ファイルを読み込める false：ファイルを読み込めない
rights[].recordExportable	真偽値	ファイルの書き出しが可能かどうかの設定です。 true：ファイルを書き出せる false：ファイルを書き出せない
revision	文字列	アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

URI