Compartir a través de

CertificateAppCredentials class

  • Referencia
Paquete:
botframework-connector

Implementación de autenticación de CertificateAppCredentials

Extends
AppCredentials

Constructores

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

Inicializa una nueva instancia de la clase CertificateAppCredentials.

Propiedades

certificatePrivateKey
certificateThumbprint
oAuthEndpoint

Obtiene el punto de conexión de OAuth que se va a usar. Establece el punto de conexión de OAuth que se va a usar.
oAuthScope

Obtiene el ámbito de OAuth que se va a usar. Establece el ámbito de OAuth que se va a usar.

Propiedades heredadas

appId
tokenCacheKey

Métodos heredados

getToken(boolean)

Obtiene un token de acceso de OAuth.
isTrustedServiceUrl(string)

Comprueba si la dirección URL del servicio es para un host de confianza o no.
signRequest(WebResource)

Aplique las credenciales a la solicitud HTTP.
trustServiceUrl(string, Date)

Agrega el host de la dirección URL del servicio a los hosts de confianza. Si no se proporciona la hora de expiración, la fecha de expiración será fecha actual (utc) + 1 día.

Detalles del constructor

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

Inicializa una nueva instancia de la clase CertificateAppCredentials.

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

Parámetros

appId

string

Identificador de aplicación de Microsoft relacionado con el certificado.

certificateThumbprint

string

Huella digital codificada hexadecimal del certificado.

certificatePrivateKey

string

Una clave privada de certificado codificado en PEM.

channelAuthTenant

string

Opcional. El inquilino del token de oauth.

oAuthScope

string

Opcional. Ámbito del token.

Detalles de las propiedades

certificatePrivateKey 

certificatePrivateKey: string

Valor de propiedad

string

certificateThumbprint 

certificateThumbprint: string

Valor de propiedad

string

oAuthEndpoint

Obtiene el punto de conexión de OAuth que se va a usar. Establece el punto de conexión de OAuth que se va a usar.

string oAuthEndpoint

Valor de propiedad

string

OAuthEndpoint que se va a usar.

oAuthScope

Obtiene el ámbito de OAuth que se va a usar. Establece el ámbito de OAuth que se va a usar.

string oAuthScope

Valor de propiedad

string

Ámbito de OAuth que se va a usar.

Detalles de las propiedades heredadas

appId 

appId: string

Valor de propiedad

string

heredado deappCredentials.appId

tokenCacheKey 

tokenCacheKey: string

Valor de propiedad

string

heredado deappCredentials.tokenCacheKey

Detalles de los métodos heredados

getToken(boolean)

Obtiene un token de acceso de OAuth.

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

Parámetros

forceRefresh

boolean

True para forzar una actualización del token; o false para obtener un token almacenado en caché si existe.

Devoluciones

Promise<string>

Promesa que representa el trabajo en cola que se va a ejecutar.

Comentarios

Si la promesa se realiza correctamente, el resultado contiene la cadena del token de acceso.

heredado deappCredentials.getToken

isTrustedServiceUrl(string)

Advertencia

Esta API ya está en desuso.

Comprueba si la dirección URL del servicio es para un host de confianza o no.

static function isTrustedServiceUrl(serviceUrl: string): boolean

Parámetros

serviceUrl

string

Dirección URL del servicio

Devoluciones

boolean

True si el host de la dirección URL del servicio es de confianza; False en caso contrario.

Heredado deAppCredentials.isTrustedServiceUrl

signRequest(WebResource)

Aplique las credenciales a la solicitud HTTP.

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

Parámetros

webResource

WebResource

Solicitud HTTP de WebResource.

Devoluciones

Promise<WebResource>

Promesa que representa la operación asincrónica.

heredado deappCredentials.signRequest

trustServiceUrl(string, Date)

Advertencia

Esta API ya está en desuso.

Agrega el host de la dirección URL del servicio a los hosts de confianza. Si no se proporciona la hora de expiración, la fecha de expiración será fecha actual (utc) + 1 día.

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

Parámetros

serviceUrl

string

Dirección URL del servicio

expiration

Date

Heredado deAppCredentials.trustServiceUrl