Firebase Authentication Admin SDK

https://firebase.google.com/docs/auth/admin
Admin
The Firebase Authentication Admin SDK provides server-side APIs to programmatically manage user...
Tokens:34,874
Snippets:200
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Initialize ActionCodeSettings in Go

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Example of creating an ActionCodeSettings struct in Go using the Firebase Admin SDK. Uses DynamicLinkDomain field.

```go
actionCodeSettings := &auth.ActionCodeSettings{
	URL:                   "https://www.example.com/checkout?cartId=1234",
	HandleCodeInApp:       true,
	IOSBundleID:           "com.example.ios",
	AndroidPackageName:    "com.example.android",
	AndroidInstallApp:     true,
	AndroidMinimumVersion: "12",
	DynamicLinkDomain:     "coolapp.page.link",
}

```

--------------------------------

### Initialize ActionCodeSettings in C#

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Example of creating an ActionCodeSettings object in C# using the Firebase Admin SDK. Uses LinkDomain property.

```csharp
var actionCodeSettings = new ActionCodeSettings()
{
    Url = "https://www.example.com/checkout?cartId=1234",
    HandleCodeInApp = true,
    IosBundleId = "com.example.ios",
    AndroidPackageName = "com.example.android",
    AndroidInstallApp = true,
    AndroidMinimumVersion = "12",
    LinkDomain = "coolapp.page.link",
};

```

--------------------------------

### Initialize ActionCodeSettings in Java

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Example of building an ActionCodeSettings object in Java using the builder pattern. Note the use of setDynamicLinkDomain, which is deprecated in the documentation.

```java
ActionCodeSettings actionCodeSettings = ActionCodeSettings.builder()
    .setUrl("https://www.example.com/checkout?cartId=1234")
    .setHandleCodeInApp(true)
    .setIosBundleId("com.example.ios")
    .setAndroidPackageName("com.example.android")
    .setAndroidInstallApp(true)
    .setAndroidMinimumVersion("12")
    .setDynamicLinkDomain("coolapp.page.link")
    .build();

```

--------------------------------

### Initialize ActionCodeSettings in Python

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Example of creating an ActionCodeSettings object in Python using the Firebase Admin SDK. Uses dynamic_link_domain parameter.

```python
action_code_settings = auth.ActionCodeSettings(
    url='https://www.example.com/checkout?cartId=1234',
    handle_code_in_app=True,
    ios_bundle_id='com.example.ios',
    android_package_name='com.example.android',
    android_install_app=True,
    android_minimum_version='12',
    dynamic_link_domain='coolapp.page.link',
)

```

--------------------------------

### Initialize ActionCodeSettings in Node.js

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Example of creating an ActionCodeSettings object in Node.js for an email verification link that opens in a mobile app first. The URL must be whitelisted in the Firebase Console, and the linkDomain must be configured in Firebase Hosting.

```javascript
const actionCodeSettings = {
  // URL you want to redirect back to. The domain (www.example.com) for
  // this URL must be whitelisted in the Firebase Console.
  url: 'https://www.example.com/checkout?cartId=1234',
  // This must be true for email link sign-in.
  handleCodeInApp: true,
  iOS: {
    bundleId: 'com.example.ios',
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12',
  },
  // The domain must be configured in Firebase Hosting and owned by the project.
  linkDomain: 'custom-domain.com',
};

```

--------------------------------

### Get user by uid with Firebase Admin SDK

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user's profile by their unique identifier (uid) using the Firebase Admin SDK. Each language variant returns a UserRecord object; if the uid does not exist or cannot be fetched, the method throws an error. The Node.js example is from manage_users.js and the Go example is from auth.go.

```javascript
getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
```

```java
UserRecord userRecord = FirebaseAuth.getInstance().getUser(uid);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getUid());
```

```python
from firebase_admin import auth

user = auth.get_user(uid)
print(f'Successfully fetched user data: {user.uid}')
```

```go
// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

u, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatalf("error getting user %s: %v\n", uid, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
```

```csharp
UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");
```

--------------------------------

### Get user by phone number (Go)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user by phone number using the Go Admin SDK. Throws an error if the phone number does not belong to an existing user or the user cannot be fetched.

```go
u, err := client.GetUserByPhoneNumber(ctx, phone)
if err != nil {
	log.Fatalf("error getting user by phone %s: %v\n", phone, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
auth.go

```

--------------------------------

### Get user by phone number (C#)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user by phone number using the C# Admin SDK. Throws an error if the phone number does not belong to an existing user or the user cannot be fetched.

```csharp
UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");

```

--------------------------------

### Get user by phone number (Python)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user by phone number using the Python Admin SDK. Throws an error if the phone number does not belong to an existing user or the user cannot be fetched.

```python
from firebase_admin import auth

user = auth.get_user_by_phone_number(phone)
print(f'Successfully fetched user data: {user.uid}')

```

--------------------------------

### Update user with Firebase Admin SDK (Go)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Updates a user's properties using the Firebase Admin SDK for Go. The example builds a UserToUpdate struct with the desired properties and calls client.UpdateUser. It logs a fatal error if the update fails, otherwise logs the updated user. The source file is auth.go.

```go
params := (&auth.UserToUpdate{}).
	Email("user@example.com").
	EmailVerified(true).
	PhoneNumber("+15555550100").
	Password("newPassword").
	DisplayName("John Doe").
	PhotoURL("http://www.example.com/12345678/photo.png").
	Disabled(true)
u, err := client.UpdateUser(ctx, uid, params)
if err != nil {
	log.Fatalf("error updating user: %v\n", err)
}
log.Printf("Successfully updated user: %v\n", u)
```

--------------------------------

### List all users with ListUsersAsync() in C#

Source: https://firebase.google.com/docs/auth/admin/manage-users

Lists all users in C# using FirebaseAuth.DefaultInstance.ListUsersAsync(null). The first loop uses AsRawResponses() to get raw responses, while the second uses GetAsyncEnumerator() to iterate through users in batches, buffering no more than 1000 users in memory at a time.

```csharp
// Start listing users from the beginning, 1000 at a time.
var pagedEnumerable = FirebaseAuth.DefaultInstance.ListUsersAsync(null);
var responses = pagedEnumerable.AsRawResponses().GetAsyncEnumerator();
while (await responses.MoveNextAsync())
{
    ExportedUserRecords response = responses.Current;
    foreach (ExportedUserRecord user in response.Users)
    {
        Console.WriteLine($"User: {user.Uid}");
    }
}

// Iterate through all users. This will still retrieve users in batches,
// buffering no more than 1000 users in memory at a time.
var enumerator = FirebaseAuth.DefaultInstance.ListUsersAsync(null).GetAsyncEnumerator();
while (await enumerator.MoveNextAsync())
{
    ExportedUserRecord user = enumerator.Current;
    Console.WriteLine($"User: {user.Uid}");
}
```

--------------------------------

### Unity (C#): Get ID token with TokenAsync

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. Uses ContinueWith to handle the task result, checking for cancellation or fault. Send the token to your backend via HTTPS.

```csharp
Firebase.Auth.FirebaseUser user = auth.CurrentUser;
user.TokenAsync(true).ContinueWith(task => {
  if (task.IsCanceled) {
    Debug.LogError("TokenAsync was canceled.");
   return;
  }

  if (task.IsFaulted) {
    Debug.LogError("TokenAsync encountered an error: " + task.Exception);
    return;
  }

  string idToken = task.Result;

  // Send token to your backend via HTTPS
  // ...
});

```

--------------------------------

### Generate password reset link with Admin SDK

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Generate a password reset link for an existing user's email using the Admin SDK. Each language example shows the API call and error handling. The link is then embedded in a custom email template and sent via SMTP.

```javascript
// Admin SDK API to generate the password reset link.
const userEmail = 'user@example.com';
getAuth()
  .generatePasswordResetLink(userEmail, actionCodeSettings)
  .then((link) => {
    // Construct password reset email template, embed the link and send
    // using custom SMTP server.
    return sendCustomPasswordResetEmail(userEmail, displayName, link);
  })
  .catch((error) => {
    // Some error occurred.
  });

```

```java
String email = "user@example.com";
try {
  String link = FirebaseAuth.getInstance().generatePasswordResetLink(
      email, actionCodeSettings);
  // Construct email verification template, embed the link and send
  // using custom SMTP server.
  sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
  System.out.println("Error generating email link: " + e.getMessage());
}

```

```python
email = 'user@example.com'
link = auth.generate_password_reset_link(email, action_code_settings)
# Construct password reset email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)

```

```go
email := "user@example.com"
link, err := client.PasswordResetLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
	log.Fatalf("error generating email link: %v\n", err)
}

// Construct password reset template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)

```

```csharp
var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GeneratePasswordResetLinkAsync(
    email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);

```

--------------------------------

### Update user with Firebase Admin SDK (C#)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Updates a user's properties using the Firebase Admin SDK for C#. The example creates a UserRecordArgs object with the desired properties and calls FirebaseAuth.DefaultInstance.UpdateUserAsync. It awaits the result and prints the updated user's UID.

```csharp
UserRecordArgs args = new UserRecordArgs()
{
    Uid = uid,
    Email = "modifiedUser@example.com",
    PhoneNumber = "+11234567890",
    EmailVerified = true,
    Password = "newPassword",
    DisplayName = "Jane Doe",
    PhotoUrl = "http://www.example.com/12345678/photo.png",
    Disabled = true,
};
UserRecord userRecord = await FirebaseAuth.DefaultInstance.UpdateUserAsync(args);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully updated user: {userRecord.Uid}");
```

--------------------------------

### Define user records for batch import (Go)

Source: https://firebase.google.com/docs/auth/admin/import-users

Initialize a slice of auth.UserToImport pointers specifying UID, email, password hash, and salt.

