Active Roles 7.3.3 - Synchronization Service Administration 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

RoleAssignment object attributes

RoleAssignment object attributes

 

Table 67: RoleAssignment object attributes

Attribute

Type

Description

Supported operations

Alias

Single-valued, string

Gets the object’s alias.

Read

Id

Single-valued, string

Gets the object’s ID.

Read

Member

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

Gets the user or group for the role assignment.

This attribute is required to create a new RoleAssignment object in SharePoint.

Read

Parent

Single-valued, string, reference (Web object)

Gets the parent for the role assignment.

Read

RoleDefinitionBindings

Single-valued, string, reference (RoleDefinition object)

Gets the role definition bindings for the role assignment.

Read, write
(update only)

RoleDefinition object attributes

RoleDefinition object attributes

 

Table 68: RoleDefinition object attributes

Attribute

Type

Description

Supported operations

BasePermissions

Multivalued, string

Gets or sets the base permissions for a role definition.

Read, write
(update only)

Description

Single-valued, string

Gets or sets the role definition description.

Read, write
(update only)

Hidden

Single-valued, Boolean

Gets whether the role definition is displayed in the user interface.

Read

Id

Single-valued, string

Gets the object’s identifier.

Read

Members

Multivalued, string, reference

Gets or sets role assignments for the role definition.

Read, write
(update only)

Name

Single-valued, string

Gets or sets the role definition name.

Read, write

Order

Single-valued, string

Gets or sets the order in which to display the permission levels in the user interface.

Read, write
(update only)

Parent

Single-valued, string, reference

Gets the object’s parent.

Read

Type

Single-valued, string

Gets the role definition type.

Read

Xml

Single-valued, string

Gets the role definition permission in the XML format.

Read

Site object attributes

Site object attributes

 

Table 69: Site object attributes

Attribute

Type

Description

Supported operations

AdministrationSiteType

Single-valued, string

Gets or sets the administration site types supported by SharePoint.

Read, write
(update only)

AllowDesigner

Single-valued, Boolean

Gets or sets the Site Collection Allow Designer property.

Read, write
(update only)

AllowExternalEmbedding

Single-valued, string

Gets or sets the external domain embedding for the site collection.

Read, write
(update only)

AllowMasterPageEditing

Single-valued, Boolean

Gets whether master page editing is allowed.

Read

AllowRevertFrom
Template

Single-valued, Boolean

Gets or sets whether reverting from a template is allowed.

Read, write
(update only)

AllowRssFeeds

Single-valued, Boolean

Gets whether the site collection allows RSS feeds.

Read

AllowSelfService
Upgrade

Single-valued, Boolean

Gets or sets whether upgrade is allowed.

Read, write
(update only)

AllowSelfService
UpgradeEvaluation

Single-valued, Boolean

Gets or sets whether upgrade evaluation site collection can be created.

Read, write
(update only)

AllowUnsafeUpdates

Single-valued, Boolean

Gets or sets whether updates to the database are allowed without security validation.

Read, write
(update only)

ApplicationRightsMask

Multivalued, string

Gets the rights mask for the parent Web application of the site collection.

Read

Archived

Single-valued, Boolean

Gets or sets whether the site is in archived mode.

Read, write
(update only)

AuditLogTrimming
Callout

Single-valued, string

Gets or sets the class name of the object that performs audit log trimming.

Read, write
(update only)

AuditLogTrimming
Retention

Single-valued, integer

Gets or sets the period (in days) during which the audit log data is retained.

Read, write
(update only)

AverageResourceUsage

Single-valued, string

Gets the average resource usage of the site collection for the specified number of days.

Read

BrowserDocuments
Enabled

Single-valued, Boolean

Gets whether the documents can be viewed in a Web browser.

Read

CanUpgrade

Single-valued, Boolean

Gets whether the object is upgradeable.

Read

CatchAccessDenied
Exception

Single-valued, Boolean

Gets or sets whether SharePoint handles “Access denied” exceptions.

Read, write
(update only)

CertificationDate

Single-valued, DateTime

Gets the confirmation date and time for the automatic deletion of the site collection.

Read

CompatibilityLevel

Single-valued, integer

Gets the major version number of the site collection. This version number is used to perform compatibility checks.

Read

ContentDatabase

Single-valued, string

Gets the content database associated with the site collection.

Read

CurrentChangeToken

Single-valued, string

Gets the change token that is used to write the next change to the site collection.

Read

CurrentResourceUsage

Single-valued, string

Gets the resource usage for the site collection.

Read

DeadWebNotificationCount

Single-valued, integer

Gets the number of notifications that were sent about the Web sites that are not in use within the site collection.

Read

DenyPermissionsMask

Multivalued, string

Gets or sets the deny permission mask for all site users, including the site administrator.

