This documentation is archived and is not being maintained.

ITeamFoundationIdentityService Interface

Visual Studio 2013

Service for managing Identities.

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

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

The ITeamFoundationIdentityService type exposes the following members.

  NameDescription
Public propertyReadBatchSizeLimitThe maximum number of IdentityDescriptors, TeamFoundationIds or search factor values that can be queried in one call.
Top

  NameDescription
Public methodAddGroupAdministratorMakes the passed in team foundation identity an administrator for the passed in group.
Public methodAddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity)Add member to TFS Group.
Public methodAddMemberToApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)Add member to TFS Group.
Public methodAddRecentUserAddRecentUser 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.
Public methodCreateApplicationGroup(TeamFoundationRequestContext, String, String, String)Creates a TFS application group.
Public methodCreateApplicationGroup(TeamFoundationRequestContext, String, String, String, Boolean, Boolean)Creates a TFS application group.
Public methodCreateDescriptor
Public methodCreateScopeCreate a scope for TFS groups (similar to Team Project scope).
Public methodCreateUserCreate 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.
Public methodDeleteApplicationGroupDeletes a TFS application group.
Public methodDeleteScopeDeletes a TFS "scope".
Public methodDeleteUserDeletes a user identity.
Public methodEnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, TeamFoundationIdentity)Ensures that given descriptor is a member of specified TFS Group.
Public methodEnsureIsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)Ensures that given descriptor is a member of specified TFS Group.
Public methodEnsureNotMemberEnsures that given descriptor is not a member of specified TFS Group.
Public methodEnsureWellKnownGroupExistsEnsures that a well-known TFS application group has been created.
Public methodGetIdentityChanges
Public methodGetMostRecentlyUsedUsers
Public methodGetPreferredEmailAddress(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.
Public methodGetPreferredEmailAddress(TeamFoundationRequestContext, Guid, Boolean)Gets the preferred email address for an identity. If the preferred has not been set, the default is always returned.
Public methodGetProjectAdminSid
Public methodGetScopeInfoGets info about an IMS scope.
Public methodIsEmailConfirmationPendingReturns true when the preferred email address requires confirmation.
Public methodIsIdentityCached
Public methodIsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)Expanded membership query.
Public methodIsMember(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean)Expanded membership query.
Public methodListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable(Of String))
Public methodListApplicationGroups(TeamFoundationRequestContext, String, ReadIdentityOptions, IEnumerable(Of String), IdentityPropertyScope)Lists all TFS application groups within the specified scope.
Public methodReadFilteredIdentitiesReadFilteredIdentities 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.
Public methodReadFilteredIdentitiesByDescriptorRead a page of filtered identities by IdentityDescriptor, sorted by DisplayName.
Public methodReadIdentities(TeamFoundationRequestContext, IdentityDescriptor())Reads identities for given descriptors. Simple overload.
Public methodReadIdentities(TeamFoundationRequestContext, Guid())Reads identities by Team Foundation ID.
Public methodReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, String())Reads identities. Simple overload, see below.
Public methodReadIdentities(TeamFoundationRequestContext, IdentityDescriptor(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of String))
Public methodReadIdentities(TeamFoundationRequestContext, Guid(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of String))Reads identities by Team Foundation Id. Note - performs FASTEST when no membership information is requested.
Public methodReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, String(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of 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.
Public methodReadIdentities(TeamFoundationRequestContext, IdentityDescriptor(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of 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.
Public methodReadIdentities(TeamFoundationRequestContext, Guid(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of String), IdentityPropertyScope)Read identities by Team Foundation ID. Note - performs FASTEST when no membership information is requested.
Public methodReadIdentities(TeamFoundationRequestContext, IdentitySearchFactor, String(), MembershipQuery, ReadIdentityOptions, IEnumerable(Of 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.
Public methodReadIdentity(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.
Public methodReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String)See overload.
Public methodReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions)Overload for above method that takes a single descriptor.
Public methodReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable(Of 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.
Public methodReadIdentity(TeamFoundationRequestContext, IdentityDescriptor, MembershipQuery, ReadIdentityOptions, IEnumerable(Of String), IdentityPropertyScope)Overload for above method that takes a single descriptor.
Public methodReadIdentity(TeamFoundationRequestContext, IdentitySearchFactor, String, MembershipQuery, ReadIdentityOptions, IEnumerable(Of 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.
Public methodReadIdentityFromSourceReadIdentityFromSource is used to retrive the identity from its source location (AD or GSS).
Public methodReadRequestIdentityResolves the authorized user associated with the request context to a TeamFoundationIdentity.
Public methodRefreshIdentitySynchronizes 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).
Public methodRemoveGroupAdministratorRemoves the passed in team foundation identity from being an administrator for the passed in group.
Public methodRemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor)Removes member from TFS Group.
Public methodRemoveMemberFromApplicationGroup(TeamFoundationRequestContext, IdentityDescriptor, IdentityDescriptor, Boolean)
Public methodRenameScopeRenames a TFS "scope".
Public methodServiceEndServiceEnd is called when the Host is being Shutdown and this service should free all resources it is holding onto. (Inherited from ITeamFoundationService.)
Public methodServiceStartServiceStart 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.)
Public methodSetCustomDisplayNameSets or removes a custom display name for the calling user.
Public methodSetPreferredEmailAddressSet the preferred email address current user.
Public methodUpdateApplicationGroupUpdates a property of a TFS application group.
Public methodUpdateExtendedProperties(TeamFoundationRequestContext, IdentityDescriptor, IEnumerable(Of PropertyValue))
Public methodUpdateExtendedProperties(TeamFoundationRequestContext, IdentityPropertyScope, IdentityDescriptor, IEnumerable(Of PropertyValue))
Public methodUpdateIdentities
Public methodUpdateIdentityUpdates identity properties.
Top
Show: