IIdentityManagementService2 Interface

  • Article

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

Syntax

'Declaration
Public Interface IIdentityManagementService2 _
    Inherits IIdentityManagementService

public interface IIdentityManagementService2 : IIdentityManagementService

public interface class IIdentityManagementService2 : IIdentityManagementService

type IIdentityManagementService2 =  
    interface 
        interface IIdentityManagementService 
    end

public interface IIdentityManagementService2 extends IIdentityManagementService

The IIdentityManagementService2 type exposes the following members.

Properties

  Name Description
Public property IdentityDomainScope (Inherited from IIdentityManagementService.)

Top

Methods

  Name Description
Public method AddMemberToApplicationGroup Add member to TFS Group. (Inherited from IIdentityManagementService.)
Public method AddRecentUser(Guid) Adds the specified identity to MRU list of users for the current user.
Public method AddRecentUser(TeamFoundationIdentity) Adds the specified identity to a most recently used (MRU) list of users for the current user.
Public method ClearCustomDisplayName Clears the custom display name for the current user, returning to using the display name from the external identity provider, such as Active Directory, Live, and so on.
Public method CreateApplicationGroup Creates a TFS application group (Inherited from IIdentityManagementService.)
Public method DeleteApplicationGroup Deletes a TFS application group (Inherited from IIdentityManagementService.)
Public method GetMostRecentlyUsedUsers Get the set of identities that have been recently accessed by the current user.
Public method GetMostRecentlyUsedUsersEx Get the set of identities which have been recently accessed by the current user and the current team members
Public method GetScopeName Gets the scope name for the provided scope id. (Inherited from IIdentityManagementService.)
Public method IsMember Expanded membership query for direct or nested member. (Inherited from IIdentityManagementService.)
Public method IsOwnedWellKnownGroup Check if the given descriptor is of TeamFoundation type, belongs to this IMS host and is a well-known group. This does not confirm that such a group actually exists, just that the Sid pattern meets these requirements. (Inherited from IIdentityManagementService.)
Public method IsOwner Check if the given descriptor is of TeamFoundation type, and belongs to this IMS host. This does not confirm that such a group actually exists, just that the Sid pattern belongs to this host. (Inherited from IIdentityManagementService.)
Public method ListApplicationGroups(String, ReadIdentityOptions) Lists all TFS application groups in the specified scope (Inherited from IIdentityManagementService.)
Public method ListApplicationGroups(String, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Lists all TFS application groups in the specified scope.
Public method ReadFilteredIdentities [ReadFilteredIdentities] is used to retrieve a set of identities based on an expression. The expression is a syntax that resembles a SQL WHERE clause. For full details on the expressions capabilities, see documentation on the [QueryExpression] class.
Public method ReadIdentities(array<Guid[], MembershipQuery) Read identities by Team Foundation Id. Note - performance will be fastest when no membership information is requested. (Inherited from IIdentityManagementService.)
Public method ReadIdentities(array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions) Read identities for given descriptors. First try IMS store. If not found, optionally try source like AD. Note - performance will be fastest when no membership information is requested. (Inherited from IIdentityManagementService.)
Public method ReadIdentities(IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions) Read identities based on search factor. First read from IMS store, and then (optionally) read from source like AD. (Inherited from IIdentityManagementService.)
Public method ReadIdentities(array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities by Team Foundation ID. Note that performance will be fastest when no membership information is requested.
Public method ReadIdentities(array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities for given descriptors. First try information management system (IMS) store. If not found, optionally try a source like Active Directory. Note that performance will be fastest when no membership information is requested.
Public method ReadIdentities(IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Read identities based on search factor. First read from IMS store, and then optionally read from a source like Active Directory.
Public method ReadIdentity(String) Read an identity using the General search factor.
Public method ReadIdentity(IdentityDescriptor, MembershipQuery, ReadIdentityOptions) Overload that takes a single descriptor. Read identity for given descriptor. First try IMS store. If not found, optionally try source like AD. Note - performance will be fastest when no membership information is requested. (Inherited from IIdentityManagementService.)
Public method ReadIdentity(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. (Inherited from IIdentityManagementService.)
Public method ReadIdentity(IdentityDescriptor, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Overload that takes a single descriptor.Read identity for given descriptor. First try IMS store. If it is not found, optionally try a source like Active Directory. Note that performance will be fastest when no membership information is requested.
Public method ReadIdentity(IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope) Overload that takes a single search factor and returns a match following this order: 1. With multiple matches, active identity if one exists, or else first match.2. When there is a single match, the match.3. When there is no match, null.Read identity is based on search factor. First read from IMS store, and then optionally read from source like Active Directory.
Public method RefreshIdentity Refresh identity properties from provider now. This identity must already be in the IMS store. If identity is a group, its DIRECT members and their properties will also be refreshed (asynchronously). (Inherited from IIdentityManagementService.)
Public method RemoveMemberFromApplicationGroup Remove member from TFS Group. (Inherited from IIdentityManagementService.)
Public method SetCustomDisplayName Sets the display name for the current user in a sticky manner, overriding any display name returned by an external identity provider like Active Directory or Live.
Public method UpdateApplicationGroup Updates a property of a TFS application group (Inherited from IIdentityManagementService.)
Public method UpdateExtendedProperties Save changes to extended properties.

Top

See Also

Reference

Microsoft.TeamFoundation.Framework.Client Namespace