C# Класс Microsoft.Alm.Authentication.BaseVstsAuthentication

Base functionality for performing authentication operations against Visual Studio Online.
Наследование: BaseAuthentication
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
ClientId string
Resource string
TokenScope VstsTokenScope

Private Properties

Свойство Тип Описание
BaseVstsAuthentication System

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
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.

Приватные методы

Метод Описание
BaseVstsAuthentication ( ICredentialStore personalAccessTokenStore, ITokenStore vstsIdeTokenCache, IVstsAuthority vstsAuthority ) : System

Описание методов

BaseVstsAuthentication() защищенный Метод

protected BaseVstsAuthentication ( VstsTokenScope tokenScope, ICredentialStore personalAccessTokenStore ) : System
tokenScope VstsTokenScope
personalAccessTokenStore ICredentialStore
Результат System

DeleteCredentials() публичный Метод

Deletes a set of stored credentials by their target resource.
public DeleteCredentials ( TargetUri targetUri ) : void
targetUri TargetUri The 'key' by which to identify credentials.
Результат void

DetectAuthority() публичный статический Метод

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.
Результат bool

GeneratePersonalAccessToken() защищенный Метод

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 .
Результат Task

GetAuthentication() публичный статический Метод

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.
Результат BaseAuthentication

GetCredentials() публичный Метод

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.
Результат Credential

ValidateCredentials() публичный Метод

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.
Результат Task

Описание свойств

ClientId публичное свойство

The application client identity by which access will be requested.
public string ClientId
Результат string

Resource публичное свойство

The Azure resource for which access will be requested.
public string Resource
Результат string

TokenScope публичное свойство

The desired scope of the authentication token to be requested.
public VstsTokenScope,Microsoft.Alm.Authentication TokenScope
Результат VstsTokenScope