Converse agora com nosso suporte
Chat com o suporte

Active Roles 8.0.1 LTS - Synchronization Service Administration Guide

Synchronization Service Overview Deploying Synchronization Service Getting started Connections to external data systems
External data systems supported with built-in connectors
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Oracle Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Working with Micro Focus NetIQ Directory Working with Salesforce Working with ServiceNow Working with Oracle Unified Directory Working with an LDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with an OpenLDAP directory service Working with IBM RACF connector Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft 365
Creating a Microsoft 365 connection Modifying a Microsoft 365 connection Microsoft 365 data supported for data synchronization
ClientPolicy object attributes supported for Microsoft 365 data synchronization ConferencingPolicy object attributes supported for Microsoft 365 data synchronization Contact object attributes supported for Microsoft 365 data synchronization DistributionGroup object attributes supported for Microsoft 365 data synchronization Domain object attributes supported for Microsoft 365 data synchronization DynamicDistributionGroup object attributes supported for Microsoft 365 data synchronization ExternalAccessPolicy object attributes supported for Microsoft 365 data synchronization HostedVoicemailPolicy object attributes supported for Microsoft 365 data synchronization LicensePlanService object attributes supported for Microsoft 365 data synchronization Mailbox object attributes supported for Microsoft 365 data synchronization MailUser object attributes supported for Microsoft 365 data synchronization PresencePolicy object attributes supported for Microsoft 365 data synchronization SecurityGroup object attributes supported for Microsoft 365 data synchronization SPOSite object attributes supported for Microsoft 365 data synchronization SPOSiteGroup object attributes supported for Microsoft 365 data synchronization SPOWebTemplate object attributes supported for Microsoft 365 data synchronization SPOTenant object attributes supported for Microsoft 365 data synchronization User object attributes supported for Microsoft 365 data synchronization VoicePolicy object attributes supported for Microsoft 365 data synchronization Microsoft 365 Group attributes supported for Microsoft 365 data synchronization Changing the display names of synchronized Microsoft 365 licenses and services
Objects and attributes specific to Microsoft 365 services How the Microsoft 365 Connector works with data
Working with Microsoft Azure Active Directory Configuring data synchronization with the SCIM Connector Configuring data synchronization with the Generic SCIM Connector
Using connectors installed remotely Creating a connection Renaming a connection Deleting a connection Modifying synchronization scope for a connection Using connection handlers Specifying password synchronization settings for a connection
Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use
About scenarios Scenario 1: Create users from a .csv file to an Active Directory domain Scenario 2: Use a .csv file to update user accounts in an Active Directory domain Scenario 3: Synchronizing data between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 4: Deprovisioning between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 5: Provisioning of Groups between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 6: Enabling Delta Sync mode between One Identity Manager Custom Target Systems and an Active Directory domain Example of using the Generic SCIM Connector for data synchronization
Appendix A: Developing PowerShell scripts for attribute synchronization rules Appendix B: Using a PowerShell script to transform passwords

Mailbox object attributes supported for Microsoft 365 data synchronization

The Office 365 Connector supports the following Mailbox attributes for synchronization.

Table 97: Mailbox attributes

Attribute

Description

Supported operations

AcceptMessagesOnlyFrom

Gets or sets the senders that can send email messages to the object.

This reference attribute accepts any of the following values for the distribution groups:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • MailUser
  • Mailbox
  • Contact

Read, Write

AcceptMessagesOnlyFromDLMembers

Gets or sets the distribution groups whose members are allowed to send email messages to the object.

This reference attribute accepts any of the following values for the distribution groups:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

AcceptMessagesOnlyFromSendersOrMembers

Gets or sets the senders who can send email messages to the object.

This reference attribute can take any of the following values for the senders:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

Alias

Gets or sets the alias of the object.

Read, Write

ApplyMandatoryProperties

Sets whether to modify the mandatory properties of a legacy mailbox.

For example, you can use this attribute to remove the legacyMailbox tag from a legacy mailbox residing on an Exchange Server, or check whether this tag exists on the mailbox.

This attribute can take one of the following values:

  • TRUE: Specifies that the legacyMailbox tag does not exist on the mailbox.
  • FALSE: Specifies that the legacyMailbox tag exists on the mailbox.

Write

ArchiveName

Gets or sets the name of the object. This is the name displayed on the user interface in Outlook Web App and Microsoft Outlook.

