API Management の認証ポリシーAPI Management authentication policies

このトピックでは、次の API Management ポリシーについて説明します。This topic provides a reference for the following API Management policies. ポリシーを追加および構成する方法については、「 Azure API Management のポリシー」をご覧ください。For information on adding and configuring policies, see Policies in API Management.

認証ポリシーAuthentication policies

基本認証Authenticate with Basic

authentication-basic ポリシーを使用し、基本認証を使用してバックエンド サービスで認証します。Use the authentication-basic policy to authenticate with a backend service using Basic authentication. このポリシーでは、HTTP 承認ヘッダーが、ポリシーに指定された資格情報に対応する値に効率よく設定されます。This policy effectively sets the HTTP Authorization header to the value corresponding to the credentials provided in the policy.

ポリシー ステートメントPolicy statement

<authentication-basic username="username" password="password" />  

Example

<authentication-basic username="testuser" password="testpassword" />  

要素Elements

NameName 説明Description 必須Required
authentication-basicauthentication-basic ルート要素。Root element. はいYes

属性Attributes

NameName 説明Description 必須Required 既定値Default
ユーザー名username 基本認証の資格情報のユーザー名を指定します。Specifies the username of the Basic credential. はいYes 該当なしN/A
passwordpassword 基本認証の資格情報のパスワードを指定します。Specifies the password of the Basic credential. はいYes 該当なしN/A

使用法Usage

このポリシーは、次のポリシー セクションスコープで使用できます。This policy can be used in the following policy sections and scopes.

  • ポリシー セクション: inboundPolicy sections: inbound

  • ポリシー スコープ: APIPolicy scopes: API

クライアント証明書による認証Authenticate with client certificate

authentication-certificate ポリシーを使用し、クライアント証明書を使用してバックエンド サービスで認証します。Use the authentication-certificate policy to authenticate with a backend service using client certificate. 証明書は最初に API Management にインストールする必要があります。サムプリントによって識別されます。The certificate needs to be installed into API Management first and is identified by its thumbprint.

ポリシー ステートメントPolicy statement

<authentication-certificate thumbprint="thumbprint" />  

Example

<authentication-certificate thumbprint="....." />  

要素Elements

NameName 説明Description 必須Required
authentication-certificateauthentication-certificate ルート要素。Root element. はいYes

属性Attributes

NameName 説明Description 必須Required 既定値Default
thumbprintthumbprint クライアント証明書のサムプリント。The thumbprint for the client certificate. はいYes 該当なしN/A

使用法Usage

このポリシーは、次のポリシー セクションスコープで使用できます。This policy can be used in the following policy sections and scopes.

  • ポリシー セクション: inboundPolicy sections: inbound

  • ポリシー スコープ: APIPolicy scopes: API

マネージド ID による認証Authenticate with managed identity

authentication-managed-identity ポリシーを使用して、API Management サービスのマネージド ID を利用したバックエンド サービスによる認証を行います。Use the authentication-managed-identity policy to authenticate with a backend service using the managed identity of the API Management service. このポリシーでは、指定されたリソースにアクセスするためのアクセス トークンを Azure Active Directory から取得するために、マネージド ID を効果的に利用します。This policy effectively uses the managed identity to obtain an access token from Azure Active Directory for accessing the specified resource.

ポリシー ステートメントPolicy statement

<authentication-managed-identity resource="resource" output-token-variable-name="token-variable" ignore-error="true|false"/>  

Example

<authentication-managed-identity resource="https://graph.windows.net" output-token-variable-name="test-access-token" ignore-error="true" /> 

要素Elements

NameName 説明Description 必須Required
authentication-managed-identityauthentication-managed-identity ルート要素。Root element. はいYes

属性Attributes

NameName 説明Description 必須Required 既定値Default
resourceresource 文字列 をオンにします。String. Azure Active Directory におけるターゲット Web API のアプリ ID の URI (セキュリティで保護されたリソース)。The App ID URI of the target web API (secured resource) in Azure Active Directory. はいYes 該当なしN/A
output-token-variable-nameoutput-token-variable-name 文字列 をオンにします。String. オブジェクトの種類 string としてトークン値を受け取るコンテキスト変数の名前。Name of the context variable that will receive token value as an object type string. いいえ No 該当なしN/A
ignore-errorignore-error ブール値。Boolean. true に設定された場合、アクセス トークンが取得されなかったとしても、ポリシー パイプラインは引き続き実行されます。If set to true, the policy pipeline will continue to execute even if an access token is not obtained. いいえ No falsefalse

使用法Usage

このポリシーは、次のポリシー セクションスコープで使用できます。This policy can be used in the following policy sections and scopes.

  • ポリシー セクション: inboundPolicy sections: inbound

  • ポリシー スコープ: グローバル、製品、API、操作Policy scopes: global, product, API, operation

次の手順Next steps

ポリシーを使用する方法の詳細については、次のトピックを参照してください。For more information working with policies, see: