Políticas de autenticação de Gerenciamento de APIAPI Management authentication policies

Este tópico fornece uma referência para as políticas de Gerenciamento de API a seguir.This topic provides a reference for the following API Management policies. Para obter mais informações sobre como adicionar e configurar políticas, consulte Políticas de Gerenciamento de API.For information on adding and configuring policies, see Policies in API Management.

Políticas de autenticaçãoAuthentication policies

Autenticar com o BasicAuthenticate with Basic

Use a política authentication-basic para autenticar com um serviço de back-end usando a autenticação do Basic.Use the authentication-basic policy to authenticate with a backend service using Basic authentication. Essa política define efetivamente o cabeçalho de autorização HTTP para o valor correspondente às credenciais fornecidas na política.This policy effectively sets the HTTP Authorization header to the value corresponding to the credentials provided in the policy.

Declaração de políticaPolicy statement

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

ExemploExample

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

ElementosElements

NomeName DescriçãoDescription NecessárioRequired
authentication-basicauthentication-basic Elemento raiz.Root element. SimYes

AtributosAttributes

NomeName DescriçãoDescription NecessárioRequired PadrãoDefault
usernameusername Especifica o nome de usuário da credencial do Basic.Specifies the username of the Basic credential. SimYes N/DN/A
passwordpassword Especifica a senha da credencial do Basic.Specifies the password of the Basic credential. SimYes N/DN/A

UsoUsage

Essa política pode ser usada nas seções e nos escopos da política a seguir.This policy can be used in the following policy sections and scopes.

  • Seções de política: de entradaPolicy sections: inbound

  • Escopos da política: todos os escoposPolicy scopes: all scopes

Autenticar com o certificado de clienteAuthenticate with client certificate

Use a política authentication-certificate para autenticar com um serviço de back-end usando um certificado de cliente.Use the authentication-certificate policy to authenticate with a backend service using client certificate. O certificado precisa ser instalado no Gerenciamento de API primeiro e é identificado por sua impressão digital.The certificate needs to be installed into API Management first and is identified by its thumbprint.

Declaração de políticaPolicy statement

<authentication-certificate thumbprint="thumbprint" certificate-id="resource name"/>

ExemplosExamples

Neste exemplo, o certificado de cliente é identificado por sua impressão digital.In this example client certificate is identified by its thumbprint.

<authentication-certificate thumbprint="CA06F56B258B7A0D4F2B05470939478651151984" />

Neste exemplo, o certificado de cliente é identificado pelo nome do recurso.In this example client certificate is identified by resource name.

<authentication-certificate certificate-id="544fe9ddf3b8f30fb490d90f" />  

ElementosElements

NomeName DescriçãoDescription NecessárioRequired
authentication-certificateauthentication-certificate Elemento raiz.Root element. SimYes

AtributosAttributes

NomeName DescriçãoDescription NecessárioRequired PadrãoDefault
thumbprintthumbprint A impressão digital do certificado do cliente.The thumbprint for the client certificate. thumbprint Oucertificate-id deve estar presente.Either thumbprint or certificate-id must be present. N/DN/A
ID do certificadocertificate-id O nome do recurso do certificado.The certificate resource name. thumbprint Oucertificate-id deve estar presente.Either thumbprint or certificate-id must be present. N/DN/A

UsoUsage

Essa política pode ser usada nas seções e nos escopos da política a seguir.This policy can be used in the following policy sections and scopes.

  • Seções de política: de entradaPolicy sections: inbound

  • Escopos da política: todos os escoposPolicy scopes: all scopes

Autenticar com identidade gerenciadaAuthenticate with managed identity

Use a authentication-managed-identity política para autenticar com um serviço de back-end usando a identidade gerenciada do serviço de gerenciamento de API.Use the authentication-managed-identity policy to authenticate with a backend service using the managed identity of the API Management service. Essa política usa basicamente a identidade gerenciada para obter um token de acesso de Azure Active Directory para acessar o recurso especificado.This policy essentially uses the managed identity to obtain an access token from Azure Active Directory for accessing the specified resource. Depois de obter o token com êxito, a política definirá o valor do token no Authorization cabeçalho usando o Bearer esquema.After successfully obtaining the token, the policy will set the value of the token in the Authorization header using the Bearer scheme.

Declaração de políticaPolicy statement

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

ExemploExample

Usar identidade gerenciada para autenticar com um serviço de back-endUse managed identity to authenticate with a backend service

<authentication-managed-identity resource="https://graph.windows.net"/> 

Usar identidade gerenciada na política de solicitação de envioUse managed identity in send-request policy

<send-request mode="new" timeout="20" ignore-error="false">
    <set-url>https://example.com/</set-url>
    <set-method>GET</set-method>
    <authentication-managed-identity resource="ResourceID"/>
</send-request>

ElementosElements

NomeName DescriçãoDescription NecessárioRequired
autenticação-gerenciada-identidadeauthentication-managed-identity Elemento raiz.Root element. SimYes

AtributosAttributes

NomeName DescriçãoDescription NecessárioRequired PadrãoDefault
resourceresource Cadeia de caracteres.String. O URI da ID do aplicativo da API Web de destino (recurso protegido) em Azure Active Directory.The App ID URI of the target web API (secured resource) in Azure Active Directory. SimYes N/DN/A
saída-token-variável-nomeoutput-token-variable-name Cadeia de caracteres.String. Nome da variável de contexto que receberá o valor de token como um stringtipo de objeto.Name of the context variable that will receive token value as an object type string. NãoNo N/DN/A
ignore-errorignore-error Booliano.Boolean. Se definido como true, o pipeline de política continuará a ser executado mesmo se um token de acesso não for obtido.If set to true, the policy pipeline will continue to execute even if an access token is not obtained. NãoNo falsefalse

UsoUsage

Essa política pode ser usada nas seções e nos escopos da política a seguir.This policy can be used in the following policy sections and scopes.

  • Seções de política: de entradaPolicy sections: inbound

  • Escopos da política: todos os escoposPolicy scopes: all scopes

Próximas etapasNext steps

Para obter mais informações sobre como trabalhar com políticas, consulte:For more information working with policies, see: