Tutorial: Configuración de una aplicación Android para iniciar sesión de usuarios mediante la plataforma de identidad de Microsoft

• Un inquilino trabajador Puede usar su Directorio Predeterminado o configurar un nuevo tenant.
• Registre una nueva aplicación en el Centro de administración de Microsoft Entra, configurada solo para Cuentas en este directorio organizativo. Consulte Registro de una aplicación para obtener más detalles. Registre los valores siguientes en la página Información general de la aplicación para su uso posterior:
  • Id. de aplicación (cliente)
  • Id. de directorio (inquilino)
• Un proyecto de Android. Si no tiene un proyecto de Android, créelo.

• Un inquilino externo. Para crear uno, elija entre los métodos siguientes:
  • Use la extensión Microsoft Entra External ID para configurar un inquilino externo directamente en Visual Studio Code. (Recomendado)
  • Crear un nuevo inquilino externo en el Centro de administración de Microsoft Entra.
• Registre una nueva aplicación en el Centro de administración de Microsoft Entra, configurada para Cuentas en cualquier directorio organizativo y cuentas personales de Microsoft. Consulte Registro de una aplicación para obtener más detalles. Registre los valores siguientes en la página Información general de la aplicación para su uso posterior:
  • Id. de aplicación (cliente)
  • Id. de directorio (inquilino)

1. En Administrar, seleccione Autenticación>Agregar una plataforma>Android.

2. Escriba el nombre del paquete del proyecto en función del tipo de ejemplo que descargó anteriormente.

   • Ejemplo de Java: com.azuresamples.msalandroidapp
   • Ejemplo de Kotlin: com.azuresamples.msalandroidkotlinapp

3. En la sección Hash de firma del panel Configurar tu aplicación Android, selecciona Generar un hash de firma de desarrollo y copia el comando KeyTool a tu línea de comandos.

   • KeyTool. exe se instala como parte de Java Development Kit (JDK). También debe instalar la herramienta OpenSSL para ejecutar el comando KeyTool. Para obtener más información, consulta la Documentación de Android sobre la generación de una clave para obtener más información.

4. Escriba el hash de firma generado por KeyTool.

5. Selecciona Configurar y guarda la configuración de MSAL que aparece en el panel Configuración de Android para que puedas especificarla cuando configures la aplicación más tarde.

6. Seleccione Listo.

Para especificar el tipo de aplicación en el registro de la aplicación, siga estos pasos:

1. En Administrar, seleccione Autenticación.
2. En la página Configuraciones de plataforma, seleccione Agregar una plataforma y, a continuación, seleccione la opción iOS/macOS .
3. Escriba el Bundle ID de su proyecto. Si descargó el código de ejemplo, este valor es com.microsoft.identitysample.ciam.MSALiOS.
4. Seleccione Configurar y guarde la configuración de MSAL que aparece en el panel de configuración de iOS/macOS para que pueda escribirla al configurar la aplicación más adelante.
5. Seleccione Listo.

Habilitación del flujo de cliente público

Para identificar la aplicación como cliente público, siga estos pasos:

1. En Administrar, seleccione Autenticación.

2. En Configuración avanzada, para Permitir flujos de cliente públicos, seleccione Sí.

3. Haga clic en Guardar para guardar los cambios.

1. En el panel del proyecto de Android Studio, vaya a app\src\main\res.

2. Haga clic con el botón derecho en res y elija New>Directory (Nuevo > Directorio). Escribe raw como el nombre del nuevo directorio y selecciona Aceptar.

3. En app>src>main>res>raw, cree un nuevo archivo JSON llamado auth_config_single_account.json y pegue la configuración de MSAL que guardó anteriormente.

   Debajo del identificador URI de redirección, pegue:

     "account_mode" : "SINGLE",
   

   El archivo de configuración debe ser similar a este ejemplo:

   {
     "client_id": "00001111-aaaa-bbbb-3333-cccc4444",
     "authorization_user_agent": "WEBVIEW",
     "redirect_uri": "msauth://com.azuresamples.msalandroidapp/00001111%cccc4444%3D",
     "broker_redirect_uri_registered": true,
     "account_mode": "SINGLE",
     "authorities": [
       {
         "type": "AAD",
         "audience": {
           "type": "AzureADandPersonalMicrosoftAccount",
           "tenant_id": "common"
         }
       }
     ]
   }
   

   Como este tutorial solo muestra cómo configurar una aplicación en el modo de cuenta única, consulta el modo de cuenta única o múltiple y la configurar tu aplicación para obtener más información

