AcquireTokenForClientParameterBuilder Classe

Definição

Builder para AcquireTokenForClient (usado em fluxos de credenciais do cliente, em aplicações daemon). Veja https://aka.ms/msal-net-client-credentials

public sealed class AcquireTokenForClientParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder>
type AcquireTokenForClientParameterBuilder = class
    inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>
Public NotInheritable Class AcquireTokenForClientParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenForClientParameterBuilder)
Herança

Métodos

Name Descrição
ExecuteAsync()

Executa o pedido de Token de forma assíncrona.

(Herdado de BaseAbstractAcquireTokenParameterBuilder<T>)
ExecuteAsync(CancellationToken)

Executa o pedido de Token de forma assíncrona, com possibilidade de cancelar o método assíncrono.

(Herdado de AbstractConfidentialClientAcquireTokenParameterBuilder<T>)
Validate()

Valida os parâmetros da operação AcquireToken.

(Herdado de AbstractConfidentialClientAcquireTokenParameterBuilder<T>)
WithAdfsAuthority(String, Boolean)

Adiciona uma Autoridade conhecida correspondente a um servidor ADFS. Consulte https://aka.ms/msal-net-adfs.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAttributes(String)

Especifica um atributo de identidade a incluir no pedido de token. Os valores dos atributos serão devolvidos como uma reivindicação no token chamada "xms_attr" nas reivindicações do token de acesso. Isto é tipicamente usado em cenários FMI (Federated Managed Identity). Exemplo de atributo json: "{"sg1":"0000-00000-0001","sg2":["0000-00000-0002","0000-00000-0003","0000-00000-0004"]}"

WithAuthority(AadAuthorityAudience, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade conhecida do Azure AD à aplicação para os utilizadores que iniciam sessão, especificando o público de início de sessão (a cloud sendo a cloud pública do Azure). Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)
Obsoleto.

Adiciona uma autoridade conhecida do Azure AD à aplicação para os utilizadores de iniciar sessão, especificando a instância cloud e o público de iniciação de sessão. Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, Guid, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade conhecida do Azure AD à aplicação para iniciar sessão com utilizadores de uma única organização (aplicação de inquilino único) descrita pela sua instância cloud e pelo seu ID de inquilino. Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, String, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade conhecida do Azure AD à aplicação para iniciar sessão com utilizadores de uma única organização (aplicação de inquilino único) descrita pela sua instância cloud e pelo seu nome de domínio ou ID de inquilino. Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Autoridade específica para a qual o token é solicitado. Passar um valor diferente do configurado no construtor da aplicação reduz a seleção a um tenant específico. Isto não altera o valor configurado na aplicação. Isto é específico para aplicações que gerem várias contas (como um cliente de email com várias caixas de correio). Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, Guid, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade conhecida do Azure AD à aplicação para iniciar sessão com utilizadores de uma única organização (aplicação de inquilino único) especificada pelo seu ID de inquilino. Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, String, Boolean)
Obsoleto.

Importante: Use WithTenantId ou WithTenantIdFromAuthority em vez disso, ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade Azure AD conhecida à aplicação para iniciar sessão com utilizadores de uma única organização (aplicação de inquilino único) descrita pelo seu nome de domínio. Consulte https://aka.ms/msal-net-application-configuration.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithAzureRegion(Boolean)
Obsoleto.

Por favor, use o WithAzureRegion no objeto ConfidentialClientApplicationBuilder

WithB2CAuthority(String)

Adiciona uma autoridade conhecida correspondente a uma política B2C do Azure AD. Veja https://aka.ms/msal-net-b2c-specificities

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithClaims(String)

Define reivindicações na consulta. Use quando o administrador do AAD tiver ativado o acesso condicional. Adquirir o token normalmente resultará em um MsalUiRequiredException com a Claims propriedade definida. Tente novamente a aquisição do token e use esse valor no WithClaims(String) método. Consulte https://aka.ms/msal-exceptions para mais detalhes, bem como https://aka.ms/msal-net-claim-challenge.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithCorrelationId(Guid)

Define o id de correlação a ser usado no pedido de autenticação. Usado para rastrear um pedido nos registos tanto do SDK como do serviço Identity Provider. Se não for definido, será gerado um aleatório.

(Herdado de BaseAbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(Dictionary<String,String>)
Obsoleto.

Define parâmetros extra de consulta para a cadeia de consulta no pedido de autenticação HTTP.

(Herdado de BaseAbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>)

Define Parâmetros Extra de Consulta para a cadeia de consulta no pedido de autenticação HTTP com controlo sobre quais os parâmetros incluídos na chave de cache

(Herdado de BaseAbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(String)
Obsoleto.

Define parâmetros extra de consulta para a cadeia de consulta no pedido de autenticação HTTP.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithFmiPath(String)

Adiciona um parâmetro de fmi_path ao pedido. Modifica o tema do token.

WithForceRefresh(Boolean)

Especifica se a aplicação cliente deve ignorar tokens de acesso ao ler a cache do token. Novos tokens continuarão a ser escritos na cache de tokens de aplicação. Por defeito, o token é retirado da cache do token de aplicação (forceRefresh=false)

WithMtlsProofOfPossession()

Especifica que o certificado fornecido será usado para tokens PoP com autenticação mTLS (TLS mútuo). Para mais informações, consulte a documentação de Prova de Posse.

WithPreferredAzureRegion(Boolean, String, Boolean)
Obsoleto.

Por favor, use o WithAzureRegion no objeto ConfidentialClientApplicationBuilder

WithProofOfPossession(PoPAuthenticationConfiguration)
Obsoleto.

Modifica o pedido de aquisição do token para que o token adquirido seja um token de Prova de Posse (PoP), em vez de um token Portador. Os tokens PoP são semelhantes aos tokens Bearer, mas estão ligados ao pedido HTTP e a uma chave criptográfica, que o MSAL pode gerir no Windows. Veja https://aka.ms/msal-net-pop

(Herdado de AbstractConfidentialClientAcquireTokenParameterBuilder<T>)
WithScopes(IEnumerable<String>)

Especifica quais os âmbios a solicitar. Este método é usado quando a sua aplicação precisa de especificar os escopos necessários para chamar uma API protegida. Consulte <ver/ver>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent< para saber mais sobre escopos, permissões e consentimento, e >veja</veja>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes< para saber como criar escopos para aplicações legadas que antes expunham permissões OAuth2>.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithSendX5C(Boolean)

Aplicável apenas a aplicações de primeira parte, este método também permite especificar se a reivindicação x5c deve ser enviada para o Azure AD. Enviar o x5c permite aos programadores de aplicações conseguir uma simples transferência de certificados no Azure AD: este método envia a cadeia de certificados para o Azure AD juntamente com o pedido de token, para que o Azure AD possa usá-lo para validar o nome do assunto com base numa política de emissor de confiança. Isto poupa ao administrador da aplicação a necessidade de gerir explicitamente o rollover de certificados (seja via portal ou operação PowerShell/CLI). Para mais informações, consultar: https://aka.ms/msal-net-sni

WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration)

Modifica o pedido para adquirir um token de Prova de Posse (PoP) de Pedido HTTP Assinado (SHR), em vez de um Portador. Os tokens SHR PoP estão ligados ao pedido HTTP e a uma chave criptográfica, que o MSAL gere no Windows. Os tokens SHR PoP são diferentes dos tokens MTLS PoP, que são usados para autenticação Mutual TLS (mTLS). Consulte https://aka.ms/mtls-pop para obter detalhes.

(Herdado de AbstractConfidentialClientAcquireTokenParameterBuilder<T>)
WithTenantId(String)

Sobrepõe-se ao ID do inquilino especificado na autoridade ao nível da aplicação. Esta operação preserva o anfitrião autoridade (ambiente).

Se uma autoridade não foi especificada ao nível da aplicação, o padrão utilizado é https://login.microsoftonline.com/common.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)
WithTenantIdFromAuthority(Uri)

Extrai o ID do inquilino do URI de autoridade fornecido e sobrepõe o ID de inquilino especificado na autoridade ao nível da aplicação. Esta operação preserva o host de autoridade (ambiente) fornecido ao construtor da aplicação. Se não foi fornecida uma autoridade ao construtor da aplicação, este método substituirá o ID do inquilino na autoridade padrão - https://login.microsoftonline.com/common.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)

Métodos da Extensão

Name Descrição
OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>)

