Active Roles 7.3.3 - Synchronization Service Administration Guide

Alias

Single-valued, string

Gets the object’s alias.

Id

Single-valued, string

Gets the object’s ID.

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.

Parent

Single-valued, string, reference (Web object)

Gets the parent for the role assignment.

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.