Skip to content

Commit 46a857b

Browse files
Merge pull request #293873 from dlepow/certname
[APIM] Update validate-client-certificate for DN
2 parents f7edfcc + 6c0f48d commit 46a857b

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

articles/api-management/validate-client-certificate-policy.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: article
9-
ms.date: 07/23/2024
9+
ms.date: 01/30/2025
1010
ms.author: danlep
1111
---
1212

@@ -73,9 +73,9 @@ For more information about custom CA certificates and certificate authorities, s
7373
| thumbprint | Certificate thumbprint. | No | N/A |
7474
| serial-number | Certificate serial number. | No | N/A |
7575
| common-name | Certificate common name (part of Subject string). | No | N/A |
76-
| subject | Subject string. Must follow format of Distinguished Name. | No | N/A |
76+
| subject | Subject string. Must follow format of Distinguished Name, which consists of comma-separated name attributes, for example, *"CN=MyName, OU=MyOrgUnit, C=US..."*.| No | N/A |
7777
| dns-name | Value of dnsName entry inside Subject Alternative Name claim. | No | N/A |
78-
| issuer-subject | Issuer's subject. Must follow format of Distinguished Name. | No | N/A |
78+
| issuer-subject | Issuer's subject. Must follow format of Distinguished Name, which consists of comma-separated name attributes, for example, *"CN=MyName, OU=MyOrgUnit, C=US..."*. | No | N/A |
7979
| issuer-thumbprint | Issuer thumbprint. | No | N/A |
8080
| issuer-certificate-id | Identifier of existing certificate entity representing the issuer's public key. Mutually exclusive with other issuer attributes. | No | N/A |
8181

@@ -85,6 +85,11 @@ For more information about custom CA certificates and certificate authorities, s
8585
- [**Policy scopes:**](./api-management-howto-policies.md#scopes) global, workspace, product, API, operation
8686
- [**Gateways:**](api-management-gateways-overview.md) classic, v2, consumption, self-hosted, workspace
8787

88+
89+
### Usage notes
90+
91+
* You must use double quotes to enclose values of name attributes in the `subject` and `issuer-subject` attributes when they contain certain special characters such as ",". For example, specify `O="Contoso, Inc."` instead of `O=Contoso, Inc.` for the organization name. [Learn more](/windows/win32/api/wincrypt/nf-wincrypt-certnametostra#remarks)
92+
8893
## Example
8994

9095
The following example validates a client certificate to match the policy's default validation rules and checks whether the subject and issuer name match specified values.
@@ -98,7 +103,7 @@ The following example validates a client certificate to match the policy's defau
98103
ignore-error="false">
99104
<identities>
100105
<identity
101-
subject="C=US, ST=Illinois, L=Chicago, O=Contoso Corp., CN=*.contoso.com"
106+
subject="C=US, ST=Illinois, L=Chicago, O="Contoso, Inc.", CN=*.contoso.com"
102107
issuer-subject="C=BE, O=FabrikamSign nv-sa, OU=Root CA, CN=FabrikamSign Root CA" />
103108
</identities>
104109
</validate-client-certificate>

0 commit comments

Comments
 (0)