RetrieveUserIdByExternalIdRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve the Microsoft Dynamics CRM 2013 or Microsoft Dynamics CRM Online system user ID that is associated with a given identity provider ID. For Microsoft Dynamics CRM 2013 (IFD), the identity provider is typically Active Directory Federation Services 2.0 (ADFS). For Microsoft Dynamics CRM Online, the identity provider can be Microsoft account or Microsoft online services.

Namespace: Microsoft.Xrm.Sdk.Discovery
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

'Declaration
<DataContractAttribute(Name:="RetrieveUserIdByExternalIdRequest", Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")> _
Public NotInheritable Class RetrieveUserIdByExternalIdRequest
    Inherits DiscoveryRequest

[DataContractAttribute(Name="RetrieveUserIdByExternalIdRequest", Namespace="https://schemas.microsoft.com/xrm/2011/Contracts/Discovery")] 
public sealed class RetrieveUserIdByExternalIdRequest : DiscoveryRequest

Example

Guid orgId = ((WhoAmIResponse)_orgServiceProxy.Execute(new WhoAmIRequest())).OrganizationId;

//Obtaining user's systemuserid
RetrieveUserIdByExternalIdRequest request = new RetrieveUserIdByExternalIdRequest();
request.ExternalId = "C:" + upn;
request.OrganizationId = orgId;

RetrieveUserIdByExternalIdResponse response = (RetrieveUserIdByExternalIdResponse)_discServiceProxy.Execute(request);
Guid userId = response.UserId;

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method.

Privileges and Access Rights

To perform this action, the caller must have a system user account in Microsoft Dynamics CRM.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.Discovery.DiscoveryRequest
    Microsoft.Xrm.Sdk.Discovery.RetrieveUserIdByExternalIdRequest

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

RetrieveUserIdByExternalIdRequest Members
Microsoft.Xrm.Sdk.Discovery Namespace
RetrieveUserIdByExternalIdResponse

Other Resources

Discovery Service Messages (Request and Response Classes)

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.