APIセキュリティをデザイン
APIデザインプロセスの一環として、API(認証)にアクセスできるコンシューマーと、許可されるオペレーション(承認)を指定する必要があります。
API全体に共通のセキュリティを定義するか、重要なリソースに対して特定のセキュリティを使用して詳細なポリシーを選択できます。
また、認証なしで特定のオペレーションを自由にアクセスできるように指定することもできます。
API Designerでは、以下の主なセキュリティタイプですべてのケースを扱えます:
- 基本認証
- ベアラー認証
- ダイジェスト認証
- OAuth1.0
- OAuth2.0
- OpenID Connect
- カスタム/APIキー
- パススルー
Cookie認証はサポートされていません。
セキュリティスキームの作成
APIバージョンで、または個々のエレメントでグローバルに使用されるセキュリティスキームを作成します。
- 選択したタイプに固有のその他のパラメーターを入力します。
これで、セキュリティスキームが作成され、APIのグローバル設定または特定のリソースと操作で使用できるようになります。
APIセキュリティの定義
API、リソース、オペレーションのセキュリティスキームを定義します。
- [Global security] (グローバルセキュリティ)セクションでセキュリティスキームを追加し、APIバージョンに対してグローバルに適用するものを選択します。
- リソースを選択し、リソースのすべてのオペレーションに適用するセキュリティスキームを選択します。 または、特定のセキュリティを定義するオペレーションを選択することもできます。