Read, write (update only)

EvalSiteId

Single-valued, string (GUID)

Gets the identifier of the upgrade evaluation site collection, if it was created for the site collection.

Read

ExpirationDate

Single-valued, DateTime

Gets or sets the date after which an upgrade evaluation site collection gets automatically deleted.

Read, write
(update only)

FileNotFoundUrl

Single-valued, string

Gets the URL to the file not found page.

The HTTP requests where the resource cannot be found are redirected to this URL.

Read, write
(update only)

HasAppPrincipalContext

Single-valued, Boolean

Gets whether the object is running within an application principal context.

Read

HideSystemStatusBar

Single-valued, Boolean

Gets whether the site’s system status bar is hidden.

Read

HostHeaderIsSiteName

Single-valued, Boolean

Gets whether the host header is used to uniquely identify the site collection.

Read

HostName

Single-valued, string

Gets the name of the server that hosts the site collection.

Read

Id

Single-valued, string

Gets the object’s ID.

Read

IISAllowsAnonymous

Single-valued, Boolean

Gets a value that indicates whether IIS allows anonymous access.

Read

Impersonating

Single-valued, Boolean

Gets the impersonation status of the object.

Read

InheritAllowSelfService
UpgradeEvaluation
Setting

Single-valued, Boolean

Gets or sets whether to inherit the AllowSelfServiceUpgradeEvaluationSetting value from the parent.

Read, write
(update only)

InheritAllowSelfService
UpgradeSetting

Single-valued, Boolean

Gets or sets whether to inherit the AllowSelfServiceUpgradeSetting value from the parent.

Read, write
(update only)

InvitedUserMaximum
Level

Single-valued, integer

Description is not available.

Read, write (update only)

IsEvalSite

Single-valued, Boolean

Gets or sets whether the object is an upgrade evaluation site collection.

Read, write
(update only)

IsReadLocked

Single-valued, Boolean

Gets or sets whether the site collection is unavailable for Read access.

Read, write
(update only)

Language

Single-valued, integer, reference

Description is not available.

Read, write

LastContentModified
Date

Single-valued, DateTime

Gets the date and time (in UTC) when the site content was last modified.

Read

LastSecurityModified
Date

Single-valued, DateTime

Gets the date and time (in UTC) when the site collection security settings were last modified.

Read

LockIssue

Single-valued, string

Gets or sets the comment that was written when the site collection was locked.

Read, write
(update only)

MaintenanceMode

Single-valued, Boolean

Gets whether the site is in maintenance mode.

Read

NeedsUpgrade

Single-valued, Boolean

Gets or sets whether the site requires upgrading.

Read, write
(update only)

OutgoingEmailAddress

Single-valued, string

Gets or sets the outgoing email address for the site.

Read, write
(update only)

Owner

Single-valued, string, reference (User object)

Gets or sets the site collection owner.

This attribute is required to create a new site collection in SharePoint.

Read, write (create only)

OwnerEmail

Single-valued, string

Gets or sets the site collection owner email address.

Read, write

Parent

Single-valued, string, reference (WebApplication object)

Gets the object’s parent.

Read

Port

Single-valued, integer

Gets the port number used by the virtual server that hosts the site collection.

Read

PortalName

Single-valued, string

Gets or sets the portal name.

Read, write
(update only)

PortalUrl

Single-valued, string

Gets or sets the portal URL.

Read, write
(update only)

PrimaryUri

Single-valued, string

Gets the portal URI.

Read

QuotaID

Single-valued, integer

Description is not available.

Read, write (update only)

ReadLocked

Single-valued, Boolean

Gets or sets whether the site is unavailable for Read access.

Read, write
(update only)

ReadOnly

Single-valued, Boolean

Gets or sets whether the site collection is read-only and unavailable for Write access.

Read, write
(update only)

ResourceQuotaExceeded

Single-valued,

Boolean

Gets whether the resource quota limit for the site collection has been exceeded since the last daily quota reset operation.

Read

ResourceQuotaExceededNotificationSent

Single-valued, Boolean

Gets whether a resource quota exceeded notification was sent since the last daily quota reset operation for the site collection.

Read

ResourceQuotaWarning
NotificationSent

Single-valued, Boolean

Gets whether a resource quota exceeded warning was sent since the last daily quota reset operation for the site collection.

Read

SchemaVersion

Single-valued, string

Gets the site collection version number for upgrade compatibility checks.

Read

SecondaryContact

Single-valued, string, reference (User object)

Description is not available.

Read, write (update only)

ServerRelativeUrl

Single-valued, string

Gets or sets the server-relative URL of the root Web site.

Read, write
(update only)

ShareByEmailEnabled

Single-valued, Boolean

Gets or sets whether the users are allowed to grant access permissions to guests, so that they could access the site collection resources.