Read, Write

AuditAdmin

Gets or sets the operations to log for administrators.

This attribute can take the following values:

  • None
  • Update
  • Copy
  • Move
  • MoveToDeletedItems
  • SoftDelete
  • HardDelete
  • FolderBind
  • SendAs
  • SendOnBehalf
  • MessageBind

To enable mailbox audit logging, set the value of the AuditEnabled attribute to TRUE.

Read, Write

AuditDelegate

Gets or sets the operations to log for delegate users.

This attribute can take the following values:

  • None
  • Update
  • Move
  • MoveToDeletedItems
  • SoftDelete
  • HardDelete
  • FolderBind
  • SendAs
  • SendOnBehalf

To enable mailbox audit logging, set the value of the AuditEnabled attribute to TRUE.

Read, Write

AuditEnabled

Gets or sets whether mailbox audit logging is enabled or disabled. If mailbox audit logging is enabled, the operations specified for the AuditAdmin, AuditDelegate, and AuditOwner attributes will be logged.

This attribute can take one of the following values:

  • TRUE: Enables mailbox audit logging.
  • FALSE: Disables mailbox audit logging.

Read, Write

AuditLogAgeLimit

Gets or sets the retention period for the mailbox audit logs. Logs whose age exceeds the specified retention period will be deleted.

This attribute accepts the retention period in the following format: DD.HH:MM:SS

The maximum value the attribute can accept is 24855.03:14:07

Examples of use
  • A value of 30.05:00:00 retains mailbox audit logs for 30 days and 5 hours.

  • A value of 00.00:00:00 retains mailbox audit logs indefinitely, and will never be deleted.

Read, Write

BypassModerationFromSendersOrMembers

Gets or sets the senders whose messages bypass moderation for the object.

This reference attribute can take any of the following values for the senders:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Legacy Exchange DN
  • Primary SMTP email address

The values in this attribute do not apply to the senders that are the moderators of the mailbox.

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

CalendarRepairDisabled

Gets or sets whether the calendar items in the mailbox can be repaired by the Calendar Repair Assistant.

This attribute can take one of the following values:

  • TRUE: Enables repair operations.
  • FALSE: Disables repair operations.

Read, Write

CalendarVersionStoreDisabled

Gets or sets whether to log calendar changes for the object.

This attribute can take one of the following values:

  • TRUE: Calendar changes will be logged.

  • FALSE: Calendar changes will not be logged.

Read, Write

CreateDTMFMap

Sets whether to create a dual-tone multi-frequency (DTMF) map for the object.

This attribute can take one of the following values:

  • TRUE. Specifies to create a DTMF map for the object.
  • FALSE. Specifies not to create a DTMF map for the object.

Write

CustomAttribute1

Gets or sets the additional custom values you specified.

Read, Write

CustomAttribute2

CustomAttribute3

CustomAttribute4

CustomAttribute5

CustomAttribute6

CustomAttribute7

CustomAttribute8

CustomAttribute9

CustomAttribute10

CustomAttribute11

CustomAttribute12

CustomAttribute13

CustomAttribute14

CustomAttribute15

DeliverToMailboxAndForward

Gets or sets whether this mailbox receives forwarded messages if message forwarding to another address is configured for the mailbox.

This attribute can take one of the following values:

  • TRUE:Messages are delivered to this object and to the forwarding address.
  • FALSE: Messages are delivered to the forwarding address only and not to this object.

Read, Write

DisplayName

Gets or sets the display name used in Microsoft 365 for the object.

Read, Write

EmailAddresses

Gets or sets all the proxy addresses of the object. The proxy addresses also include the primary SMTP address.

NOTE: When writing proxy addresses using this attribute, make sure the specified addresses are valid, as they are not validated by Exchange.

Read, Write

EndDateForRetentionHold

Gets or sets the retention hold end date for messaging records management (MRM).

TIP: To enable or disable retention hold, use the RetentionHoldEnabled attribute.

Read, Write

ExternalDirectoryObjectId

Gets the globally unique identifier (GUID) of the object.

Read

ExternalOofOptions

Gets or sets whether out-of-office (OoO) messages are sent to external senders.

This attribute can take one of the following values:

  • External: OoO messages are sent for external senders as well.
  • InternalOnly: OoO messages are sent only for messages originating from your organization.

