TeamFoundationOAuthService Class

A service that is used to register OAuth client applications and issue OAuth delegation tokens

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.Framework.Server.TeamFoundationOAuthService

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

Syntax

'Declaration
<TeamFoundationServiceDependency(GetType(TeamFoundationSqlNotificationService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationIdentityService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationRegistryService))> _
<TeamFoundationServiceDependency(GetType(TeamFoundationSecurityService))> _
Public Class TeamFoundationOAuthService _
    Implements ITeamFoundationService
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationIdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
public class TeamFoundationOAuthService : ITeamFoundationService
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationIdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
public ref class TeamFoundationOAuthService : ITeamFoundationService
[<TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationIdentityService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))>]
[<TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))>]
type TeamFoundationOAuthService =  
    class 
        interface ITeamFoundationService 
    end
public class TeamFoundationOAuthService implements ITeamFoundationService

The TeamFoundationOAuthService type exposes the following members.

Constructors

Name Description
Public method TeamFoundationOAuthService

Top

Methods

Name Description
Public method CreateToken(TeamFoundationRequestContext, OAuthToken) CreateAccessToken from a sourceToken allows the caller to take an existing authorization or refresh token and create an access token. Note: If the input token is an authorization token the return tokens will have an initial accesstoken as array index [0], and a refresh token in array index [1]. If an access token is given it will be returned in array index [0].
Public method CreateToken(TeamFoundationRequestContext, TeamFoundationIdentity, String, OAuthTokenType, String) CreateToken will create a new access token for the identity specified. It will be saved with the identity with the description that was supplied.
Public method DeleteApplication Delete the application specified by the given clientId.
Public method DeleteToken DeleteToken will remove a token from the store. This will revoke any privileges this token was granted.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetApplication Retrieve a registered application that has the given clientId.
Public method GetApplications Retrieve the applications that have the given clientIds
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetIdentityFromToken GetIdentityFromToken is used to retrieve the identity the supplied token is associated with. If the token is not a valid token null will be returned.
Public method GetToken GetToken is used to retrieve the details associated with a token.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method QueryApplications Query all registered applications including an optional identity filter (to return only applications registered by a given user)
Public method QueryAuthorizedApplications Get the list of applications that have outstanding token grants for a particular identity
Public method QueryRelatedTokens Retrieve the set of tokens which were sourced from the given token (e.g. Access + Refresh tokens sourced from a given Auth token, Access token sourced from a given Refresh token)
Public method QueryTokens QueryTokens is used to retrieve the set of access tokens associated with a given identity in the given host.
Public method RegisterApplication Register an application that has the given properties
Public method RevokeApplication Revokes any tokens associated with the given application for the user
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateApplication Update the given application.

Top

Explicit Interface Implementations

Name Description
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceEnd Implementation of ITeamFoundationService.ServiceEnd
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceStart Implementation of ITeamFoundationService.ServiceStart

Top

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

Reference

Microsoft.TeamFoundation.Framework.Server Namespace