RetrievePrincipalAccess Function
Retrieves the access rights of the specified security principal (team or user) to the specified record.
Bound Entities
Bound functions are invoked by appending the function name to the URI representing an entity or collection.
| Entity Type | Binding Type |
|---|---|
| systemuser | entity |
| team | entity |
| organization | entity |
Parameters
Parameters allow for data to be passed to the function.
| Name | Type | Nullable | Unicode | Description |
|---|---|---|---|---|
|
Target
|
crmbaseentity | False | True | The target record for which to retrieve access rights. |
Return Type
| Type | Nullable | Description |
|---|---|---|
| RetrievePrincipalAccessResponse | False | The RetrievePrincipalAccess function returns the following value. |
Entities
Use the RetrievePrincipalAccess function with the following entity types:
| Name | Display Name | Description |
|---|---|---|
| account | Account | Business that represents a customer or potential customer. The company that is billed in business transactions. |
| activityfileattachment | Activity File Attachment | Attachment entity with data stored in file type attribute |
| annotation | Note | Note that is attached to one or more objects, including other notes. |
| appnotification | Notification | Notification to be provided to a user. |
| appointment | Appointment | Commitment representing a time interval with start/end times and duration. |
| asyncoperation | System Job | Process whose execution can proceed independently or in the background. |
| bot | Chatbot | Represents a Power Virtual Agents Chatbot. https://powerva.microsoft.com/ |
| botcomponent | Chatbot subcomponent | Holds key authoring components of a Chatbot such a topics, entities, variables, etc. |
| canvasapp | Canvas App | An application built through a canvas-based editing experience. |
| category | Category | Entity for categorizing records to make it easier for your customers to find them on portals and through search. |
| chat | Teams chat | For internal use only. Entity which stores association data of Dynamics 365 records with Microsoft Teams chat |
| connection | Connection | Relationship between two entities. |
| connectionreference | Connection Reference | |
| connector | Connector | Connector Entity to support Solutioning Integration |
| contact | Contact | Person with whom a business unit has a relationship, such as customer, supplier, and colleague. |
| conversationtranscript | ConversationTranscript | Contains the transcripts of conversations between participants such as customers, Virtual Agents or Human agents. |
| customapi | Custom API | Entity that defines a custom API |
| customapirequestparameter | Custom API Request Parameter | Entity that defines a request parameter for a custom API |
| customapiresponseproperty | Custom API Response Property | Entity that defines a response property for a custom API |
| datalakefolder | Data Lake Folder | A folder is a place to store data in Azure Data Lake. |
| datalakefolderpermission | Data Lake Folder Permission | |
| duplicaterule | Duplicate Detection Rule | Rule used to identify potential duplicates. |
| Activity that is delivered using email protocols. | ||
| emailserverprofile | Email Server Profile | Holds the Email Server Profiles of an organization |
| environmentvariabledefinition | Environment Variable Definition | Contains information about the settable variable: its type, default value, and etc. |
| environmentvariablevalue | Environment Variable Value | Holds the value for the associated EnvironmentVariableDefinition entity. |
| exportsolutionupload | ExportSolutionUpload | |
| fax | Fax | Activity that tracks call outcome and number of pages for a fax and optionally stores an electronic copy of the document. |
| featurecontrolsetting | FeatureControlSetting | featurecontrolsetting |
| feedback | Feedback | Container for feedback and ratings for knowledge articles. |
| flowmachine | Flow Machine | |
| flowmachinegroup | Flow Machine Group | |
| flowmachineimage | Flow Machine Image | |
| flowmachineimageversion | Flow Machine Image Version | |
| flowsession | Flow Session | Entity to store the information that is generated when a modern flow or UI flow runs. |
| goal | Goal | Target objective for a user or a team for a specified time period. |
| goalrollupquery | Rollup Query | Query that is used to filter the results of the goal rollup. |
| import | Data Import | Status and ownership information for an import job. |
| importfile | Import Source File | File name of file used for import. |
| importmap | Data Map | Data map used in import. |
| keyvaultreference | Key Vault Reference | Contains data that refers to an Azure Key Vault containing credentials used to connect to secure web-hosted resources. |
| knowledgearticle | Knowledge Article | Organizational knowledge for internal and external use. |
| knowledgebaserecord | Knowledge Base Record | Metadata of knowledge base (KB) articles associated with Microsoft Dynamics 365 entities. |
| letter | Letter | Activity that tracks the delivery of a letter. The activity can contain the electronic copy of the letter. |
| mailbox | Mailbox | |
| mailmergetemplate | Mail Merge Template | Template for a mail merge document that contains the standard attributes of that document. |
| managedidentity | Managed Identity | Contains data to represent an Azure Active Directory Application used to connect to secure web-hosted resources. |
| msdyn_aibdataset | AI Builder Dataset | |
| msdyn_aibdatasetfile | AI Builder Dataset File | |
| msdyn_aibdatasetrecord | AI Builder Dataset Record | |
| msdyn_aibdatasetscontainer | AI Builder Datasets Container | |
| msdyn_aibfeedbackloop | AI Builder Feedback Loop | |
| msdyn_aibfile | AI Builder File | |
| msdyn_aibfileattacheddata | AI Builder File Attached Data | |
| msdyn_aiconfiguration | AI Configuration | |
| msdyn_aifptrainingdocument | AI Form Processing Document | |
| msdyn_aimodel | AI Model | |
| msdyn_aiodimage | AI Object Detection Image | |
| msdyn_aiodlabel | AI Object Detection Label | |
| msdyn_aiodtrainingboundingbox | AI Object Detection Bounding Box | |
| msdyn_aiodtrainingimage | AI Object Detection Image Mapping | |
| msdyn_aitemplate | AI Template | |
| msdyn_analysiscomponent | Analysis Component | |
| msdyn_analysisjob | Analysis Job | |
| msdyn_analysisresult | Analysis Result | |
| msdyn_analysisresultdetail | Analysis Result Detail | |
| msdyn_dataflow | Dataflow | |
| msdyn_dataflowrefreshhistory | DataflowRefreshHistory | |
| msdyn_entityrefreshhistory | EntityRefreshHistory | |
| msdyn_federatedarticle | Knowledge Federated Article | |
| msdyn_kalanguagesetting | Knowledge article language setting | Allows you to select default language for knowledge authoring. |
| msdyn_kbattachment | Knowledge Article Attachment | |
| msdyn_kmfederatedsearchconfig | Search provider | |
| msdyn_knowledgearticleimage | Knowledge Article Image | |
| msdyn_knowledgearticletemplate | Knowledge Article Template | Organizational Knowledge Article Template for Internal and external creation of Knowledge Articles. |
| msdyn_knowledgeinteractioninsight | Knowledge Interaction Insight | Knowledge Interaction Insight |
| msdyn_knowledgemanagementsetting | Knowledge Management Setting | Setup knowledge management for your organization. |
| msdyn_knowledgepersonalfilter | Knowledge search personal filter config | Allows you to configure and manage personal filter settings. |
| msdyn_knowledgesearchfilter | Knowledge search filter | Allows you to configure and manage filter settings. |
| msdyn_knowledgesearchinsight | Knowledge Search Insight | Knowledge Search Insight |
| msdyn_pmanalysishistory | PM Analysis History | |
| msdyn_pminferredtask | PM Inferred Task | |
| msdyn_pmrecording | PM Recording | |
| msdyn_pmtemplate | PM Template | |
| msdyn_richtextfile | Rich Text Attachment | Image or file attached to a rich text field |
| msdyn_serviceconfiguration | Service Configuration | |
| msdyn_slakpi | SLA KPI | |
| msdyn_solutionhealthrule | Solution Health Rule | |
| msdyn_solutionhealthruleargument | Solution Health Rule Argument | |
| msdynce_botcontent | BotContent | |
| personaldocumenttemplate | Personal Document Template | Used to store Personal Document Templates in database in binary format. |
| phonecall | Phone Call | Activity to track a telephone call. |
| processsession | Process Session | Information that is generated when a dialog is run. Every time that you run a dialog, a dialog session is created. |
| processstageparameter | ProcessStageParameter | |
| queue | Queue | A list of records that require action, such as accounts, activities, and cases. |
| recurringappointmentmaster | Recurring Appointment | The Master appointment of a recurring appointment series. |
| report | Report | Data summary in an easy-to-read layout. |
| sharepointdocumentlocation | Document Location | Document libraries or folders on a SharePoint server from where documents can be managed in Microsoft Dynamics 365. |
| sharepointsite | SharePoint Site | SharePoint site from where documents can be managed in Microsoft Dynamics 365. |
| sla | SLA | Contains information about the tracked service-level KPIs for cases that belong to different customers. |
| slakpiinstance | SLA KPI Instance | Service level agreement (SLA) key performance indicator (KPI) instance that is tracked for an individual case |
| socialactivity | Social Activity | For internal use only. |
| socialprofile | Social Profile | This entity is used to store social profile information of its associated account and contacts on different social channels. |
| solutioncomponentbatchconfiguration | Solution Component Batch Configuration | |
| stagesolutionupload | StageSolutionUpload | |
| synapsedatabase | Synapse Database | This entity represents an external Synapse database and its associated datalake folder link. |
| syncerror | Sync Error | Failure reason and other detailed information for a record that failed to sync. |
| task | Task | Generic activity representing work needed to be done. |
| template | Email Template | Template for an email message that contains the standard attributes of an email message. |
| userform | User Dashboard | User-owned dashboards. |
| userquery | Saved View | Saved database query that is owned by a user. |
| userqueryvisualization | User Chart | Chart attached to an entity. |
| workflow | Process | Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed. |
| workflowbinary | Workflow Binary |