設計情報

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

APIメソッドごとの権限設定方法まとめ Authentication(認証API)

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

はじめに

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

同一のキーを認証API以外でも利用する場合は、他の権限設定と組み合わせて設定してください。
ただしその場合でも、必要以上に権限を付与しないように注意してください。

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

権限を必要最低限にするためグループはAPIエージェント専用のものを作成してください。
また、Authentication(認証API)のAPIメソッドに関しては「サイト認証API」権限のみを設定すれば実行することが可能です。

以下の画像のように作成したグループの「サイト認証API」に、API利用したい認証エリアを追加してください。

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

Authentication(認証API)のメソッドでは、アプリロールを指定することができません。

そのため、アプリロールの設定が不要であり、Authentication(認証API)単体で使用する場合は、
DBを操作する処理を利用不可に制限することができます。
解決しない場合はこちら コンテンツに関しての
要望はこちら