Read, write
(update only)

ShareByLinkEnabled

Single-valued, Boolean

Gets or sets whether the users are allowed to share the site collection documents by providing hyperlinks to those documents.

Read, write
(update only)

ShowURLStructure

Single-valued, Boolean

Gets or sets whether to show the site collection URL structure.

Read, write
(update only)

SourceSiteId

Single-valued, string (GUID)

Gets the source site ID for an upgrade evaluation site collection.

Read

StorageMaximumLevel

Single-valued, LargeInteger

Description is not available.

Read, write (update only)

StorageWarningLevel

Single-valued, LargeInteger

Description is not available.

Read, write (update only)

SyndicationEnabled

Single-valued, Boolean

Gets or sets whether RSS syndication is enabled for the site collection.

Read, write
(update only)

SystemAccount

Single-valued, string, reference (User object)

Gets the system account of the site collection.

Read

TrimAuditLog

Single-valued, Boolean

Gets or sets whether to delete old data from the audit log.

Read, write
(update only)

UpgradeReminderDate

Single-valued, DateTime

Description is not available.

Read

Upgrading

Single-valued, Boolean

Gets whether a site upgrade is currently in progress.

Read

Url

Single-valued, string

Gets or sets the full URL of the root Web site of the site collection. The URL contains the host name and port number.

This attribute is required to create a new site collection in SharePoint.

Read, write (create only)

UserCodeEnabled

Single-valued, Boolean

Gets whether the user code service is enabled for the site collection.

Read

UserCodeMaximumLevel

Single-valued, string

Description is not available.

Read, write (update only)

UserCodeWarningLevel

Single-valued, string

Description is not available.

Read, write (update only)

UserDefinedWorkflows
Enabled

Single-valued, Boolean

Gets or sets whether user-defined workflows are enabled for the site collection.

Read, write
(update only)

UserIsSiteAdminIn
System

Single-valued, Boolean

Gets whether the current user is a site collection administrator.

Read

UserToken

Single-valued, binary

Gets the user token associated with the site collection

Read

WarningNotificationSent

Single-valued, Boolean

Gets whether a warning notification has been sent.

Read

WebTemplate

Single-valued, string

Description is not available.

Read, write

WriteLocked

Single-valued, Boolean

Gets whether the site collection is unavailable for Write access.

Read

Zone

Single-valued, string

Gets the URL zone that was used when creating the site object.

Read

User object attributes

User object attributes

 

Table 70: User object attributes

Attribute

Type

Description

Supported operations

Alias

Single-valued, string

Gets the alias of the object.

Read

AllowBrowseUserInfo

Single-valued, Boolean

Gets or sets whether the user can view information about other users of the Web site.

Read, write (update only)

Email

Single-valued, string

Gets or sets the user’s email address.

Read, write (update only)

Groups

Multivalued, string, reference (Group object)

Gets the groups in which the object is a member.

Read

Id

Single-valued, string

Gets the object’s ID.

Read

IsApplicationPrincipal

Single-valued, Boolean

Gets whether the user is an application principal.

Read

IsDomainGroup

Single-valued, Boolean

Gets whether the user is a domain group.

Read

IsHiddenInUI

Single-valued, Boolean

Gets whether the user is hidden in the user interface.

Read

IsShareByEmailGuest
User

Single-valued, Boolean

Gets or sets whether the user is shared by email guest user.

Read, write (update only)

IsSiteAdmin

Single-valued, Boolean

Gets or sets whether the user is a site collection administrator.

Read, write (update only)

IsSiteAuditor

Single-valued, Boolean

Gets whether the user is a site collection auditor.

Read

IsUserSettingsSynced
WithProvider

Single-valued, Boolean

Gets or sets whether user settings have been synchronized with External Settings Provider.

Read, write (update only)

LoginName

Single-valued, string

Gets or sets login name of the user.

Read, write (create only)

Name

Single-valued, string

Gets or sets the display name of the user.

Read, write (update only)

Notes

Single-valued, string

Gets or sets notes for the user.

Read, write (update only)

Parent

Single-valued, string, reference (Site object)

Gets the object’s parent.

Read

RawSid

Single-valued, binary

Gets the system ID of the user.

Read

RequireRequestToken

Single-valued, Boolean

Gets or sets whether the user requires a request token.

Read, write (update only)

Sid

Single-valued, string

Gets the SID for the user’s network account.

Read

SystemUserKey

Single-valued, string

Gets the user key specific to the configuration.

Read

UserId

Single-valued, string

Gets the user’s name identifier and the issuer of that identifier.

Read

UserToken

Single-valued, binary

Gets the token that identifies the authentication process for the user.

Read

Xml

Single-valued, string

Gets information about the user in the XML format.

Read

Related Documents