```go
// Up to 1000 users can be imported at once.
var users []*auth.UserToImport
users = append(users, (&auth.UserToImport{}).
	UID("uid1").
	Email("user1@example.com").
	PasswordHash([]byte("passwordHash1")).
	PasswordSalt([]byte("salt1")))
users = append(users, (&auth.UserToImport{}).
	UID("uid2").
	Email("user2@example.com").
	PasswordHash([]byte("passwordHash2")).
	PasswordSalt([]byte("salt2")))

```

--------------------------------

### Get user by email with Firebase Admin SDK

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user's profile by their email address using the Firebase Admin SDK. Only the main (top-level) email is searchable; provider-specific emails (e.g., a linked Facebook email) will not match. If the email does not exist or cannot be fetched, the SDK throws an error. The Node.js example is from manage_users.js and the Go example is from auth.go.

```javascript
getAuth()
  .getUserByEmail(email)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data: ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
```

```java
UserRecord userRecord = FirebaseAuth.getInstance().getUserByEmail(email);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getEmail());
```

```python
from firebase_admin import auth

user = auth.get_user_by_email(email)
print(f'Successfully fetched user data: {user.uid}')
```

```go
u, err := client.GetUserByEmail(ctx, email)
if err != nil {
	log.Fatalf("error getting user by email %s: %v\n", email, err)
}
log.Printf("Successfully fetched user data: %v\n", u)
```

```csharp
UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
// See the UserRecord reference doc for the contents of userRecord.
Console.WriteLine($"Successfully fetched user data: {userRecord.Uid}");
```

--------------------------------

### Get user by phone number with Firebase Admin SDK

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user's profile by their phone number using the Firebase Admin SDK. This example is from manage_users.js and returns a UserRecord object; if the phone number does not exist or cannot be fetched, the method throws an error.

```javascript
getAuth()
  .getUserByPhoneNumber(phoneNumber)
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log(`Successfully fetched user data:  ${userRecord.toJSON()}`);
  })
  .catch((error) => {
    console.log('Error fetching user data:', error);
  });
```

--------------------------------

### Update user with Firebase Admin SDK (Java)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Updates a user's properties using the Firebase Admin SDK for Java. The example builds an UpdateRequest with the desired properties and calls FirebaseAuth.getInstance().updateUser(request). The method returns a UserRecord object, and the example prints the updated user's UID.

```java
UpdateRequest request = new UpdateRequest(uid)
    .setEmail("user@example.com")
    .setPhoneNumber("+11234567890")
    .setEmailVerified(true)
    .setPassword("newPassword")
    .setDisplayName("Jane Doe")
    .setPhotoUrl("http://www.example.com/12345678/photo.png")
    .setDisabled(true);

UserRecord userRecord = FirebaseAuth.getInstance().updateUser(request);
System.out.println("Successfully updated user: " + userRecord.getUid());
```

--------------------------------

### List all users with client.Users() in Go

Source: https://firebase.google.com/docs/auth/admin/manage-users

Lists all users in Go using client.Users(ctx, ""). The first loop iterates through users with Next(), retrieving 1000 at a time. The second loop uses iterator.NewPager to page through 100 users at a time; using both Next() and NextPage() on the same iterator will result in an error.

```go
// Note, behind the scenes, the Users() iterator will retrive 1000 Users at a time through the API
iter := client.Users(ctx, "")
for {
	user, err := iter.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		log.Fatalf("error listing users: %s\n", err)
	}
	log.Printf("read user user: %v\n", user)
}

// Iterating by pages 100 users at a time.
// Note that using both the Next() function on an iterator and the NextPage()
// on a Pager wrapping that same iterator will result in an error.
pager := iterator.NewPager(client.Users(ctx, ""), 100, "")
for {
	var users []*auth.ExportedUserRecord
	nextPageToken, err := pager.NextPage(&users)
	if err != nil {
		log.Fatalf("paging error %v\n", err)
	}
	for _, u := range users {
		log.Printf("read user user: %v\n", u)
	}
	if nextPageToken == "" {
		break
	}
}
```

--------------------------------

### Initialize ActionCodeSettings

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Documentation for initializing ActionCodeSettings in Firebase Authentication for email action links.

