Chat now with support
Chat with Support

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

RoleDefinition object attributes

 

Table 80: 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 name of the object.

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

 

Table 81: 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 of the site collection lock.

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

 

Table 82: 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 the login name of the object.

Read, write (create only)

Name

Single-valued, string

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

Read, write (update only)

Notes

Single-valued, string

Gets or sets notes about the object.

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

Web object attributes

 

Table 83: Web object attributes

Attribute

Type

Description

Supported operations

AllowAnonymousAccess

Single-valued, Boolean

Gets whether anonymous access is allowed for the Web site.

Read

AllowAutomaticASPX
PageIndexing

Single-valued, Boolean

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

Read, write (update only)

AllowDesignerFor
CurrentUser

Single-valued, Boolean

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

Read

AllowMasterPageEditingForCurrentUser

Single-valued, Boolean

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

Read

AllowRevertFrom
TemplateForCurrentUser

Single-valued, Boolean

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

Read

AllowRssFeeds

Single-valued, Boolean

Gets whether the Web site allows RSS feeds.

Read

AllowUnsafeUpdates

Single-valued, Boolean

Gets whether database updates are allowed without security validation.

Read, write (update only)

AllWebTemplates
Allowed

Single-valued, Boolean

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

Read

AlternateCssUrl

Single-valued, string

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

Read, write (update only)

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.

Read, write (update only)

AnonymousPermMask64

Multivalued, string

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

Read, write (update only)

AnonymousState

Single-valued, string

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

Read, write (update only)

AppDatabaseName

Single-valued, string

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

Read

AppDatabaseServer
ReferenceId

Single-valued, string (GUID)

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

Read

AppDatabaseTarget
ApplicationId

Single-valued, string

Gets the ID of the target application.

Read

AppInstanceId

Single-valued, string (GUID)

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

Read

ASPXPageIndexed

Single-valued, Boolean

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

Read

AssociatedMemberGroup

Single-valued, string, reference (Group object)

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

Read, write

AssociatedOwnerGroup

Single-valued, string, reference (Group object)

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

Read, write (update only)

AssociatedVisitorGroup

Single-valued, string, reference (Group object)

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

Read, write

Author

Single-valued, string, reference (User object)

Gets or sets the user who created the Web site.

Read, write

CacheAllSchema

Single-valued, Boolean

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

Read, write (update only)

ClientTag

Single-valued, string (integer)

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

Read, write (create only)

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.

Read

Created

Single-valued, string (DateTime)

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

Read, write (update only)

CurrencyLocaleID

Single-valued, string (integer)

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

Read, write (update only)

CurrentChangeToken

Single-valued, string (SPChangeToken)

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

Read

CurrentUser

Single-valued, string, reference (User object)

Gets the current user of the Web site.

Read

CustomJavaScriptFileUrl

Single-valued, string

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

Read, write (update only)

CustomMasterUrl

Single-valued, string

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

Read, write (update only)

CustomUploadPage

Single-valued, string

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

Read, write (update only)

Description

Single-valued, string

Gets or sets the description for the web site.

Read, write (update only)

DocumentLibraryCalloutOfficeWebApp
PreviewersDisabled

Single-valued, Boolean

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

Read

EffectiveBase
Permissions

Multivalued, string

Gets the effective base permissions assigned to the current user.

Read

EffectivePresence
Enabled

Single-valued, Boolean

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

Read

EnableMinimalDownload

Single-valued, Boolean

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

Read, write (update only)

ExcludeFromOffline
Client

Single-valued, Boolean

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

Read, write (update only)

ExecuteUrl

Single-valued, string

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

Read

Exists

Single-valued, Boolean

Gets a value that indicates whether the Web site exists.

Read

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.

Read, write (update only)

FirstUniqueAncestorWeb

Single-valued, string, reference (Web object)

Gets the first unique Web site that has unique permissions.

Read

FirstUniqueRole
DefinitionWeb