4. Se recomienda usar "WEBVIEW". En caso de que desee configurar "authorization_user_agent" como "BROWSER" en la aplicación, debe realizar las siguientes actualizaciones. a) Actualice auth_config_single_account.json con "authorization_user_agent": "Navegador". b) Actualizar AndroidManifest.xml. En la aplicación, vaya a app>src>main>AndroidManifest.xml, agregue la BrowserTabActivity actividad como hijo del <application> elemento. Esta entrada permite a Microsoft Entra ID volver a llamar a la aplicación una vez completada la autenticación:

   <!--Intent filter to capture System Browser or Authenticator calling back to our app after sign-in-->
   <activity
       android:name="com.microsoft.identity.client.BrowserTabActivity"
       android:exported="true">
       <intent-filter>
           <action android:name="android.intent.action.VIEW" />
           <category android:name="android.intent.category.DEFAULT" />
           <category android:name="android.intent.category.BROWSABLE" />
           <data android:scheme="msauth"
               android:host="Enter_the_Package_Name"
               android:path="/Enter_the_Signature_Hash" />
       </intent-filter>
   </activity>
   

   • Use el nombre del paquete para reemplazar el valor android:host=.. Debería ser parecido a este: com.azuresamples.msalandroidapp.
   • Use el hash de firma para reemplazar el valor android:path=. Asegúrate de que haya un / inicial al comienzo del hash de firma. Debería ser parecido a este: /aB1cD2eF3gH4+iJ5kL6-mN7oP8q=.

   También puedes encontrar estos valores en la hoja de Autenticación del registro de la aplicación.

1. En el panel del proyecto de Android Studio, vaya a app\src\main\res.

2. Haga clic con el botón derecho en res y seleccione Nuevo>directorio. Escribe raw como el nombre del nuevo directorio y selecciona Aceptar.

3. En app\src\main\res\raw, cree un nuevo archivo JSON denominado auth_config_ciam_auth.json.

4. En el auth_config_ciam_auth.json archivo , agregue las siguientes configuraciones de MSAL:

   {
     "client_id" : "Enter_the_Application_Id_Here",
     "authorization_user_agent" : "DEFAULT",
     "redirect_uri" : "Enter_the_Redirect_Uri_Here",
     "account_mode" : "SINGLE",
     "authorities" : [
       {
         "type": "CIAM",
         "authority_url": "https://Enter_the_Tenant_Subdomain_Here.ciamlogin.com/Enter_the_Tenant_Subdomain_Here.onmicrosoft.com/"
       }
     ]
   }
   

   El archivo de configuración JSON especifica varias opciones de configuración para una aplicación Android. Incluye el identificador de cliente, el agente de usuario de autorización, el URI de redirección y el modo de cuenta. Además, define una entidad para la autenticación, especificando el tipo y la dirección URL de autoridad.

   Reemplace los siguientes marcadores de posición por los valores de inquilino que obtuvo del Centro de administración de Microsoft Entra:

   • Enter_the_Application_Id_Here y reemplácelo por el identificador de aplicación (cliente) de la aplicación que registró anteriormente.
   • Enter_the_Redirect_Uri_Here y reemplácelo por el valor de redirect_uri en el archivo de configuración de la Biblioteca de autenticación de Microsoft (MSAL) que descargó anteriormente al agregar la dirección URL de redirección de la plataforma.
   • Enter_the_Tenant_Subdomain_Here y reemplácelo por el subdominio Directorio (inquilino). Por ejemplo, si el dominio principal del cliente es contoso.onmicrosoft.com, utilice contoso. Si no conoce el subdominio del inquilino, aprenda a leer los detalles del inquilino.

5. Abra el archivo /app/src/main/AndroidManifest.xml .

6. En AndroidManifest.xml, agregue la especificación de datos siguiente a un filtro de intención:

   <data
       android:host="ENTER_YOUR_PROJECT_PACKAGE_NAME_HERE"
       android:path="/ENTER_YOUR_SIGNATURE_HASH_HERE"
       android:scheme="msauth" />
   

   Busque el marcador de posición:

   • ENTER_YOUR_PROJECT_PACKAGE_NAME_HERE y reemplácelo por el nombre del paquete del proyecto de Android.
   • ENTER_YOUR_SIGNATURE_HASH_HERE y reemplácelo por el hash de firma que generó anteriormente al agregar la dirección URL de redirección de la plataforma.

Uso del dominio de dirección URL personalizado (opcional)

Use un dominio personalizado para personalizar completamente la dirección URL de autenticación. Desde la perspectiva del usuario, los usuarios permanecen en el dominio durante el proceso de autenticación, en lugar de redirigirse a ciamlogin.com nombre de dominio.

Siga estos pasos para usar un dominio personalizado:

1. Siga los pasos descritos en Habilitación de dominios url personalizados para aplicaciones en inquilinos externos para habilitar el dominio de dirección URL personalizado para el inquilino externo.

2. Abra auth_config_ciam_auth.json archivo:

   1. Actualice el valor de la authority_url propiedad a https://Enter_the_Custom_Domain_Here/Enter_the_Tenant_ID_Here. Reemplace por Enter_the_Custom_Domain_Here el dominio de dirección URL personalizado y Enter_the_Tenant_ID_Here por el identificador de inquilino. Si no tiene el identificador del inquilino, obtenga información sobre cómo leer los detalles del inquilino.
   2. Agregue la propiedad knownAuthorities con un valor [Introduzca_el_Dominio_Personalizado_Aquí].

Después de realizar los cambios en el archivo auth_config_ciam_auth.json , si el dominio de dirección URL personalizado está login.contoso.com y el identificador de inquilino es aaaabbbb-0000-cccc-1111-dddd2222eeee, el archivo debe tener un aspecto similar al siguiente fragmento de código:

{
    "client_id" : "Enter_the_Application_Id_Here",
    "authorization_user_agent" : "DEFAULT",
    "redirect_uri" : "Enter_the_Redirect_Uri_Here",
    "account_mode" : "SINGLE",
    "authorities" : [
    {
        "type": "CIAM",
        "authority_url": "https://login.contoso.com/aaaabbbb-0000-cccc-1111-dddd2222eeee",
        "knownAuthorities": ["login.contoso.com"]
    }
    ]
}

PublicClientApplication.createSingleAccountPublicClientApplication(
    getContext(),
    R.raw.auth_config_single_account,
    new IPublicClientApplication.ISingleAccountApplicationCreatedListener() {
        @Override
        public void onCreated(ISingleAccountPublicClientApplication application) {
            // Initialize the single account application instance
            mSingleAccountApp = application;
            loadAccount();
        }

        @Override
        public void onError(MsalException exception) {
            // Handle any errors that occur during initialization
            displayError(exception);
        }
    }
);

Este código crea una aplicación cliente pública de cuenta única mediante el archivo de configuración auth_config_single_account.json. Cuando la aplicación se crea correctamente, asigna la instancia a mSingleAccountApp y llama al loadAccount() método . Si se produce un error durante la creación, controla el error llamando al método displayError(exception).

private suspend fun initClient(): ISingleAccountPublicClientApplication = withContext(Dispatchers.IO) {
    return@withContext PublicClientApplication.createSingleAccountPublicClientApplication(
        this@MainActivity,
        R.raw.auth_config_ciam_auth
    )
}

El código inicializa una sola aplicación cliente pública de cuenta de forma asincrónica. Usa el archivo de configuración de autenticación proporcionado y se ejecuta en el distribuidor de E/S.