CRMAccount.RetrieveSharedPrincipalsAndAccess Method
The RetrieveSharedPrincipalsAndAccess method retrieves all the security principals (users or teams) that have access to the specified account, along with their access rights.
Syntax
[Visual Basic .NET]
Public Function RetrieveSharedPrincipalsAndAccess(
ByVal Caller As CUserAuth,
ByVal AccountId As String,
ByRef Rights As UInt32()
) As CSecurityPrincipal()
[C#]
public CSecurityPrincipal[] RetrieveSharedPrincipalsAndAccess(
CUserAuth Caller,
string AccountId,
out uint[] Rights
);
[C++]
public: CSecurityPrincipal* RetrieveSharedPrincipalsAndAccess(
CUserAuth* Caller,
String* AccountId,
unsigned long* Rights
) __gc[];
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadAccount privilege to perform this action. See CUserAuth.
AccountId
Specifies the ID of the account.
Rights
[out] Specifies the array of rights for the security principals requested. See ACCESSRIGHTS.
Return Value
Returns a CSecurityPrincipal[] type that specifies the array of security principals requested. See CSecurityPrincipal.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMAccount proxy object
Microsoft.CRM.Proxy.CRMAccount account = new Microsoft.CRM.Proxy.CRMAccount ();
account.Credentials = System.Net.CredentialCache.DefaultCredentials;
account.Url = strDir + "CRMAccount.srf";
string strErrorMsg;
string strAccountId = "{3E24E79C-7EC5-4473-95FF-7E46FEBB534B}";
uint[] rights;
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Initialize security principal
Microsoft.CRM.Proxy.CSecurityPrincipal[] securityPrincipals;
// Retrieve the shared principals and their access
securityPrincipals = account.RetrieveSharedPrincipalsAndAccess(userAuth, strAccountId, out rights);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also