```APIDOC
## Initialize ActionCodeSettings

### Description
Initializes an `ActionCodeSettings` instance to configure email action links. This allows passing additional state via a continue URL and specifying whether the link should be handled in a mobile app or a web browser.

### Parameters
| Parameter | Type | Description |
|---|---|---|
| `url` | string | Sets the link (state/continue URL) which has different meanings in different contexts. |
| `iOS` | ({bundleId: string}\|undefined) | Sets the iOS bundle ID to help Firebase Authentication determine if it should create a web-only or mobile link. |
| `android` | ({packageName: string, installApp:boolean\|undefined, minimumVersion: string\|undefined}\|undefined) | Sets the Android package name to help Firebase Authentication determine if it should create a web-only or mobile link. |
| `handleCodeInApp` | (boolean\|undefined) | Whether the email action link will be opened in a mobile app or a web link first. Default is false. |
| `linkDomain` | (string\|undefined) | When custom Hosting link domains are defined, specify which one to use when the link is opened by a specified mobile app. |
| `dynamicLinkDomain` | (string\|undefined) | Deprecated. Don't specify this parameter. |

### Example (Node.js)
```javascript
const actionCodeSettings = {
  // URL you want to redirect back to. The domain (www.example.com) for
  // this URL must be whitelisted in the Firebase Console.
  url: 'https://www.example.com/checkout?cartId=1234',
  // This must be true for email link sign-in.
  handleCodeInApp: true,
  iOS: {
    bundleId: 'com.example.ios',
  },
  android: {
    packageName: 'com.example.android',
    installApp: true,
    minimumVersion: '12',
  },
  // The domain must be configured in Firebase Hosting and owned by the project.
  linkDomain: 'custom-domain.com',
};
```

### Example (Java)
```java
ActionCodeSettings actionCodeSettings = ActionCodeSettings.builder()
    .setUrl("https://www.example.com/checkout?cartId=1234")
    .setHandleCodeInApp(true)
    .setIosBundleId("com.example.ios")
    .setAndroidPackageName("com.example.android")
    .setAndroidInstallApp(true)
    .setAndroidMinimumVersion("12")
    .setDynamicLinkDomain("coolapp.page.link")
    .build();
```

### Example (Python)
```python
action_code_settings = auth.ActionCodeSettings(
    url='https://www.example.com/checkout?cartId=1234',
    handle_code_in_app=True,
    ios_bundle_id='com.example.ios',
    android_package_name='com.example.android',
    android_install_app=True,
    android_minimum_version='12',
    dynamic_link_domain='coolapp.page.link',
)
```

### Example (Go)
```go
actionCodeSettings := &auth.ActionCodeSettings{
	URL:                   "https://www.example.com/checkout?cartId=1234",
	HandleCodeInApp:       true,
	IOSBundleID:           "com.example.ios",
	AndroidPackageName:    "com.example.android",
	AndroidInstallApp:     true,
	AndroidMinimumVersion: "12",
	DynamicLinkDomain:     "coolapp.page.link",
}
```

### Example (C#)
```csharp
var actionCodeSettings = new ActionCodeSettings()
{
    Url = "https://www.example.com/checkout?cartId=1234",
    HandleCodeInApp = true,
    IosBundleId = "com.example.ios",
    AndroidPackageName = "com.example.android",
    AndroidInstallApp = true,
    AndroidMinimumVersion = "12",
    LinkDomain = "coolapp.page.link",
};
```
```

--------------------------------

### Define user records for batch import (Java)

Source: https://firebase.google.com/docs/auth/admin/import-users

Build a list of ImportUserRecord objects with UID, email, password hash, and salt for batch user import.

```java
// Up to 1000 users can be imported at once.
List<ImportUserRecord> users = new ArrayList<>();
users.add(ImportUserRecord.builder()
    .setUid("uid1")
    .setEmail("user1@example.com")
    .setPasswordHash("passwordHash1".getBytes())
    .setPasswordSalt("salt1".getBytes())
    .build());
users.add(ImportUserRecord.builder()
    .setUid("uid2")
    .setEmail("user2@example.com")
    .setPasswordHash("passwordHash2".getBytes())
    .setPasswordSalt("salt2".getBytes())
    .build());

```

--------------------------------

### Sign in with custom token in C++ using SignInWithCustomToken

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Initiates sign-in using SignInWithCustomToken in C++, returning a Future for handling auth results.

```cpp
firebase::Future<firebase::auth::AuthResult> result =
    auth->SignInWithCustomToken(custom_token);
```

--------------------------------

### Generate Email Verification Link

Source: https://firebase.google.com/docs/auth/admin/email-action-links

Code examples for generating an email verification link using the Firebase Admin SDK in various programming languages.

```APIDOC
## generateEmailVerificationLink

### Description
Generates an email verification link for an existing user's unverified email address. The operation resolves with the email action link, which can be embedded in a custom verification email.

### Method
Function call

### Endpoint
`getAuth().generateEmailVerificationLink(useremail, actionCodeSettings)`

### Parameters
- **useremail** (string) - Required - The email address of the existing user to generate the verification link for.
- **actionCodeSettings** (ActionCodeSettings) - Optional - An object containing additional settings for the action code.

### Request Example
```javascript
const useremail = 'user@example.com';
getAuth()
  .generateEmailVerificationLink(useremail, actionCodeSettings)
  .then((link) => {
    // Construct email verification template, embed the link and send
    // using custom SMTP server.
    return sendCustomVerificationEmail(useremail, displayName, link);
  })
  .catch((error) => {
    // Some error occurred.
  });
```

### Response
#### Success Response
- **link** (string) - The generated email verification link.

#### Response Example
```javascript
// The link is returned as a Promise that resolves to a string.
```
```

```APIDOC
## generateEmailVerificationLink (Java)

### Description
Generates an email verification link for an existing user's unverified email address. The operation resolves with the email action link, which can be embedded in a custom verification email.

### Method
Function call

### Endpoint
`FirebaseAuth.getInstance().generateEmailVerificationLink(email, actionCodeSettings)`

### Parameters
- **email** (String) - Required - The email address of the existing user to generate the verification link for.
- **actionCodeSettings** (ActionCodeSettings) - Optional - An object containing additional settings for the action code.

### Request Example
```java
String email = "user@example.com";
try {
  String link = FirebaseAuth.getInstance().generateEmailVerificationLink(
      email, actionCodeSettings);
  // Construct email verification template, embed the link and send
  // using custom SMTP server.
  sendCustomEmail(email, displayName, link);
} catch (FirebaseAuthException e) {
  System.out.println("Error generating email link: " + e.getMessage());
}
```

### Response
#### Success Response
- **link** (String) - The generated email verification link.

#### Response Example
```java
// The link is returned as a String.
```
```

```APIDOC
## generate_email_verification_link (Python)

### Description
Generates an email verification link for an existing user's unverified email address. The operation resolves with the email action link, which can be embedded in a custom verification email.

### Method
Function call

### Endpoint
`auth.generate_email_verification_link(email, action_code_settings)`

### Parameters
- **email** (str) - Required - The email address of the existing user to generate the verification link for.
- **action_code_settings** (ActionCodeSettings) - Optional - An object containing additional settings for the action code.

### Request Example
```python
email = 'user@example.com'
link = auth.generate_email_verification_link(email, action_code_settings)
# Construct email from a template embedding the link, and send
# using a custom SMTP server.
send_custom_email(email, link)
```

### Response
#### Success Response
- **link** (str) - The generated email verification link.

#### Response Example
```python
# The link is returned as a string.
```
```

```APIDOC
## EmailVerificationLinkWithSettings (Go)

### Description
Generates an email verification link for an existing user's unverified email address. The operation resolves with the email action link, which can be embedded in a custom verification email.

### Method
Function call

### Endpoint
`client.EmailVerificationLinkWithSettings(ctx, email, actionCodeSettings)`

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **email** (string) - Required - The email address of the existing user to generate the verification link for.
- **actionCodeSettings** (ActionCodeSettings) - Optional - An object containing additional settings for the action code.

### Request Example
```go
email := "user@example.com"
link, err := client.EmailVerificationLinkWithSettings(ctx, email, actionCodeSettings)
if err != nil {
	log.Fatalf("error generating email link: %v\n", err)
}

// Construct email verification template, embed the link and send
// using custom SMTP server.
sendCustomEmail(email, displayName, link)
```

### Response
#### Success Response
- **link** (string) - The generated email verification link.

#### Response Example
```go
// The link is returned as a string.
```
```

```APIDOC
## GenerateEmailVerificationLinkAsync (C#)

### Description
Generates an email verification link for an existing user's unverified email address. The operation resolves with the email action link, which can be embedded in a custom verification email.

### Method
Function call

### Endpoint
`FirebaseAuth.DefaultInstance.GenerateEmailVerificationLinkAsync(email, actionCodeSettings)`

### Parameters
- **email** (string) - Required - The email address of the existing user to generate the verification link for.
- **actionCodeSettings** (ActionCodeSettings) - Optional - An object containing additional settings for the action code.

### Request Example
```csharp
var email = "user@example.com";
var link = await FirebaseAuth.DefaultInstance.GenerateEmailVerificationLinkAsync(
    email, actionCodeSettings);
// Construct email verification template, embed the link and send
// using custom SMTP server.
SendCustomEmail(email, displayName, link);
```

### Response
#### Success Response
- **link** (string) - The generated email verification link.

#### Response Example
```csharp
// The link is returned as a Task<string>.
```
```

--------------------------------

### Define user records for batch import (Python)

Source: https://firebase.google.com/docs/auth/admin/import-users

Create a list of auth.ImportUserRecord instances containing user details and hashed credentials for import.

```python
# Up to 1000 users can be imported at once.
users = [
    auth.ImportUserRecord(
        uid='uid1',
        email='user1@example.com',
        password_hash=b'password_hash_1',
        password_salt=b'salt1'
    ),
    auth.ImportUserRecord(
        uid='uid2',
        email='user2@example.com',
        password_hash=b'password_hash_2',
        password_salt=b'salt2'
    ),
]

```

--------------------------------

### Sign in with custom token in Unity using SignInWithCustomTokenAsync

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Performs asynchronous authentication in Unity using a custom token and logs the resulting display name and user ID.

```csharp
auth.SignInWithCustomTokenAsync(custom_token).ContinueWith(task => {
  if (task.IsCanceled) {
    Debug.LogError("SignInWithCustomTokenAsync was canceled.");
    return;
  }
  if (task.IsFaulted) {
    Debug.LogError("SignInWithCustomTokenAsync encountered an error: " + task.Exception);
    return;
  }

  Firebase.Auth.AuthResult result = task.Result;
  Debug.LogFormat("User signed in successfully: {0} ({1})",
      result.User.DisplayName, result.User.UserId);
});
```

--------------------------------

