Chat now with support
Chat with Support

Active Roles 7.3.1 - Synchronization Service Administrator Guide

Synchronization Service Overview Deploying Synchronization Service Getting started Connections to external data systems
External data systems supported out of the box
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Sample queries to modify SQL Server data Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft Office 365 Working with Microsoft Azure Active Directory
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 Appendix A: Developing PowerShell scripts for attribute synchronization rules Appendix B: Using a PowerShell script to transform passwords

Domain object attributes

Domain object attributes

 

Table 80: Domain attributes

Attribute

Description

Supported operations

Authentication

Gets the authentication method with which the domain in Office 365 authenticates users.

This attribute can take one of the following values:

  • Managed. Indicates that the domain uses Office 365 authentication.
  • Federated. Indicates that the domain uses Single Sign-on (SSO) to authenticate users.

Read

DomainName

Gets the domain name in Office 365.

Read

DomainServices

Gets the Office 365 services available in the domain.

Read

IsDefault

Gets whether the domain is default in Office 365.

Read

IsInitial

Gets whether the domain is initial in Office 365.

Read

ObjectID

Gets the unique object identifier (GUID).

Read

Status

Gets whether the domain is verified with Office 365. This attribute can take one of the following values:

  • Verified. Indicates that the domain is verified.
  • Unverified. Indicates that the domain is not verified.

Read

DynamicDistributionGroup object attributes

DynamicDistributionGroup object attributes

 

Table 81: DynamicDistributionGroup attributes

Attribute

Description

Supported operations

AcceptMessagesOnlyFrom

Gets or sets the senders that can send email messages to the dynamic distribution group.

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

AcceptMessagesOnlyFromDL
Members

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

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

AcceptMessagesOnlyFromSenders
OrMembers

Gets or sets the senders who can send email messages to the dynamic distribution group.

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 dynamic distribution group.

Read, Write

BypassModerationFromSendersOr
Members

Gets or sets the senders whose messages bypass moderation for the dynamic distribution group.

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 dynamic distribution group.

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox
  • MailUser

Read, Write

ConditionalCustomAttribute1

Allow you to get or set recipients based on the corresponding CustomAttribute<Number> value.

For example, ConditionalCustomAttribute1 corresponds to CustomAttribute1, ConditionalCustomAttribute2 corresponds to CustomAttribute2, and so on.

Read, Write

ConditionalCustomAttribute2

ConditionalCustomAttribute3

ConditionalCustomAttribute4

ConditionalCustomAttribute5

ConditionalCustomAttribute6

ConditionalCustomAttribute7

ConditionalCustomAttribute8

ConditionalCustomAttribute9

ConditionalCustomAttribute10

ConditionalCustomAttribute11

ConditionalCustomAttribute12

ConditionalCustomAttribute13

ConditionalCustomAttribute14

ConditionalCustomAttribute15

ConditionalDepartment

Uses the Department field to get or set the recipients used to build the dynamic distribution group.

A comma that separates values of this multivalued attribute acts as the OR operator.

Read, Write

NOTE: When writing data using this attribute, you cannot use the RecipientFilter attribute to write data.

ConditionalStateOrProvince

Uses the State/Province field to get or set the recipients used to build the dynamic distribution group.

A comma that separates values of this multivalued attribute acts as the OR operator.

Read, Write

CustomAttribute1

Get or set the additional custom values you specify.

Read, Write

CustomAttribute2

CustomAttribute3

CustomAttribute4

CustomAttribute5

CustomAttribute6

CustomAttribute7

CustomAttribute8

CustomAttribute9

CustomAttribute10

CustomAttribute11

CustomAttribute12

CustomAttribute13

CustomAttribute14

CustomAttribute15

DisplayName

Gets or sets the display name of the dynamic distribution group.

Read, Write

EmailAddresses

Gets or sets the email addresses of the dynamic distribution group. When specifying two or more email addresses in this multivalued attribute, use a comma as a separator.

Read, Write

GrantSendOnBehalfTo

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

This reference attribute only accepts the following object type:

  • Mailbox

Read, Write

IncludedRecipients

Gets or sets the recipient types used to build the dynamic distribution group.

This attribute can take the following values:

  • AllRecipients
  • MailContacts
  • MailGroups
  • MailUsers
  • MailboxUsers
  • Resources
  • None

NOTE:

You can use combinations of these values, except the AllRecipients value. No other value can be used along with the AllRecipients value.

Read, Write

LdapRecipientFilter

Gets the recipient filter that was created by using the RecipientFilter attribute.

Read

ManagedBy

Gets or sets the owner of the dynamic distribution group.

This reference attribute accepts the following object types:

  • Mailbox
  • MailUser

Read, Write

ManagedBy

Gets or sets the name of the mail-enabled user, group, or contact displayed on the Managed by tab of the Active Directory object.

This reference attribute accepts the name in one of the following formats:

  • Alias
  • Canonical DN
  • Display Name
  • Distinguished Name (DN)
  • Domain\Account
  • GUID
  • Immutable ID
  • Legacy Exchange DN
  • SMTP Address
  • User Principal Name

