この記事では Email Job の各メソッドを使用する際、どのように権限設定をすれば良いのかをまとめております。
SPIRAL ver.2 でAPIを使用する時の参考になればと思います。
SPIRAL ver.2 でAPIを使用する時の参考になればと思います。
- APIメソッドごとのサンプルコードまとめ Email Job
- APIメソッドごとの権限設定方法まとめ Email Job
- APIメソッドごとの権限設定&サンプルコード 記事一覧
はじめに
権限は必要最低限で設定することで、セキュアにAPIを使用することができます。
そのためこちらの記事ではAPI実行に必要な最低限のグループ権限設定方法や、
メソッドごとのアプリロール設定をまとめています。
そのためこちらの記事ではAPI実行に必要な最低限のグループ権限設定方法や、
メソッドごとのアプリロール設定をまとめています。
グループ権限設定に関して
権限を最低限にする観点からグループはAPIエージェント専用のものを作成してください。
また、Email Job のAPIメソッドに関しては「利用アプリ」権限のみを設定すれば実行することが可能です。
以下の画像のように作成したグループに、メール配信をしたいDBがあるアプリを「利用アプリ」に追加してください。
また、Email Job のAPIメソッドに関しては「利用アプリ」権限のみを設定すれば実行することが可能です。
以下の画像のように作成したグループに、メール配信をしたいDBがあるアプリを「利用アプリ」に追加してください。
アプリロール設定に関して
アプリロールで設定できる権限は全部で６つあり、それぞれの説明を表にまとめました。
以下では、メソッドごとに権限をどのように設定すべきかまとめております。
使用するメソッドに合わせて、アプリロールを設定してください。
| DB権限 |
アプリ内でAPI実行を許可するDBにだけ「あり」を設定してください。 「なし」を設定したDBに対しては一切のAPI実行ができません。 |
|---|---|
| レコード作成権限 |
メール配信には関係がないため、メール系APIでは設定する必要はありません。 APIでレコード登録／アップロードする場合には「あり」に設定する必要があります。 |
| レコード操作権限 |
メール配信には関係がないため、メール系APIでは設定する必要はありません。 レコードに対して「閲覧」「変更」「削除」の権限を設定することができます。 |
| フィールド権限 |
メール配信には関係がないため、メール系APIでは設定する必要はありません。 DB内で特定のフィールドに「閲覧」「作成」「変更」の権限を設定することができます。 |
| 一括操作権限 |
メール配信には関係がないため、メール系APIでは設定する必要はありません。 APIでレコードの一括操作を実行したい場合に設定する必要があります。 |
| メール操作権限 |
メール設定やテスト配信などの実行権限などを設定することができます。 メール系APIを使用する場合は、それぞれのメソッドに合わせて権限を設定する必要があります。 |
使用するメソッドに合わせて、アプリロールを設定してください。
EXPRESSメール配信ジョブ一覧取得メソッド
EXPRESSメール配信ジョブ一覧取得を実行したい場合には下記のようにアプリロールを設定してください。
| DB権限 | あり |
|---|---|
| レコード作成権限 | なし |
| レコード操作権限 | 設定不要 |
| フィールド権限 | 設定不要 |
| 一括操作権限 | 設定不要 |
| メール操作権限 | 設定不要 |
▼ 実際の設定画面
EXPRESSメール配信ジョブ取得メソッド
EXPRESSメール配信ジョブ取得を実行したい場合には下記のようにアプリロールを設定してください。
| DB権限 | あり |
|---|---|
| レコード作成権限 | なし |
| レコード操作権限 | 設定不要 |
| フィールド権限 | 設定不要 |
| 一括操作権限 | 設定不要 |
| メール操作権限 | 設定不要 |
▼ 実際の設定画面
