Freigeben über

AppCredentials class

  • Referenz
Paket:
botframework-connector

Allgemeine AppCredentials-Authentifizierungsimplementierung und Cache. Unterstützt jeden ADAL-Clientanmeldeinformationsflow. Unterklassen können refreshToken implementieren, um das Token abzurufen.

Konstruktoren

AppCredentials(string, string, string)

Initialisiert eine neue Instanz der AppCredentials-Klasse .

Eigenschaften

appId
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.
tokenCacheKey

Methoden

getToken(boolean)

Ruft ein OAuth-Zugriffstoken ab.
isTrustedServiceUrl(string)

Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host steht oder nicht.
signRequest(WebResource)

Wenden Sie die Anmeldeinformationen auf die HTTP-Anforderung an.
trustServiceUrl(string, Date)

Fügt den Host der Dienst-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben wird, lautet das Ablaufdatum das aktuelle Datum (utc) + 1 Tag.

Details zum Konstruktor

AppCredentials(string, string, string)

Initialisiert eine neue Instanz der AppCredentials-Klasse .

new AppCredentials(appId: string, channelAuthTenant?: string, oAuthScope?: string)

Parameter

appId

string

Die App-ID.

channelAuthTenant

string

Optional. Der oauth-Tokenmandant.

oAuthScope

string

Der Bereich für das Token.

Details zur Eigenschaft

appId 

appId: 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.

tokenCacheKey 

tokenCacheKey: string

Eigenschaftswert

string

Details zur 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, sofern vorhanden.

Gibt zurück

Promise<string>

Eine Zusage, die die auszuführende Arbeit in der Warteschlange darstellt.

Hinweise

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

isTrustedServiceUrl(string)

Warnung

Diese API ist nun veraltet.

Überprüft, ob die Dienst-URL für einen vertrauenswürdigen Host steht 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.

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.

trustServiceUrl(string, Date)

Warnung

Diese API ist nun veraltet.

Fügt den Host der Dienst-URL zu vertrauenswürdigen Hosts hinzu. Wenn keine Ablaufzeit angegeben wird, lautet das Ablaufdatum das aktuelle Datum (utc) + 1 Tag.

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

Parameter

serviceUrl

string

Die Dienst-URL

expiration

Date