Read, Write

ExtensionCustomAttribute1

Gets or sets the additional custom values you specify. These attributes are multivalued.

TIP: To specify multiple values, use comma as a separator.

Read, Write

ExtensionCustomAttribute2

ExtensionCustomAttribute3

ExtensionCustomAttribute4

ExtensionCustomAttribute5

ForwardingAddress

Gets or sets a forwarding address for the mailbox.

Read, Write

ForwardingSmtpAddress

Gets or sets a forwarding SMTP address for the mailbox.

Read, Write

GrantSendOnBehalfTo

Gets or sets the distinguished name (DN) of other senders that can send messages on behalf of the object.

Read, Write

HiddenFromAddressListsEnabled

Gets or sets whether Microsoft 365 hides the object from address lists.

This attribute can take one of the following values:

  • TRUE: Hides the object from address lists.
  • FALSE (default): Shows the object in address lists.

Read, Write

ImmutableId

Gets or sets a unique immutable ID in the form of an SMTP address.

NOTE: The Office 365 Connector can read the value of this attribute only if it is stored in Microsoft 365 in a base64 encoding format. If the attribute value is stored in any other format, the connector will return an error when reading that value.

Read, Write

IsEquipment

Gets or sets whether the mailbox belongs to a piece of equipment.

This attribute can take one of the following values:

  • TRUE: Indicates an equipment mailbox.
  • FALSE: Indicates that the mailbox is not assigned to a piece of equipment.

Read, Write

IsRegular

Gets or sets whether the mailbox belongs to a user.

This attribute can take one of the following values:

  • TRUE: Indicates that the mailbox belongs to a user.
  • FALSE Indicates that the mailbox is not assigned to a user.

Read, Write

IsRoom

Gets or sets whether the mailbox belongs to a room.

This attribute can take one of the following values:

  • TRUE: Indicates that the mailbox belongs to a room.
  • FALSE: Indicates that the mailbox is not assigned to a room.

Read, Write

IsShared

Gets or sets whether the mailbox is shared.

This attribute can take one of the following values:

  • TRUE: Indicates that the mailbox is shared.
  • FALSE: Indicates that the mailbox is not shared.

Read, Write

IssueWarningQuota

Gets or sets the mailbox size at which a warning message is sent to the mailbox user.

To specify a mailbox size, use an integer value. To disable the quota, set the value of this attribute to Unlimited.

NOTE: The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

IsValid

Gets whether or not the mailbox object is configured correctly.

This attribute can take one of the following values:

  • TRUE: Indicates that the mailbox is correctly configured.
  • FALSE Indicates that the mailbox is configured incorrectly.

Read

Languages

Gets or sets preferred languages for the object in the order of their priority.

Read, Write

LitigationHoldDate

Gets or sets the date when the mailbox is placed on litigation hold. This date is used only for informational or reporting purposes.

Read, Write

LitigationHoldDuration

Gets or sets the litigation hold duration for the mailbox in days.

Read, Write

LitigationHoldEnabled

Gets or sets whether litigation hold is enabled for the mailbox.

When a mailbox is on litigation hold, messages cannot be deleted from the mailbox.

This attribute can take one of the following values:

  • TRUE: Litigation hold is enabled.
  • FALSE: Litigation hold is disabled.

Read, Write

LitigationHoldOwner

Gets or sets the user who put the mailbox on litigation hold.

Read, Write

MailboxPlan

Gets or sets the mailbox plan name associated with the mailbox.

TIP: When setting a mailbox plan, make sure that the plan is available in the organization of the mailbox.

Read, Write

MailTip

Gets or sets the message displayed to senders when they start writing an email message to the object.

Read, Write

MailTipTranslations

Gets or sets the MailTip message translations in additional languages.

This attribute accepts the following format:

<LanguageLocale>:<MailTip
MessageTranslation>

NOTE: MailTip message translations cannot be longer than 250 characters.

Read, Write

MessageTrackingReadStatusEnabled

Gets or sets whether the read status of sent messages is provided to the senders who sent messages to this mailbox.

This attribute can take one of the following values:

  • TRUE: Message tracking is enabled.
  • FALSE: Message tracking is disabled.

Read, Write

ModeratedBy

Gets or sets the users who are moderating the messages sent to the object.

TIP: To specify multiple users as moderators, use comma as separator.

