Set-User

This parameter is available only in on-premises Exchange.

The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from Unified Messaging directory searches.

This parameter is available only in on-premises Exchange.

The Arbitration switch is required to modify arbitration mailboxes. You don't need to specify a value with this switch.

Arbitration mailboxes are system mailboxes that are used for storing different types of system data and for managing messaging approval workflow.

The AssistantName parameter specifies the name of the user's assistant.

The AuthenticationPolicy parameter specifies the authentication policy to apply to the user. You can use any value that uniquely identifies the policy. For example:

• Name
• Distinguished name (DN)
• GUID

To remove the policy assignment for the user, use the value $null.

You create authentication policies with the New-AuthenticationPolicy cmdlet to block or selectively allow Basic authentication or (in Exchange 2019 CU2 or later) other legacy authentication methods.

This parameter is available only in the cloud-based service.

{{ Fill BlockCloudCache Description }}

This parameter is available only in the cloud-based service.

{{ Fill CanHaveCloudCache Description }}

This parameter is available only in on-premises Exchange.

The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate.

The City parameter specifies the user's city.

This parameter is available only in the cloud-based service.

{{ Fill ClearDataEncryptionPolicy Description }}

The Company parameter specifies the user's company.

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

• Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
• Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

The CountryOrRegion parameter specifies the user's country or region. A valid value is a valid ISO 3166-1 two-letter country code (for example, AU for Australia) or the corresponding friendly name for the country (which might be different from the official ISO 3166 Maintenance Agency short name).

A reference for two-letter country codes is available at Country Codes List.

The friendly name is returned in the CountryOrRegion property value by the Get-User cmdlet, but you can use either the friendly name or the two-letter country code in filter operations.

This parameter is available only in on-premises Exchange.

The CreateDTMFMap parameter specifies whether to create a dual-tone multiple-frequency (DTMF) map for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Valid values are:

• $true: A DTMF map is created for the recipient. This is the default value.
• $false: A DTMF map isn't created for the recipient.

The Department parameter specifies the user's department.

This parameter is available only in the cloud-based service.

{{ Fill DesiredWorkloads Description }}

The DisplayName parameter specifies the display name of the user. The display name is visible in the Exchange admin center and in Active Directory. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

This parameter is available only in the cloud-based service.

The EXOModuleEnabled parameter specifies whether the user can connect to Exchange Online PowerShell in Microsoft 365 organizations using the Exchange Online PowerShell V3 module. Valid values are:

• $true: The user can connect to Exchange Online PowerShell.
• $false: The user can't connect to Exchange Online PowerShell.

The default value depends on the management roles that are assigned to the user.

Access to Exchange Online PowerShell is also required for other features (for example, the ability to open the Exchange admin center (EAC)).

The Fax parameter specifies the user's fax number.

The FirstName parameter specifies the user's first name.

This parameter is available only in the cloud-based service.

The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.

You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate.

The GeoCoordinates parameter specifies the user's location in latitude, longitude and (optionally) altitude coordinates. A valid value for this parameter uses one of the following formats:

• Latitude and longitude: For example, "47.644125;-122.122411"
• Latitude, longitude, and altitude: For example, "47.644125;-122.122411;161.432"

Note: If period separators don't work for you, use commas instead.

The HomePhone parameter specifies the user's home telephone number.

The Identity parameter specifies the user that you want to modify. You can use any value that uniquely identifies the user. For example:

• Name
• User principal name (UPN)
• Distinguished name (DN)
• Canonical DN
• GUID
• UserPrincipalName

This parameter is available only in on-premises Exchange.

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch.

This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions:

• You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
• You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

The Initials parameter specifies the user's middle initials.

This parameter is available only in the cloud-based service.

{{ Fill IsShadowMailbox Description }}

The LastName parameter specifies the user's last name.

This parameter is available only in on-premises Exchange.

The LinkedCredential parameter specifies the username and password that's used to access the domain controller specified by the LinkedDomainController parameter.

A value for this parameter requires the Get-Credential cmdlet. To pause this command and receive a prompt for credentials, use the value (Get-Credential). Or, before you run this command, store the credentials in a variable (for example, $cred = Get-Credential) and then use the variable name ($cred) for this parameter. For more information, see Get-Credential.

You can only use the LinkedCredential parameter with a linked user.

This parameter is available only in on-premises Exchange.

The LinkedDomainController parameter specifies the domain controller in the forest where the user account resides, if this user is a linked user. The domain controller in the forest where the user account resides is used to get security information for the account specified by the LinkedMasterAccount parameter.

This parameter is required only if you're connecting a linked user.

This parameter is available only in on-premises Exchange.

The LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this user is a linked user. The master account is the account to which the user links. The master account grants access to the user. You can use one of the following values:

• GUID
• DN
• Domain\Account
• UPN
• LegacyExchangeDN
• SmtpAddress
• Alias
• $null

If you set this parameter's value to $null, you will unlink the account and convert the linked mailbox into a non-linked user mailbox. The mailbox won't retain the permissions previously set on it such as Send As, full access, folder, and calendar delegation.

This parameter is required only if you're connecting a linked user.

This parameter is available only in the cloud-based service.

{{ Fill MailboxRegion Description }}

This parameter is available only in the cloud-based service.

{{ Fill MailboxRegionSuffix Description }}

This parameter is available only in the cloud-based service.

{{ Fill ManagedOnboardingType Description }}

The Manager parameter specifies the user's manager.

The MobilePhone parameter specifies the user's primary mobile phone number.

Note: In Exchange Online, you can't use this parameter. Instead, use the MobilePhone parameter on the Update-MgUser cmdlet in Microsoft Graph PowerShell.

The Name parameter specifies the unique name of the user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").

The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks (").

The Office parameter specifies the user's physical office name or number.

The OtherFax parameter specifies the user's alternative fax number.

The OtherHomePhone parameter specifies the user's alternative home telephone number.

The OtherTelephone parameter specifies the user's alternative telephone number.

The Pager parameter specifies the user's pager number.

This parameter is functional only in the cloud-based service.

The PermanentlyClearPreviousMailboxInfo switch specifies whether to clear the Exchange Online mailbox attributes on a user. You don't need to specify a value with this switch.

Clearing these attributes might be required in mailbox move and re-licensing scenarios between on-premises Exchange and Microsoft 365. For more information, see Permanently Clear Previous Mailbox Info.

Caution: This switch prevents you from reconnecting to the mailbox and prevents you from recovering content from the mailbox.

The Phone parameter specifies the user's office telephone number.

Note: In Exchange Online, you can't use this parameter. Instead, use the BusinessPhones parameter on the Update-MgUser cmdlet in Microsoft Graph PowerShell.

The PhoneticDisplayName parameter specifies an alternate spelling of the user's name that's used for text to speech in Unified Messaging (UM) environments. Typically, you use this parameter when the pronunciation and spelling of the user's name don't match. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

The PostalCode parameter specifies the user's zip code or postal code.

The PostOfficeBox parameter specifies the user's post office box number.

The PublicFolder switch is required to modify public folder mailboxes. You don't need to specify a value with this switch.

Public folder mailboxes are specially designed mailboxes that store the hierarchy and content of public folders.

Note: This parameter is being deprecated in cloud-based environments. In cloud-based environments, use the EXOModuleEnabled parameter instead.

The RemotePowerShellEnabled parameter specifies whether the user has access to remote PowerShell. Remote PowerShell access is required to open the Exchange Management Shell or the Exchange admin center (EAC), even if you're trying to open the Exchange Management Shell or the EAC on the local Mailbox server. Valid values are:

• $true: The user has access to remote PowerShell.
• $false: The user doesn't have access to remote PowerShell.

The default value depends on the management roles that are assigned to the user.

This parameter is available only in the cloud-based service.

This parameter is reserved for internal Microsoft use.

The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are:

• $true: The user is required to change their password the next time they log on.
• $false: The user isn't required to change their password the next time they log on. This is the default value.

This parameter is available only in on-premises Exchange.

The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the following characters: !, #, $, %, ^, &, -, _, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 characters.

The SeniorityIndex parameter specifies the order in which this user will display in a hierarchical address book. A user with a value of 2 will display higher in an address book than a user with a value of 1.

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are:

• a - z
• A - Z
• 0 - 9
• space
• " ' ( ) + , - . / : ?

This parameter is available only in on-premises Exchange.

This parameter is reserved for internal Microsoft use.

The StateOrProvince parameter specifies the user's state or province.

The StreetAddress parameter specifies the user's physical address.

This parameter is available only in the cloud-based service.

The StsRefreshTokensValidFrom specifies the date-time that the user's STS refresh tokens are valid from.

Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format MM/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".

This parameter is available only in on-premises Exchange.

The TelephoneAssistant parameter specifies the telephone number of the user's assistant.

The Title parameter specifies the user's title.

This parameter is available only in on-premises Exchange.

The UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. This parameter accepts digits less than 128 characters in length and may include an optional plus sign (+) preceding the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value.

This parameter is available only in on-premises Exchange.

The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax:

• emailAddress:<integers>
• lastNameFirstName:<integers>
• firstNameLastName:<integers>

To enter values that overwrite all existing entries, use the following syntax: emailAddress:<integers>,lastNameFirstName:<integers>,firstNameLastName:<integers>.

If you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:<integers>, all existing lastNameFirstName and firstNameLastName values are removed.

To add or remove values without affecting other existing entries, use the following syntax: @{Add="emailAddress:<integers>","lastNameFirstName:<integers>","firstNameLastName:<integers>"; Remove="emailAddress:<integers>","lastNameFirstName:<integers>","firstNameLastName:<integers>"}.

If you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add="emailAddress:<integers1>","emailAddress:<integers2>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values.

This parameter is available only in on-premises Exchange.

The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: username@domain. Typically, the domain value is the domain where the user account resides.

This parameter is available only in the cloud-based service.

The VIP parameter specifies whether the user is a priority account. Valid values are:

• $true: The user is a priority account.
• $false: The user is not a priority account.

For more information about priority accounts, see Manage and monitor priority accounts.

The WebPage parameter specifies the user's Web page.

The WhatIf switch doesn't work on this cmdlet.

The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results:

• In environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value.
• In environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value.

The WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value.