Share via


BotFrameworkAdapter.GetAadTokensAsync Method

Definition

Overloads

GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)

Retrieves Azure Active Directory tokens for particular resources on a configured connection, using the bot's AppCredentials.

GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)

Retrieves Azure Active Directory tokens for particular resources on a configured connection, using customized AppCredentials.

GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)

Retrieves Azure Active Directory tokens for particular resources on a configured connection, using the bot's AppCredentials.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,Microsoft.Bot.Schema.TokenResponse>> GetAadTokensAsync (Microsoft.Bot.Builder.ITurnContext context, string connectionName, string[] resourceUrls, string userId = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAadTokensAsync : Microsoft.Bot.Builder.ITurnContext * string * string[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string, Microsoft.Bot.Schema.TokenResponse>>
override this.GetAadTokensAsync : Microsoft.Bot.Builder.ITurnContext * string * string[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string, Microsoft.Bot.Schema.TokenResponse>>
Public Overridable Function GetAadTokensAsync (context As ITurnContext, connectionName As String, resourceUrls As String(), Optional userId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Dictionary(Of String, TokenResponse))

Parameters

context
ITurnContext

Context for the current turn of conversation with the user.

connectionName
String

The name of the Azure Active Directory connection configured with this bot.

resourceUrls
String[]

The list of resource URLs to retrieve tokens for.

userId
String

The user Id for which tokens are retrieved. If passing in null the userId is taken from the Activity in the ITurnContext.

cancellationToken
CancellationToken

The async operation cancellation token.

Returns

Dictionary of resourceUrl to the corresponding TokenResponse.

Implements

Applies to

GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)

Retrieves Azure Active Directory tokens for particular resources on a configured connection, using customized AppCredentials.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,Microsoft.Bot.Schema.TokenResponse>> GetAadTokensAsync (Microsoft.Bot.Builder.ITurnContext context, Microsoft.Bot.Connector.Authentication.AppCredentials oAuthAppCredentials, string connectionName, string[] resourceUrls, string userId = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAadTokensAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string, Microsoft.Bot.Schema.TokenResponse>>
override this.GetAadTokensAsync : Microsoft.Bot.Builder.ITurnContext * Microsoft.Bot.Connector.Authentication.AppCredentials * string * string[] * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string, Microsoft.Bot.Schema.TokenResponse>>
Public Overridable Function GetAadTokensAsync (context As ITurnContext, oAuthAppCredentials As AppCredentials, connectionName As String, resourceUrls As String(), Optional userId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Dictionary(Of String, TokenResponse))

Parameters

context
ITurnContext

Context for the current turn of conversation with the user.

oAuthAppCredentials
AppCredentials

AppCredentials for OAuth.

connectionName
String

The name of the Azure Active Directory connection configured with this bot.

resourceUrls
String[]

The list of resource URLs to retrieve tokens for.

userId
String

The user Id for which tokens are retrieved. If passing in null the userId is taken from the Activity in the ITurnContext.

cancellationToken
CancellationToken

The async operation cancellation token.

Returns

Dictionary of resourceUrl to the corresponding TokenResponse.

Implements

Applies to