This documentation is archived and is not being maintained.

TeamFoundationOAuthService Class

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

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

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

[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(IdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationSecurityService))]
public ref class TeamFoundationOAuthService : ITeamFoundationService

The TeamFoundationOAuthService type exposes the following members.

  NameDescription
Public methodCreateToken(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 methodCreateToken(TeamFoundationRequestContext, Identity, 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 methodDeleteApplicationDelete the application specified by the given clientId.
Public methodDeleteTokenDeleteToken will remove a token from the store. This will revoke any privileges this token was granted.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetApplicationRetrieve a registered application with the given clientId.
Public methodGetApplicationsRetrieve the applications that have the given clientIds
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetIdentityFromTokenGetIdentityFromToken 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 methodGetTokenGetToken is used to retrieve the details associated with a token.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodQueryApplicationsQuery all registed applications including an optional identity filter (to return only applications registered by a given user)
Public methodQueryAuthorizedApplicationsGet the list of applications that have outstanding token grants for a particular identity
Public methodQueryRelatedTokensRetrieve 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 methodQueryTokensQueryTokens is used to retrieve the set of access tokens associated with a given identity within the given host.
Public methodRegisterApplicationRegister an application that has the given properties
Public methodRevokeApplicationRevokes any tokens associated with the given application for the user
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateApplicationUpdate the given application.
Top

  NameDescription
Explicit interface implemetationPrivate methodITeamFoundationService::ServiceEndImplementation of ITeamFoundationService.ServiceEnd
Explicit interface implemetationPrivate methodITeamFoundationService::ServiceStartImplementation of ITeamFoundationService.ServiceStart
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: