ParameterizedBotFrameworkAuthentication class

Paket:

botframework-connector

Extends

BotFrameworkAuthentication

Konstruktoren

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Methoden

authenticateChannelRequest(string)
authenticateRequest(Activity, string)	Überprüfen sie Bot Framework-Protokollanforderungen.
authenticateStreamingRequest(string, string)	Überprüfen sie Bot Framework-Protokollanforderungen.
createBotFrameworkClient()	Erstellt einen BotFrameworkClient, der zum Aufrufen von Skills verwendet wird.
createConnectorFactory(ClaimsIdentity)	Erstellt eine ConnectorFactory, die zum Erstellen von ConnectorClients verwendet werden kann, die Anmeldeinformationen aus dieser bestimmten Cloudumgebung verwenden können.
createUserTokenClient(ClaimsIdentity)	Erstellt die entsprechende UserTokenClient-Instanz.
getOriginatingAudience()	Ruft die ursprüngliche Zielgruppe aus dem Bot OAuth-Bereich ab.

Details zum Konstruktor

ParameterizedBotFrameworkAuthentication(boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

new ParameterizedBotFrameworkAuthentication(validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialsFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

Parameter

validateAuthority

boolean

Der zu verwendende Wert der Validierungsautorität.

toChannelFromBotLoginUrl

string

Die zum Kanal von Bot-Anmelde-URL.

toChannelFromBotOAuthScope

string

Der oauth-Bereich zum Kanal von Bot.

toBotFromChannelTokenIssuer

string

Der an bot vom Kanaltokenaussteller.

oAuthUrl

string

Die OAuth-URL.

toBotFromChannelOpenIdMetadataUrl

string

Die url für den Bot von Open ID-Metadaten des Kanals.

toBotFromEmulatorOpenIdMetadataUrl

string

Die URL für den Bot von Open ID Metadata des Emulators.

callerId

string

Die für authentifizierte Aktivitäten festgelegte CallerId.

credentialsFactory

ServiceClientCredentialsFactory

Die ServiceClientCredentialsFactory , die zum Erstellen von Anmeldeinformationen verwendet werden soll.

authConfiguration

AuthenticationConfiguration

Die zu verwendende AuthenticationConfiguration .

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Der in BotFrameworkClient zu verwendende Abruf.

connectorClientOptions

ConnectorClientOptions

Die ConnectorClientOptions , die beim Erstellen von ConnectorClients verwendet werden sollen.

Details zur Methode

authenticateChannelRequest(string)

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

Parameter

authHeader

string

Der in der Qualifikationsanforderung empfangene HTTP-Authentifizierungsheader.

Gibt zurück

Promise<ClaimsIdentity>

Das Ergebnis der Identitätsüberprüfung.

authenticateRequest(Activity, string)

Überprüfen sie Bot Framework-Protokollanforderungen.

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

Parameter

activity

Activity

Die eingehende Aktivität.

authHeader

string

Der in der Qualifikationsanforderung empfangene HTTP-Authentifizierungsheader.

Gibt zurück

Promise<AuthenticateRequestResult>

Zusage mit AuthenticateRequestResult.

authenticateStreamingRequest(string, string)

Überprüfen sie Bot Framework-Protokollanforderungen.

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

Parameter

authHeader

string

Der in der Qualifikationsanforderung empfangene HTTP-Authentifizierungsheader.

channelIdHeader

string

Der HTTP-Header der Kanal-ID.

Gibt zurück

Promise<AuthenticateRequestResult>

Zusage mit AuthenticateRequestResult.

createBotFrameworkClient()

Erstellt einen BotFrameworkClient, der zum Aufrufen von Skills verwendet wird.

function createBotFrameworkClient(): BotFrameworkClient

Gibt zurück

BotFrameworkClient

Eine BotFrameworkClient-Instanz zum Aufrufen von Skills.

createConnectorFactory(ClaimsIdentity)

Erstellt eine ConnectorFactory, die zum Erstellen von ConnectorClients verwendet werden kann, die Anmeldeinformationen aus dieser bestimmten Cloudumgebung verwenden können.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Parameter

claimsIdentity

ClaimsIdentity

ClaimsIdentity der eingehenden Aktivität.

Gibt zurück

ConnectorFactory

Eine ConnectorFactory.

createUserTokenClient(ClaimsIdentity)

Erstellt die entsprechende UserTokenClient-Instanz.

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

Parameter

claimsIdentity

ClaimsIdentity

ClaimsIdentity der eingehenden Aktivität.

Gibt zurück

Promise<UserTokenClient>

Promise mit UserTokenClient-Instanz.

getOriginatingAudience()

Ruft die ursprüngliche Zielgruppe aus dem Bot OAuth-Bereich ab.

function getOriginatingAudience(): string

Gibt zurück

string

Die ursprüngliche Zielgruppe.