### admin.auth().createUser(properties)

Source: https://firebase.google.com/docs/auth/admin/manage-mfa-users

Creates a new user account with specified profile properties, including up to 5 enrolled secondary factors for multi-factor authentication.

```APIDOC
## admin.auth().createUser(properties)

### Description
Creates a new user with the specified properties. Users with secondary factors must have a verified email address (`emailVerified: true`) and use a supported first factor. Up to 5 secondary factors are allowed.

### Parameters
- **properties** (object) - Required - The user creation properties.
  - **uid** (string) - Optional - The specified user ID.
  - **email** (string) - Optional - The user's primary email address.
  - **emailVerified** (boolean) - Optional - Must be `true` when enrolling secondary factors.
  - **password** (string) - Optional - The user's primary password.
  - **multiFactor** (object) - Optional - MFA configuration.
    - **enrolledFactors** (Array<object>) - List of secondary factors to enroll (up to 5).
      - **factorId** (string) - Required - Factor identifier (e.g., `'phone'`).
      - **phoneNumber** (string) - Required for phone factors - E.164 formatted phone number.
      - **displayName** (string) - Optional - Display name for the factor.

### Return Value
Returns a Promise resolved with the created `userRecord`.

### Example
```javascript
admin.auth().createUser({
  uid: '123456789',
  email: 'user@example.com',
  emailVerified: true,
  password: 'password',
  multiFactor: {
    enrolledFactors: [
      {
        phoneNumber: '+16505550001',
        displayName: 'Corp phone',
        factorId: 'phone',
      },
      {
        phoneNumber: '+16505550002',
        displayName: 'Personal phone',
        factorId: 'phone'
      },
    ],
  },
})
.then((userRecord) => {
  console.log(userRecord.multiFactor.enrolledFactors);
})
.catch((error) => {
  console.log(error);
});
```
```

--------------------------------

### Get user by phone number (Java)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Fetches a user by phone number using the Java Admin SDK. Throws an error if the phone number does not belong to an existing user or the user cannot be fetched.

```java
UserRecord userRecord = FirebaseAuth.getInstance().getUserByPhoneNumber(phoneNumber);
// See the UserRecord reference doc for the contents of userRecord.
System.out.println("Successfully fetched user data: " + userRecord.getPhoneNumber());

```

--------------------------------

### C++: Get ID token with GetToken

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. Checks if the user is valid before calling GetToken. Send the token to your backend via HTTPS.

```cpp
firebase::auth::User user = auth->current_user();
if (user.is_valid()) {
  firebase::Future<std::string> idToken = user.GetToken(true);

  // Send token to your backend via HTTPS
  // ...
}

```

--------------------------------

### Create a user

Source: https://firebase.google.com/docs/auth/admin/manage-users

Creates a new user with the specified properties. Returns a UserRecord object for the newly created user.

```APIDOC
## Create a user

### Description
Creates a new user with the specified properties. Any combination of the listed properties can be provided. Returns a `UserRecord` object for the newly created user.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **uid** (string) - Optional - The `uid` to assign to the newly created user. Must be a string between 1-128 characters long, inclusive. If not provided, a random `uid` will be automatically generated. Shorter `uid`s offer better performance.
- **email** (string) - Optional - The user's primary email. Must be a valid email address.
- **emailVerified** (boolean) - Optional - Whether or not the user's primary email is verified. If not provided, the default is `false`.
- **phoneNumber** (string) - Optional - The user's primary phone number. Must be a valid E.164 spec compliant phone number.
- **password** (string) - Optional - The user's raw, unhashed password. Must be at least six characters long.
- **displayName** (string) - Optional - The users' display name.
- **photoURL** (string) - Optional - The user's photo URL.
- **disabled** (boolean) - Optional - Whether or not the user is disabled. `true` for disabled; `false` for enabled. If not provided, the default is `false`.

### Request Example
{
  "uid": "some-uid",
  "email": "user@example.com",
  "emailVerified": false,
  "phoneNumber": "+15551234567",
  "password": "secret123",
  "displayName": "John Doe",
  "photoURL": "https://example.com/photo.jpg",
  "disabled": false
}

### Response
#### Success Response (200)
- **UserRecord** (object) - The newly created user record.

#### Response Example
{
  "uid": "some-uid",
  "email": "user@example.com",
  "emailVerified": false,
  "phoneNumber": "+15551234567",
  "displayName": "John Doe",
  "photoURL": "https://example.com/photo.jpg",
  "disabled": false
}

### Error Handling
If the provided `uid`, email or phone number is already in use by an existing user or the user cannot be created for any other reason, the method fails with an error. For a full list of error codes, including descriptions and resolution steps, see Admin Authentication API Errors.
```

--------------------------------

### Swift: Get ID token with getIDTokenForcingRefresh

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. The completion handler receives the token or an error. Send the token to your backend via HTTPS.

```swift
let currentUser = FIRAuth.auth()?.currentUser
currentUser?.getIDTokenForcingRefresh(true) { idToken, error in
  if let error = error {
    // Handle error
    return;
  }

  // Send token to your backend via HTTPS
  // ...
}

```

