---
title: "New-VBREntraIDUserCredentials"
description: "This cmdlet defines an object that matches an Entra ID user and a password. This object is used for the user restore using the Restore-VBREntraIDTenantItem cmdlet."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrentraidusercredentials.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Microsoft EntraID Support > Item Data Recovery > New-VBREntraIDUserCredentials"
dateModified: "2026-08-19"
---

# New-VBREntraIDUserCredentials

## Short Description
Defines an object that matches a Microsoft Entra ID user and a password.

**Product Edition**: Standard, Enterprise, Enterprise Plus, Veeam Universal License

## Syntax
```
New-VBREntraIDUserCredentials -UserId <String> -Password <SecureString> [<CommonParameters>]
```

## Detailed Description
This cmdlet defines an object that matches an Entra ID user and a password. This object is used for the user restore using the [`Restore-VBREntraIDTenantItem`](restore-vbrentraidtenantitem.md) cmdlet.

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Password</span></p>
        </td>
        <td>
          <p>Specifies a password.</p>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">UserId</span></p>
        </td>
        <td>
          <p>Specifies the ID of a user to whom you want to assign the password during further restore.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
The cmdlet returns the [`VBREntraIDUserCredentials`](vbrentraidusercredentials.md) object that matches an Entra ID user and a password.

## Examples

::: example
### Matching Entra ID User with Password

This example shows how to match a user with a password.

```
$session = Get-VBREntraIDTenantRestoreSession -Id "901e32ac-4c9e-4f7a-9b36-a4fd0f7248fe"
$user = Get-VBREntraIDTenantItem -Backup $backup -Type User -Name "admin"
$passwords = (Generate-VBREntraIDTenantUserPassword -Session $session -PasswordCount 3) | ConvertTo-SecureString -AsPlainText -Force
$userPassword = New-VBREntraIDUserCredentials -UserId $user.Id -Password $passwords[0]
```

Perform the following steps:

1. Run the [`Get-VBREntraIDTenantRestoreSession`](get-vbrentraidtenantrestoresession.md) cmdlet. Specify the `Id` parameter value. Save the result to the `$session` variable.
2. Run the [`Get-VBREntraIDTenantItem`](get-vbrentraidtenantitem.md) cmdlet. Specify the following settings:

   - Set the `$backup` variable as the `Backup` parameter value.
   - Specify the `Type` and `Name` parameter values.
   - Save the result to the `$session` variable.

3. Run the [`Generate-VBREntraIDTenantUserPassword`](generate-vbrentraidtenantuserpassword.md) cmdlet. Specify the following settings:

   - Set the `$session` variable as the `Session` parameter value.
   - Specify the `PasswordCount` parameter value.
   - Convert the result to a secure string.
   - Save the result to the `$passwords` variable.

4. Run the `New-VBREntraIDUserCredentials` cmdlet. Specify the following settings:

   - Set the `$user.Id` variable as the `UserId` parameter value.
   - Set the `$passwords[0]` variable as the `Password` parameter value.
   - Save the result to the `$userPassword` variable.

:::

## Related Commands

- [`Get-VBREntraIDTenantRestoreSession`](get-vbrentraidtenantrestoresession.md)
- [`Get-VBREntraIDTenantItem`](get-vbrentraidtenantitem.md)
- [`Generate-VBREntraIDTenantUserPassword`](generate-vbrentraidtenantuserpassword.md)