Active Roles 7.2 - Synchronization Service Administrator Guide

BasePermissions

Multivalued, string

Gets or sets the base permissions for a role definition.

Description

Single-valued, string

Gets or sets the role definition description.

Hidden

Single-valued, Boolean

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

Id

Single-valued, string

Gets the object’s identifier.

Members

Multivalued, string, reference

Gets or sets role assignments for the role definition.

Name

Single-valued, string

Gets or sets the role definition name.

Order

Single-valued, string

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

Parent

Single-valued, string, reference

Gets the object’s parent.

Type

Single-valued, string

Gets the role definition type.

AdministrationSiteType

Single-valued, string

Gets or sets the administration site types supported by SharePoint.

AllowDesigner

Single-valued, Boolean

Gets or sets the Site Collection Allow Designer property.

AllowExternalEmbedding

Single-valued, string

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

AllowMasterPageEditing

Single-valued, Boolean

Gets whether master page editing is allowed.

AllowRevertFrom
Template

Single-valued, Boolean

Gets or sets whether reverting from a template is allowed.

AllowRssFeeds

Single-valued, Boolean

Gets whether the site collection allows RSS feeds.

AllowSelfService
Upgrade

Single-valued, Boolean

Gets or sets whether upgrade is allowed.

AllowSelfService
UpgradeEvaluation

Single-valued, Boolean

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

AllowUnsafeUpdates

Single-valued, Boolean

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

ApplicationRightsMask

Multivalued, string

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

Archived

Single-valued, Boolean

Gets or sets whether the site is in archived mode.

AuditLogTrimming
Callout

Single-valued, string

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

AuditLogTrimming
Retention

Single-valued, integer

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

AverageResourceUsage

Single-valued, string

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

BrowserDocuments
Enabled

Single-valued, Boolean

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

CanUpgrade

Single-valued, Boolean

Gets whether the object is upgradeable.

CatchAccessDenied
Exception

Single-valued, Boolean

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

CertificationDate

Single-valued, DateTime

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

CompatibilityLevel

Single-valued, integer

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

ContentDatabase

Single-valued, string

Gets the content database associated with the site collection.

CurrentChangeToken

Single-valued, string

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

CurrentResourceUsage

Single-valued, string

Gets the resource usage for the site collection.

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.

DenyPermissionsMask

Multivalued, string

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

EvalSiteId

Single-valued, string (GUID)

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

ExpirationDate

Single-valued, DateTime

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

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.

HasAppPrincipalContext

Single-valued, Boolean

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

HideSystemStatusBar

Single-valued, Boolean

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

HostHeaderIsSiteName

Single-valued, Boolean

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

HostName

Single-valued, string

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

Id

Single-valued, string

Gets the object’s ID.

IISAllowsAnonymous

Single-valued, Boolean

Gets a value that indicates whether IIS allows anonymous access.

Impersonating

Single-valued, Boolean

Gets the impersonation status of the object.

InheritAllowSelfService
UpgradeEvaluation
Setting

Single-valued, Boolean

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

InheritAllowSelfService
UpgradeSetting

Single-valued, Boolean

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

InvitedUserMaximum
Level

Single-valued, integer

Description is not available.

IsEvalSite

Single-valued, Boolean

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

IsReadLocked

Single-valued, Boolean

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

Language

Single-valued, integer, reference

Description is not available.

LastContentModified
Date

Single-valued, DateTime

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

LastSecurityModified
Date

Single-valued, DateTime

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

LockIssue

Single-valued, string

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

MaintenanceMode

Single-valued, Boolean

Gets whether the site is in maintenance mode.

NeedsUpgrade

Single-valued, Boolean

Gets or sets whether the site requires upgrading.

OutgoingEmailAddress

Single-valued, string

Gets or sets the outgoing email address for the site.

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.

OwnerEmail

Single-valued, string

Gets or sets the site collection owner email address.

Parent

Single-valued, string, reference (WebApplication object)

Gets the object’s parent.

Port

Single-valued, integer

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

PortalName

Single-valued, string

Gets or sets the portal name.

PortalUrl

Single-valued, string

Gets or sets the portal URL.

PrimaryUri

Single-valued, string

Gets the portal URI.

QuotaID

Single-valued, integer

Description is not available.

ReadLocked

Single-valued, Boolean

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

ReadOnly

Single-valued, Boolean

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

ResourceQuotaExceeded

Single-valued,

Boolean

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

ResourceQuotaExceededNotificationSent

Single-valued, Boolean

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

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.

SchemaVersion

Single-valued, string

Gets the site collection version number for upgrade compatibility checks.

SecondaryContact

Single-valued, string, reference (User object)

Description is not available.

ServerRelativeUrl

Single-valued, string

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

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.

ShareByLinkEnabled

Single-valued, Boolean

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

ShowURLStructure

Single-valued, Boolean

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

SourceSiteId

Single-valued, string (GUID)

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

StorageMaximumLevel

Single-valued, LargeInteger

Description is not available.

StorageWarningLevel

Single-valued, LargeInteger

Description is not available.

SyndicationEnabled

Single-valued, Boolean

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

SystemAccount

Single-valued, string, reference (User object)

Gets the system account of the site collection.

TrimAuditLog

Single-valued, Boolean

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

UpgradeReminderDate

Single-valued, DateTime

Description is not available.

Upgrading

Single-valued, Boolean

Gets whether a site upgrade is currently in progress.

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.

UserCodeEnabled

Single-valued, Boolean

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

UserCodeMaximumLevel

Single-valued, string

Description is not available.

UserCodeWarningLevel

Single-valued, string

Description is not available.

UserDefinedWorkflows
Enabled

Single-valued, Boolean

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

UserIsSiteAdminIn
System

Single-valued, Boolean

Gets whether the current user is a site collection administrator.

UserToken

Single-valued, binary

Gets the user token associated with the site collection

WarningNotificationSent

Single-valued, Boolean

Gets whether a warning notification has been sent.

WebTemplate

Single-valued, string

Description is not available.

WriteLocked

Single-valued, Boolean

Gets whether the site collection is unavailable for Write access.

Alias

Single-valued, string

Gets the alias of the object.

AllowBrowseUserInfo

Single-valued, Boolean

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

Email

Single-valued, string

Gets or sets the user’s email address.

Groups

Multivalued, string, reference (Group object)

Gets the groups in which the object is a member.

Id

Single-valued, string

Gets the object’s ID.

IsApplicationPrincipal

Single-valued, Boolean

Gets whether the user is an application principal.

IsDomainGroup

Single-valued, Boolean

Gets whether the user is a domain group.

IsHiddenInUI

Single-valued, Boolean

Gets whether the user is hidden in the user interface.

IsShareByEmailGuest
User

Single-valued, Boolean

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

IsSiteAdmin

Single-valued, Boolean

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

IsSiteAuditor

Single-valued, Boolean

Gets whether the user is a site collection auditor.

IsUserSettingsSynced
WithProvider

Single-valued, Boolean

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

LoginName

Single-valued, string

Gets or sets login name of the user.

Name

Single-valued, string

Gets or sets the display name of the user.

Notes

Single-valued, string

Gets or sets notes for the user.

Parent

Single-valued, string, reference (Site object)

Gets the object’s parent.

RawSid

Single-valued, binary

Gets the system ID of the user.

RequireRequestToken

Single-valued, Boolean

Gets or sets whether the user requires a request token.

Sid

Single-valued, string

Gets the SID for the user’s network account.

SystemUserKey

Single-valued, string

Gets the user key specific to the configuration.

UserId

Single-valued, string

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

UserToken

Single-valued, binary

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

AllowAnonymousAccess

Single-valued, Boolean

Gets whether anonymous access is allowed for the Web site.

AllowAutomaticASPX
PageIndexing

Single-valued, Boolean

Gets or sets whether the .aspx page of the Web site should be indexed for search operations.

AllowDesignerFor
CurrentUser

Single-valued, Boolean

Gets whether the current user is allowed to use the designer for the Web site.

AllowMasterPageEditingForCurrentUser

Single-valued, Boolean

Gets whether the current user is allowed to edit master pages.

AllowRevertFrom
TemplateForCurrentUser

Single-valued, Boolean

Gets whether the current user is allowed to revert from the Web site template.

AllowRssFeeds

Single-valued, Boolean

Gets whether the Web site allows RSS feeds.

AllowUnsafeUpdates

Single-valued, Boolean

Gets whether database updates are allowed without security validation.

AllWebTemplates
Allowed

Single-valued, Boolean

Gets whether all available Web templates (those returned by the GetAvailableWebTemplates method) are allowed.

AlternateCssUrl

Single-valued, string

Gets or sets the URL pointing at an alternate CSS for the Web site.

AlternateHeader

Single-valued, string

Gets or sets the URL pointing at an alternate .aspx page that is used for rendering the top navigation area on the Web site.

AnonymousPermMask64

Multivalued, string