Intervém no pipeline de pedidos, executando um delegado fornecido pelo utilizador antes de o MSAL fazer o pedido de token. O delegado pode modificar a carga útil do pedido adicionando ou removendo parâmetros e cabeçalhos do corpo. OnBeforeTokenRequestData

WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String)

Configura o SDK para não recuperar um token da cache se este corresponder ao hash SHA256 do token configurado. Semelhante à API WithForceRefresh(bool), mas em vez de contornar a cache para todos os tokens, o bypass da cache ocorre apenas para 1 token

WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>)

Especifica parâmetros adicionais adquiridos a partir de respostas de autenticação para serem armazenados em cache com o token de acesso que normalmente não estão incluídos no objeto de cache. estes valores podem ser lidos a partir do AdditionalResponseParameters parâmetro.

WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>)

Envia attributeTokens como attribute_tokens parâmetro do corpo e inclui-os na chave de cache. Entradas nulas/vazias/espaços em branco são ignoradas; uma coleção nula ou vazia é uma no-op.

WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension)

Permite que as aplicações cliente forneçam uma operação de autenticação personalizada para ser usada no pedido de aquisição de tokens.

WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String)

Adiciona um par chave-valor à chave cache do token sem a enviar como parâmetro de consulta. Use isto para particionar tokens em cache (por exemplo, isolando sessões de curta duração de sessões normais para o mesmo utilizador). Tanto AcquireTokenByAuthorizationCode como AcquireTokenSilent devem usar a mesma chave de partição para corresponder às entradas em cache.

WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String)

Especifica reivindicações originadas pelo cliente a incluir no pedido de token. Ao contrário WithClaims(String) (para desafios de reclamações emitidas pelo servidor), os tokens adquiridos com claims do cliente são armazenados em cache e a entrada de cache é indexada pelo valor das reclamações. Valores diferentes de reivindicações produzem entradas de cache separadas. Use valores estáveis e não dinâmicos para evitar o crescimento ilimitado da cache.

WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>)

Adicione parâmetros adicionais ao pedido do token. Estes parâmetros são adicionados à chave de cache para associar estes parâmetros ao token adquirido.

WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>)

Adicione parâmetros adicionais ao pedido do token. Estes parâmetros são adicionados à chave de cache para associar estes parâmetros ao token adquirido. Funciona para fluxos confidenciais de clientes (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode).

WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String)

Especifica reivindicações adicionais a serem incluídas na declaração do cliente. Estas reclamações serão fundidas com as reclamações em incumprimento quando a declaração do cliente for gerada. Isto permite APIs de nível mais alto como a Microsoft. A Identity.Web fornece reivindicações adicionais para a declaração do cliente. Importante: os tokens estão associados às reivindicações adicionais de asserção do cliente, o que afeta as consultas de cache. Esta é uma API de extensibilidade e não deve ser usada diretamente por aplicações.

WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>)
Obsoleto.

Adiciona cabeçalhos Http adicionais ao pedido de token.

WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>)

Adiciona cabeçalhos HTTP adicionais ao pedido de token.

WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String)

Especifica um caminho FMI a ser usado para a asserção do cliente. Isto permite que APIs de nível superior como a Id.Web forneçam credenciais sensíveis à FMI. Importante: os tokens estão associados ao caminho FMI das credenciais, que afeta as consultas de cache. Esta é uma API de extensibilidade e não deve ser usada por aplicações.

WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String)

Vincula o token a uma chave na cache. As chaves de cache L2 contêm o id da chave. Não são realizadas operações criptográficas sobre o token.

WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String)

Vincula o token a uma chave na cache. Não são realizadas operações criptográficas sobre o token.

Aplica-se a