Autentica con Yahoo en Android

Puedes dejar que los usuarios se autentiquen con Firebase mediante proveedores de OAuth, como Yahoo, con solo integrar un acceso genérico basado en web de OAuth en tu app, usando el SDK de Firebase para llevar a cabo el flujo de acceso de extremo a extremo.

Antes de comenzar

Para que los usuarios accedan con cuentas de Yahoo, primero debes habilitar Yahoo como un proveedor de acceso para tu proyecto de Firebase.

  1. Agrega Firebase al proyecto de Android.

  2. En Firebase console, abre la sección Authentication.
  3. En la pestaña Método de acceso, habilita el proveedor de Yahoo.
  4. Agrega el ID y el secreto del cliente de la consola para desarrolladores de ese proveedor a la configuración correspondiente:
    1. Si quieres registrar un cliente de OAuth de Yahoo, consulta la documentación para desarrolladores sobre cómo registrar una aplicación web con esa plataforma.

      Asegúrate de seleccionar los dos permisos de la API de OpenID Connect: profile y email.

    2. Cuando registres apps con estos proveedores, asegúrate de registrar el dominio *.firebaseapp.com para el proyecto como el dominio de redireccionamiento de la app.
  5. Haz clic en Guardar.
  6. Si aún no especificas la huella digital SHA-1 de tu app, hazlo desde la página de configuración de Firebase console. Consulta Autenticación de tu cliente para conocer detalles sobre cómo obtener la huella digital SHA-1 de tu app.

Maneja el flujo de acceso con el SDK de Firebase

Si estás compilando una app para Android, la manera más sencilla de autenticar a tus usuarios con Firebase mediante sus cuentas de Yahoo es manejar el flujo de acceso con el SDK de Firebase Android.

Para manejar el flujo de acceso con el SDK de Firebase para Android, sigue estos pasos:

  1. Crea una instancia de un OAuthProvider usando su compilador con el ID de proveedor yahoo.com.

    Kotlin+KTX

    val provider = OAuthProvider.newBuilder("yahoo.com")

    Java

    OAuthProvider.Builder provider = OAuthProvider.newBuilder("yahoo.com");

  2. Opcional: Especifica parámetros de OAuth personalizados adicionales que quieras enviar con la solicitud de OAuth.

    Kotlin+KTX

    // Prompt user to re-authenticate to Yahoo.
    provider.addCustomParameter("prompt", "login")
    
    // Localize to French.
    provider.addCustomParameter("language", "fr")

    Java

    // Prompt user to re-authenticate to Yahoo.
    provider.addCustomParameter("prompt", "login");
    
    // Localize to French.
    provider.addCustomParameter("language", "fr");

    Para conocer los parámetros que admite Yahoo, consulta la documentación de OAuth de Yahoo. Ten en cuenta que no puedes pasar los parámetros obligatorios de Firebase con setCustomParameters(). Estos parámetros son client_id, redirect_uri, response_type, scope y state.

  3. Opcional: Especifica permisos de OAuth 2.0 adicionales aparte de profile y email que desees solicitar al proveedor de autenticación. Si tu aplicación requiere acceso a los datos privados del usuario desde las APIs de Yahoo, deberás solicitar permisos a estas últimas en la sección API Permissions de la consola para desarrolladores de Yahoo. Los permisos de OAuth solicitados deben coincidir exactamente con los preconfigurados en los permisos de API de la app. Por ejemplo, si se solicita acceso de lectura y escritura a los contactos del usuario, y se preconfigura en los permisos de API de la app, debes pasar sdct-w en vez del permiso de OAuth de solo lectura sdct-r. De lo contrario, el flujo fallará y se mostrará un error al usuario final.

    Kotlin+KTX

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    provider.scopes = listOf("mail-r", "sdct-w")

    Java

    // Request read access to a user's email addresses.
    // This must be preconfigured in the app's API permissions.
    List<String> scopes =
            new ArrayList<String>() {
                {
                    // Request access to Yahoo Mail API.
                    add("mail-r");
                    // This must be preconfigured in the app's API permissions.
                    add("sdct-w");
                }
            };
    provider.setScopes(scopes);
    Para obtener más información, consulta la documentación de permisos de Yahoo.

  4. Autentica con Firebase usando el objeto del proveedor de OAuth. Ten en cuenta que, a diferencia de otras operaciones de Firebase Auth, esta tomará el control de tu IU mediante una pestaña emergente de personalización de Chrome. Por lo tanto, no hagas referencia a tu actividad en los OnSuccessListeners ni en los OnFailureListeners que adjuntas, ya que se desvincularán inmediatamente cuando la operación comience la IU.

    Lo primero que debes haces es revisar si ya recibiste una respuesta. Acceder a través de este método coloca tu actividad en segundo plano, lo que significa que el sistema puede volver a reclamarla durante el flujo de acceso. Para asegurarte de no hacer que el usuario realice otro intento en caso de que esto ocurra, debes revisar si ya hay un resultado.

    Para verificar si hay un resultado pendiente, llama a getPendingAuthResult:

    Kotlin+KTX

    val pendingResultTask = firebaseAuth.pendingAuthResult
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
            .addOnSuccessListener {
                // User is signed in.
                // IdP data available in
                // authResult.getAdditionalUserInfo().getProfile().
                // The OAuth access token can also be retrieved:
                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                // The OAuth secret can be retrieved by calling:
                // ((OAuthCredential)authResult.getCredential()).getSecret().
            }
            .addOnFailureListener {
                // Handle failure.
            }
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    Java

    Task<AuthResult> pendingResultTask = firebaseAuth.getPendingAuthResult();
    if (pendingResultTask != null) {
        // There's something already here! Finish the sign-in for your user.
        pendingResultTask
                .addOnSuccessListener(
                        new OnSuccessListener<AuthResult>() {
                            @Override
                            public void onSuccess(AuthResult authResult) {
                                // User is signed in.
                                // IdP data available in
                                // authResult.getAdditionalUserInfo().getProfile().
                                // The OAuth access token can also be retrieved:
                                // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                                // The OAuth secret can be retrieved by calling:
                                // ((OAuthCredential)authResult.getCredential()).getSecret().
                            }
                        })
                .addOnFailureListener(
                        new OnFailureListener() {
                            @Override
                            public void onFailure(@NonNull Exception e) {
                                // Handle failure.
                            }
                        });
    } else {
        // There's no pending result so you need to start the sign-in flow.
        // See below.
    }

    Para iniciar el flujo de acceso, llama a startActivityForSignInWithProvider:

    Kotlin+KTX

    firebaseAuth
        .startActivityForSignInWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is signed in.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // ((OAuthCredential)authResult.getCredential()).getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    firebaseAuth
            .startActivityForSignInWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is signed in.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // ((OAuthCredential)authResult.getCredential()).getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // ((OAuthCredential)authResult.getCredential()).getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

    Si se completa correctamente, el token de acceso de OAuth asociado con el proveedor se puede recuperar a partir del objeto OAuthCredential que se muestra.

    Con el token de acceso de OAuth, puedes llamar a la API de Yahoo.

    En la que YAHOO_USER_UID es el ID del usuario de Yahoo, que se puede analizar desde el campo firebaseAuth.getCurrentUser().getProviderData().get(0).getUid() o desde authResult.getAdditionalUserInfo().getProfile().

  5. Si bien los ejemplos anteriores se enfocan en los flujos de acceso, también puedes vincular un proveedor de Yahoo con un usuario existente mediante startActivityForLinkWithProvider. Por ejemplo, puedes vincular varios proveedores con el mismo usuario para permitirle acceder con cualquiera de estos.

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForLinkWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // Provider credential is linked to the current user.
            // IdP data available in
            // authResult.getAdditionalUserInfo().getProfile().
            // The OAuth access token can also be retrieved:
            // authResult.getCredential().getAccessToken().
            // The OAuth secret can be retrieved by calling:
            // authResult.getCredential().getSecret().
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForLinkWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // Provider credential is linked to the current user.
                            // IdP data available in
                            // authResult.getAdditionalUserInfo().getProfile().
                            // The OAuth access token can also be retrieved:
                            // authResult.getCredential().getAccessToken().
                            // The OAuth secret can be retrieved by calling:
                            // authResult.getCredential().getSecret().
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

  6. Se puede utilizar el mismo patrón con startActivityForReauthenticateWithProvider, que se puede usar para recuperar credenciales nuevas para operaciones sensibles que requieren un acceso reciente.

    Kotlin+KTX

    // The user is already signed-in.
    val firebaseUser = firebaseAuth.currentUser!!
    firebaseUser
        .startActivityForReauthenticateWithProvider(activity, provider.build())
        .addOnSuccessListener {
            // User is re-authenticated with fresh tokens and
            // should be able to perform sensitive operations
            // like account deletion and email or password
            // update.
        }
        .addOnFailureListener {
            // Handle failure.
        }

    Java

    // The user is already signed-in.
    FirebaseUser firebaseUser = firebaseAuth.getCurrentUser();
    
    firebaseUser
            .startActivityForReauthenticateWithProvider(/* activity= */ this, provider.build())
            .addOnSuccessListener(
                    new OnSuccessListener<AuthResult>() {
                        @Override
                        public void onSuccess(AuthResult authResult) {
                            // User is re-authenticated with fresh tokens and
                            // should be able to perform sensitive operations
                            // like account deletion and email or password
                            // update.
                        }
                    })
            .addOnFailureListener(
                    new OnFailureListener() {
                        @Override
                        public void onFailure(@NonNull Exception e) {
                            // Handle failure.
                        }
                    });

Próximos pasos

Cuando un usuario accede por primera vez, se crea una cuenta de usuario nueva y se la vincula con las credenciales (el nombre de usuario y la contraseña, el número de teléfono o la información del proveedor de autenticación) que el usuario utilizó para acceder. Esta cuenta nueva se almacena como parte de tu proyecto de Firebase y se puede usar para identificar a un usuario en todas las apps del proyecto, sin importar cómo acceda.

  • En tus apps, puedes obtener la información básica del perfil del usuario a partir del objeto FirebaseUser. Consulta Administra usuarios.

  • En tus Reglas de seguridad de Firebase Realtime Database y Cloud Storage, puedes obtener el ID del usuario único que accedió a partir de la variable auth y usarlo para controlar a qué datos podrá acceder.

Para permitir que los usuarios accedan a tu app mediante varios proveedores de autenticación, puedes vincular las credenciales de estos proveedores con una cuenta de usuario existente.

Para salir de la sesión de un usuario, llama a signOut de la siguiente manera:

Kotlin+KTX

Firebase.auth.signOut()

Java

FirebaseAuth.getInstance().signOut();