基本認証: 簡易ポリシー

ポリシー名

基本認証: シンプル

概要

1 つのユーザー-パスワードを使用して基本認証メカニズムに基づいてアクセスを許可する

カテゴリ

セキュリティ

使用可能な最小 Flex Gateway バージョン

v1.0.0

返される状況コード

400 - SOAP 1.2 を使用した WSDL API での未承認または無効なクライアントアプリケーションのログイン情報

401 - HTTP または RAML API での未承認または無効なクライアントアプリケーションのログイン情報

500 - SOAP 1.1 を使用した WSDL API での未承認または無効なクライアントアプリケーションのログイン情報

概要

基本認証: 簡易ポリシーは、要求を出すアプリケーションに対してユーザー名とパスワードを強制的に提供させることで API を保護します。

このポリシーは、基本 HTTP 認証標準に準拠します。

エラーに遭遇すると、このポリシーは「WWW-Authenticate」 HTTP ヘッダー項目を返します。

ローカルモードでは、宣言型の設定ファイルを使用してポリシーを API に適用します。以下のポリシー定義とパラメーターの表を参照してください。

- policyRef:
    name: http-basic-authentication-flex
  config:
    username: <string> // REQUIRED
    password: <string> // REQUIRED

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`username`	必須	なし	base-64 でエンコードされた文字列
`password`	必須	なし	base-64 でエンコードされた文字列

username

必須

なし

base-64 でエンコードされた文字列

password

必須

なし

base-64 でエンコードされた文字列

- policyRef:
    name: http-basic-authentication-flex
  config:
    username: chris
    password: admin

基本認証: 簡易ポリシーを API に適用した後は、その API への要求に次のヘッダーを含める必要があります。

Authorization: Basic <username:password>

username:password の値は Base64 でエンコードされた文字列である必要があります。たとえば、Mac OS X や Linux システムでは、ユーザー名とパスワードの要件は次のように実装されます。

echo -n '<Client Id>:<Client Secret>' | base64