Referência da API do Microsoft Entra ID do Windows Account Manager (WAM)
O Microsoft Entra ID Windows Account Manager (WAM) é um conjunto de APIs que permite aos desenvolvedores integrar aplicativos do Windows. Os parâmetros a seguir podem ser utilizados com MSAL em uma plataforma Windows, facilitando o desenvolvimento de aplicativos que permitem aos usuários entrar por meio do Microsoft Entra ID ou de contas da Microsoft (MSA).
Microsoft Entra ID WAM API Reference
Parâmetro | Valor | Observações |
---|---|---|
authority |
organizations Ou um URL específico do emissor do token. Por exemplo, https://login.partner.microsoftonline.cn é o URL do emissor do token para o ambiente de nuvem Mooncake. |
O parâmetro authority especifica o provedor de identidade e o ambiente de nuvem da sua API. |
resource |
O URL para o qual o desenvolvedor está adquirindo um token, como https://www.sharepoint.com |
O parâmetro resource especifica a URL de destino para a qual o token de autenticação está sendo obtido. |
redirect_uri |
O local para onde o servidor de autorização envia o usuário depois que o aplicativo foi autorizado com sucesso e recebeu um código de autorização ou token de acesso. | Observação: Esse parâmetro não é compatível com aplicativos UWP (Plataforma Universal do Windows). O chamador deve ter permissões de nível de integridade médio. Veja Restrições e limitações de URI de redirecionamento (URL de resposta) |
correlationId |
Um GUID exclusivo gerado para cada solicitação que pode ser usado para unir solicitações entre fontes de dados | Observação: O correlationId é um parâmetro legado. Ela foi substituída por uma propriedade na própria API WAM. Veja Propriedade WebTokenRequest.CorrelationId (Windows.Security.Authentication.Web.Core) - aplicativos UWP do Windows |
validateAuthority |
Boleano; qualquer TRUE ou FALSE . |
O plug-in Microsoft Entra ID executa a validação de autoridade por padrão. Se uma aplicação precisar desabilitar essa validação, ela deverá enviar um valor FALSE para validateAuthority . Isso pode ser útil em cenários locais. Veja MsalAuthenticationOptions.ValidateAuthority Property |
certificateUsage |
vpn |
Esse parâmetro é usado para solicitar um tipo de token de certificado. O único valor permitido é vpn . Atualmente, isso só se aplica a cenários VPN. |
certificateUIName |
Qualquer sequência exibida na UI de seleção de certificado para o certificado VPN. | O parâmetro certificateUIName especifica a cadeia de caracteres mostrada na interface do usuário de seleção de certificado ao escolher um certificado VPN. |
certificateUIDescription |
Qualquer sequência exibida na UI de seleção de certificado para o certificado VPN. | O parâmetro certificateUIDescription especifica a cadeia de caracteres mostrada na interface do usuário de seleção de certificado como uma descrição ao escolher um certificado VPN. |
UserPictureEnabled |
True ou False . |
Indica se a aplicação deseja receber a imagem do usuário como parte da resposta do token. |
Username |
Nome de usuário | Representa o nome de usuário do Microsoft Entra ID |
Password |
Senha | Representa a senha do usuário Microsoft Entra ID |
SamlAssertion |
token de SAML | Token SAML enviado como artefato de autenticação de um IDP de terceiros para o Microsoft Entra ID |
SamlAssertionType |
"urn:ietf:params:oauth:grant-type:saml1_1-bearer" ou "urn:ietf:params:oauth:grant-type:saml2-bearer" |
Especifica o tipo de token SAML usado para autenticação. |
LoginHint |
Dica de nome de usuário (upn) | Fornece uma dica para o nome de usuário durante o processo de login. |
msafed |
0 ou 1 . |
Determina se é permitido que usuários com contas Microsoft entrem como identidades federadas em um locatário do Entra. Um valor 1 habilita a federação, enquanto 0 a desabilita. |
discover |
Home |
O parâmetro discover indica que a solicitação de token é executada no contexto da nuvem doméstica do usuário, não na nuvem à qual o dispositivo está associado. |
domain_hint |
O domínio relevante. Por exemplo, contoso.com |
O Microsoft Entra ID usa a dica para localizar o domínio no diretório Observação: a dica de domínio está tendo prioridade sobre o domínio substituto caso ambos sejam passados como parâmetros pela ADAL |
fallback_domain |
Um domínio, como contoso.com |
O parâmetro fallback_domain é uma dica que o Microsoft Entra ID usa para localizar o domínio no diretório. É usado principalmente para domínios de usuário não roteáveis que fazem parte do UPN do usuário. |
client_TokenType |
DeviceAuth |
O parâmetro client_TokenType é usado exclusivamente para solicitar tokens somente de dispositivo. O chamador precisa ter permissões de nível de integridade Médio. |
IsFeatureSupported |
CrossCloudB2B , redirect_uri , TokenBinding . |
Usado para verificar se um recurso é compatível com o fluxo atual. |
prompt |
no_select ou select_account |
O parâmetro prompt controla o comportamento da janela de prompt. no_select significa que nenhum controle de comportamento de prompt é anexado à janela de prompt. select_account exibe o seletor de conta. O parâmetro é passado ao serviço de login para controlar o comportamento de seleção de conta. |
minimum_token_lifetime |
Tempo em milissegundos. | Esse é o momento antes do qual um novo token precisa ser solicitado e o token de cache precisa ser descartado |
telemetry |
MATS |
Retorna telemetria adicional sobre a solicitação |
enclave |
sw indica chaves de software, hw indica chaves de hardware, kg indica teclas de proteção do teclado. |
O parâmetro enclave especifica o tipo de chaves a serem usadas. |
token_type |
pop indica tokens de prova de posse shr indica tokens de solicitação HTTP assinados |
O parâmetro token_type especifica o tipo de tokens a serem usados. |
req_cnf |
O parâmetro req_cnf é usado quando o token_type é pop . Esse campo contém informações sobre a chave que o cliente gostaria de vincular ao token de acesso para comprovação de posse. |
|
refresh_binding |
O parâmetro refresh_binding faz parte de um recurso de vinculação de token que ainda será lançado. |