Share via


IIdentityManagementService.ReadIdentity Method (IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions)

Overload that takes a single search factor and returns match following this order.

1. With multiple matches, active identity if exists, else first match.

2. When there is a single match, the match.

3. When there is no match, null.

Read identity based on search factor. First read from IMS store, and then (optionally) read from source like AD.

Namespace:  Microsoft.TeamFoundation.Framework.Client
Assembly:  Microsoft.TeamFoundation.Client (in Microsoft.TeamFoundation.Client.dll)

Syntax

'Declaration
Function ReadIdentity ( _
    searchFactor As IdentitySearchFactor, _
    searchFactorValue As String, _
    queryMembership As MembershipQuery, _
    readOptions As ReadIdentityOptions _
) As TeamFoundationIdentity
TeamFoundationIdentity ReadIdentity(
    IdentitySearchFactor searchFactor,
    string searchFactorValue,
    MembershipQuery queryMembership,
    ReadIdentityOptions readOptions
)
TeamFoundationIdentity^ ReadIdentity(
    IdentitySearchFactor searchFactor, 
    String^ searchFactorValue, 
    MembershipQuery queryMembership, 
    ReadIdentityOptions readOptions
)
abstract ReadIdentity : 
        searchFactor:IdentitySearchFactor * 
        searchFactorValue:string * 
        queryMembership:MembershipQuery * 
        readOptions:ReadIdentityOptions -> TeamFoundationIdentity
function ReadIdentity(
    searchFactor : IdentitySearchFactor, 
    searchFactorValue : String, 
    queryMembership : MembershipQuery, 
    readOptions : ReadIdentityOptions
) : TeamFoundationIdentity

Parameters

  • searchFactorValue
    Type: System.String

    actual search string (account name, etc.)

Return Value

Type: Microsoft.TeamFoundation.Framework.Client.TeamFoundationIdentity
Array of matching identities

.NET Framework Security

See Also

Reference

IIdentityManagementService Interface

ReadIdentity Overload

Microsoft.TeamFoundation.Framework.Client Namespace