C# Class Microsoft.Alm.Authentication.VstsAadAuthentication

Facilitates Azure Directory authentication.

Inheritance: BaseVstsAuthentication, IVstsAadAuthentication

Mostrar archivo Open project: Microsoft/Git-Credential-Manager-for-Windows Class Usage Examples

Public Methods

Method	Description
InteractiveLogon ( TargetUri targetUri, bool requestCompactToken ) : Task	Creates an interactive logon session, using ADAL secure browser GUI, which enables users to authenticate with the Azure tenant and acquire the necessary access tokens to exchange for a VSTS personal access token. Tokens acquired are stored in the secure secret stores provided during initialization.
NoninteractiveLogon ( TargetUri targetUri, bool requestCompactToken ) : Task	Uses Active Directory Federation Services to authenticate with the Azure tenant non-interactively and acquire the necessary access tokens to exchange for a VSTS personal access token. Tokens acquired are stored in the secure secret stores provided during initialization.
SetCredentials ( TargetUri targetUri, Credential credentials ) : void	Sets credentials for future use with this authentication object. Not supported.
VstsAadAuthentication ( System.Guid tenantId, VstsTokenScope tokenScope, ICredentialStore personalAccessTokenStore ) : System

Private Methods

Method	Description
VstsAadAuthentication ( ICredentialStore personalAccessTokenStore, ITokenStore vstsIdeTokenCache, IVstsAuthority vstsAuthority ) : System	Test constructor which allows for using fake credential stores

Method Details

InteractiveLogon() public method

Creates an interactive logon session, using ADAL secure browser GUI, which enables users to authenticate with the Azure tenant and acquire the necessary access tokens to exchange for a VSTS personal access token.

Tokens acquired are stored in the secure secret stores provided during initialization.

public InteractiveLogon ( TargetUri targetUri, bool requestCompactToken ) : Task
targetUri	TargetUri	The unique identifier for the resource for which access is to /// be acquired.
requestCompactToken	bool	/// Requests a compact format personal access token; otherwise requests a standard /// personal access token. /// Compact tokens are necessary for clients which have restrictions on the size of /// the basic authentication header which they can create (example: Git). ///
return	Task

NoninteractiveLogon() public method

Uses Active Directory Federation Services to authenticate with the Azure tenant non-interactively and acquire the necessary access tokens to exchange for a VSTS personal access token.

Tokens acquired are stored in the secure secret stores provided during initialization.

public NoninteractiveLogon ( TargetUri targetUri, bool requestCompactToken ) : Task
targetUri	TargetUri	The unique identifier for the resource for which access is to /// be acquired.
requestCompactToken	bool	/// Requests a compact format personal access token; otherwise requests a standard /// personal access token. /// Compact tokens are necessary for clients which have restrictions on the size of /// the basic authentication header which they can create (example: Git). ///
return	Task

SetCredentials() public method

Sets credentials for future use with this authentication object.

Not supported.

public SetCredentials ( TargetUri targetUri, Credential credentials ) : void
targetUri	TargetUri	/// The uniform resource indicator of the resource access tokens are being set for. ///
credentials	Credential	The credentials being set.
return	void

VstsAadAuthentication() public method

public VstsAadAuthentication ( System.Guid tenantId, VstsTokenScope tokenScope, ICredentialStore personalAccessTokenStore ) : System
tenantId	System.Guid	/// The unique identifier for the responsible Azure tenant. /// Use /// to detect the tenant identity and create the authentication object. ///
tokenScope	VstsTokenScope	The scope of all access tokens acquired by the authority.
personalAccessTokenStore	ICredentialStore	The secure secret store for storing any personal /// access tokens acquired.
return	System