AcquireTokenForClientParameterBuilder Classe

Definição

Construtor para AcquireTokenForClient (usado em fluxos de credenciais de cliente, em aplicativos daemon). Consulte 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

Nome Description
ExecuteAsync()

Executa a solicitação de token de forma assíncrona.

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

Executa a solicitação de token de forma assíncrona, com a 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 do ADFS. Consulte https://aka.ms/msal-net-adfs.

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

Especifica um atributo de identidade a ser incluído na solicitação de token. Os valores de atributo serão retornados como uma declaração no token chamado "xms_attr" nas declarações de token de acesso. Normalmente, isso é usado com cenários FMI (Identidade Gerenciada Federada). Exemplo de atributo json: "{"sg1":"0000-00000-0001","sg2":["0000-00000-0002","0000-00000-00000-00003","00000-00004"]}"

WithAuthority(AadAuthorityAudience, Boolean)
Obsoleto.

Importante: use WithTenantId ou WithTenantIdFromAuthority ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade Azure AD conhecida ao aplicativo para conectar usuários que especificam o público-alvo de entrada (a nuvem é o Azure nuvem pública). Consulte https://aka.ms/msal-net-application-configuration.

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

Adiciona uma autoridade Azure AD conhecida ao aplicativo para conectar usuários que especificam a instância de nuvem e o público-alvo de entrada. Consulte https://aka.ms/msal-net-application-configuration.

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

Importante: use WithTenantId ou WithTenantIdFromAuthority ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade de Azure AD conhecida ao aplicativo para conectar usuários de uma única organização (aplicativo de locatário único) descrito por sua instância de nuvem e sua ID de locatário. Consulte https://aka.ms/msal-net-application-configuration.

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

Importante: use WithTenantId ou WithTenantIdFromAuthority ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade de Azure AD conhecida ao aplicativo para conectar usuários de uma única organização (aplicativo de locatário único) descrito por sua instância de nuvem e seu nome de domínio ou ID de locatário. Consulte https://aka.ms/msal-net-application-configuration.

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

Importante: use WithTenantId ou WithTenantIdFromAuthority ou WithB2CAuthority para autoridades B2C.

Autoridade específica para a qual o token é solicitado. Passar um valor diferente do configurado no construtor do aplicativo restringe a seleção a um locatário específico. Isso não altera o valor configurado no aplicativo. Isso é específico para aplicativos que gerenciam 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 ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade Azure AD conhecida ao aplicativo para conectar usuários de uma única organização (aplicativo de locatário único) especificada por sua ID de locatário. Consulte https://aka.ms/msal-net-application-configuration.

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

Importante: use WithTenantId ou WithTenantIdFromAuthority ou WithB2CAuthority para autoridades B2C.

Adiciona uma autoridade Azure AD conhecida ao aplicativo para conectar usuários de uma única organização (aplicativo de locatário único) descrito pelo nome de domínio. Consulte https://aka.ms/msal-net-application-configuration.

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

Use WithAzureRegion no objeto ConfidentialClientApplicationBuilder

WithB2CAuthority(String)

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

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

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

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

Define a ID de correlação a ser usada na solicitação de autenticação. Usado para acompanhar uma solicitação nos logs do SDK e do serviço provedor de identidade. Se não for definido, um aleatório será gerado.

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

Define parâmetros de consulta extras para a cadeia de caracteres de consulta na solicitação de autenticação HTTP.

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

Define parâmetros de consulta extra para a cadeia de caracteres de consulta na solicitação de autenticação HTTP com controle sobre quais parâmetros estão incluídos na chave de cache

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

Define parâmetros de consulta extras para a cadeia de caracteres de consulta na solicitação de autenticação HTTP.

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

Adiciona um parâmetro fmi_path à solicitação. Ele modifica o assunto do token.

WithForceRefresh(Boolean)

Especifica se o aplicativo cliente deve ignorar tokens de acesso ao ler o cache de token. Novos tokens ainda serão gravados no cache do token de aplicativo. Por padrão, o token é retirado do cache do token de aplicativo (forceRefresh=false)

WithMtlsProofOfPossession()

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

WithPreferredAzureRegion(Boolean, String, Boolean)
Obsoleto.

Use WithAzureRegion no objeto ConfidentialClientApplicationBuilder

WithProofOfPossession(PoPAuthenticationConfiguration)
Obsoleto.

Modifica a solicitação de aquisição de token para que o token adquirido seja um PoP (Token de Prova de Posse), em vez de um token de portador. Os tokens PoP são semelhantes aos tokens de portador, mas estão associados à solicitação HTTP e a uma chave criptográfica, que a MSAL pode gerenciar em Windows. Consulte https://aka.ms/msal-net-pop

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

Especifica quais escopos solicitar. Esse método é usado quando seu aplicativo precisa especificar os escopos necessários para chamar uma API protegida. <Consulte>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</veja> para saber mais sobre escopos, permissões e consentimento e <veja>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</veja> como criar escopos para aplicativos herdados que costumavam expor permissões OAuth2.

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

