ITeamFoundationIdentityService Interface

Service for managing Identities.

Namespace:  Microsoft.TeamFoundation.Server.Core
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)

Syntax

'Declaration
<DefaultServiceImplementationAttribute(GetType(TeamFoundationIdentityService))> _
Public Interface ITeamFoundationIdentityService _
    Inherits ITeamFoundationService

[DefaultServiceImplementationAttribute(typeof(TeamFoundationIdentityService))]
public interface ITeamFoundationIdentityService : ITeamFoundationService

[DefaultServiceImplementationAttribute(typeof(TeamFoundationIdentityService))]
public interface class ITeamFoundationIdentityService : ITeamFoundationService

[<DefaultServiceImplementationAttribute(typeof(TeamFoundationIdentityService))>]
type ITeamFoundationIdentityService =  
    interface 
        interface ITeamFoundationService 
    end

public interface ITeamFoundationIdentityService extends ITeamFoundationService

The ITeamFoundationIdentityService type exposes the following members.

Properties

	Name	Description
	ReadBatchSizeLimit	The maximum number of IdentityDescriptors, TeamFoundationIds or search factor values that can be queried in one call.

Top

Methods

	Name	Description
	AddGroupAdministrator	Makes the passed in team foundation identity an administrator for the passed in group.
	AddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity)	Add member to TFS Group.
	AddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)	Add member to TFS Group.
	AddRecentUser	AddRecentUser is used to note a user that the calling user has recently used in an action. This allows this system to track recent users and use this list to improve suggestions for the selection of users.
	CreateApplicationGroup(TeamFoundationRequestContext, String, String, String)	Creates a TFS application group.
	CreateApplicationGroup(TeamFoundationRequestContext, String, String, String, Boolean, Boolean)	Creates a TFS application group.
	CreateDescriptor
	CreateScope	Create a scope for TFS groups (similar to Team Project scope).
	CreateUser	Create a Team Foundation identity (user) with domain\account alias. Users have global scope, they are not scoped to any project. Currently the only use case for this function is to track an identity imported from another environment. Hence the identity is marked inactive. It is not desirable for it to remain active, because it could interfere with a real, active account by this name.
	DeleteApplicationGroup	Deletes a TFS application group.
	DeleteScope	Deletes a TFS "scope".
	DeleteUser	Deletes a user identity.
	EnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity)	Ensures that given descriptor is a member of specified TFS Group.
	EnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)	Ensures that given descriptor is a member of specified TFS Group.
	EnsureNotMember	Ensures that given descriptor is not a member of specified TFS Group.
	EnsureWellKnownGroupExists	Ensures that a well-known TFS application group has been created.
	GetIdentityChanges
	GetMostRecentlyUsedUsers
	GetPreferredEmailAddress(TeamFoundationRequestContext, Guid)	Gets the preferred email address for an identity. This address has been confirmed by the user to be the valid email address. If the custom email address is not confirmed, returns the default email address.
	GetPreferredEmailAddress(TeamFoundationRequestContext, Guid, Boolean)	Gets the preferred email address for an identity. If the preferred has not been set, the default is always returned.
	GetProjectAdminSid
	GetScopeInfo	Gets info about an IMS scope.
	IsEmailConfirmationPending	Returns true when the preferred email address requires confirmation.
	IsIdentityCached
	IsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)	Expanded membership query.
	IsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean)	Expanded membership query.
	ListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable<String>)
	ListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Lists all TFS application groups within the specified scope.
	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. There are two parts to the expression. There are a set of values that can be used from the identity and they must be AND'ed together. These are things like the identities DisplayName or IdentityType. All string comparisons are done case insensitive. Specific Properties available from all identities: Microsoft.TeamFoundation.Identity Supports: In (FUTURE) -- A direct member of the value which must be a TFID Under (FUTURE) -- A direct or indirect member of the value which must be a TFID Near -- Specialized term that has extensible conditions that define near Value must be a TFID. Microsoft.TeamFoundation.Identity.DisplayName Supports: = -- The display name of the identity is equal to the value Contains -- The display name of the identity contains to the value StartsWith -- The display name of the identity is starts with the value Microsoft.TeamFoundation.Identity.Type Supports: = -- Value must be 'Group' or 'User' Microsoft.TeamFoundation.Identity.Scope Supports: = -- Value must a string representing the scope Valid scopes are [SERVER], [projecturi], [projectname], and projecturi If this condition is not supplied [SERVER] is used. All other properties will compared against extensible properties associated with the identity. These comparisons MUST follow any well-known properties otherwise these comparisons will be made against extensible properties. No parenthesis is supported.
	ReadFilteredIdentitiesByDescriptor	Read a page of filtered identities by IdentityDescriptor, sorted by DisplayName.
	ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[])	Reads identities for given descriptors. Simple overload.
	ReadIdentities(TeamFoundationRequestContext, array<Guid[])	Reads identities by Team Foundation ID.
	ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[])	Reads identities. Simple overload, see below.
	ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>)
	ReadIdentities(TeamFoundationRequestContext, array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>)	Reads identities by Team Foundation Id. Note - performs FASTEST when no membership information is requested.
	ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>)	Reads identities. First try IMS store, then optionally source like AD. The actual source will be indicated by a property of the identity object itself.
	ReadIdentities(TeamFoundationRequestContext, array<IdentityDescriptor[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Reads identities for given descriptors. First try IMS store. If not found, optionally try source like AD. The actual source will be indicated by a property of the identity object itself. Note - performs FASTEST when no membership information is requested.
	ReadIdentities(TeamFoundationRequestContext, array<Guid[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Read identities by Team Foundation ID. Note - performs FASTEST when no membership information is requested.
	ReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, array<String[], MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Reads identities. First try IMS store, then optionally source like AD. The actual source will be indicated by a property of the identity object itself.
	ReadIdentity(TeamFoundationRequestContext, String)	Overload for above method that takes a single search factor and returns match following this order. 1. When there is no match, null. 2. When there is a single match, that identity regardless of whether the identity is active. 3. When there is a single active identity match, that identity.
	ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String)	See overload.
	ReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions)	Overload for above method that takes a single descriptor.
	ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>)	Overload for above method that takes a single search factor and returns match following this order. 1. When there is no match, null. 2. When there is a single match, that identity regardless of whether the identity is active. 3. When there is a single active identity match, that identity.
	ReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Overload for above method that takes a single descriptor.
	ReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable<String>, IdentityPropertyScope)	Overload for above method that takes a single search factor and returns match following this order. 1. When there is no match, null. 2. When there is a single match, that identity regardless of whether the identity is active. 3. When there is a single active identity match, that identity.
	ReadIdentityFromSource	ReadIdentityFromSource is used to retrive the identity from its source location (AD or GSS).
	ReadRequestIdentity	Resolves the authorized user associated with the request context to a TeamFoundationIdentity.
	RefreshIdentity	Synchronizes an identity now. This identity must already be in the IMS store. If identity is a group, its DIRECT members' properties will also be synced (asynchronously).
	RemoveGroupAdministrator	Removes the passed in team foundation identity from being an administrator for the passed in group.
	RemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)	Removes member from TFS Group.
	RemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean)
	RenameScope	Renames a TFS "scope".
	ServiceEnd	ServiceEnd is called when the Host is being Shutdown and this service should free all resources it is holding onto. (Inherited from ITeamFoundationService.)
	ServiceStart	ServiceStart is called when the service is initialized. If the service is intialized asynchronously it must implement Service_Ready which is used to determine when the service is ready for users to access it. (Inherited from ITeamFoundationService.)
	SetCustomDisplayName	Sets or removes a custom display name for the calling user.
	SetPreferredEmailAddress	Set the preferred email address current user.
	UpdateApplicationGroup	Updates a property of a TFS application group.
	UpdateExtendedProperties(TeamFoundationRequestContext, IdentityDescriptor, IEnumerable<PropertyValue>)
	UpdateExtendedProperties(TeamFoundationRequestContext, IdentityPropertyScope, IdentityDescriptor, IEnumerable<PropertyValue>)
	UpdateIdentities
	UpdateIdentity	Updates identity properties.

Top

See Also

Reference

Microsoft.TeamFoundation.Server.Core Namespace