--------------------------------

### Sign in with custom token in Swift using signIn(withCustomToken:)

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Authenticates the client using a custom token in Swift on iOS.

```swift
Auth.auth().signIn(withCustomToken: customToken ?? "") { user, error in
  // ...
}
```

--------------------------------

### Objective-C: Get ID token with getIDTokenForcingRefresh

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. The completion handler receives the token or an error. Send the token to your backend via HTTPS.

```objectivec
FIRUser *currentUser = [FIRAuth auth].currentUser;
[currentUser getIDTokenForcingRefresh:YES
                           completion:^(NSString *_Nullable idToken,
                                        NSError *_Nullable error) {
          if (error) {
            // Handle error
            return;
          }

          // Send token to your backend via HTTPS
          // ...
}];

```

--------------------------------

### Initialize Firebase Admin SDK with ServiceAccountID in Go

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Configures ServiceAccountID on firebase.Config and initializes the app with NewApp in Go. The calling service account must possess the iam.serviceAccounts.signBlob IAM permission.

```go
conf := &firebase.Config{
	ServiceAccountID: "my-client-id@my-project-id.iam.gserviceaccount.com",
}
app, err := firebase.NewApp(context.Background(), conf)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}
init.go
```

--------------------------------

### Web (JavaScript): Get ID token with getIdToken

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. Uses a Promise to handle success or error. Send the token to your backend via HTTPS.

```javascript
firebase.auth().currentUser.getIdToken(/* forceRefresh */ true).then(function(idToken) {
  // Send token to your backend via HTTPS
  // ...
}).catch(function(error) {
  // Handle error
});

```

--------------------------------

### Initialize Firebase Admin SDK with serviceAccountId in Python

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Initializes the Python Admin SDK by specifying serviceAccountId within the options dictionary. Ensure the caller identity has the iam.serviceAccounts.signBlob permission to sign tokens remotely.

```python
options = {
    'serviceAccountId': 'my-client-id@my-project-id.iam.gserviceaccount.com',
}
firebase_admin.initialize_app(options=options)
```

--------------------------------

### Android (Java): Get ID token with FirebaseAuth.getInstance().getCurrentUser()

Source: https://firebase.google.com/docs/auth/admin/verify-id-tokens

Retrieves the ID token for the current user, forcing a refresh. Uses an OnCompleteListener to handle success or failure. Send the token to your backend via HTTPS.

```java
FirebaseUser mUser = FirebaseAuth.getInstance().getCurrentUser();
mUser.getIdToken(true)
    .addOnCompleteListener(new OnCompleteListener<GetTokenResult>() {
        public void onComplete(@NonNull Task<GetTokenResult> task) {
            if (task.isSuccessful()) {
                String idToken = task.getResult().getToken();
                // Send token to your backend via HTTPS
                // ...
            } else {
                // Handle error -> task.getException();
            }
        }
    });

```

--------------------------------

### Define user records for batch import (C#)

Source: https://firebase.google.com/docs/auth/admin/import-users

Construct a list of ImportUserRecordArgs objects specifying user identifiers, emails, and encoded byte arrays for password credentials.

```csharp
//  Up to 1000 users can be imported at once.
var users = new List<ImportUserRecordArgs>()
{
    new ImportUserRecordArgs()
    {
        Uid = "uid1",
        Email = "user1@example.com",
        PasswordHash = Encoding.ASCII.GetBytes("passwordHash1"),
        PasswordSalt = Encoding.ASCII.GetBytes("salt1"),
    },
    new ImportUserRecordArgs()
    {
        Uid = "uid2",
        Email = "user2@example.com",
        PasswordHash = Encoding.ASCII.GetBytes("passwordHash2"),
        PasswordSalt = Encoding.ASCII.GetBytes("salt2"),
    },
};

```

--------------------------------

### Create a user

Source: https://firebase.google.com/docs/auth/admin/manage-users

Documentation for creating a new Firebase Authentication user using the Admin SDK.

```APIDOC
## Create a user

### Description
Creates a new Firebase Authentication user with the provided profile information.

### Method
createUser

### Parameters
#### Request Body
- **email** (string) - Optional - The user's email address.
- **emailVerified** (boolean) - Optional - Whether the email address has been verified.
- **phoneNumber** (string) - Optional - The user's phone number.
- **password** (string) - Optional - The user's password.
- **displayName** (string) - Optional - The user's display name.
- **photoURL** (string) - Optional - The user's photo URL.
- **disabled** (boolean) - Optional - Whether the user is disabled.
- **uid** (string) - Optional - A custom user ID. If not provided, a random UID is generated.

### Request Example
```javascript
const userRecord = await getAuth().createUser({
  email: 'user@example.com',
  emailVerified: false,
  phoneNumber: '+11234567890',
  password: 'secretPassword',
  displayName: 'John Doe',
  photoURL: 'http://www.example.com/12345678/photo.png',
  disabled: false,
});
```

### Response
#### Success Response
- **userRecord** (UserRecord) - The created user record, containing the user's UID and other profile information.

#### Response Example
```javascript
console.log('Successfully created new user:', userRecord.uid);
```
```

