Chat now with support
Chat with Support

Active Roles Sync Service 8.2 - Administration Guide

Synchronization Service overview Deploying Synchronization Service Deploying Synchronization Service for use with AWS Managed Microsoft AD 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 Database Working with Oracle Database user accounts 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 an OpenLDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with IBM RACF Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft 365 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 Developing PowerShell scripts for attribute synchronization rules Using PowerShell script to transform passwords

ClaimProvider object attributes

In a SharePoint connection, the Synchronization Service supports the following attributes of the ClaimProvider object with the following synchronization operations.

Table 57: ClaimProvider object attributes

Attribute

Type

Description

Supported operations

AssemblyName

Single-valued, string

Gets the name of the assembly that implements the claims provider.

Read

Description

Single-valued, string

Gets the description of the claims provider.

Read

DisplayName

Single-valued, string

Gets the display name of the claims provider.

Read

Id

Single-valued, string

Gets the object ID.

Read

IsEnabled

Single-valued, Boolean

Gets whether the claims provider is enabled.

Read

IsUsedByDefault

Single-valued, Boolean

Gets whether the claims provider applies by default to all web applications and zones.

Read

IsValid

Single-valued, Boolean

Gets whether the claims provider is valid.

Read

IsVisible

Single-valued, Boolean

Gets whether the claims provider is visible.

Read

Parent

Single-valued, string, reference (Farm object)

Gets the parent of the object.

Read

TypeName

Single-valued, string

Gets the type of the object.

Read

Farm object attributes

In a SharePoint connection, the Synchronization Service supports the following attributes of the Farm object with the following synchronization operations.

Table 58: Farm object attributes

Attribute

Type

Description

Supported operations

BuildVersion

Single-valued, string

Gets the build version of the SharePoint server farm.

Read

CanBackupRestoreAsConfiguration

Single-valued, Boolean

Gets whether the farm can participate in a configuration-only backup or restore.

Read

CanRenameOnRestore

Single-valued, Boolean

Gets whether the farm can be renamed during its restore.

Read

CanSelectForBackup

Single-valued, Boolean

Gets whether the farm can be selected for backup.

Read

CanSelectForRestore

Single-valued, Boolean

Gets whether the farm can be selected for restore in the Central Administration user interface.

Read

DaysBeforePasswordExpirationToSendEmail

Single-valued, integer

Gets the number of days before password expiration when a notification email is sent.

Read

DefaultServiceAccount

Single-valued, string

Gets the default service account.

Read

EncodedFarmId

Single-valued, integer

Gets the farm identifier.

Read

Id

Single-valued, string

Gets the object ID.

Read

Name

Single-valued, string

Gets the farm name.

Read

Parent

Single-valued, string

Gets the parent of the object.

Read

PasswordChangeEmailAddress

Single-valued, string

Gets the email address that receives password change notification messages.

Read

PasswordChangeGuardTime

Single-valued, integer

Gets the time interval (in seconds) that is used to wait for other computers’ response during password change operations.

Read

PasswordChangeMaximumTries

Single-valued, integer

Gets the maximum allowed number of password change attempts before the operation fails.

Read

PersistedFileChunkSize

Single-valued, integer

Gets the chunk size used to transfer files to or from the configuration database during a read or write operation.

Read

Products

Multivalued, string

Gets the identifiers of products installed in the farm.

Read

ServerDebugFlags

Multivalued, integer

Gets server debug flags.

Read

Servers

Multivalued, string

Gets the physical servers that are included in the farm.

Read

TimerService

Single-valued, string

Gets the timer service that is used by the farm.

Read

TraceSessionGuid

Single-valued, string

Gets the GUID that is used for trace session registration.

Read

UseMinWidthForHtmlPicker

Single-valued, Boolean

Gets the HTML select control.

Read

UserLicensingEnabled

Single-valued, Boolean

Gets whether user licensing is enabled.

Read

XsltTransformTimeOut

Single-valued, integer

Gets the timeout period (in seconds) for a customized XSLT transformation operation.

Read

Group object attributes

In a SharePoint connection, the Synchronization Service supports the following attributes of the Group object with the following synchronization operations.

Table 59: Group object attributes

Attribute

Type

Description

Supported operations

AllowMembersEditMembership

Single-valued, Boolean

Gets or sets whether group membership can be modified by the group members.

Read, write (update only)

AllowRequestToJoinLeave

Single-valued, Boolean

Gets or sets whether users can request to join or leave the group.

Read, write (update only)

AutoAcceptRequestToJoinLeave

Single-valued, Boolean

Gets or sets whether users are automatically added or removed from the group upon their request.

Read, write (update only)

CanCurrentUserEditMembership

Single-valued, Boolean

Gets whether the current user can modify membership of the group.

Read

CanCurrentUserManageGroup

Single-valued, Boolean

Gets whether the current user can manage the group.

Read

CanCurrentUserViewMembership

Single-valued, Boolean

Gets whether the current user can view a list of group members.

Read

ContainsCurrentUser

Single-valued, Boolean

Gets whether the group contains the current user.

Read

Description

Single-valued, string

Gets or sets the group description.

Read, write (update only)

DistributionGroupAlias

Single-valued, string

Gets the distribution group alias for the group.

Read

DistributionGroupEmail

Single-valued, string

Gets the distribution group email.

Read

DistributionGroupErrorMessage

Single-valued, string

Gets the last error message encountered during an asynchronous distribution group operation.

Read

ExplicitlyContainsCurrentUser

Single-valued, Boolean

Gets whether the group explicitly contains the current user as a direct member.

Read

Id

Single-valued, string

Gets the object ID.

Read

LoginName

Single-valued, string

Gets the login name of the group.

Read

Name

Single-valued, string

Gets or sets the name of the group.

Read, write

OnlyAllowMembersViewMembership

Single-valued, Boolean

Gets or sets whether only group members can view the list of members for the group.

Read, write (update only)

Owner

Single-valued, string, reference (User or Group object)

Gets or sets the group owner. A group owner can be a user or another group.

Read, write (create only)

Parent

Single-valued, string, reference (Site object)

Gets the parent of the object.

Read

RequestToJoinLeaveEmailSetting

Single-valued, string

Gets or sets the email address that receives requests to join or leave the group.

Read, write (update only)

Users

Multivalued, string, reference (User object)

Gets or sets the users that are members of the group.

Read, write (update only)

Xml

Single-valued, string

Gets the group properties in the XML string format.

Read

Language object attributes

In a SharePoint connection, the Synchronization Service supports the following attributes of the Language object with the following synchronization operations.

Table 60: Language object attributes

Attribute

Type

Description

Supported operations

DisplayName

Single-valued, string

Gets the language name displayed on the user interface.

Read

Id

Single-valued, string

Gets the object ID.

Read

LanguageTag

Single-valued, string

Gets the language tag.

Read

Parent

Single-valued, string

Gets the parent of the object.

Read

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating