RetrieveUserIdByExternalIdRequest Class

 

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

Contains the data that is needed to retrieve the Microsoft Dynamics 365 or Microsoft Dynamics 365 (online) system user ID that is associated with a given identity provider ID.

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

Inheritance Hierarchy

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

Syntax

[DataContractAttribute(Name = "RetrieveUserIdByExternalIdRequest", 
    Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts/Discovery")]
public sealed class RetrieveUserIdByExternalIdRequest : DiscoveryRequest
<DataContractAttribute(Name := "RetrieveUserIdByExternalIdRequest",
    Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts/Discovery")>
Public NotInheritable Class RetrieveUserIdByExternalIdRequest
    Inherits DiscoveryRequest

Constructors

Name Description
System_CAPS_pubmethod RetrieveUserIdByExternalIdRequest()

Initializes a new instance of the RetrieveUserIdByExternalIdRequest class.

Properties

Name Description
System_CAPS_pubproperty ExtensionData

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

System_CAPS_pubproperty ExternalId

Gets or sets the ID of the target user.

System_CAPS_pubproperty OrganizationId

Gets or sets the ID of the organization that the target system user is a member of.

System_CAPS_pubproperty OrganizationName

Gets or sets the unique name of the organization that the target system user is a member of.

System_CAPS_pubproperty Release

Gets or sets the release version of the Microsoft Dynamics 365 product.

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

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 365.

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

RetrieveUserIdByExternalIdResponse
Microsoft.Xrm.Sdk.Discovery Namespace
Discovery service messages (request and response classes)

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright