FirebaseAdmin.Auth.FirebaseAuth

This is the entry point to all server-side Firebase Authentication operations.

Summary

You can get an instance of this class via FirebaseAuth.DefaultInstance.

Inheritance

Inherits from: FirebaseAdmin.IFirebaseService

Properties

DefaultInstance
static FirebaseAuth
Gets the auth instance associated with the default Firebase app.

Public static functions

GetAuth(FirebaseApp app)
Returns the auth instance for the specified app.

Public functions

CreateCustomTokenAsync(string uid)
async Task< string >
Creates a Firebase custom token for the given user ID.
CreateCustomTokenAsync(string uid, CancellationToken cancellationToken)
async Task< string >
Creates a Firebase custom token for the given user ID.
CreateCustomTokenAsync(string uid, IDictionary< string, object > developerClaims)
async Task< string >
Creates a Firebase custom token for the given user ID containing the specified additional claims.
CreateCustomTokenAsync(string uid, IDictionary< string, object > developerClaims, CancellationToken cancellationToken)
async Task< string >
Creates a Firebase custom token for the given user ID containing the specified additional claims.
CreateUserAsync(UserRecordArgs args)
async Task< UserRecord >
Creates a new user account with the attributes contained in the specified UserRecordArgs.
CreateUserAsync(UserRecordArgs args, CancellationToken cancellationToken)
async Task< UserRecord >
Creates a new user account with the attributes contained in the specified UserRecordArgs.
DeleteUserAsync(string uid)
async Task
Deletes the user identified by the specified uid .
DeleteUserAsync(string uid, CancellationToken cancellationToken)
async Task
Deletes the user identified by the specified uid .
GetUserAsync(string uid)
async Task< UserRecord >
Gets a UserRecord object containing information about the user who's user ID was specified in uid .
GetUserAsync(string uid, CancellationToken cancellationToken)
async Task< UserRecord >
Gets a UserRecord object containing information about the user who's user ID was specified in uid .
GetUserByEmailAsync(string email)
async Task< UserRecord >
Gets a UserRecord object containing information about the user identified by email .
GetUserByEmailAsync(string email, CancellationToken cancellationToken)
async Task< UserRecord >
Gets a UserRecord object containing information about the user identified by email .
GetUserByPhoneNumberAsync(string phoneNumber)
async Task< UserRecord >
Gets a UserRecord object containing information about the user identified by phoneNumber .
GetUserByPhoneNumberAsync(string phoneNumber, CancellationToken cancellationToken)
async Task< UserRecord >
Gets a UserRecord object containing information about the user identified by phoneNumber .
ListUsersAsync(ListUsersOptions options)
PagedAsyncEnumerable< ExportedUserRecords, ExportedUserRecord >
Gets an async enumerable to iterate or page through users starting from the specified page token.
SetCustomUserClaimsAsync(string uid, IReadOnlyDictionary< string, object > claims)
async Task
Sets the specified custom claims on an existing user account.
SetCustomUserClaimsAsync(string uid, IReadOnlyDictionary< string, object > claims, CancellationToken cancellationToken)
async Task
Sets the specified custom claims on an existing user account.
UpdateUserAsync(UserRecordArgs args)
async Task< UserRecord >
Updates an existing user account with the attributes contained in the specified UserRecordArgs.
UpdateUserAsync(UserRecordArgs args, CancellationToken cancellationToken)
async Task< UserRecord >
Updates an existing user account with the attributes contained in the specified UserRecordArgs.
VerifyIdTokenAsync(string idToken)
async Task< FirebaseToken >
Parses and verifies a Firebase ID token.
VerifyIdTokenAsync(string idToken, CancellationToken cancellationToken)
async Task< FirebaseToken >
Parses and verifies a Firebase ID token.

Properties