NOTE: This reference attribute is required if you set the value of the ModerationEnabled attribute to TRUE.

This reference attribute accepts the following object types:

Mailbox

MailUser

Read, Write

ModerationEnabled

Gets or sets whether moderation is enabled for the object.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

Name

Gets or sets the name of the object.

This is the name that appears in the Active Directory Users and Computers tool.

Read, Write

ObjectID

Gets the globally unique object identifier (GUID) of the object.

Read

Office

Gets or sets the company office location associated with the object.

Read, Write

Password

Sets the password for the user account associated with the mailbox.

Write

PrimarySmtpAddress

Gets or sets the primary SMTP email address of the object.

NOTE: You can use this attribute if the object has two or more SMTP email addresses configured.

For external recipients, the email address specified with this attribute will appear.

Read, Write

ProhibitSendQuota

Gets or sets the mailbox size at which the mailbox user can no longer send messages.

To specify a mailbox size, use an integer value. To disable the quota, set the value of this attribute to Unlimited.

NOTE: The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

ProhibitSendReceiveQuota

Gets or sets the mailbox size at which the mailbox user can no longer send or receive messages.

To specify a mailbox size, use an integer value. To disable the quota, set the value of this attribute to Unlimited.

NOTE: The value set on a mailbox by using this attribute overrides the value specified for the entire mailbox database.

Read, Write

RejectMessagesFrom

Gets or sets the senders whose messages to the object will be rejected.

This reference attribute accepts the following object types:

  • Contact
  • Mailbox

Read, Write

RejectMessagesFromDLMembers

Gets or sets the distribution groups whose members cannot send email messages to the object (their messages will be rejected).

This reference attribute accepts the following object types:

  • DistributionGroup

  • DynamicDistributionGroup

Read, Write

RejectMessagesFromSendersOrMembers

Gets or sets the senders that cannot send email messages to the object (their messages will be rejected).

This attribute can take any of the following values for the recipients:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name
  • Alias
  • Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox

Read, Write

RequireSenderAuthenticationEnabled

Gets or sets whether the senders that send messages to this object must be authenticated.

This attribute can take one of the following values:

  • TRUE: Messages sent to this object must be authenticated.
  • FALSE: No message authentication is required.

Read, Write

ResourceCapacity

Gets or sets the maximum number of people that can be accommodated by the room to which the mailbox belongs.

Read, Write

ResourceCustom

Gets or sets additional information about the resource.

Read, Write

RetainDeletedItemsFor

Gets or sets the duration of keeping deleted items.

This attribute accepts a value in the following format: DD.HH:MM:SS

For example, a value of 10.00:00:00 means that deleted items are retained for 10 days.

Read, Write

RetentionComment

Gets or sets a comment onhold status of the user. This comment is also displayed in Outlook.

NOTE: You can only write the value of this attribute if the value of the RetentionHoldEnabled attribute is set to TRUE.

Read, Write

RetentionHoldEnabled

Gets or sets whether retention hold is enabled for messaging retention policies.

This attribute can take one of the following values:

  • TRUE: Retention hold is enabled.
  • FALSE: Retention hold is disabled.

Read, Write

RetentionPolicy

Gets or sets the name of the retention policy to apply to the folders and mail items of this mailbox.

Read, Write

RetentionUrl

Gets or sets the URL of the web page providing additional details about the messaging retention policies in effect within the organization.

Read, Write

RoleAssignmentPolicy

Gets or sets the management role assignment policy to assign to the mailbox when it is created or enabled.

