設計情報

投稿者:SPIRERS ナレッジ向上チーム 2022年10月24日 (月)

APIメソッドごとの権限設定方法まとめ Record File

この記事では Record File の各メソッドを使用する際、どのように権限設定をすれば良いのかをまとめております。
SPIRAL ver.2 でAPIを使用する時の参考になればと思います。

はじめに

権限は必要最低限で設定することで、セキュアにAPIを使用することができます。
そのためこちらの記事ではAPI実行に必要な最低限のグループ権限設定方法や、
メソッドごとのアプリロール設定をまとめています。

グループ権限設定に関して

権限を最低限にする観点からグループはAPIエージェント専用のものを作成してください。
また、 Record File のAPIメソッドに関しては「利用アプリ」権限のみを設定すれば実行することが可能です。

以下の画像のように作成したグループに、API操作したいDBがあるアプリを「利用アプリ」に追加してください。

アプリロール設定に関して

アプリロールで設定できる権限は全部で6つあり、それぞれの説明を表にまとめました。
DB権限 アプリ内でAPI実行を許可するDBにだけ「あり」を設定してください。
「なし」を設定したDBに対しては一切のAPI実行ができません。
レコード作成権限 APIでレコード登録/アップロードする場合には「あり」に設定する必要があります。
レコード操作権限 レコードに対して「閲覧」「変更」「削除」の権限を設定することができます。
条件を設定することで特定のレコードのみの操作権限を設定することも可能です。
フィールド権限 DB内で特定のフィールドに「閲覧」「作成」「変更」の権限を設定することができます。
権限を設定していないフィードに対してはAPI実行ができません。
一括操作権限 APIでレコードの一括操作を実行したい場合に設定する必要があります。
メール操作権限 メール関連の権限になりますので、レコード操作系のAPIでは設定する必要がありません。
以下では、メソッドごとに権限をどのように設定すべきかまとめております。
使用するメソッドに合わせて、アプリロールを設定してください。

ファイルアップロードトークン発行の設定

ファイルアップロードトークン発行(【POST】apps/{app}/dbs/{db}/{field}/files/uploadToken )を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 あり
レコード操作権限 設定不要
フィールド権限 ファイルフィールドに「作成」のチェックを付けてください。
※仕様上「閲覧」にもチェックを付ける必要があります。
一括操作権限 設定不要
メール操作権限 設定不要
▼ 実際の設定画面

ファイルアップロードの設定

ファイルアップロード(【POST】apps/{app}/dbs/{db}/{field}/files )を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 あり
レコード操作権限 設定不要
フィールド権限 ファイルフィールドに「作成」のチェックを付けてください。
※仕様上「閲覧」にもチェックを付ける必要があります。
一括操作権限 設定不要
メール操作権限 設定不要
▼ 実際の設定画面
注意事項等
ファイルをDBに格納する場合は、レコード登録/更新メソッドを使用する必要があります。
その際ファイル以外のフィールドにもデータを登録したい場合は、それに合わせてフィールド権限のチェックを増やしてください。

ファイルダウンロードの設定

ファイルダウンロード(【GET】apps/{app}/dbs/{db}/{field}/{recordId}/files/{fileKey}/download )を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 なし
レコード操作権限 「閲覧」にチェックを付けてください。
フィールド権限 ファイルフィールドに「閲覧」のチェックを付けてください。
一括操作権限 設定不要
メール操作権限 設定不要
▼ 実際の設定画面
コンテンツに関しての
要望はこちら