Single-valued, string, reference (Web object)

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

Read

HasUniqueRole
Assignments

Single-valued, Boolean

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

Read, write (create only)

HasUniqueRole
Definitions

Single-valued, Boolean

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

Read

HideSiteContentsLink

Single-valued, Boolean

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

Read, write (update only)

Id

Single-valued, string

Gets the object’s ID.

Read

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.

Read, write (update only)

IndexedPropertyKeys

Multivalued, string

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

Read

IsADAccountCreation
Mode

Single-valued, Boolean

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

Read

IsADEmailEnabled

Single-valued, Boolean

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

Read

IsAppWeb

Single-valued, Boolean

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

Read

IsMultilingual

Single-valued, Boolean

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

Read, write (update only)

IsRootWeb

Single-valued, Boolean

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

Read

Language

Single-valued, reference (Language object)

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

Read, write (create only)

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.

Read, write (update only)

Locale

Single-valued, string (CultureInfo)

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

Read

MasterPageReference
Enabled

Single-valued, Boolean

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

Read

MasterUrl

Single-valued, string

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

Read, write (update only)

Name

Single-valued, string

Gets or sets the name of the object.

Read, write (update only)

NoCrawl

Single-valued, Boolean

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

Read, write (update only)

NonHostHeaderUrl

Single-valued, string

Gets the full URL of the Web site.

Read

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.

Read, write (update only)

Parent

Single-valued, string, reference (Site object)

Gets the object’s parent.

Read

ParserEnabled

Single-valued, Boolean

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

Read, write (update only)

PortalMember

Single-valued, Boolean

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

Read

PortalName

Single-valued, string

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

Read

PortalSubscriptionUrl

Single-valued, string

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

Read

PortalUrl

Single-valued, string

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

Read

PresenceEnabled

Single-valued, Boolean

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

Read, write (update only)

Provisioned

Single-valued, Boolean

Gets or sets whether the Web site has been provisioned.

Read, write (update only)

QuickLaunchEnabled

Single-valued, Boolean

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

Read, write (update only)

RecycleBinEnabled

Single-valued, Boolean

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

Read

RequestAccessEmail

Single-valued, string

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

Read, write (update only)

RequestAccessEnabled

Single-valued, Boolean

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

Read

RequireDynamicCanary

Single-valued, Boolean

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

Read

SaveSiteAsTemplate
Enabled

Single-valued, Boolean

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

Read, write (update only)

ServerRelativeUrl

Single-valued, string

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

Read, write (update only)

ShowUrlStructureFor
CurrentUser

Single-valued, Boolean

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

Read

Site

Single-valued, string, reference (Site object)

Gets the parent site collection for the Web site.

Read

SiteClientTag

Single-valued, string

Gets the client cache control number for the site collection.

Read

SiteLogoDescription

Single-valued, string

Gets or sets the description of the Web site logo.

Read, write (update only)

SiteLogoUrl

Single-valued, string

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

Read, write (update only)

SupportedUICultures

Multivalued, string (CultureInfo)

Gets information about the cultures supported by the Web site.

Read

SyndicationEnabled

Single-valued, Boolean

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

Read, write (update only)

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.

Read, write (update only)

Title

Single-valued, string

Gets or sets the title of the object.

Read, write (update only)

TreeViewEnabled

Single-valued, Boolean

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

Read, write (update only)

UICulture

Single-valued, string (CultureInfo)

Gets the default language for the Web site.

Read

UIVersion

Single-valued, string (integer)

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

Read, write (update only)

Url

Single-valued, string

Gets or sets the absolute URL of the Web site.

Read, write (create only)

UserIsSiteAdmin

Single-valued, Boolean

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

Read

UserIsWebAdmin

Single-valued, Boolean

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

Read

WebTemplate

Single-valued, string

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

Read

WebTemplateId

Single-valued, string (integer)

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

Read, write (create only)

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating