Autentisera med ett klientcertifikat
GÄLLER FÖR: Alla API Management-nivåer
Använd principen för att autentisera authentication-certificate
med en serverdelstjänst med hjälp av ett klientcertifikat. När certifikatet installeras i API Management först identifierar du det först med dess tumavtryck eller certifikat-ID (resursnamn).
Varning
Minimera riskerna för exponering av autentiseringsuppgifter när du konfigurerar den här principen. Microsoft rekommenderar att du använder säkrare autentiseringsmetoder om det stöds av serverdelen, till exempel hanterad identitetsautentisering eller autentiseringshanterare. Om du konfigurerar känslig information i principdefinitioner rekommenderar vi att du använder namngivna värden och lagrar hemligheter i Azure Key Vault.
Varning
Om certifikatet refererar till ett certifikat som lagras i Azure Key Vault identifierar du det med hjälp av certifikat-ID:t. När ett nyckelvalvscertifikat roteras ändras tumavtrycket i API Management och principen löser inte det nya certifikatet om det identifieras med tumavtryck.
Kommentar
Ange principens element och underordnade element i den ordning som anges i principbeskrivningen. Läs mer om hur du anger eller redigerar API Management-principer.
Principuttryck
<authentication-certificate thumbprint="thumbprint" certificate-id="resource name" body="certificate byte array" password="optional password"/>
Attribut
Attribut | beskrivning | Obligatoriskt | Standardvärde |
---|---|---|---|
tumavtryck | Tumavtrycket för klientcertifikatet. Principuttryck tillåts. | Antingen thumbprint eller certificate-id kan vara närvarande. |
Ej tillämpligt |
certifikat-ID | Certifikatresursnamnet. Principuttryck tillåts. | Antingen thumbprint eller certificate-id kan vara närvarande. |
Ej tillämpligt |
brödtext | Klientcertifikat som en bytematris. Använd om certifikatet inte hämtas från det inbyggda certifikatarkivet. Principuttryck tillåts. | Nej | Ej tillämpligt |
password | Lösenord för klientcertifikatet. Principuttryck tillåts. | Använd om certifikatet som anges i body är lösenordsskyddat. |
Ej tillämpligt |
Förbrukning
- Principavsnitt: inkommande
- Principomfattningar: global, arbetsyta, produkt, API, åtgärd
- Gatewayer: klassisk, v2, förbrukning, lokalt installerad, arbetsyta
Användningsanteckningar
- Vi rekommenderar att du konfigurerar key vault-certifikat för att hantera certifikat som används för att skydda åtkomsten till serverdelstjänster.
- Om du konfigurerar ett certifikatlösenord i den här principen rekommenderar vi att du använder ett namngivet värde.
Exempel
Klientcertifikat som identifieras av certifikat-ID:t
<authentication-certificate certificate-id="544fe9ddf3b8f30fb490d90f" />
Klientcertifikat som identifieras med tumavtryck
<authentication-certificate thumbprint="CA06F56B258B7A0D4F2B05470939478651151984" />
Klientcertifikatet anges i principen i stället för att hämtas från det inbyggda certifikatarkivet
<authentication-certificate body="@(context.Variables.GetValueOrDefault<byte[]>("byteCertificate"))" password="optional-certificate-password" />
Relaterade principer
Relaterat innehåll
Mer information om hur du arbetar med principer finns i:
- Självstudie: Transformera och skydda ditt API
- Principreferens för en fullständig lista över principinstruktioner och deras inställningar
- Principuttryck
- Ange eller redigera principer
- Återanvända principkonfigurationer
- Lagringsplats för principfragment
- Skapa principer med Microsoft Copilot i Azure