Gets or sets base permissions for anonymous users of the Web site.

AnonymousState

Single-valued, string

Gets or sets the level of access for anonymous users of the Web site.

AppDatabaseName

Single-valued, string

Gets the name of the application database associated with the Web site.

AppDatabaseServer
ReferenceId

Single-valued, string (GUID)

Gets the ID of the server on which the database is located.

AppDatabaseTarget
ApplicationId

Single-valued, string

Gets the ID of the target application.

AppInstanceId

Single-valued, string (GUID)

Gets the ID of the App instance the Web site represents.

ASPXPageIndexed

Single-valued, Boolean

Gets whether the automatic indexing of Web site’s .aspx pages is enabled.

AssociatedMemberGroup

Single-valued, string, reference (Group object)

Gets or sets the users who can be contributors of the Web site.

AssociatedOwnerGroup

Single-valued, string, reference (Group object)

Gets or sets the associated owner groups of the Web site.

AssociatedVisitorGroup

Single-valued, string, reference (Group object)

Gets or sets the associated visitor group of the Web site.

Author

Single-valued, string, reference (User object)

Gets or sets the user who created the Web site.

CacheAllSchema

Single-valued, Boolean

Gets or sets whether caching of all schemas of the Web site is enabled.

ClientTag

Single-valued, string (integer)

Gets or sets the client cache control number for the Web site.

Configuration

Single-valued, string (integer)

Gets the ID of the site definition configuration that was used to create the Web site or the template from which the Web site was created.

Created

Single-valued, string (DateTime)

Gets or sets the date and time when the Web site was created.

CurrencyLocaleID

Single-valued, string (integer)

Gets or sets the identifier of the currency that is used on the Web site.

CurrentChangeToken

Single-valued, string (SPChangeToken)

Gets the token that is used for logging the next change to the Web site.

CurrentUser

Single-valued, string, reference (User object)

Gets the current user of the Web site.

CustomJavaScriptFileUrl

Single-valued, string

Gets or sets the URL pointing at the custom JavaScript file used by the CustomJsUrl Web control.

CustomMasterUrl

Single-valued, string

Gets or sets the URL pointing to a custom master page for the Web site.

CustomUploadPage

Single-valued, string

Gets or sets the path to a custom application page for uploading files.

Description

Single-valued, string

Gets or sets the description for the Web site.

DocumentLibraryCalloutOfficeWebApp
PreviewersDisabled

Single-valued, Boolean

Gets whether the WAC previewers are disabled for the Document Library Callouts.

EffectiveBase
Permissions

Multivalued, string

Gets the effective base permissions assigned to the current user.

EffectivePresence
Enabled

Single-valued, Boolean

Gets whether effective presence information is enabled for the Web site.

EnableMinimalDownload

Single-valued, Boolean

Gets or sets whether Minimal Download Strategy is enabled for the Web site.

ExcludeFromOffline
Client

Single-valued, Boolean

Gets or sets whether to download data from the Web site to the client during offline synchronization.

ExecuteUrl

Single-valued, string

Gets the URL that is called after instantiating the site definition for business solutions.

Exists

Single-valued, Boolean

Gets a value that indicates whether the Web site exists.

FileDialogPost
ProcessorId

Single-valued, string (GUID)

Gets or sets the ID for the user interface element used for Web views in the file dialog boxes and forms of document libraries.

FirstUniqueAncestorWeb

Single-valued, string, reference (Web object)

Gets the first unique Web site that has unique permissions.

FirstUniqueRole
DefinitionWeb

Single-valued, string, reference (Web object)

Gets the Web site that defines role definitions for the current Web site.

HasUniqueRole
Assignments

Single-valued, Boolean

Gets or sets whether the object has unique role assignments or inherits its assignments from a parent.

HasUniqueRole
Definitions

Single-valued, Boolean

Gets whether the object has unique role assignments, including those inherited from a parent object.

HideSiteContentsLink

Single-valued, Boolean

Gets or sets whether a link to site contents is available in the site actions menu (the gear icon).

Id

Single-valued, string

Gets the object’s ID.

IncludeSupporting
Folders

Single-valued, Boolean

Gets or sets whether supporting folders for files or folders in the Web site are included in enumeration operations for these files or folders.

IndexedPropertyKeys

Multivalued, string

Gets the property keys for properties that need to be exposed through the Site Data Web Service.

IsADAccountCreation
Mode

Single-valued, Boolean

Gets whether user accounts are created automatically in Active Directory when users are invited to the Web site.

IsADEmailEnabled

