設計情報

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

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

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

はじめに

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

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

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

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

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

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

レコード一括出力依頼一覧取得メソッド

レコード一括出力依頼一覧取得を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 なし
レコード操作権限 設定不要
フィールド権限 設定不要
一括操作権限 「一括DL」にチェックを付けてください。
メール操作権限 設定不要
▼ 実際の設定画面
APIリファレンス

レコード一括出力依頼作成メソッド

レコード一括出力依頼作成を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 なし
レコード操作権限 すべてのレコードもしくは条件を絞ったレコードの「閲覧」にチェックを付けてください。
フィールド権限 必要なフィードにのみ「閲覧」のチェックを付けてください。
一括操作権限 「一括DL」にチェックを付けてください。
メール操作権限 設定不要
▼ 実際の設定画面
APIリファレンス
補足
レコード操作権限によって出力するファイルに含める、レコードを簡易ですが条件付けすることが可能です。
またフィールド権限によって出力するファイルに含める、フィールドを指定することも可能になっています。

アプリロールを指定して作成メソッドを実行した場合、
同じアプリロールを指定しないと依頼一覧取得、依頼取得、依頼キャンセルが正しく実行できません。
基本的にこのページで紹介しているメソッドを利用する場合は同一のロールを使うようにしてください。
※アプリロールを指定して作成した依頼に関しては、「全権限」であっても取得/キャンセルが実行できません。

レコード一括出力依頼取得メソッド

レコード一括出力依頼取得を実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 なし
レコード操作権限 設定不要
フィールド権限 設定不要
一括操作権限 「一括DL」にチェックを付けてください。
メール操作権限 設定不要
▼ 実際の設定画面
APIリファレンス

レコード一括出力依頼キャンセルメソッド

レコード一括出力依頼キャンセルを実行したい場合には下記のようにアプリロールを設定してください。
DB権限 あり
レコード作成権限 なし
レコード操作権限 設定不要
フィールド権限 設定不要
一括操作権限 「一括DL」にチェックを付けてください。
メール操作権限 設定不要
▼ 実際の設定画面
APIリファレンス
解決しない場合はこちら コンテンツに関しての
要望はこちら