Skip to content

Commit 9e6a1ab

Browse files
committed
[APIM] Credential guidance in policies
1 parent fbb23b2 commit 9e6a1ab

File tree

4 files changed

+27
-1
lines changed

4 files changed

+27
-1
lines changed

articles/api-management/authentication-basic-policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ ms.author: danlep
1616

1717
Use the `authentication-basic` policy to authenticate with a backend service using Basic authentication. This policy effectively sets the HTTP Authorization header to the value corresponding to the credentials provided in the policy.
1818

19+
[!INCLUDE [api-management-credentials-caution](../../includes/api-management-credentials-caution.md)]
20+
1921
[!INCLUDE [api-management-policy-generic-alert](../../includes/api-management-policy-generic-alert.md)]
2022

2123

articles/api-management/authentication-certificate-policy.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ ms.author: danlep
1414

1515
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1616

17-
Use the `authentication-certificate` policy to authenticate with a backend service using a client certificate. When the certificate is [installed into API Management](./api-management-howto-mutual-certificates.md) first, identify it first by its thumbprint or certificate ID (resource name).
17+
Use the `authentication-certificate` policy to authenticate with a backend service using a client certificate. When the certificate is [installed into API Management](./api-management-howto-mutual-certificates.md) first, identify it first by its thumbprint or certificate ID (resourcename).
18+
19+
[!INCLUDE [api-management-credentials-caution](../../includes/api-management-credentials-caution.md)]
1820

1921
> [!CAUTION]
2022
> If the certificate references a certificate stored in Azure Key Vault, identify it using the certificate ID. When a key vault certificate is rotated, its thumbprint in API Management will change, and the policy will not resolve the new certificate if it is identified by thumbprint.
@@ -43,6 +45,12 @@ ms.author: danlep
4345
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4446
- [**Gateways:**](api-management-gateways-overview.md) classic, v2, consumption, self-hosted, workspace
4547

48+
### Usage notes
49+
50+
- We recommend configuring [key vault certificates](api-management-howto-mutual-certificates.md) to manage certificates used to secure access to backend services.
51+
- If you configure certificates or passwords not stored in the built-in certificate store, we recommend using [named values](api-management-howto-properties.md) to provide credentials.
52+
53+
4654
## Examples
4755

4856
### Client certificate identified by the certificate ID

articles/api-management/proxy-policy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ ms.author: danlep
1616

1717
The `proxy` policy allows you to route requests forwarded to backends via an HTTP proxy. Only HTTP (not HTTPS) is supported between the gateway and the proxy. Basic and NTLM authentication only.
1818

19+
[!INCLUDE [api-management-credentials-caution](../../includes/api-management-credentials-caution.md)]
20+
1921
[!INCLUDE [api-management-policy-generic-alert](../../includes/api-management-policy-generic-alert.md)]
2022

2123

@@ -39,6 +41,11 @@ The `proxy` policy allows you to route requests forwarded to backends via an HTT
3941
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
4042
- [**Gateways:**](api-management-gateways-overview.md) classic, v2, consumption, self-hosted, workspace
4143

44+
### Usage notes
45+
46+
- We recommend using [named values](api-management-howto-properties.md) to provide credentials, with secrets protected in a key vault.
47+
48+
4249
## Example
4350

4451
In this example, [named values](api-management-howto-properties.md) are used for the username and password to avoid storing sensitive information in the policy document.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
author: vladvino
3+
ms.service: azure-api-management
4+
ms.topic: include
5+
ms.date: 09/11/2024
6+
ms.author: vlvinogr
7+
---
8+
> [!CAUTION]
9+
> Credentials may be exposed by this policy. Microsoft recommends that you use the most secure authentication methods supported by your backend, and protect sensitive information with [named values](api-management-howto-properties.md). Learn more about [risks](mitigate-owasp-api-threats.md#broken-user-authentication) of different authentication mechanisms.

0 commit comments

Comments
 (0)