TeamsUserCredential.GetTokenAsync Method

Definition

Namespace:: Microsoft.TeamsFx

Assembly:: Microsoft.TeamsFx.dll

Package:: Microsoft.TeamsFx v2.3.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets an Azure.Core.AccessToken for the specified set of scopes.

public override System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync(Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken);

override this.GetTokenAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>

Public Overrides Function GetTokenAsync (requestContext As TokenRequestContext, cancellationToken As CancellationToken) As ValueTask(Of AccessToken)

Parameters

requestContext: TokenRequestContext

The Azure.Core.TokenRequestContext with authentication information.

cancellationToken: CancellationToken

The System.Threading.CancellationToken to use.

Returns

ValueTask<AccessToken>

A valid Azure.Core.AccessToken.

Exceptions

RuntimeNotSupported

When runtime is not in browser enviroment.

InternalError

When failed to login with unknown error.

UiRequiredError

When need user consent to get access token.

ServiceError

When failed to get access token from identity server(AAD).

Examples

For example:

// Get Graph access token for single scope
await teamsUserCredential.GetTokenAsync(new TokenRequestContext(new string[] { "User.Read" }), new CancellationToken());
// Get Graph access token for multiple scopes
await teamsUserCredential.GetTokenAsync(new TokenRequestContext(new string[] { "User.Read", "Application.Read.All" }), new CancellationToken());

Remarks

Can only be used within Teams.

Applies to