UserTokenClient.GetSignInResourceAsync Method
Definition
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.
Overloads
| Name | Description |
|---|---|
| GetSignInResourceAsync(String, String, String, String, BotRequestContext, CancellationToken) |
Get the token or raw signin link to be sent to the user for signin for a connection. Builds the state parameter internally from the userId and connectionName. |
| GetSignInResourceAsync(String, String, Uri, Uri, BotRequestContext, CancellationToken) |
Gets the sign-in resource for the given state. |
GetSignInResourceAsync(String, String, String, String, BotRequestContext, CancellationToken)
Get the token or raw signin link to be sent to the user for signin for a connection. Builds the state parameter internally from the userId and connectionName.
public virtual System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult> GetSignInResourceAsync(string userId, string connectionName, string channelId, string? finalRedirect = default, Microsoft.Teams.Core.Http.BotRequestContext? requestContext = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetSignInResourceAsync : string * string * string * string * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult>
override this.GetSignInResourceAsync : string * string * string * string * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult>Public Overridable Function GetSignInResourceAsync (userId As String, connectionName As String, channelId As String, Optional finalRedirect As String = Nothing, Optional requestContext As BotRequestContext = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetSignInResourceResult)Parameters
- userId
- String
The user ID.
- connectionName
- String
The connection name.
- channelId
- String
The channel ID.
- finalRedirect
- String
The optional final redirect URL.
- requestContext
- BotRequestContext
Optional per-request properties used for authentication.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
A task that represents the asynchronous operation. The result contains the sign-in resource with the sign-in link and token exchange information.
Applies to
GetSignInResourceAsync(String, String, Uri, Uri, BotRequestContext, CancellationToken)
Gets the sign-in resource for the given state.
public virtual System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult> GetSignInResourceAsync(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 GetSignInResourceAsync : string * string * Uri * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult>
override this.GetSignInResourceAsync : string * string * Uri * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.GetSignInResourceResult>Public Overridable Function GetSignInResourceAsync (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 GetSignInResourceResult)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 resource result.