C# Class Microsoft.Alm.Authentication.BaseVstsAuthentication

Base functionality for performing authentication operations against Visual Studio Online.

Inheritance: BaseAuthentication

Public Properties

Property	Type	Description
BaseVstsAuthentication	System

Method	Description
DeleteCredentials ( TargetUri targetUri ) : void	Deletes a set of stored credentials by their target resource.
DetectAuthority ( TargetUri targetUri, System.Guid &tenantId ) : bool	Detects the backing authority of the end-point.
GetAuthentication ( TargetUri targetUri, VstsTokenScope scope, ICredentialStore personalAccessTokenStore ) : BaseAuthentication	Creates a new authentication broker based for the specified resource.
GetCredentials ( TargetUri targetUri ) : Credential	Attempts to get a set of credentials from storage by their target resource.
ValidateCredentials ( TargetUri targetUri, Credential credentials ) : Task	Validates that a set of credentials grants access to the target resource.

Method	Description
BaseVstsAuthentication ( VstsTokenScope tokenScope, ICredentialStore personalAccessTokenStore ) : System
GeneratePersonalAccessToken ( TargetUri targetUri, Token accessToken, bool requestCompactToken ) : Task	Generates a "personal access token" or service specific, usage resticted access token.

Method	Description
BaseVstsAuthentication ( ICredentialStore personalAccessTokenStore, ITokenStore vstsIdeTokenCache, IVstsAuthority vstsAuthority ) : System

protected BaseVstsAuthentication ( VstsTokenScope tokenScope, ICredentialStore personalAccessTokenStore ) : System
tokenScope	VstsTokenScope
personalAccessTokenStore	ICredentialStore
return	System

Deletes a set of stored credentials by their target resource.

public DeleteCredentials ( TargetUri targetUri ) : void
targetUri	TargetUri	The 'key' by which to identify credentials.
return	void

Detects the backing authority of the end-point.

public static DetectAuthority ( TargetUri targetUri, System.Guid &tenantId ) : bool
targetUri	TargetUri	The resource which the authority protects.
tenantId	System.Guid	The identity of the authority tenant; otherwise.
return	bool

Generates a "personal access token" or service specific, usage resticted access token.

protected GeneratePersonalAccessToken ( TargetUri targetUri, Token accessToken, bool requestCompactToken ) : Task
targetUri	TargetUri	The target resource for which to acquire the personal access /// token for.
accessToken	Token	Azure Directory access token with privileges to grant access /// to the target resource.
requestCompactToken	bool	Generates a compact token if ; /// generates a self describing token if .
return	Task

Creates a new authentication broker based for the specified resource.

public static GetAuthentication ( TargetUri targetUri, VstsTokenScope scope, ICredentialStore personalAccessTokenStore ) : BaseAuthentication
targetUri	TargetUri	The resource for which authentication is being requested.
scope	VstsTokenScope	The scope of the access being requested.
personalAccessTokenStore	ICredentialStore	Storage container for personal access token secrets.
return	BaseAuthentication

Attempts to get a set of credentials from storage by their target resource.

public GetCredentials ( TargetUri targetUri ) : Credential
targetUri	TargetUri	The 'key' by which to identify credentials.
return	Credential

Validates that a set of credentials grants access to the target resource.

public ValidateCredentials ( TargetUri targetUri, Credential credentials ) : Task
targetUri	TargetUri	The target resource to validate against.
credentials	Credential	The credentials to validate.
return	Task

The application client identity by which access will be requested.

public string ClientId
return	string

The Azure resource for which access will be requested.

public string Resource
return	string

The desired scope of the authentication token to be requested.

public VstsTokenScope,Microsoft.Alm.Authentication TokenScope
return	VstsTokenScope