Set-EntraUser

Module:

Microsoft.Entra.Users Module v1.3

Updates a user.

Set-EntraUser

 -UserId <String>
 [-PostalCode <String>]
 [-CompanyName <String>]
 [-GivenName <String>]
 [-Mobile <String>]
 [-PreferredLanguage <String>]
 [-CreationType <String>]
 [-UsageLocation <String>]
 [-UserType <String>]
 [-AgeGroup <String>]
 [-MailNickName <String>]
 [-ExtensionProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
 [-ConsentProvidedForMinor <String>]
 [-ImmutableId <String>]
 [-Country <String>]
 [-SignInNames <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]>]
 [-Department <String>]
 [-StreetAddress <String>]
 [-PasswordPolicies <String>]
 [-JobTitle <String>]
 [-City <String>]
 [-OtherMails <System.Collections.Generic.List`1[System.String]>]
 [-UserPrincipalName <String>]
 [-DisplayName <String>]
 [-AccountEnabled <Boolean>]
 [-PasswordProfile <PasswordProfile>]
 [-State <String>]
 [-TelephoneNumber <String>]
 [-Surname <String>]
 [-ShowInAddressList <Boolean>]
 [<CommonParameters>]

The Set-EntraUser cmdlet updates a user in Microsoft Entra ID. Specify the UserId parameter to update a user in Microsoft Entra ID.

Update-EntraUser is an alias for Set-EntraUser.

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -DisplayName 'Updated user Name'

This example updates the specified user's Display name parameter.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AccountEnabled $true

This example updates the specified user's AccountEnabled parameter.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.
• -AccountEnabled Specifies whether the account is enabled.

Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -All | Where-Object -Property DisplayName -Match '(George|James|Education)' |
ForEach-Object { Set-EntraUser -UserId $($_.Id) -AgeGroup 'minor' -ConsentProvidedForMinor 'granted' }

This example updates the specified user's as minors with parental consent.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.
• -ConsentProvidedForMinor Sets whether consent has to obtained for minors. Allowed values: null, granted, denied, and notRequired.

Connect-Entra -Scopes 'User.ReadWrite.All'
$params = @{
 UserId = 'SawyerM@contoso.com'
 City = 'Add city name'
 CompanyName = 'Microsoft'
 Country = 'Add country name'
 Department = 'Add department name'
 GivenName = 'Sawyer Miller G'
 JobTitle = 'Manager'
 MailNickName = 'Add mailnickname'
 Mobile = '9984534564'
 OtherMails = 'johndoe@contosodev.com'
 PasswordPolicies = 'DisableStrongPassword'
 State = 'UP'
 StreetAddress = 'Add address'
 UserType = 'Member'
}
Set-EntraUser @params

This example updates the specified user's property.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.
• -UserType classify user types in your directory, such as "Member" and "Guest."
• -PasswordPolicies Specifies password policies for the user.
• -OtherMails Specifies other email addresses for the user

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordProfile @{
 Password = '*****'
 ForceChangePasswordNextSignIn = $true
}

This example updates the specified user's PasswordProfile parameter.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.
• -PasswordProfile specifies the user's password profile.

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -UsageLocation 'US'

This example updates the specified user's Usage Location for license management.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.
• -UsageLocation specifies the user's usage location. Two-letter ISO 3166 country code. Required for licensed users to check service availability. Examples: US, JP, GB. Not nullable.

Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -UserId 'SawyerM@contoso.com' | Set-EntraUser -PasswordPolicies DisablePasswordExpiration

This example updates the specified user's password policy.

Possible values for password policy include:

• DisableStrongPassword: Allows weaker passwords than the default policy.
• DisablePasswordExpiration: Prevents passwords from expiring.

You can specify both values together, for example: DisablePasswordExpiration and DisableStrongPassword. For example, Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordPolicies "DisablePasswordExpiration,DisableStrongPassword".

Connect-Entra -Scopes 'User.ReadWrite.All'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$extensionName = (Get-EntraApplicationExtensionProperty -ApplicationId $application.Id).Name | Select-Object -First 1
$additionalProperties = @{ $extensionName = "Survey.Report" }
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties $additionalProperties

This example updates the specified user's extension properties, for example, an app role for an application.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties @{
 onPremisesExtensionAttributes = @{
 extensionAttribute1 = "Job Group D"
 extensionAttribute2 = "Audit Role"
 }
}

This example updates the specified user's onPremisesExtensionAttributes properties.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.

Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -BusinessPhones '+1 425 555 0109' -OfficeLocation '18/2111'

This example updates the specified user's onPremisesExtensionAttributes properties.

• -UserId Specifies the ID as a user principal name (UPN) or UserId.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Update-EntraUser is an alias for Set-EntraUser.