Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

5.6. OpenAPI 認証

3scale ツールボックスを使用して OpenAPI 認証を実装すると、承認されたユーザーのみが API にアクセスできるようにして、機密データを保護し、API の使用を効率的に管理できます。このアプローチにより、API インフラストラクチャーが強化され、開発者とコンシューマー間の信頼関係が構築されます。

注記

最上位のセキュリティー要件は 1 つだけサポートされています。操作レベルのセキュリティー要件はサポートされていません。

サポートされているセキュリティースキーム: 任意のフロータイプの apiKey および oauth2。

apiKey セキュリティースキームタイプの場合は、以下のようになります。

  • 認証情報の場所は、セキュリティースキームオブジェクトのフィールドで OpenAPI から読み取られます。
  • 認証ユーザーキーは、セキュリティースキームオブジェクトの OpenAPI 名フィールドから読み取られます。

apiKey セキュリティー要件を備えた OpenAPI 3.0.2 の部分的な例:

openapi: "3.0.2"
security:
  - petstore_api_key: []
components:
  securitySchemes:
    petstore_api_key:
      type: apiKey
      name: api_key
      in: header
      ...
Copy to Clipboard Toggle word wrap

oauth2 セキュリティースキームタイプの場合は、以下のようになります。

  • 認証情報の場所は headers にハードコーディングされています。
  • OpenID Connect Issuer Type のデフォルトは rest です。--oidc-issuer-type=<value> コマンドオプションを使用してこれをオーバーライドできます。
  • OpenID Connect Issuer は OpenAPI から読み取られません。3scale では発行者の URL にクライアントシークレットが含まれている必要があるため、この --oidc-issuer-endpoint=<value> コマンドオプションを使用して発行を設定する必要があります。
  • OIDC AUTHORIZATION FLOW は、セキュリティースキームオブジェクトの flows フィールドから読み取られます。

oauth2 セキュリティー要件を備えた OpenAPI 3.0.2 の部分的な例:

openapi: "3.0.2"
security:
    - petstore_oauth:
      - write:pets
      - read:pets
  components:
    securitySchemes:
      petstore_oauth:
        type: oauth2
        flows:
          clientCredentials:
            tokenUrl: http://example.org/api/oauth/dialog
            scopes:
              write:pets: modify pets in your account
              read:pets: read your pets
              ...
Copy to Clipboard Toggle word wrap

OpenAPI がセキュリティー要件を指定していない場合:

  • この製品は Open API とみなされます。
  • default_credentials 3scale ポリシーが追加されました。注記: これは anonymous_policy とも呼ばれます。
  • --default-credentials-userkey コマンドが必要です。注記: 指定されていない場合、コマンドは失敗します。

関連情報

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat