CertificateAppCredentials class

Paket:

botframework-connector

CertificateAppCredentials-Authentifizierungsimplementierung

Extends

AppCredentials

Konstruktoren

CertificateAppCredentials(string, string, string, string, string)

Initialisiert eine neue Instanz der CertificateAppCredentials Klasse.

Eigenschaften

certificatePrivateKey
certificateThumbprint
oAuthEndpoint	Ruft den zu verwendenden OAuth-Endpunkt ab. Legt den zu verwendenden OAuth-Endpunkt fest.
oAuthScope	Ruft den zu verwendenden OAuth-Bereich ab. Legt den zu verwendenden OAuth-Bereich fest.

Geerbte Eigenschaften

appId
tokenCacheKey

Geerbte Methoden

getToken(boolean)	Ruft ein OAuth-Zugriffstoken ab.
isTrustedServiceUrl(string)	Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host gilt oder nicht.
signRequest(WebResource)	Wenden Sie die Anmeldeinformationen auf die HTTP-Anforderung an.
trustServiceUrl(string, Date)	Fügt die Host-of-Service-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben wird, ist das Ablaufdatum das aktuelle (utc)-Datum + 1 Tag.

Details zum Konstruktor

CertificateAppCredentials(string, string, string, string, string)

Initialisiert eine neue Instanz der CertificateAppCredentials Klasse.

new CertificateAppCredentials(appId: string, certificateThumbprint: string, certificatePrivateKey: string, channelAuthTenant?: string, oAuthScope?: string)

Parameter

appId

string

Microsoft-Anwendungs-ID im Zusammenhang mit dem Zertifikat.

certificateThumbprint

string

Ein hexadierter Fingerabdruck des Zertifikats.

certificatePrivateKey

string

Ein PEM-codierter privater Zertifikatschlüssel.

channelAuthTenant

string

Wahlfrei. Der Oauth-Tokenmandant.

oAuthScope

string

Wahlfrei. Der Bereich für das Token.

Details zur Eigenschaft

certificatePrivateKey

certificatePrivateKey: string

Eigenschaftswert

string

certificateThumbprint

certificateThumbprint: string

Eigenschaftswert

string

oAuthEndpoint

Ruft den zu verwendenden OAuth-Endpunkt ab. Legt den zu verwendenden OAuth-Endpunkt fest.

string oAuthEndpoint

Eigenschaftswert

string

Der zu verwendende OAuthEndpoint.

oAuthScope

Ruft den zu verwendenden OAuth-Bereich ab. Legt den zu verwendenden OAuth-Bereich fest.

string oAuthScope

Eigenschaftswert

string

Der zu verwendende OAuth-Bereich.

Geerbte Eigenschaftsdetails

appId

appId: string

Eigenschaftswert

string

geerbt vonAppCredentials.appId-

tokenCacheKey

tokenCacheKey: string

Eigenschaftswert

string

geerbt vonAppCredentials.tokenCacheKey-

Details zur geerbten Methode

getToken(boolean)

Ruft ein OAuth-Zugriffstoken ab.

function getToken(forceRefresh?: boolean): Promise<string>

Parameter

forceRefresh

boolean

True, um eine Aktualisierung des Tokens zu erzwingen; oder false, um ein zwischengespeichertes Token abzurufen, falls vorhanden.

Gibt zurück

Promise<string>

Eine Zusage, die die auszuführende Arbeitswarteschlange darstellt.

Hinweise

Wenn die Zusage erfolgreich ist, enthält das Ergebnis die Zugriffstokenzeichenfolge.

geerbt vonAppCredentials.getToken

isTrustedServiceUrl(string)

Warnung

Diese API ist nun veraltet.

Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host gilt oder nicht.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parameter

serviceUrl

string

Die Dienst-URL

Gibt zurück

boolean

True, wenn der Host der Dienst-URL vertrauenswürdig ist; Andernfalls "False".

vonAppCredentials.isTrustedServiceUrl

signRequest(WebResource)

Wenden Sie die Anmeldeinformationen auf die HTTP-Anforderung an.

function signRequest(webResource: WebResource): Promise<WebResource>

Parameter

webResource

WebResource

Die WebResource-HTTP-Anforderung.

Gibt zurück

Promise<WebResource>

Eine Zusage, die den asynchronen Vorgang darstellt.

geerbt vonAppCredentials.signRequest

trustServiceUrl(string, Date)

Warnung

Diese API ist nun veraltet.

Fügt die Host-of-Service-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben wird, ist das Ablaufdatum das aktuelle (utc)-Datum + 1 Tag.

static function trustServiceUrl(serviceUrl: string, expiration?: Date)

Parameter

serviceUrl

string

Die Dienst-URL

expiration

Date

geerbt vonAppCredentials.trustServiceUrl