Language

UserTokenClient.GetSignInUrlAsync Method

Definition

Gets the sign-in URL for the given state.

public virtual System.Threading.Tasks.Task<string?> GetSignInUrlAsync(string state, string? codeChallenge = default, Uri? emulatorUrl = default, Uri? finalRedirect = default, Microsoft.Teams.Core.Http.BotRequestContext? requestContext = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSignInUrlAsync : string * string * Uri * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.GetSignInUrlAsync : string * string * Uri * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Overridable Function GetSignInUrlAsync (state As String, Optional codeChallenge As String = Nothing, Optional emulatorUrl As Uri = Nothing, Optional finalRedirect As Uri = Nothing, Optional requestContext As BotRequestContext = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

state
String

The encoded state parameter.

codeChallenge
String

The optional code challenge for PKCE.

emulatorUrl
Uri

The optional emulator URL.

finalRedirect
Uri

The optional final redirect URL.

requestContext
BotRequestContext

Optional per-request properties used for authentication.

cancellationToken
CancellationToken

The cancellation token.

Returns

The sign-in URL, or null if not available.

Applies to