TIP: Consider the following when using this attribute:

  • If the assignment policy name you want to specify contains spaces, put the name in quotation marks (").

  • If you omit this attribute when creating or enabling a mailbox, the system will use the default assignment policy.

  • If you do not want to assign an assignment policy, leave this attribute empty.

Read, Write

RulesQuota

Gets or sets the size limit for the rules specified for the mailbox.

Qualify the value you specify in this attribute by appending either B (bytes) or KB (kilobytes): for example, 64 B or 256 KB.

Unqualified values are considered bytes. The maximum value this attribute can accept is 256 KB.

Read, Write

SecondaryAddress

Gets or sets the secondary address for the object if it has Unified Messaging enabled.

Write

SecondaryDialPlan

Sets the secondary Unified Messaging dial plan for the object.

Write

SendModerationNotifications

Gets or sets whether to send status notifications to users when a message they sent to the moderated object is rejected by a moderator.

This attribute can take one of the following values:

  • Always: Specifies that notifications are sent to all senders.
  • Internal: Specifies that notifications are only sent to the senders internal to your organization.
  • Never: Specifies that all status notifications are disabled.

Read, Write

SharingPolicy

Gets or sets the sharing policy associated with the mailbox.

Read, Write

SimpleDisplayName

Gets or sets an alternate description of the object if only a limited set of characters is allowed.

The limited set of characters includes ASCII characters 26–126.

Read, Write

SingleItemRecoveryEnabled

Gets or sets whether the purging of recovery items is enabled or disabled.

This attribute can take one of the following values:

  • TRUE: Disables the purging of recovery items.
  • FALSE: Enables the purging of recovery items.

Read, Write

UMDtmfMap

Gets or sets whether to create a user-defined DTMF map for the object if it has Unified Messaging enabled.

Read, Write

UsageLocation

Gets a two-letter country code (for example, FR, GB or NL) that defines the location of the user. The usage location determines the services available to the user.

Read

UserCertificate

Gets or sets the digital certificate used to sign email messages of the user.

Read, Write

UserPrincipalName

Gets or sets the logon name of the mailbox user.

Read, Write

UserSMimeCertificate

Gets or sets the SMIME certificate used to sign email messages by the user.

Read, Write

MailUser object attributes supported for Microsoft 365 data synchronization

The Office 365 Connector supports the following MailUser attributes for synchronization.

Table 98: MailUser attributes

Attribute

Description

Supported operations

AcceptMessagesOnlyFrom

Gets or sets the senders that can send email messages to the object.

This reference attribute can take senders in any of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • Exchange DN
  • GUID
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • MailUser
  • Mailbox
  • Contact

Read, Write

AcceptMessagesOnlyFromDLMembers

Gets or sets the distribution groups whose members are allowed to send email messages to the object.

This reference attribute can take distribution groups in any of the following formats:

  • Canonical name
  • Display name
  • DN
  • GUID
  • Legacy Exchange DN
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

AcceptMessagesOnlyFromSendersOrMembers

Gets or sets the senders who can send email messages to the object.

This reference attribute can take senders in any of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

Alias

Gets or sets the alias of the object.

Read, Write

ArchiveName

Gets or sets the name of the object. This is the name displayed on the user interface in Outlook Web App and Microsoft Outlook.

Read

BypassModerationFromSendersOrMembers

Gets or sets the senders whose messages bypass moderation for the object.

This reference attribute can take any of the following values for the senders:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

Moderation does not apply to the senders designated as moderators for the mail user.

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

CalendarVersionStoreDisabled

Gets or sets whether to log calendar changes for the object.

This attribute can take one of the following values:

  • TRUE: Calendar changes will be logged.

  • FALSE: Calendar changes will not be logged.

Read, Write

CreateDTMFMap

Sets whether to create a dual-tone multi-frequency (DTMF) map for the object.

This attribute can take one of the following values:

  • TRUE. Specifies to create a DTMF map for the object.
  • FALSE. Specifies not to create a DTMF map for the object.

Write

CustomAttribute1

Gets or sets the additional custom values you specified.

Read, Write

CustomAttribute2

CustomAttribute3

CustomAttribute4

CustomAttribute5

CustomAttribute6

CustomAttribute7

CustomAttribute8

CustomAttribute9

CustomAttribute10

CustomAttribute11

CustomAttribute12

CustomAttribute13

CustomAttribute14

CustomAttribute15

DeliverToMailboxAndForward

Gets whether messages sent to the mail user are forwarded to another address in case message forwarding is configured.

This attribute can take one of the following values:

  • TRUE:Messages are delivered to this object and to the forwarding address.
  • FALSE: Messages are delivered to the forwarding address only and not to this object.

Read

DisplayName

Gets or sets the display name used in Microsoft 365 for the object.

Read, Write

EmailAddresses

Gets or sets the email alias(es) of the object.

TIP: To specify multiple email addresses, use comma (,) as a separator.

Read, Write

EndDateForRetentionHold

Gets the retention hold end date for messaging records management (MRM).

TIP: To enable or disable retention hold, use the RetentionHoldEnabled attribute.

Read

ExtensionCustomAttribute1

Gets or sets the additional custom values you specify. These attributes are multivalued.

TIP: To specify multiple values, use comma as a separator.

Read, Write

ExtensionCustomAttribute2

ExtensionCustomAttribute3

ExtensionCustomAttribute4

ExtensionCustomAttribute5

ExternalDirectoryObjectId

Gets the globally unique identifier (GUID) of the object.

Read

ExternalEmailAddress

Gets or sets an email address outside of the organization of the mail user.

Messages sent to the mail user will be delivered to this external address.

Read, Write

FederatedIdentity

Allows you to associate an on-premises Active Directory user with the Microsoft 365 mail user.

Write

ForwardingAddress

Gets the forwarding address for the mail user.

Read

GrantSendOnBehalfTo

Gets or sets the distinguished name (DN) of other senders that can send messages on behalf of the object.

This reference attribute accepts the Mailbox object type only.

Read, Write

HiddenFromAddressListsEnabled

Gets or sets whether Microsoft 365 hides the object from address lists.

This attribute can take one of the following values:

  • TRUE: Hides the object from address lists.
  • FALSE (default): Shows the object in address lists.

Read, Write

ImmutableId

Gets or sets a unique immutable ID in the form of an SMTP address.

NOTE: The Office 365 Connector can read the value of this attribute only if it is stored in Microsoft 365 in a base64 encoding format. If the attribute value is stored in any other format, the connector will return an error when reading that value.

Read, Write

LitigationHoldDate

Gets the date when the mail user’s mailbox is placed on litigation hold.

Read

LitigationHoldEnabled

Gets whether litigation hold is enabled for the mailbox of the mail user.

When a mailbox is on litigation hold, messages cannot be deleted from the mailbox.

This attribute can take one of the following values:

  • TRUE: Litigation hold is enabled.
  • FALSE: Litigation hold is disabled.

Read

LitigationHoldOwner

Gets the user who enabled litigation hold on the mailbox. This attribute can only be used for informational or reporting purposes.

Read

MacAttachmentFormat

Gets or sets the Apple Macintosh operating system attachment format for messages sent to the object.

This attribute can take the following values:

  • BinHex
  • UuEncode
  • AppleSingle
  • AppleDouble

Read, Write

MailTip

Gets or sets the message displayed to senders when they start writing an email message to the object.

Read, Write

MailTipTranslations

Gets or sets the MailTip message translations in additional languages.

This attribute accepts the following format:

<LanguageLocale>:<MailTip
MessageTranslation>

NOTE: MailTip message translations cannot be longer than 250 characters.

Read, Write

MessageBodyFormat

Gets or sets the message body format for messages sent to the contact.

The values this attribute can write depend on the value in the MessageFormat attribute.

When the value of MessageFormat is Mime, the MessageBodyFormat attribute can write the following values:

  • Text
  • Html
  • TextAndHtml

When the value of MessageFormat is Text, the MessageBodyFormat attribute can only write the Text value.

Read, Write

MessageFormat

Gets or sets the message format for messages sent to the contact.

This attribute can take the following values:

  • Text
  • Mime

Read, Write

ModeratedBy

Gets or sets the users who are moderating the messages sent to the object.

TIP: To specify multiple users as moderators, use comma as separator.

NOTE: This reference attribute is required if you set the value of the ModerationEnabled attribute to TRUE.

This reference attribute accepts the following object types:

  • Mailbox
  • MailUser

Read, Write

ModerationEnabled

Gets or sets whether moderation is enabled for the object.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

Name

Gets or sets the name of the object.

Read, Write

ObjectID

Gets the globally unique object identifier (GUID) of the object.

Read

Password

Sets the password for the mail user.

Write

RejectMessagesFrom

Gets or sets the senders whose messages to the object will be rejected.

This attribute can take senders in one of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Name
  • Legacy Exchange DN
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • Contact
  • Mailbox

Read, Write

RejectMessagesFromDLMembers

Gets or sets the distribution groups whose members cannot send email messages to the object (their messages will be rejected).

This reference attribute can take distribution groups in one of the following formats:

  • Alias
  • Canonical name
  • Display name
  • DN
  • GUID
  • Legacy Exchange DN
  • Name
  • Primary SMTP email address

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

RequireSenderAuthenticationEnabled

Gets or sets whether the senders that send messages to this object must be authenticated.

This attribute can take one of the following values:

  • TRUE: Messages sent to this object must be authenticated.
  • FALSE: No message authentication is required.

Read, Write

RetainDeletedItemsFor

Gets for how long to keep deleted items for the mail user.

This attribute accepts a value in the following format: DD.HH:MM:SS

For example, a value of 10.00:00:00 means that deleted items are retained for 10 days.

Read

RetentionComment

Gets the comment on the hold status of the mail user. This comment is displayed in Outlook.

Read

RetentionHoldEnabled

Gets whether retention hold is enabled for messaging retention policies.

This attribute can take one of the following values:

  • TRUE: Retention hold is enabled.
  • FALSE: Retention hold is disabled.

Read

RetentionUrl

Gets the URL of the web page providing additional details about the messaging retention policies in effect within the organization.

Read

SecondaryAddress

Gets or sets the secondary address for the object if it has Unified Messaging enabled.

Write

SecondaryDialPlan

Sets the secondary Unified Messaging dial plan for the object.

Write

SendModerationNotifications

Gets or sets whether to send status notifications to users when a message they sent to the moderated object is rejected by a moderator.

This attribute can take one of the following values:

  • Always: Specifies that notifications are sent to all senders.
  • Internal: Specifies that notifications are only sent to the senders internal to your organization.
  • Never: Specifies that all status notifications are disabled.

Read, Write

SimpleDisplayName

Gets or sets an alternate description of the object if only a limited set of characters is allowed.

The limited set of characters includes ASCII characters 26–126.

Read, Write

SingleItemRecoveryEnabled

Gets whether the purging of recovery items is enabled.

This attribute can take one of the following values:

  • TRUE: Disables the purging of recovery items.
  • FALSE: Enables the purging of recovery items.

Read

StartDateForRetentionHold

Gets the start date of the retention hold.

TIP: To use this attribute, you must set the RetentionHoldEnabled attribute to TRUE.

Read

UMDtmfMap

Gets or sets whether to create a user-defined DTMF map for the object if it has Unified Messaging enabled.

Read, Write

UsageLocation

Gets a two-letter country code (for example, FR, GB or NL) that defines the location of the user. The usage location determines the services available to the user.

Read

UseMapiRichTextFormat

Gets or sets a format for the MAPI Rich Text Format messages sent to the object.

  • Never: Specifies to convert all messages sent to the object to the plain text format.
  • Always: Specifies to always use the MAPI Rich Text Format (RTF) for the messages sent to the object.
  • UseDefaultSettings: Specifies to use the message format set in the MAPI client that sent the message to the object.

Read, Write

NOTE: You can only write data by using this attribute when updating an existing object in Office 365.

UsePreferMessageFormat

Gets or sets whether the message format specified for the object overrides any global settings (for example, those configured for the remote domain).

This attribute can take one of the following values:

  • TRUE: Specifies that the message format set for the object overrides any global settings.
  • FALSE: Specifies that global settings have precedence over the mail format set for the object.

Read, Write

UserPrincipalName

Gets or sets the user principal name (UPN) of the mail user.

Read, Write

WindowsEmailAddress

Gets or sets the email address of the object stored in Active Directory.

Read, Write

PresencePolicy object attributes supported for Microsoft 365 data synchronization

The Office 365 Connector supports the following PresencePolicy attributes for synchronization.

Table 99: PresencePolicy attributes

Attribute

Description

Supported operations

Anchor

Gets the Anchor property value of the object.

Read

Description

Gets the description of the object.

Read

Identity

Gets the unique identifier assigned to the object.

Read

Members

Gets the users who have been assigned to the object.

Read

ObjectID

Gets the globally unique object identifier (GUID) of the object.

Read

SecurityGroup object attributes supported for Microsoft 365 data synchronization

The Office 365 Connector supports the following SecurityGroup attributes for synchronization.

Table 100: SecurityGroup attributes

Attribute

Description

Supported operations

Description

Gets or sets the description of the object.

Read, Write

DisplayName

Gets or sets the display name used in Microsoft 365 for the object.

Read, Write

Members

Gets or sets the users who have been assigned to the security group.

Read, Write

ObjectID

Gets the globally unique object identifier (GUID) of the object.

Read

Documentos relacionados

The document was helpful.

Selecione a classificação

I easily found the information I needed.

Selecione a classificação