JwtTokenValidation.ValidateAuthHeader 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
ValidateAuthHeader(String, ICredentialProvider, IChannelProvider, String, String, HttpClient) |
Validates the authentication header of an incoming request. |
ValidateAuthHeader(String, ICredentialProvider, IChannelProvider, String, AuthenticationConfiguration, String, HttpClient) |
Validates the authentication header of an incoming request. |
ValidateAuthHeader(String, ICredentialProvider, IChannelProvider, String, String, HttpClient)
Validates the authentication header of an incoming request.
public static System.Threading.Tasks.Task<System.Security.Claims.ClaimsIdentity> ValidateAuthHeader (string authHeader, Microsoft.Bot.Connector.Authentication.ICredentialProvider credentials, Microsoft.Bot.Connector.Authentication.IChannelProvider channelProvider, string channelId, string serviceUrl = default, System.Net.Http.HttpClient httpClient = default);
static member ValidateAuthHeader : string * Microsoft.Bot.Connector.Authentication.ICredentialProvider * Microsoft.Bot.Connector.Authentication.IChannelProvider * string * string * System.Net.Http.HttpClient -> System.Threading.Tasks.Task<System.Security.Claims.ClaimsIdentity>
Public Shared Function ValidateAuthHeader (authHeader As String, credentials As ICredentialProvider, channelProvider As IChannelProvider, channelId As String, Optional serviceUrl As String = Nothing, Optional httpClient As HttpClient = Nothing) As Task(Of ClaimsIdentity)
Parameters
- authHeader
- String
The authentication header to validate.
- credentials
- ICredentialProvider
The bot's credential provider.
- channelProvider
- IChannelProvider
The bot's channel service provider.
- channelId
- String
The ID of the channel that sent the request.
- serviceUrl
- String
The service URL for the activity.
- httpClient
- HttpClient
The HTTP client.
Returns
A task that represents the work queued to execute.
Remarks
If the task completes successfully, the result contains the claims-based identity for the request.
Applies to
ValidateAuthHeader(String, ICredentialProvider, IChannelProvider, String, AuthenticationConfiguration, String, HttpClient)
Validates the authentication header of an incoming request.
public static System.Threading.Tasks.Task<System.Security.Claims.ClaimsIdentity> ValidateAuthHeader (string authHeader, Microsoft.Bot.Connector.Authentication.ICredentialProvider credentials, Microsoft.Bot.Connector.Authentication.IChannelProvider channelProvider, string channelId, Microsoft.Bot.Connector.Authentication.AuthenticationConfiguration authConfig, string serviceUrl = default, System.Net.Http.HttpClient httpClient = default);
static member ValidateAuthHeader : string * Microsoft.Bot.Connector.Authentication.ICredentialProvider * Microsoft.Bot.Connector.Authentication.IChannelProvider * string * Microsoft.Bot.Connector.Authentication.AuthenticationConfiguration * string * System.Net.Http.HttpClient -> System.Threading.Tasks.Task<System.Security.Claims.ClaimsIdentity>
Public Shared Function ValidateAuthHeader (authHeader As String, credentials As ICredentialProvider, channelProvider As IChannelProvider, channelId As String, authConfig As AuthenticationConfiguration, Optional serviceUrl As String = Nothing, Optional httpClient As HttpClient = Nothing) As Task(Of ClaimsIdentity)
Parameters
- authHeader
- String
The authentication header to validate.
- credentials
- ICredentialProvider
The bot's credential provider.
- channelProvider
- IChannelProvider
The bot's channel service provider.
- channelId
- String
The ID of the channel that sent the request.
- authConfig
- AuthenticationConfiguration
The authentication configuration.
- serviceUrl
- String
The service URL for the activity.
- httpClient
- HttpClient
The HTTP client.
Returns
A task that represents the work queued to execute.
Remarks
If the task completes successfully, the result contains the claims-based identity for the request.