Single-valued, Boolean

Gets whether email for AD DS is enabled on the Web site.

IsAppWeb

Single-valued, Boolean

Gets whether the Web site is a container for an application.

IsMultilingual

Single-valued, Boolean

Gets or sets whether the Web site has a multilingual user interface enabled.

IsRootWeb

Single-valued, Boolean

Gets whether the Web site is the top-level site in the site collection.

Language

Single-valued, reference (Language object)

Gets or sets the locale identifier of the default language for the Web site.

LastItemModifiedDate

Single-valued, string (DateTime)

Gets or sets the date and time when the last modification was made to an item on the Web site.

Locale

Single-valued, string (CultureInfo)

Gets the locale that is used to show time, currency, and numeric data on the Web site.

MasterPageReference
Enabled

Single-valued, Boolean

Gets whether master page referencing is enabled for the Web site.

MasterUrl

Single-valued, string

Gets or sets the URL pointing at the master page for the Web site.

Name

Single-valued, string

Gets or sets the name of the Web site.

NoCrawl

Single-valued, Boolean

Gets or sets whether searching is disabled for the Web site.

NonHostHeaderUrl

Single-valued, string

Gets the full URL of the Web site.

OverwriteTranslationsOnChange

Single-valued, Boolean

Gets or sets whether text changes made by user in the default language automatically overwrite existing translations in all other languages.

Parent

Single-valued, string, reference (Site object)

Gets the object’s parent.

ParserEnabled

Single-valued, Boolean

Gets or sets whether parsing is enabled for document libraries of the Web site.

PortalMember

Single-valued, Boolean

Gets whether the Web site is associated with a portal site.

PortalName

Single-valued, string

Gets the name of the portal site associated with the Web site.

PortalSubscriptionUrl

Single-valued, string

Gets the URL that is used for alerts within the portal.

PortalUrl

Single-valued, string

Gets the URL that points to the portal site associated with the Web site.

PresenceEnabled

Single-valued, Boolean

Gets or sets whether inline presence information is enabled for the Web site.

Provisioned

Single-valued, Boolean

Gets or sets whether the Web site has been provisioned.

QuickLaunchEnabled

Single-valued, Boolean

Gets or sets whether the Quick Launch area is enabled and available on the Web site.

RecycleBinEnabled

Single-valued, Boolean

Gets whether the recycle bin is enabled for the Web site.

RequestAccessEmail

Single-valued, string

Gets or sets the email address to which access requests are sent.

RequestAccessEnabled

Single-valued, Boolean

Gets whether it is required to send a request in order to get access to the Web site.

RequireDynamicCanary

Single-valued, Boolean

Gets whether the canary is required for all requests to the UrlZone.

SaveSiteAsTemplate
Enabled

Single-valued, Boolean

Gets or sets whether the Web site can be saved as a template.

ServerRelativeUrl

Single-valued, string

Gets or sets the Web site URL in a server-relative format.

ShowUrlStructureFor
CurrentUser

Single-valued, Boolean

Gets whether the current user is allowed to view the file structure of the Web site.

Site

Single-valued, string, reference (Site object)

Gets the parent site collection for the Web site.

SiteClientTag

Single-valued, string

Gets the client cache control number for the site collection.

SiteLogoDescription

Single-valued, string

Gets or sets the description of the Web site logo.

SiteLogoUrl

Single-valued, string

Gets or sets the absolute URL pointing at the Web site logo.

SupportedUICultures

Multivalued, string (CultureInfo)

Gets information about the cultures supported by the Web site.

SyndicationEnabled

Single-valued, Boolean

Gets or sets whether RSS is enabled for the Web site.

ThemedCssFolderUrl

Single-valued, string

Gets or sets the URL pointing to the folder that holds the CSS file that is used to display the Web site.

Title

Single-valued, string

Gets or sets the Web site title.

TreeViewEnabled

Single-valued, Boolean

Gets or sets whether Tree View is enabled in the Web site user interface.

UICulture

Single-valued, string (CultureInfo)

Gets the default language for the Web site.

UIVersion

Single-valued, string (integer)

Gets or sets the current version number of the user interface.

Url

Single-valued, string

Gets or sets the absolute URL of the Web site.

UserIsSiteAdmin

Single-valued, Boolean

Gets whether the user has administrator rights on the Web site.

UserIsWebAdmin

Single-valued, Boolean

Gets whether the user is a member of the Administrator group for the Web site.

WebTemplate

Single-valued, string

Gets the name of the site definition or template that was used to create the Web site.