Aplicável somente a aplicativos de primeira parte, esse método também permite especificar se a declaração x5c deve ser enviada para Azure AD. O envio do x5c permite que os desenvolvedores de aplicativos obtenham fácil substituição de certificado no Azure AD: esse método enviará a cadeia de certificados para Azure AD junto com a solicitação de token, para que Azure AD possa usá-lo para validar o nome da entidade com base em uma política de emissor confiável. Isso salva o administrador do aplicativo da necessidade de gerenciar explicitamente a substituição de certificado (por meio do portal ou da operação do PowerShell/CLI). Para obter detalhes, consulte https://aka.ms/msal-net-sni

WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration)

Modifica a solicitação para adquirir um token PoP (Solicitação HTTP Assinada) de Prova de Posse (PoP), em vez de um portador. Os tokens PoP do SHR são associados à solicitação HTTP e a uma chave criptográfica, que a MSAL gerencia em Windows. Os tokens PoP do SHR são diferentes dos tokens PoP do mTLS, que são usados para autenticação do MTLS (Mutual TLS). Consulte https://aka.ms/mtls-pop para obter detalhes.

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

Substitui a ID do locatário especificada na autoridade no nível do aplicativo. Essa operação preserva o host de autoridade (ambiente).

Se uma autoridade não tiver sido especificada no nível do aplicativo, o padrão usado será https://login.microsoftonline.com/common.

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

Extrai a ID do locatário do URI de autoridade fornecido e substitui a ID de locatário especificada na autoridade no nível do aplicativo. Essa operação preserva o host de autoridade (ambiente) fornecido ao construtor de aplicativos. Se uma autoridade não tiver sido fornecida ao construtor de aplicativos, esse método substituirá a ID do locatário na autoridade padrão – https://login.microsoftonline.com/common.

(Herdado de AbstractAcquireTokenParameterBuilder<T>)

Métodos de Extensão

Nome Description
OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>)

Intervém no pipeline de solicitação executando um delegado fornecido pelo usuário antes que a MSAL faça a solicitação de token. O delegado pode modificar o conteúdo da solicitação adicionando ou removendo os cabeçalhos e parâmetros do corpo. OnBeforeTokenRequestData

WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String)

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

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

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

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

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

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

Permite que os aplicativos cliente forneçam uma operação de autenticação personalizada a ser usada na solicitação de aquisição de token.

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

Adiciona um par chave-valor à chave de cache de token sem enviá-la como um parâmetro de consulta. Use isso para particionar tokens armazenados em cache (por exemplo, isolando sessões de curta duração de sessões regulares para o mesmo usuário). Ambos AcquireTokenByAuthorizationCode e AcquireTokenSilent devem usar a mesma chave de partição para corresponder a entradas armazenadas em cache.

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

Especifica declarações originadas pelo cliente a serem incluídas na solicitação de token. Ao contrário WithClaims(String) (para desafios de declarações emitidas pelo servidor), os tokens adquiridos com declarações de cliente são armazenados em cache e a entrada de cache é chaveada no valor de declarações. Valores de declarações diferentes produzem entradas de cache separadas. Use valores estáveis e não dinâmicos para evitar o crescimento de cache não associado.

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

Adicione parâmetros de corpo extra à solicitação de token. Esses parâmetros são adicionados à chave de cache para associar esses parâmetros ao token adquirido.

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

Adicione parâmetros de corpo extra à solicitação de token. Esses parâmetros são adicionados à chave de cache para associar esses parâmetros ao token adquirido. Funciona para fluxos de cliente confidenciais (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode).

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

Especifica declarações extras a serem incluídas na declaração do cliente. Essas declarações serão mescladas com declarações padrão quando a declaração do cliente for gerada. Isso permite APIs de nível mais alto, como Microsoft. Identity.Web fornece declarações adicionais para a declaração do cliente. Importante: os tokens são associados às declarações de declaração de cliente extras, o que afeta as pesquisas de cache. Essa é uma API de extensibilidade e não deve ser usada diretamente por aplicativos.

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

Adiciona cabeçalhos Http adicionais à solicitação de token.

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

Adiciona cabeçalhos HTTP adicionais à solicitação de token.

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

Especifica um caminho FMI a ser usado para a declaração do cliente. Isso permite que APIs de nível mais alto, como a Id.Web, forneçam credenciais sensíveis ao FMI. Importante: os tokens são associados ao caminho FMI de credencial, que afeta pesquisas de cache Essa é uma API de extensibilidade e não deve ser usada por aplicativos.

WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String)

Associa o token a uma chave no cache. As chaves de cache L2 contêm a ID da chave. Nenhuma operação criptográfica é executada no token.

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

Associa o token a uma chave no cache. Nenhuma operação criptográfica é executada no token.

Aplica-se a