API を実行したユーザーのレコードのアクセス権の設定を取得する
API を実行したユーザーのレコードのアクセス権限を取得する
API を実行したユーザーについて、レコードやフィールドのアクセス権の設定を取得します。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/records/acl/evaluate.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/records/acl/evaluate.json
HTTP メソッド
GET
必要なアクセス権
次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリ ID |
ids | 配列(数値) | 必須 | アクセス権を取得するレコードのレコード ID 最大で 100 件のレコード ID を指定できます。 存在しないレコード ID が含まれているとエラーになります。 |
リクエストの例(URLにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/records/acl/evaluate.json?app=8&ids[0]=1&ids[1]=2
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/records/acl/evaluate.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
rights | 配列 | アクセス権の設定の一覧 |
rights[].id | 文字列 | レコード ID |
rights[].record | オブジェクト | 指定したレコードのアクセス権の設定 |
rights[].record.viewable | 真偽値 | レコードの閲覧が可能かどうか
|
rights[].record.editable | 真偽値 | レコードの編集が可能かどうか
|
rights[].record.deletable | 真偽値 | レコードの削除が可能かどうか
|
rights[].fields | オブジェクト | レコードに存在するフィールドのアクセス権 レコードを更新する API で操作できるフィールドのアクセス権が返ります。 API を実行するユーザーに閲覧権限のないフィールドや、アクセス権を設定していないフィールドも含まれます。 テーブル内のフィールドでも通常に配置したフィールドと同じ階層で返ります。 |
rights[].fields.フィールドコード .viewable |
真偽値 | フィールドの閲覧が可能かどうか
|
rights[].fields.フィールドコード .editable |
真偽値 | フィールドの編集が可能かどうか
|
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|
制限事項
- API トークンは使用できません。
- 次のフィールドに関するアクセス権は、この API で取得できません。
- フィールドの閲覧権限や編集権限は、レコードの権限で上書きされます。
*1 「フィールドのアクセス権」で設定できないフィールドです。 ^