API キー認証コンポーネントは、API キーに基づく認証を提供します。HTTP リクエストの URL パラメーター、リクエストヘッダー、または Cookie から API キーを抽出し、事前に構成された認証情報リストと比較してアクセス権限を検証します。
機能タイプ
認証
フィールド
ComponentConfig
パラメーター | 型 | 必須 | デフォルト値 | 説明 |
Config | はい | - | API キー認証の設定。 |
ApiKeyConfig
パラメーター | 型 | 必須 | デフォルト値 | 説明 |
ApiKeySources | はい | - | リクエストから API キーを抽出するメソッド。サポートされるソースは 1 つのみです。 | |
ApiKeyCredentials | はい | - | 信頼できる API キー認証情報のリスト。 |
ApiKeySourcesConfig
パラメーター | 型 | 必須 | デフォルト | 説明 |
Headers | String[] | いいえ | - | HTTP リクエストヘッダーから API キーを抽出します。 |
Params | String[] | いいえ | - | URL パラメーターから API キーを抽出します。 |
Cookies | String[] | いいえ | - | Cookie から API キーを抽出します。 |
ApiKeyCredential
パラメーター | 型 | 必須 | デフォルト値 | 説明 |
Provider | はい | System | 認証情報のタイプ。 | |
Credential | String | 条件付き必須 | - | 資格情報の値。これは API キー文字列です。 |
ApiKeyCredentialProvider
値 | 説明 |
System | システムによって自動的に生成される認証情報。 |
Custom | ユーザーによってアップロードされる認証情報。 |
エラーコード
HTTP ステータスコード | エラーメッセージ | 説明 |
401 | Client authentication failed. | API キー認証に失敗しました。キーが不正であるか、API キーが指定されていないことが原因である可能性があります。 |