Compartilhar via

BotFrameworkAuthentication class

  • Referência
Pacote:
botframework-connector

Representa um ambiente de nuvem usado para autenticar chamadas de rede do Bot Framework Protocol dentro desse ambiente.

Métodos

authenticateChannelRequest(string)

Autentique a solicitação de Protocolo do Bot Framework para Habilidades.
authenticateRequest(Activity, string)

Validar solicitações do Bot Framework Protocol.
authenticateStreamingRequest(string, string)

Validar solicitações do Bot Framework Protocol.
createBotFrameworkClient()

Cria um BotFrameworkClient para chamar habilidades.
createConnectorFactory(ClaimsIdentity)

Cria um ConnectorFactory que pode ser usado para criar ConnectorClients que podem usar credenciais desse ambiente de nuvem específico.
createUserTokenClient(ClaimsIdentity)

Cria a instância userTokenClient apropriada.
getOriginatingAudience()

Obtém o público de origem do escopo do Bot OAuth.

Detalhes do método

authenticateChannelRequest(string)

Autentique a solicitação de Protocolo do Bot Framework para Habilidades.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação HTTP na solicitação de habilidade.

Retornos

Promise<ClaimsIdentity>

UmclaimsIdentity .

authenticateRequest(Activity, string)

Validar solicitações do Bot Framework Protocol.

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

Parâmetros

activity

Activity

A atividade de entrada.

authHeader

string

O cabeçalho de autenticação HTTP.

Retornos

Promise<AuthenticateRequestResult>

UmAuthenticateRequestResult .

authenticateStreamingRequest(string, string)

Validar solicitações do Bot Framework Protocol.

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

Parâmetros

authHeader

string

O cabeçalho de autenticação HTTP.

channelIdHeader

string

O cabeçalho HTTP da ID do canal.

Retornos

Promise<AuthenticateRequestResult>

UmAuthenticateRequestResult .

createBotFrameworkClient()

Cria um BotFrameworkClient para chamar habilidades.

function createBotFrameworkClient(): BotFrameworkClient

Retornos

BotFrameworkClient

Um BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Cria um ConnectorFactory que pode ser usado para criar ConnectorClients que podem usar credenciais desse ambiente de nuvem específico.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Parâmetros

claimsIdentity
ClaimsIdentity

ClaimsIdentity da atividade de entrada.

Retornos

ConnectorFactory

UmConnectorFactory .

createUserTokenClient(ClaimsIdentity)

Cria a instância userTokenClient apropriada.

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

Parâmetros

claimsIdentity
ClaimsIdentity

ClaimsIdentity da atividade de entrada.

Retornos

Promise<UserTokenClient>

UmUserTokenClient .

getOriginatingAudience()

Obtém o público de origem do escopo do Bot OAuth.

function getOriginatingAudience(): string

Retornos

string

O público de origem.