Compartir vía

Referencia de API del lado servidor de la cuenta Microsoft (MSA)

  • Artículo

Las cuentas Microsoft (MSA) son un servicio web de inicio de sesión único que permite a los usuarios iniciar sesión en sitios web, aplicaciones y servicios mediante un único conjunto de credenciales. La API del lado servidor de la cuenta Microsoft (MSA) proporciona una variedad de parámetros que se pueden usar para personalizar el proceso de autenticación y mejorar la experiencia del usuario.

Estos parámetros se pueden usar con MSAL en una plataforma Windows, lo que facilita el desarrollo de aplicaciones Windows que se integran sin problemas con los usuarios que inician sesión a través de cuentas Microsoft.

API del lado servidor de MSA

Estos se pasan a login.microsoftonline.com o login.live.com como parámetros de URL, con el formato login.microsoftonline.com?parametername=value.

Parámetro Value Notas
ImplicitAssociate 0/1 Si se establece en 1, la cuenta Microsoft (MSA) que el usuario usa para iniciar sesión se vincula automáticamente con la aplicación en Windows, sin necesidad de confirmación del usuario.
Nota: Esto no habilita el inicio de sesión único (SSO) para el usuario.
LoginHint username Rellena previamente el nombre de usuario durante el inicio de sesión, a menos que ya se haya proporcionado (por ejemplo, a través de un token de actualización). Los usuarios pueden modificar este nombre de usuario rellenado previamente si es necesario.
cobrandid GUID de cobranding Este parámetro aplica cobranding a la experiencia del usuario de inicio de sesión. Cobranding permite personalizar elementos como el logotipo de la aplicación, la imagen de fondo, el texto de subtítulos, el texto de descripción y los colores del botón. Si va a integrar una aplicación con el inicio de sesión de la cuenta Microsoft y desea personalizar la pantalla de inicio de sesión, póngase en contacto con el soporte técnico de Microsoft.
client_flight Cadena client_flight es un parámetro de transferencia que se devuelve a la aplicación tras la finalización del proceso de inicio de sesión. El valor de este parámetro se registra en el flujo de telemetría y las aplicaciones lo usan para vincular sus solicitudes de autenticación. Esto puede ser beneficioso para correlacionar las solicitudes de inicio de sesión, incluso si no todas las aplicaciones tienen acceso a este flujo de telemetría. Las aplicaciones como Office Union, Teams y otras son usuarios importantes de este parámetro.
lw 0/1 Nota: Esta característica está en desuso. Habilita el registro ligero. Si está habilitado, los usuarios que se suscriben a través del flujo de autenticación no tienen que escribir su nombre, apellido, país y fecha de nacimiento, a menos que las leyes aplicables a la región del usuario lo exijan.
fl phone2,
email,
wld,
wld2,
easi,
easi2		 Nota: Esta característica está en desuso. Este parámetro controla las opciones del nombre de usuario proporcionadas durante el proceso de registro:
phone: restringe el nombre de usuario al número de teléfono,
phone2: el valor predeterminado es el número de teléfono, pero permite otras opciones,
email: restringe el nombre de usuario al correo electrónico (Outlook o EASI),
wld: restringe el nombre de usuario a Outlook,
wld2: el valor predeterminado es Outlook, pero permite otras opciones, como el teléfono,
easi: restringe el nombre de usuario a EASI,
easi2: el valor predeterminado es EASI, pero permite otras opciones, incluido el teléfono.
nopa 0/1/2 Nota: Esta característica está en desuso. Habilita el registro sin contraseña. Un valor de 1 permite el registro sin contraseña, pero obliga a crear una contraseña después de 30 días. Un valor de 2 permite el registro sin contraseña indefinidamente. Para usar el valor 2, las aplicaciones deben agregarse a una lista de permitidos a través de un proceso manual.
coa 0/1 Nota: Esta característica está en desuso. Habilita el inicio de sesión sin contraseña enviando un código al número de teléfono del usuario. Para usar el valor 1, las aplicaciones deben agregarse a una lista de permitidos a través de un proceso manual.
signup 0/1 Inicie el flujo de autenticación en la páginaCrear cuenta en lugar de la página inicio de sesión.
fluent 0/1 Nota: Esta característica está en desuso. Habilita la nueva apariencia de Fluent para el flujo de inicio de sesión. Para usar el valor 1, las aplicaciones deben agregarse a una lista de permitidos a través de un proceso manual.
api-version “”/”2.0” Cuando se establece en 2.0, este parámetro permite que el clientid especifique un identificador de aplicación diferente del registrado por la aplicación de llamada de Windows, puesto que el identificador de aplicación especificado está configurado para permitirlo.
Clientid/client_id app ID Identificador de aplicación para la aplicación que invoca el flujo de autenticación.
Client_uiflow new_account Permite que las aplicaciones agreguen una nueva cuenta sin invocar el AccountsSettingsPane. Requiere que también pase el tipo de solicitud ForceAuthentication. Requiere que también pase el tipo de solicitud ForceAuthentication.

