Share via

Referência da API do lado do servidor da conta Microsoft (MSA)

  • Artigo

As contas Microsoft (MSA) são um serviço Web de logon único que permite aos usuários fazer login em sites, aplicativos e serviços usando um único conjunto de credenciais. A API do lado do servidor da conta Microsoft (MSA) fornece uma variedade de parâmetros que podem ser usados para personalizar o processo de autenticação e aprimorar a experiência do usuário.

Esses parâmetros podem ser utilizados com MSAL em uma plataforma Windows, facilitando o desenvolvimento de aplicativos Windows que se integram perfeitamente aos usuários que fazem login por meio de contas Microsoft.

API do lado do servidor MSA

Eles são passados para login.microsoftonline.com ou login.live.com como parâmetros de URL, no formato login.microsoftonline.com?parametername=value.

Parâmetro Valor Observações
ImplicitAssociate 0/1 Se definido como 1, a Conta Microsoft (MSA) que o usuário usa para entrar será automaticamente vinculada ao aplicativo no Windows, sem exigir a confirmação do usuário.
Observação: Isso não habilita o logon único (SSO) para o usuário.
LoginHint Nome de Usuário Preenche previamente o nome de usuário durante a entrada, a menos que já tenha sido fornecido (por exemplo, por meio de um token de atualização). Os usuários podem modificar esse nome de usuário pré-preenchido, se necessário.
cobrandid cobranding GUID Esse parâmetro aplica cobranding à experiência do usuário de login. O cobranding permite a personalização de elementos como logotipo do aplicativo, imagem de fundo, texto do subtítulo, texto de descrição e cores dos botões. Se você estiver integrando um aplicativo com login de conta Microsoft e desejar personalizar a tela de login, envie um email para msa-info@microsoft.com.
client_flight String client_flight é um parâmetro de passagem que é retornado ao aplicativo após a conclusão do processo de login. O valor desse parâmetro é registrado no fluxo de telemetria e utilizado pelos aplicativos para unir suas solicitações de autenticação. Isto pode ser benéfico para correlacionar pedidos de entrada, mesmo que nem todas as aplicações tenham acesso a esse fluxo de telemetria. Aplicativos como Office Union, Teams e outros são usuários notáveis desse parâmetro.
lw 0/1 Observação: Esse recurso está obsoleto. Habilita a inscrição Lightweight. Se habilitado, os usuários que se inscreverem por meio do fluxo de autenticação não serão obrigados a inserir nome, sobrenome, país e data de nascimento, a menos que exigido pelas leis aplicáveis à região do usuário.
fl phone2,
email,
wld,
wld2,
easi,
easi2		 Observação: Esse recurso está obsoleto. Esse parâmetro controla as opções de nome de usuário fornecidas durante o processo de inscrição:
phone – Restringe o nome de usuário ao número de telefone,
phone2 – O padrão é o número de telefone, mas permite outras opções,
email – Restringe o nome de usuário ao email (Outlook ou EASI),
wld – Restringe o nome de usuário ao Outlook,
wld2 – O padrão é Outlook, mas o padrão é Outlook, mas permite outras opções, incluindo telefone, permite outras opções, incluindo telefone,
easi – Restringe o nome de usuário ao EASI,
easi2 – O padrão é EASI, mas permite outras opções, incluindo telefone.
nopa 0/1/2 Observação: Esse recurso está obsoleto. Permite inscrição sem senha. O valor 1 permite a inscrição sem senha, mas impõe a criação de senha após 30 dias. Um valor 2 permite inscrição sem senha indefinidamente. Para usar o valor 2, os aplicativos devem ser adicionados a uma lista de permissões por meio de um processo manual.
coa 0/1 Observação: Esse recurso está obsoleto. Permite o login sem senha enviando um código para o número de telefone do usuário. Para usar o valor 1, os aplicativos devem ser adicionados a uma lista de permissões por meio de um processo manual.
signup 0/1 Inicie o fluxo de autenticação na página Criar conta em vez da página *Entrar*.
fluent 0/1 Observação: Esse recurso está obsoleto. Habilita a nova aparência do Fluente para o fluxo de login. Para usar o valor 1, os aplicativos devem ser adicionados a uma lista de permissões por meio de um processo manual.
api-version “”/”2.0” Quando definido como 2.0, esse parâmetro permite que o clientid especifique um App ID diferente daquele registrado pelo aplicativo de chamada do Windows, desde que o App ID especificado esteja configurado para permitir isso.
Clientid/client_id app ID ID do aplicativo que chama o fluxo de autenticação.ID do aplicativo que chama o fluxo de autenticação.
Client_uiflow new_account Permite que os aplicativos adicionem uma nova conta sem invocar o AccountsSettingsPane. Requer que você também passe o tipo de prompt ForceAuthentication. Requer que você também passe o tipo de prompt ForceAuthentication.

Parâmetros do token de autorização MSA

Parâmetro Valor Observações
scope String Define a extensão das permissões solicitadas pelo cliente nos pontos de extremidade de autorização e token.
claims String Especifica declarações opcionais solicitadas pelo aplicativo cliente.
response_type String Especifica um valor de tipo de resposta do OAuth 2.0 que determina o fluxo do processo de autorização, incluindo os parâmetros retornados dos respectivos pontos de extremidade.
phone String Especifica uma lista separada por vírgulas de números de telefone formatados vinculados ao dispositivo host.
qrcode_uri String Nas solicitações de geração de código QR para transferência de uma sessão autenticada, essa URL é incorporada ao código QR.
Ttv 1 / 2 TBD
qrcode_state String Nas solicitações de criação de código QR, esse parâmetro de estado é incorporado à URL exibida no código QR.
Child_client_id String O ID do aplicativo cliente filho no fluxo do agente duplo.
child_redirect_uri String O URI de redirecionamento do aplicativo cliente filho usado no fluxo do agente duplo.
safe_rollout String Um parâmetro usado para especificar um plano de implementação seguro aplicado à solicitação. Útil quando o proprietário de um aplicativo está implementando uma alteração na configuração do aplicativo e deseja que a alteração seja aplicada gradualmente para fins de implantação de segurança.
additional_scope String Especifica um escopo extra para que o serviço de autenticação possa obter consentimento extra em uma solicitação. Dessa forma, o aplicativo cliente pode evitar a interrupção do consentimento ao solicitar um escopo diferente no futuro.
x-client-info E/S Um token Client_info é Um token Client_info é retornado quando o valor é 1,0.
challenge String Inicialmente fornecido pela aplicação de recursos, é encaminhado pela aplicação cliente para o servidor MSA sem quaisquer modificações.
max_age Inteiro Idade máxima de autenticação. Especifica o tempo decorrido permitido em segundos desde a última vez que o usuário final foi ativamente autenticado pela MSA.
mfa_max_age Inteiro Especifica o tempo decorrido permitido em segundos desde a última vez que um usuário passou pela autenticação multifator no MSA.
acr_values String Valores de referência de classe de contexto de autenticação solicitados. Uma sequência separada por espaço que especifica os valores acr que o Authorization Server está sendo solicitado a usar para processar essa Solicitação de Autenticação, com os valores aparecendo em ordem de preferência. A Classe de Contexto de Autenticação satisfeita pela autenticação realizada é retornada como o Valor de Declaração acr.
redirect_uri String URI de redirecionamento para o qual a resposta é enviada. Esse URI deve corresponder exatamente a um dos valores do URI de redirecionamento para o Cliente pré-registrado no MSA.
state String Um valor opaco usado para manter o estado entre a solicitação e o retorno de chamada.
oauth2_response 1 Quando igual a 1, significa que a resposta ws-trust deve seguir o formato de resposta OAuth.

Confira também