TokenAcquisitionOptions Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Opções passadas para criar o objeto de aquisição de token que chama a msal .NET.
public class TokenAcquisitionOptions : Microsoft.Identity.Abstractions.AcquireTokenOptions
type TokenAcquisitionOptions = class
inherit AcquireTokenOptions
Public Class TokenAcquisitionOptions
Inherits AcquireTokenOptions
- Herança
Construtores
| Nome | Description |
|---|---|
| TokenAcquisitionOptions() |
Opções passadas para criar o objeto de aquisição de token que chama a msal .NET. |
Propriedades
| Nome | Description |
|---|---|
| AuthenticationOptionsName |
Obtém o nome das opções que descrevem o aplicativo cliente confidencial (ClientID, Região, Autoridade, credenciais do cliente). Em ASP.NET Core, o nome das opções de autenticação é o mesmo que o esquema de autenticação. (Herdado de AcquireTokenOptions) |
| CancellationToken |
Token de cancelamento a ser usado ao chamar os métodos de aquisição de token. |
| Claims |
Uma cadeia de caracteres com uma ou várias declarações a serem solicitadas. É um blob json (codificado ou não) Normalmente usado com acesso condicional. Ele recebe o membro Declarações da UiRequiredException. Ele também pode ser usado para solicitar declarações opcionais específicas e para Contexto de autenticação da AC (Herdado de AcquireTokenOptions) |
| CorrelationId |
Define a ID de correlação a ser usada na solicitação para o ponto de extremidade "/token" do STS. (Herdado de AcquireTokenOptions) |
| ExtraHeadersParameters |
Opções passadas para criar o objeto de aquisição de token que chama a msal .NET. (Herdado de AcquireTokenOptions) |
| ExtraParameters |
Um recipiente de propriedades usado para extensibilidade. (Herdado de AcquireTokenOptions) |
| ExtraQueryParameters |
Define parâmetros de consulta para a cadeia de caracteres de consulta na solicitação HTTP para o ponto de extremidade "/token". (Herdado de AcquireTokenOptions) |
| FmiPath |
Sub-caminho de FMI (Identidade Gerenciada Federada). (Herdado de AcquireTokenOptions) |
| ForceRefresh |
Especifica se a solicitação de token ignorará o token de acesso no cache de token e tentará adquirir um novo token de acesso.
Se |
| LongRunningWebApiSessionKey |
Chave usada para APIs Web de execução prolongada que precisam chamar APIs Web downstream em nome do usuário. Pode ser nulo, se você não estiver desenvolvendo uma API Web de execução prolongada, LongRunningWebApiSessionKeyAuto se quiser que o adquirente de token aloque uma chave de sessão para você ou sua própria cadeia de caracteres se quiser associar a sessão a algumas informações que você tem externamente (por exemplo, um identificador de gancho de Microsoft Graph). (Herdado de AcquireTokenOptions) |
| ManagedIdentity |
Quando ManagedIdentity é definido, o aplicativo usa uma identidade gerenciada em vez de credenciais de cliente para adquirir um token de aplicativo. Para usar uma identidade atribuída pelo sistema, basta deixar UserAssignedClientId nulo. Para usar uma identidade atribuída pelo usuário, defina UserAssignedClientId como a ClientID da identidade atribuída pelo usuário que você deseja usar. O uso de qualquer forma de identidade gerenciada requer que o aplicativo seja implantado no Azure e a identidade gerenciada seja configurada. Para obter mais detalhes, verifique as identidades gerenciadas para Azure documentação. (Herdado de AcquireTokenOptions) |
| PopClaim |
Além do PopPublicKey, especifique o PopClaim quando necessário em protocolos POP específicos. (Herdado de AcquireTokenOptions) |
| PoPConfiguration |
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. Consulte https://aka.ms/msal-net-pop. |
| PopPublicKey |
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. Consulte https://aka.ms/msal-net-pop. (Herdado de AcquireTokenOptions) |
| Tenant |
(Microsoft identidade específica) Permite substituir o locatário/conta para o qual obter um token. Isso é útil em aplicativos multilocatários nos casos em que uma determinada conta de usuário é um convidado em outros locatários e você deseja adquirir tokens para um locatário específico. (Herdado de AcquireTokenOptions) |
| UserFlow |
(Microsoft identidade específica) No caso do AzureAD B2C, usa um fluxo de usuário específico. (Herdado de AcquireTokenOptions) |
Métodos
| Nome | Description |
|---|---|
| Clone() |
Clone as opções (para poder substituí-las). |
Métodos de Extensão
| Nome | Description |
|---|---|
| WithCachePartitionKeys(TokenAcquisitionOptions, IDictionary<String,String>) |
Define pares chave-valor de partição de cache nas opções. Quando definido, a pesquisa e o armazenamento do cache de token incluirão esses componentes, isolando tokens armazenados em cache de entradas que têm chaves de partição diferentes (ou não). |
| WithClientAssertion(AcquireTokenOptions, String) |
Considere a declaração do cliente para a solicitação de token. |
| WithExtraBodyParameters(AcquireTokenOptions, IDictionary<String,String>) |
Adiciona parâmetros de corpo extra à solicitação de aquisição de token. Os parâmetros são mesclados em qualquer dicionário de parâmetros de corpo extra existentes, portanto, isso pode ser composto com outras extensões que também adicionam parâmetros de corpo. |