Parámetros del token de autorización de MSA

Parámetro Value Notas
scope Cadena Define la extensión de los permisos solicitados por el cliente en los puntos de conexión de autorización y token.
claims Cadena Especifica las notificaciones opcionales solicitadas por la aplicación cliente.
response_type Cadena Especifica un valor de tipo de respuesta OAuth 2.0 que dicta el flujo del proceso de autorización, incluidos los parámetros devueltos desde los puntos de conexión respectivos.
phone Cadena Especifica una lista separada por comas de números de teléfono con formato vinculados al dispositivo host.
qrcode_uri Cadena En las solicitudes de generación de código QR para transferir una sesión autenticada, esta dirección URL se inserta en el código QR.
Ttv 1 / 2 TBD
qrcode_state Cadena En las solicitudes de creación de código QR, este parámetro de estado se incorpora a la dirección URL que se muestra en el código QR.
Child_client_id Cadena Identificador de la aplicación de cliente secundario en el flujo de agente doble.
child_redirect_uri Cadena URI de redirección de la aplicación de cliente secundario usada en el flujo de agente doble.
safe_rollout Cadena Parámetro usado para especificar un plan de lanzamiento seguro aplicado a la solicitud. Resulta útil cuando un propietario de aplicación está implementando un cambio en la configuración de la aplicación y quiere que el cambio se aplique gradualmente con fines de una implementación segura.
additional_scope Cadena Especifica un ámbito adicional para que el servicio de autenticación pueda recopilar un consentimiento adicional en una solicitud. De este modo, la aplicación cliente puede evitar la interrupción del consentimiento al solicitar un ámbito diferente en el futuro.
x-client-info E/S Se devuelve un token Client_info cuando el valor es 1.0.
challenge Cadena Inicialmente proporcionado por la aplicación de recursos, es reenviado por la aplicación cliente al servidor MSA sin modificaciones.
max_age Entero Antigüedad máxima de autenticación. Especifica el tiempo transcurrido permitido en segundos desde la última vez que MSA autenticó activamente al usuario final.
mfa_max_age Entero Especifica el tiempo transcurrido permitido en segundos desde la última vez que un usuario pasó a través de la autenticación multifactor en MSA.
acr_values Cadena Valores de referencia de clase de contexto de autenticación solicitados. Cadena separada por espacios que especifica los valores acr que se solicitan al servidor de autorización para procesar esta solicitud de autenticación, con los valores que aparecen en orden de preferencia. La clase de contexto de autenticación conforme con la autenticación realizada se devuelve como el valor de notificación acr.
redirect_uri Cadena URI de redirección al que se envía la respuesta. Este URI debe coincidir exactamente con uno de los valores de URI de redirección del cliente registrado previamente en MSA.
state Cadena Valor opaco que se usa para mantener el estado entre la solicitud y la devolución de llamada.
oauth2_response 1 Cuando es igual a 1, significa que la respuesta ws-trust debe seguir el formato de respuesta de OAuth.

Consulte también