This documentation is archived and is not being maintained.

RetrieveUserPrivileges Message (CrmService)

Dynamics
banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Works for all deployment typesWorks online and offline

Retrieves all the privileges a user has through his or her roles in the specified business unit.

The relevant classes are specified in the following table.

TypeClass
RequestRetrieveUserPrivilegesRequest
ResponseRetrieveUserPrivilegesResponse
Entityprivilege

Remarks

To use this message, pass an instance of the RetrieveUserPrivilegesRequest class as the request parameter in the Execute method.

To perform this action, the caller must have access rights on the entity instance specified in the request class. For a list of required privileges, see RetrieveUserPrivileges Privileges.

Example

The following code example demonstrates how to use the RetrieveUserPrivileges message.

[C#]
// Set up the CRM service.
CrmAuthenticationToken token = new CrmAuthenticationToken();
// You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0; 
token.OrganizationName = "AdventureWorksCycle";
 
CrmService service = new CrmService();
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx";
service.CrmAuthenticationTokenValue = token;
service.Credentials = System.Net.CredentialCache.DefaultCredentials;

// Create the request object.
RetrieveUserPrivilegesRequest retrieve = new RetrieveUserPrivilegesRequest();

// Set the ID of the user that you want privileges for.
retrieve.UserId = new Guid("18ECA720-493E-4800-BBFD-638BD54EB325");

// Execute the request.
RetrieveUserPrivilegesResponse retrieved = (RetrieveUserPrivilegesResponse) service.Execute(retrieve);
[Visual Basic .NET]
' Set up the CRM service.
Dim token As New CrmAuthenticationToken()
' You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0
token.OrganizationName = "AdventureWorksCycle"
 
Dim service As New CrmService()
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx"
service.CrmAuthenticationTokenValue = token
service.Credentials = System.Net.CredentialCache.DefaultCredentials

' Create the request object.
Dim retrieve As New RetrieveUserPrivilegesRequest()

' Set the ID of the user that you want privileges for.
retrieve.UserId = New Guid("18ECA720-493E-4800-BBFD-638BD54EB325")

' Execute the request.
Dim retrieved As RetrieveUserPrivilegesResponse = CType(service.Execute(retrieve), RetrieveUserPrivilegesResponse)

See Also

Concepts

Reference


© 2010 Microsoft Corporation. All rights reserved.


Show: