[Index]

Model: device/exchangeonline/User

Model Details: device/exchangeonline/User

Title Description Details
Title * The Title parameter specifies the user's title.
  • Field Name: Title
  • Type: String
MailboxRelease *
  • Field Name: MailboxRelease
  • Type: String
OtherHomePhone The OtherHomePhone parameter specifies the user's alternative home telephone number.
  • Field Name: OtherHomePhone.[n]
  • Type: Array
Department * The Department parameter specifies the user's department.
  • Field Name: Department
  • Type: String
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
AuthenticationPolicy * PARAMVALUE: AuthPolicyIdParameter
  • Field Name: AuthenticationPolicy
  • Type: String
AdministrativeUnits
  • Field Name: AdministrativeUnits.[n]
  • Type: Array
Fax * The Fax parameter specifies the user's fax number.
  • Field Name: Fax
  • Type: String
TelephoneAssistant * This parameter is available only in on-premises Exchange 2016. The TelephoneAssistant parameter specifies the telephone number of the user's assistant.
  • Field Name: TelephoneAssistant
  • Type: String
UpgradeRequest *
  • Field Name: UpgradeRequest
  • Type: String
Company * The Company parameter specifies the user's company.
  • Field Name: Company
  • Type: String
VoiceMailSettings
  • Field Name: VoiceMailSettings.[n]
  • Type: Array
MobilePhone * The MobilePhone parameter specifies the user's primary mobile phone number.
  • Field Name: MobilePhone
  • Type: String
MailboxProvisioningConstraint *
  • Field Name: MailboxProvisioningConstraint
  • Type: String
GeoCoordinates * The GeoCoordinates parameter specifies the user's physical location in latitude, longitude, and altitude coordinates. Use this parameter to specify the global position of physical resources, such as conference rooms. You have to specify one of the following sets of coordinates; use semicolons to separate the values. Latitude and longitude; for example, "47.644125;-122.122411" Latitude, longitude, and altitude; for example, "47.644125;-122.122411;161.432"
  • Field Name: GeoCoordinates
  • Type: String
InPlaceHoldsRaw
  • Field Name: InPlaceHoldsRaw.[n]
  • Type: Array
OriginatingServer *
  • Field Name: OriginatingServer
  • Type: String
WebPage * The WebPage parameter specifies the user's Web page.
  • Field Name: WebPage
  • Type: String
Notes * The Notes parameters specifies additional information about the object. If the value contains spaces, enclose the value in quotation marks (").
  • Field Name: Notes
  • Type: String
WindowsEmailAddress * 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 on-premises 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 cloud environments or in on-premises 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.
  • Field Name: WindowsEmailAddress
  • Type: String
IsSoftDeletedByRemove *
  • Field Name: IsSoftDeletedByRemove
  • Type: Boolean
StreetAddress * The StreetAddress parameter specifies the user's physical address.
  • Field Name: StreetAddress
  • Type: String
ArchiveRelease *
  • Field Name: ArchiveRelease
  • Type: String
LegacyExchangeDN *
  • Field Name: LegacyExchangeDN
  • Type: String
ExchangeVersion *
  • Field Name: ExchangeVersion
  • Type: String
Initials * The Initials parameter specifies the user's middle initials.
  • Field Name: Initials
  • Type: String
MailboxProvisioningPreferences *
  • Field Name: MailboxProvisioningPreferences
  • Type: String
UserPrincipalName * This parameter is available only in on-premises Exchange 2016. 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.
  • Field Name: UserPrincipalName
  • Type: String
WindowsLiveID *
  • Field Name: WindowsLiveID
  • Type: String
CertificateSubject This parameter is available only in on-premises Exchange 2016. The CertificateSubject parameter specifies the value of the subject field of the user's digital certificate.
  • Field Name: CertificateSubject.[n]
  • Type: Array
SeniorityIndex * 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.
  • Field Name: SeniorityIndex
  • Type: Integer
Guid *
  • Field Name: Guid
  • Type: String
RecipientType *
  • Field Name: RecipientType
  • Type: String
AllowUMCallsFromNonUsers * The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from directory searches.
  • Field Name: AllowUMCallsFromNonUsers
  • Type: String
DisplayName * 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 (").
  • Field Name: DisplayName
  • Type: String
OrganizationId *
  • Field Name: OrganizationId
  • Type: String
UMCallingLineIds This parameter is available only in on-premises Exchange 2016. 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.
  • Field Name: UMCallingLineIds.[n]
  • Type: Array
ResetPasswordOnNextLogon * 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.
  • Field Name: ResetPasswordOnNextLogon
  • Type: Boolean
PostOfficeBox The PostOfficeBox parameter specifies the user's post office box number.
  • Field Name: PostOfficeBox.[n]
  • Type: Array
LinkedMasterAccount * This parameter is available only in on-premises Exchange 2016. 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.
  • Field Name: LinkedMasterAccount
  • Type: String
WhenSoftDeleted *
  • Field Name: WhenSoftDeleted
  • Type: String
SidHistory *
  • Field Name: SidHistory
  • Type: String
RemotePowerShellEnabled * 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.
  • Field Name: RemotePowerShellEnabled
  • Type: Boolean
AccountDisabled *
  • Field Name: AccountDisabled
  • Type: Boolean
IsSecurityPrincipal *
  • Field Name: IsSecurityPrincipal
  • Type: Boolean
DistinguishedName *
  • Field Name: DistinguishedName
  • Type: String
OtherTelephone The OtherTelephone parameter specifies the user's alternative telephone number.
  • Field Name: OtherTelephone.[n]
  • Type: Array
UMDialPlan *
  • Field Name: UMDialPlan
  • Type: String
MicrosoftOnlineServicesID *
  • Field Name: MicrosoftOnlineServicesID
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
MailboxRegionLastUpdateTime *
  • Field Name: MailboxRegionLastUpdateTime
  • Type: String
UpgradeDetails *
  • Field Name: UpgradeDetails
  • Type: String
StsRefreshTokensValidFrom *
  • Field Name: StsRefreshTokensValidFrom
  • Type: String
  • Format: date-time
UpgradeStageTimeStamp *
  • Field Name: UpgradeStageTimeStamp
  • Type: String
SamAccountName * This parameter is available only in on-premises Exchange 2016. 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 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.
  • Field Name: SamAccountName
  • Type: String
ObjectCategory *
  • Field Name: ObjectCategory
  • Type: String
RecipientTypeDetails * The RecipientTypeDetails parameter specifies the type of recipients returned. Recipient types are divided into recipient types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory that has an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails parameter. For example, a conference room mailbox has RecipientTypeDetails set to ConferenceRoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox. You can select from the following values: ArbitrationMailbox ConferenceRoomMailbox Contact DiscoveryMailbox DynamicDistributionGroup EquipmentMailbox ExternalManagedContact ExternalManagedDistributionGroup LegacyMailbox LinkedMailbox MailboxPlan MailContact MailForestContact MailNonUniversalGroup MailUniversalDistributionGroup MailUniversalSecurityGroup MailUser PublicFolder RoleGroup RoomList RoomMailbox SharedMailbox SystemAttendantMailbox SystemMailbox User UserMailbox
  • Field Name: RecipientTypeDetails
  • Type: String
IsValid *
  • Field Name: IsValid
  • Type: Boolean
WhenChanged *
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
DirectReports
  • Field Name: DirectReports.[n]
  • Type: Array
ObjectState *
  • Field Name: ObjectState
  • Type: String
UpgradeMessage *
  • Field Name: UpgradeMessage
  • Type: String
StateOrProvince * The StateOrProvince parameter specifies the user's state or province.
  • Field Name: StateOrProvince
  • Type: String
MailboxLocations
  • Field Name: MailboxLocations.[n]
  • Type: Array
FirstName * The FirstName parameter specifies the user's first name.
  • Field Name: FirstName
  • Type: String
NetID *
  • Field Name: NetID
  • Type: String
LastName * The LastName parameter specifies the user's last name.
  • Field Name: LastName
  • Type: String
PhoneticDisplayName * 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 (").
  • Field Name: PhoneticDisplayName
  • Type: String
SKUAssigned *
  • Field Name: SKUAssigned
  • Type: String
ConsumerNetID *
  • Field Name: ConsumerNetID
  • Type: String
PSComputerName
  • Field Name: PSComputerName
  • Type: String
AssistantName * The AssistantName parameter specifies the name of the user's assistant.
  • Field Name: AssistantName
  • Type: String
Phone * The Phone parameter specifies the user's office telephone number.
  • Field Name: Phone
  • Type: String
Identity * The Identity parameter the user that you want to view. You can use any value that uniquely identifies the user. For example: Name Display name Distinguished name (DN) Canonical DN GUID
  • Field Name: Identity
  • Type: String
UserAccountControl *
  • Field Name: UserAccountControl
  • Type: String
PostalCode * The PostalCode parameter specifies the user's zip code or postal code.
  • Field Name: PostalCode
  • Type: String
ExternalDirectoryObjectId *
  • Field Name: ExternalDirectoryObjectId
  • Type: String
Office * The Office parameter specifies the user's physical office name or number.
  • Field Name: Office
  • Type: String
PreviousRecipientTypeDetails *
  • Field Name: PreviousRecipientTypeDetails
  • Type: String
UpgradeStatus *
  • Field Name: UpgradeStatus
  • Type: String
WhenChangedUTC *
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
City * The City parameter specifies the user's city.
  • Field Name: City
  • Type: String
WhenCreatedUTC *
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
IsDirSynced *
  • Field Name: IsDirSynced
  • Type: Boolean
UpgradeStage *
  • Field Name: UpgradeStage
  • Type: String
Sid *
  • Field Name: Sid
  • Type: String
UMDtmfMap 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:<intgers2>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values.
  • Field Name: UMDtmfMap.[n]
  • Type: Array
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
Pager * The Pager parameter specifies the user's pager number.
  • Field Name: Pager
  • Type: String
IsSoftDeletedByDisable *
  • Field Name: IsSoftDeletedByDisable
  • Type: Boolean
SimpleDisplayName * 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>", """, "'", "(", ")", "+", ",", "-", ".", "/", ":", and "?".
  • Field Name: SimpleDisplayName
  • Type: String
IsLinked *
  • Field Name: IsLinked
  • Type: Boolean
Name * 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 (").
  • Field Name: Name
  • Type: String
MailboxRegion *
  • Field Name: MailboxRegion
  • Type: String
Manager * The Manager parameter specifies the user's manager.
  • Field Name: Manager
  • Type: String
WhenCreated *
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
HomePhone * The HomePhone parameter specifies the user's home telephone number.
  • Field Name: HomePhone
  • Type: String
OtherFax The OtherFax parameter specifies the user's alternative fax number.
  • Field Name: OtherFax.[n]
  • Type: Array
CountryOrRegion * The CountryOrRegion parameter specifies the user's country or region.
  • Field Name: CountryOrRegion
  • Type: String
Id *
  • Field Name: Id
  • Type: String
OrganizationalUnit * The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: Name Canonical name Distinguished name (DN) GUID
  • Field Name: OrganizationalUnit
  • Type: String