privilege EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: Permission to perform an action in Microsoft CRM. The platform checks for the privilege and rejects the attempt if the user does not hold the privilege.

Entity Set path:[organization URI]/api/data/v8.2/privileges

Base Type: crmbaseentity EntityType

Display Name: Privilege

Primary Key: privilegeid

Primary Name Attribute: name

Properties

Collection-valued navigation properties

Operations bound to privilege

Operations using the privilege entity type.

The privilege entity type has no lookup properties.

The privilege entity type has no single-valued navigation properties.

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name	Type	Details
accessright	Edm.Int32	Description: Rights a user has to an instance of an entity.
canbebasic	Edm.Boolean	Description: Information that specifies whether the privilege applies to the user, the user's team, or objects shared by the user. Default Options: 1 : Yes 0 : No
canbedeep	Edm.Boolean	Description: Information that specifies whether the privilege applies to child business units of the business unit associated with the user. Default Options: 1 : Yes 0 : No
canbeentityreference	Edm.Boolean	Description: Information that specifies whether the privilege applies to the local reference of an external party. Default Options: 1 : Yes 0 : No
canbeglobal	Edm.Boolean	Description: Information that specifies whether the privilege applies to the entire organization. Default Options: 1 : Yes 0 : No
canbelocal	Edm.Boolean	Description: Information that specifies whether the privilege applies to the user's business unit. Default Options: 1 : Yes 0 : No
canbeparententityreference	Edm.Boolean	Description: Information that specifies whether the privilege applies to parent reference of the external party. Default Options: 1 : Yes 0 : No
name	Edm.String	Description: Name of the privilege.
privilegeid	Edm.Guid	Description: Unique identifier of the privilege.
versionnumber	Edm.Int64	Description: Read-only property

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name	Type	Partner
Privilege_AsyncOperations	asyncoperation EntityType	regardingobjectid_privilege
Privilege_BulkDeleteFailures	bulkdeletefailure EntityType	regardingobjectid_privilege
roleprivileges_association	role EntityType	roleprivileges_association
roletemplateprivileges_association	roletemplate EntityType	roletemplateprivileges_association

Operations bound to privilege

The following operations are bound to the privilege entity type.

Name	Bound to
RetrievePrivilegeSet Function	Collection

Operations using the privilege entity type.

The following operations use the privilege entity type in a parameter or return type.

Name	How used	Description
RemovePrivilegeRole Action	Privilege Parameter	Removes a privilege from an existing role.
RetrievePrivilegeSet Function	entityset Parameter	Retrieves the set of privileges defined in the system.
RetrievePrivilegeSet Function	ReturnType	Retrieves the set of privileges defined in the system.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright