AuthKt

public final class AuthKt


Summary

Public methods

static final @NonNull ActionCodeSettings

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

static final @NonNull FirebaseAuth

Accessing this object for Kotlin apps has changed; see the migration guide.

static final @NonNull FirebaseAuth

Accessing this object for Kotlin apps has changed; see the migration guide.

static final @NonNull AuthCredential

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

static final @NonNull OAuthProvider
oAuthProvider(
    @NonNull String providerId,
    @ExtensionFunctionType @NonNull Function1<@NonNull OAuthProvider.BuilderUnit> init
)

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

static final @NonNull OAuthProvider
oAuthProvider(
    @NonNull String providerId,
    @NonNull FirebaseAuth firebaseAuth,
    @ExtensionFunctionType @NonNull Function1<@NonNull OAuthProvider.BuilderUnit> init
)

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

static final @NonNull UserProfileChangeRequest

This method is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Public methods

actionCodeSettings

public static final @NonNull ActionCodeSettings actionCodeSettings(
    @ExtensionFunctionType @NonNull Function1<@NonNull ActionCodeSettings.BuilderUnit> init
)

Returns an ActionCodeSettings instance initialized using the init function.

Important: In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

auth

public static final @NonNull FirebaseAuth auth(@NonNull Firebase receiver, @NonNull FirebaseApp app)

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseAuth instance of the default FirebaseApp.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

getAuth

public static final @NonNull FirebaseAuth getAuth(@NonNull Firebase receiver)

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseAuth instance of the default FirebaseApp.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

oAuthCredential

public static final @NonNull AuthCredential oAuthCredential(
    @NonNull String providerId,
    @ExtensionFunctionType @NonNull Function1<@NonNull OAuthProvider.CredentialBuilderUnit> init
)

Returns an OAuth AuthCredential instance initialized using the init function.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

oAuthProvider

public static final @NonNull OAuthProvider oAuthProvider(
    @NonNull String providerId,
    @ExtensionFunctionType @NonNull Function1<@NonNull OAuthProvider.BuilderUnit> init
)

Returns an OAuthProvider instance initialized using the init function.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

oAuthProvider

public static final @NonNull OAuthProvider oAuthProvider(
    @NonNull String providerId,
    @NonNull FirebaseAuth firebaseAuth,
    @ExtensionFunctionType @NonNull Function1<@NonNull OAuthProvider.BuilderUnit> init
)

Returns an OAuthProvider instance initialized using the init function.

Important: In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

userProfileChangeRequest

public static final @NonNull UserProfileChangeRequest userProfileChangeRequest(
    @ExtensionFunctionType @NonNull Function1<@NonNull UserProfileChangeRequest.BuilderUnit> init
)

Returns an UserProfileChangeRequest instance initialized using the init function.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.