Web Role (mspp_webrole) table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Sets the user's role for the Portal.

Added by: Power Pages Apps Solution

Messages

Message	Web API Operation	SDK class or method
BulkRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Create	POST /mspp_webroles See Create	CreateRequest or Create
CreateMultiple	CreateMultiple	CreateMultipleRequest
Delete	DELETE /mspp_webroles(mspp_webroleid) See Delete	DeleteRequest or Delete
PurgeRetainedContent	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Retrieve	GET /mspp_webroles(mspp_webroleid) See Retrieve	RetrieveRequest or Retrieve
RetrieveEntityChanges		RetrieveEntityChangesRequest
RetrieveMultiple	GET /mspp_webroles See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RollbackRetain	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.
Update	PATCH /mspp_webroles(mspp_webroleid) See Update	UpdateRequest or Update
UpdateMultiple	UpdateMultiple	UpdateMultipleRequest
ValidateRetentionConfig	This message is to be executed only by Dataverse to trigger registered plug-ins and flows.

Properties

Property	Value
CollectionSchemaName	mspp_webroles
DisplayCollectionName	Web Roles
DisplayName	Web Role
EntitySetName	mspp_webroles
IsBPFEntity	False
LogicalCollectionName	mspp_webroles
LogicalName	mspp_webrole
OwnershipType	OrganizationOwned
PrimaryIdAttribute	mspp_webroleid
PrimaryNameAttribute	mspp_name
SchemaName	mspp_webrole

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• mspp_anonymoususersrole
• mspp_authenticatedusersrole
• mspp_createdby
• mspp_createdon
• mspp_description
• mspp_key
• mspp_modifiedby
• mspp_modifiedon
• mspp_name
• mspp_webroleId
• mspp_websiteid
• statecode
• statuscode

mspp_anonymoususersrole

Property	Value
Description
DisplayName	Anonymous Users Role
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_anonymoususersrole
RequiredLevel	None
Type	Boolean

mspp_anonymoususersrole Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

mspp_authenticatedusersrole

Property	Value
Description
DisplayName	Authenticated Users Role
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_authenticatedusersrole
RequiredLevel	None
Type	Boolean

mspp_authenticatedusersrole Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

mspp_createdby

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

mspp_createdon

Property	Value
DateTimeBehavior	UserLocal
Description	Shows the date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_createdon
RequiredLevel	None
Type	DateTime

mspp_description

Property	Value
Description
DisplayName	Description
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_description
MaxLength	2000
RequiredLevel	None
Type	Memo

mspp_key

Property	Value
Description	An alternate key that is not intended to be localized to allow retrieval of a specific Web Role in workflows or code.
DisplayName	Key
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_key
MaxLength	100
RequiredLevel	None
Type	String

mspp_modifiedby

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

mspp_modifiedon

Property	Value
DateTimeBehavior	UserLocal
Description	Shows the date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_modifiedon
RequiredLevel	None
Type	DateTime

mspp_name

Property	Value
Description	The name of the custom entity.
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

mspp_webroleId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Web Role
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	mspp_webroleid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

mspp_websiteid

Property	Value
Description	Unique identifier for Website associated with Web Role.
DisplayName	Website
IsValidForForm	True
IsValidForRead	True
LogicalName	mspp_websiteid
RequiredLevel	ApplicationRequired
Targets	mspp_website
Type	Lookup

statecode

Property	Value
Description	Status of the Web Role
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Choices/Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active
1	Inactive	2	Inactive

statuscode

Property	Value
Description	Reason for the status of the Web Role
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Choices/Options

Value	Label	State
1	Active	0
2	Inactive	1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• mspp_createdbyName
• mspp_createdbyYomiName
• mspp_modifiedbyName
• mspp_modifiedbyYomiName
• mspp_websiteidName

mspp_createdbyName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mspp_createdbyname
MaxLength	200
RequiredLevel	None
Type	String

mspp_createdbyYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mspp_createdbyyominame
MaxLength	200
RequiredLevel	None
Type	String

mspp_modifiedbyName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mspp_modifiedbyname
MaxLength	200
RequiredLevel	None
Type	String

mspp_modifiedbyYomiName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mspp_modifiedbyyominame
MaxLength	200
RequiredLevel	None
Type	String

mspp_websiteidName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	mspp_websiteidname
MaxLength	100
RequiredLevel	None
Type	String

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

• mspp_systemuser_mspp_webrole_createdby
• mspp_systemuser_mspp_webrole_modifiedby
• mspp_website_webrole

mspp_systemuser_mspp_webrole_createdby

Added by: System Solution Solution

See the mspp_systemuser_mspp_webrole_createdby one-to-many relationship for the systemuser table/entity.

mspp_systemuser_mspp_webrole_modifiedby

Added by: System Solution Solution

See the mspp_systemuser_mspp_webrole_modifiedby one-to-many relationship for the systemuser table/entity.

mspp_website_webrole

See the mspp_website_webrole one-to-many relationship for the mspp_website table/entity.

Many-To-Many Relationships

Relationship details provided where the mspp_webrole table is the first table in the relationship. Listed by SchemaName.

• mspp_columnpermissionprofile_webrole
• mspp_entitypermission_webrole
• mspp_publishingstatetransitionrule_webrole
• mspp_webpageaccesscontrolrule_webrole
• mspp_websiteaccess_webrole

mspp_columnpermissionprofile_webrole

IntersectEntityName: mspp_columnpermissionprofile_webrole

Table 1

Property	Value
IntersectAttribute	mspp_webroleid
IsCustomizable	False
LogicalName	mspp_webrole
NavigationPropertyName	mspp_columnpermissionprofile_webrole
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order: 10000

Table 2

Property	Value
LogicalName	mspp_columnpermissionprofile
IntersectAttribute	mspp_columnpermissionprofileid
NavigationPropertyName	mspp_columnpermissionprofile_webrole
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order: 10000

mspp_entitypermission_webrole

See the mspp_entitypermission_webrole many-to-many relationship for the mspp_entitypermission table/entity.

mspp_publishingstatetransitionrule_webrole

See the mspp_publishingstatetransitionrule_webrole many-to-many relationship for the mspp_publishingstatetransitionrule table/entity.

mspp_webpageaccesscontrolrule_webrole

See the mspp_webpageaccesscontrolrule_webrole many-to-many relationship for the mspp_webpageaccesscontrolrule table/entity.

mspp_websiteaccess_webrole

See the mspp_websiteaccess_webrole many-to-many relationship for the mspp_websiteaccess table/entity.

See also

Dataverse table/entity reference
Web API Reference
mspp_webrole EntityType