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 ObrigatórioRequired
authentication-basicauthentication-basic Elemento raiz.Root element. SimYes

AtributosAttributes

NOMEName DESCRIÇÃODescription Obrigató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 de política: APIPolicy scopes: API

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

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

<authentication-certificate thumbprint="CA06F56B258B7A0D4F2B05470939478651151984" />  

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

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

ElementosElements

NOMEName DESCRIÇÃODescription ObrigatórioRequired
authentication-certificateauthentication-certificate Elemento raiz.Root element. SimYes

AtributosAttributes

NOMEName DESCRIÇÃODescription ObrigatórioRequired PadrãoDefault
impressão digitalthumbprint A impressão digital do certificado do cliente.The thumbprint for the client certificate. Tanto thumbprint ou certificate-id deve estar presente.Either thumbprint or certificate-id must be present. N/DN/A
certificate-idcertificate-id O nome do recurso de certificado.The certificate resource name. Tanto thumbprint ou certificate-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 de política: APIPolicy scopes: API

Autenticar com identidade gerenciadaAuthenticate with managed identity

Use o authentication-managed-identity diretiva 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. Esta política usa efetivamente a identidade gerenciada para obter um token de acesso do Azure Active Directory para acessar o recurso especificado.This policy effectively uses the managed identity to obtain an access token from Azure Active Directory for accessing the specified resource.

Declaração de políticaPolicy statement

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

ExemploExample

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

ElementosElements

NOMEName DESCRIÇÃODescription ObrigatórioRequired
identidade gerenciada autenticaçãoauthentication-managed-identity Elemento raiz.Root element. SimYes

AtributosAttributes

NOMEName DESCRIÇÃODescription ObrigatórioRequired PadrãoDefault
resourceresource Cadeia de caracteres.String. O URI de ID do aplicativo de destino API web (recurso seguro) no 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-variable-nameoutput-token-variable-name Cadeia de caracteres.String. Nome da variável de contexto que receberá o valor do token como um tipo de objeto string.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 apólices dará continuidade à execução mesmo se não for obtido um token de acesso.If set to true, the policy pipeline will continue to execute even if an access token is not obtained. NãoNo falsofalse

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 de política: global, produto, API, operaçãoPolicy scopes: global, product, API, operation

Próximas etapasNext steps

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