--------------------------------

### Incrementally add custom claims in Go

Source: https://firebase.google.com/docs/auth/admin/custom-claims

Retrieve a user by email using `client.GetUserByEmail` and update their custom claims dictionary with `client.SetCustomUserClaims`.

```go
user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Add incremental custom claim without overwriting existing claims.
currentCustomClaims := user.CustomClaims
if currentCustomClaims == nil {
	currentCustomClaims = map[string]interface{}{}
}

if _, found := currentCustomClaims["admin"]; found {
	// Add level.
	currentCustomClaims["accessLevel"] = 10
	// Add custom claims for additional privileges.
	err := client.SetCustomUserClaims(ctx, user.UID, currentCustomClaims)
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}
auth.go


```

--------------------------------

### List all users with auth.list_users() in Python

Source: https://firebase.google.com/docs/auth/admin/manage-users

Lists all users in Python using auth.list_users(). The first loop manually pages through results with get_next_page(), while the second uses iterate_all() to iterate through all users in batches, buffering no more than 1000 users in memory at a time.

```python
# Start listing users from the beginning, 1000 at a time.
page = auth.list_users()
while page:
    for user in page.users:
        print('User: ' + user.uid)
    # Get next batch of users.
    page = page.get_next_page()

# Iterate through all users. This will still retrieve users in batches,
# buffering no more than 1000 users in memory at a time.
for user in auth.list_users().iterate_all():
    print('User: ' + user.uid)
```

--------------------------------

### Define user records for batch import (Node.js)

Source: https://firebase.google.com/docs/auth/admin/import-users

Construct an array of user import record objects with UID, email, password hash, and salt. Up to 1000 users can be imported in a single API call.

```javascript
// Up to 1000 users can be imported at once.
const userImportRecords = [
  {
    uid: 'uid1',
    email: 'user1@example.com',
    passwordHash: Buffer.from('passwordHash1'),
    passwordSalt: Buffer.from('salt1'),
  },
  {
    uid: 'uid2',
    email: 'user2@example.com',
    passwordHash: Buffer.from('passwordHash2'),
    passwordSalt: Buffer.from('salt2'),
  },
  //...
];

```

--------------------------------

### Incrementally add custom claims in Python

Source: https://firebase.google.com/docs/auth/admin/custom-claims

Retrieve the user with `auth.get_user_by_email` and preserve existing claims while adding new privileges using `auth.set_custom_user_claims`.

```python
user = auth.get_user_by_email('user@admin.example.com')
# Add incremental custom claim without overwriting existing claims.
current_custom_claims = user.custom_claims
if current_custom_claims.get('admin'):
    # Add level.
    current_custom_claims['accessLevel'] = 10
    # Add custom claims for additional privileges.
    auth.set_custom_user_claims(user.uid, current_custom_claims)

```

--------------------------------

### Update user with Firebase Admin SDK (Python)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Updates a user's properties using the Firebase Admin SDK for Python. The example calls auth.update_user with the uid and keyword arguments for the properties to update. It prints the updated user's UID. Note the typo 'Sucessfully' in the print statement.

```python
user = auth.update_user(
    uid,
    email='user@example.com',
    phone_number='+15555550100',
    email_verified=True,
    password='newPassword',
    display_name='John Doe',
    photo_url='http://www.example.com/12345678/photo.png',
    disabled=True)
print(f'Sucessfully updated user: {user.uid}')
```

--------------------------------

### Initialize Firebase Admin SDK with serviceAccountId in Node.js

Source: https://firebase.google.com/docs/auth/admin/create-custom-tokens

Initializes the Node.js Admin SDK using a service account ID to sign tokens in Google-managed environments. Requires the calling service account to have the iam.serviceAccounts.signBlob permission.

```javascript
initializeApp({
  serviceAccountId: 'my-client-id@my-project-id.iam.gserviceaccount.com',
});
```

--------------------------------

### Update user with Firebase Admin SDK (Node.js)

Source: https://firebase.google.com/docs/auth/admin/manage-users

Updates a user's properties using the Firebase Admin SDK for Node.js. The updateUser method returns a Promise that resolves with a UserRecord object. The example sets email, phoneNumber, emailVerified, password, displayName, photoURL, and disabled. The source file is manage_users.js.

```javascript
getAuth()
  .updateUser(uid, {
    email: 'modifiedUser@example.com',
    phoneNumber: '+11234567890',
    emailVerified: true,
    password: 'newPassword',
    displayName: 'Jane Doe',
    photoURL: 'http://www.example.com/12345678/photo.png',
    disabled: true,
  })
  .then((userRecord) => {
    // See the UserRecord reference doc for the contents of userRecord.
    console.log('Successfully updated user', userRecord.toJSON());
  })
  .catch((error) => {
    console.log('Error updating user:', error);
  });
```
Tokens:
Raw