RetrieveUserPrivilegesRequest Class

 

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

Contains the data needed to retrieve the privileges a system user (user) has through his or her roles in the specified business unit.

For the Web API use the RetrieveUserPrivileges Function.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RetrieveUserPrivilegesRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveUserPrivilegesRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveUserPrivilegesRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveUserPrivilegesRequest()

Initializes a new instance of the RetrieveUserPrivilegesRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty UserId

Gets or sets the user to retrieve privileges for.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute method, which returns an instance of RetrieveUserPrivilegesResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Privileges entity and access rights on the record specified in the UserId property. For a complete list of the privileges required, see RetrieveUserPrivileges message privileges.

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

// Get the GUID of the current user.
WhoAmIRequest whoAmI = new WhoAmIRequest();
Guid userLoggedId =
    ((WhoAmIResponse)_serviceProxy.Execute(whoAmI)).UserId;
Console.WriteLine("User logged: " + userLoggedId);

// Check if this user has prvReadPOAA.
RetrieveUserPrivilegesRequest userPrivilegesRequest =
    new RetrieveUserPrivilegesRequest();
userPrivilegesRequest.UserId = userLoggedId;
RetrieveUserPrivilegesResponse userPrivilegesResponse =
    (RetrieveUserPrivilegesResponse)_serviceProxy.Execute(userPrivilegesRequest);

// Fixed the GUID for prvReadPOAA.
Guid prvReadPOAA = new Guid("{68564CD5-2B2E-11DF-80A6-00137299E1C2}");

if (userPrivilegesResponse.RolePrivileges.Any(r => r.PrivilegeId.Equals(prvReadPOAA)))
{
    Console.WriteLine("This user DOES have prvReadPOAA");
}
else
{
    Console.WriteLine("This user DOESN'T have prvReadPOAA");
}

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

RetrieveUserPrivilegesResponse
Microsoft.Crm.Sdk.Messages Namespace
SystemUser (user) entity messages and methods

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright