HTTP Basic認証

Basic認証で保護されたREST APIの呼出しをサポートするには、BASIC_AUTH管理対象セキュリティ・ポリシーを使用します。接続定義に必要なセキュリティ・ポリシーをカスタマイズできます。

概要

HTTP Basic認証では、クライアントは、基本という語の後ろにスペースと、次の形式のユーザー名とパスワードを含むBase64エンコードされた文字列を含むAuthorizationヘッダーを使用してHTTPリクエストを送信: username:password。

HTTP Basic認証ポリシーをドキュメントに追加するには、使用可能な認証スキーム・テンプレートを使用します。「新規接続定義の実装」を参照してください。

ノート:

一部のアプリケーションでは、accountIdなど、usernameに異なる名前が使用されます。管理対象ポリシーを変更して、プロパティのデフォルト名をオーバーライドできます。

セキュリティ・プロパティ

このセキュリティ・ポリシーを使用する接続定義は、securityPropertiesセクションで次のプロパティを定義します。「接続プロパティおよびサンプル・コード」を参照してください。

name, displayName, shortDescription列およびdescription列の値は、アダプタ定義ドキュメントにセキュリティ・ポリシーを挿入したときに表示されるデフォルト値を示します。これらの値は、必要に応じて更新できます。

name	displayName	shortDescription	description	データ型	必須
`username`	`Username`	`Use UserName`	`A username credential`	String	はい
`password`	`Password`	`Enter Password`	`A password credential`	パスワード	はい

サンプル・コード: 基本認証

次のコード・サンプルは、アダプタ定義ドキュメント内の接続内のHTTP Basic認証のデフォルト構成を示しています。

"securityPolicies": [
  {
    "type": "managed",
    "policy": "BASIC_AUTH",
    "description": "HTTP Basic Authentication",
    "displayName": "HTTP Basic Authentication",
    "scope": "ACTION",
    "securityProperties": [
      {
        "name": "username",
        "displayName": "Username",
        "description": "Registered username.",
        "shortDescription": "Example: AC1234",
        "hidden": false,
        "required": true
      },
      {
        "name": "password",
        "displayName": "Password",
        "description": "Password for the registered user.",
        "shortDescription": "Example: <password for the user>",
        "hidden": false,
        "required": true
      }
    ]
  }
]