This reference attribute accepts the following object types:

  • Mailbox
  • MailUser

Read, Write

ModeratedBy

Gets or sets the users who are moderating the messages sent to the dynamic distribution group.

To specify multiple users, use a comma as a separator.

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 dynamic distribution group.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

Name

Gets or sets the name of the dynamic distribution group.

Read, Write

Notes

Gets or sets comments for the dynamic distribution group.

Read, Write

ObjectID

Gets the unique object identifier (GUID).

Read

PhoneticDisplayName

Gets or sets a phonetic pronunciation of the value specified in the DisplayName attribute.

Read, Write

PrimarySmtpAddress

Gets or sets the primary return SMTP email address of the dynamic distribution group. You can use this attribute if the group has two or more SMTP email addresses.

Read, Write

RecipientContainer

Gets or sets the recipients used to build the dynamic distribution group, based on their location in Active Directory.

This attribute can take the canonical name of the Active Directory organizational unit (OU) or domain where the recipients reside.

When this attribute is omitted, the local container is used.

Read, Write

RecipientFilter

Gets or sets the mail-enabled recipients to be included in the dynamic distribution group. This attribute accepts OPATH filtering syntax.

Syntax example:

((Company -eq 'MyCompany') -and (City -eq 'London'))

Read, Write

When writing data using this attribute, you cannot use any of the following attributes to write data:

  • IncludedRecipients
  • ConditionalCompany
  • ConditionalCustomAttribute <Number>
  • ConditionalDepartment
  • ConditionalStateOrProvince

RejectMessagesFrom

Gets or sets the senders whose messages to the dynamic distribution group are rejected.

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

  • Alias
  • Canonical DN
  • Display name
  • Distinguished name (DN)
  • Domain\account
  • GUID
  • Immutable ID
  • Legacy Exchange DN
  • SMTP address
  • User principal name

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 dynamic distribution group (their messages are rejected).

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

  • Alias
  • Canonical DN
  • Display name
  • Distinguished name (DN)
  • Domain\account
  • GUID
  • Immutable ID
  • Legacy Exchange DN
  • SMTP address
  • User principal name

This reference attribute accepts the following object types:

  • DistributionGroup
  • DynamicDistributionGroup

Read, Write

RejectMessagesFromSendersOr
Members

Gets or sets the senders that cannot send email messages to the dynamic distribution group (their messages are rejected).

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

  • Alias
  • Canonical DN
  • Display name
  • Distinguished name (DN)
  • Domain\account
  • GUID
  • Immutable ID
  • Legacy Exchange DN
  • SMTP address
  • User principal name

This reference attribute accepts the following object types:

  • Contact
  • DistributionGroup
  • DynamicDistributionGroup
  • Mailbox

Read, Write

ReportToManagerEnabled

Gets or sets a value that specifies whether or not to send delivery reports to the dynamic distribution group manager.

This Boolean attribute can take one of the following values:

TRUE. Indicates that delivery reports are enabled.

FALSE (default). Indicates that delivery reports are disabled.

Read, Write.

ReportToOriginatorEnabled

Gets or sets a value that specifies whether or not to send a delivery reports to the user who sent an e-mail message to the dynamic distribution group.

This Boolean attribute can take one of the following values:

  • TRUE. Indicates that delivery reports are enabled.
  • FALSE (default). Indicates that delivery reports are disabled.

Read, Write

SendModerationNotifications

Gets or sets whether or not to send a notification to the sender whose message to the moderated dynamic distribution group is rejected by a moderator.

This attribute can take one of the following values:

  • Always. Indicates that moderation notifications are sent to all senders.
  • Internal. Indicates that moderation notifications are sent to the internal senders only.
  • Never. Indicates that moderation notifications are disabled.

Read, Write

SendOofMessageToOriginator
Enabled

Gets or sets a value that specifies whether or not to deliver out-of-office messages to the user who sent an e-mail message to the dynamic distribution group.

This attribute can take one of the following values:

  • TRUE
  • FALSE

Read, Write

ExternalAccessPolicy object attributes

ExternalAccessPolicy object attributes

 

Table 82: ExternalAccessPolicy attributes

Attribute

Description

Supported operations

Anchor

Gets the Anchor property value of the policy.

Read

Description

Gets the policy description.

Read

Identity

Gets the unique identifier assigned to the policy.

Read

Members

Gets the users who have been assigned the policy.

Read

ObjectID

Gets the unique object identifier (GUID).

Read

HostedVoicemailPolicy object attributes

HostedVoicemailPolicy object attributes

 

Table 83: HostedVoicemailPolicy attributes

Attribute

Description

Supported operations

Anchor

Gets the Anchor property value of the policy.

Read

Description

Gets the policy description.

Read

Identity

Gets the unique identifier assigned to the policy.

Read

Members

Gets the users who have been assigned the policy.

Read

ObjectID

Gets the unique object identifier (GUID).

Read

Related Documents