BotFrameworkAuthentication class

Paquet:

botframework-connector

Représente un environnement cloud utilisé pour authentifier les appels réseau Bot Framework Protocol dans cet environnement.

Méthodes

authenticateChannelRequest(string)	Authentifiez la demande de protocole Bot Framework auprès des compétences.
authenticateRequest(Activity, string)	Valider les demandes du protocole Bot Framework.
authenticateStreamingRequest(string, string)	Valider les demandes du protocole Bot Framework.
createBotFrameworkClient()	Crée un BotFrameworkClient pour appeler des compétences.
createConnectorFactory(ClaimsIdentity)	Crée un ConnectorFactory qui peut être utilisé pour créer ConnectorClients qui peut utiliser des informations d’identification à partir de cet environnement cloud particulier.
createUserTokenClient(ClaimsIdentity)	Crée l’instance UserTokenClient appropriée.
getOriginatingAudience()	Obtient l’audience d’origine à partir de l’étendue OAuth du bot.

Détails de la méthode

authenticateChannelRequest(string)

Authentifiez la demande de protocole Bot Framework auprès des compétences.

function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>

Paramètres

authHeader

string

En-tête d’authentification HTTP dans la requête de compétence.

Retours

Promise<ClaimsIdentity>

ClaimsIdentity.

authenticateRequest(Activity, string)

Valider les demandes du protocole Bot Framework.

function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>

Paramètres

activity

Activity

Activité entrante.

authHeader

string

En-tête d’authentification HTTP.

Retours

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

Valider les demandes du protocole Bot Framework.

function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>

Paramètres

authHeader

string

En-tête d’authentification HTTP.

channelIdHeader

string

En-tête HTTP DE l’ID de canal.

Retours

Promise<AuthenticateRequestResult>

Un AuthenticateRequestResult.

createBotFrameworkClient()

Crée un BotFrameworkClient pour appeler des compétences.

function createBotFrameworkClient(): BotFrameworkClient

Retours

BotFrameworkClient

Un BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Crée un ConnectorFactory qui peut être utilisé pour créer ConnectorClients qui peut utiliser des informations d’identification à partir de cet environnement cloud particulier.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Paramètres

claimsIdentity

ClaimsIdentity

ClaimsIdentity de l’activité entrante.

Retours

ConnectorFactory

ConnectorFactory.

createUserTokenClient(ClaimsIdentity)

Crée l’instance UserTokenClient appropriée.

function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>

Paramètres

claimsIdentity

ClaimsIdentity

ClaimsIdentity de l’activité entrante.

Retours

Promise<UserTokenClient>

Un UserTokenClient.

getOriginatingAudience()

Obtient l’audience d’origine à partir de l’étendue OAuth du bot.

function getOriginatingAudience(): string

Retours

string

Public d’origine.