レコードのアクセス権の変更

レコードのアクセス権の設定を変更します。

URI

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

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

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

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

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

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

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

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

HTTPメソッド

PUT

アクセス権

• アプリに管理権限が必要です。
• このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

指定するパラメータの一覧です。レコードの編集、または削除を許可する場合、レコードの閲覧も許可する必要があります。

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。「app」、「id」のいずれかのパラメータを使用します。両方のパラメータを指定すると、「id」の指定が優先されます。
id
rights	配列	必須	アクセス権の設定を表す配列です。優先度が高い設定から順に並べます。
rights[].filterCond	文字列		レコードの条件をクエリ形式で指定します。クエリ形式については、次のページを参照してください。 レコードの一括取得（クエリで条件を指定） 指定できる条件には、後述する制限事項があります。 レコードの条件の制限事項 省略した場合は「すべてのレコード」が対象となります。
rights[].entities	配列	必須	アクセス権の設定の対象を表す配列です。優先度が高い設定から順に並べます。ただし、ここで指定した順に関わらず、「Everyone」（すべてのユーザー）に対して指定した設定は、常に優先度が最低です。
rights[].entities[].entity	オブジェクト	必須	アクセス権の設定の対象を表すオブジェクトです。
rights[].entities[].entity.type	文字列	必須	アクセス権の設定対象の種類を指定します。 ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION ユーザーフィールドの場合：FIELD_ENTITY
rights[].entities[].entity.code	文字列	必須	アクセス権の設定対象のコードを指定します。 アクセス権の設定対象に「Everyone」（すべてのユーザー）を指定しない場合、「Everyone」はすべての操作が許可されません。 ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
rights[].entities[].viewable	真偽値又は文字列		レコードの閲覧が可能かどうかを指定します。 レコードの閲覧を許可する場合：true レコードの閲覧を許可しない場合（初期設定）：false 省略した場合はfalseとなります。
rights[].entities[].editable	真偽値又は文字列		レコードの編集が可能かどうかを指定します。 レコードの編集を許可する場合：true レコードの編集を許可しない場合（初期設定）：false 省略した場合はfalse。閲覧権限がないときは強制的にfalseとなります。
rights[].entities[].deletable	真偽値又は文字列		レコードの削除が可能かどうかを指定します。 レコードの削除を許可する場合：true レコードの削除を許可しない場合（初期設定）：false 省略した場合はfalse。閲覧権限がないときは強制的にfalseとなります。
rights[].entities[].includeSubs	真偽値又は文字列		設定を下位組織に継承するかどうかを指定します。 継承する場合：true 継承しない場合（初期設定）：false 省略した場合はfalseとなります。
revision	数値又は文字列		アプリの設定を変更する前のリビジョン番号を指定します。previewの場合のみ、指定されたリビジョン番号を検証します。 指定したリビジョンが最新ではない場合、リクエストはエラーになります。 指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

レコードの条件の制限事項

「rights[].filterCond」パラメータには、画面での操作と同等の条件のみ指定できます。そのため、次の制限があります。

• 「order by」、「limit」、および「offset」は使用できません。
• 「and」と「or」は混在できません。
• 次の種類のフィールドでは、「like」および「not like」を使用できません。
• 文字列（1行）
• リンク
• 次の種類のフィールドでは、「in」、「>」、および「<」を使用できません。
• レコード番号
• 数値
• 計算
• 次の種類のフィールドでは、「=」を使用できません。
• ステータス
• 次の種類のフィールドは、条件の指定に使用できません。
• 文字列(複数行)
• リッチエディター
• 添付ファイル
• 次の関数は使用できません。
• NOW()
• TODAY()
• LAST_MONTH()
• THIS_MONTH()
• THIS_YEAR()

リクエストの例

ヘッダ

PUT /k/v1/record/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