Compartilhar via

UserTokenClient class

  • Referência
Pacote:
botframework-connector

Cliente para acessar o serviço de token de usuário.

Métodos

exchangeToken(string, string, string, TokenExchangeRequest)

Executa uma operação de troca de token, como para logon único.
getAadTokens(string, string, string[], string)

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.
getSignInResource(string, Activity, string)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
getTokenStatus(string, string, string)

Recupera o status do token para cada conexão configurada para o usuário especificado.
getUserToken(string, string, string, string)

Tenta recuperar o token de um usuário que está em um fluxo de logon.
signOutUser(string, string, string)

Desconscreve o usuário com o servidor de token.

Detalhes do método

exchangeToken(string, string, string, TokenExchangeRequest)

Executa uma operação de troca de token, como para logon único.

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parâmetros

userId

string

A ID de usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

exchangeRequest

TokenExchangeRequest

Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Retornos

Promise<TokenResponse>

Um objeto TokenResponse .

getAadTokens(string, string, string[], string)

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

Parâmetros

userId

string

A ID de usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

resourceUrls

string[]

A lista de URLs de recurso para a qual recuperar tokens.

channelId

string

A ID do canal que será associada ao token.

Retornos

Promise<Record<string, TokenResponse>>

Um dicionário de resourceUrls para o TokenResponse correspondente.

getSignInResource(string, Activity, string)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

function getSignInResource(connectionName: string, activity: Activity, finalRediect: string): Promise<SignInUrlResponse>

Parâmetros

connectionName

string

Nome da conexão de autenticação a ser usada.

activity

Activity

A Atividade da qual derivar o estado de troca de token.

finalRediect

string

A URL final para a qual o fluxo OAuth será redirecionada.

Retornos

Promise<SignInUrlResponse>

Um SignInUrlResponse.

getTokenStatus(string, string, string)

Recupera o status do token para cada conexão configurada para o usuário especificado.

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

Parâmetros

userId

string

A ID de usuário que será associada ao token.

channelId

string

A ID do canal que será associada ao token.

includeFilter

string

O includeFilter.

Retornos

Promise<TokenStatus[]>

Uma lista de objetos TokenStatus .

getUserToken(string, string, string, string)

Tenta recuperar o token de um usuário que está em um fluxo de logon.

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

Parâmetros

userId

string

A ID de usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

magicCode

string

(Opcional) O usuário opcional inseriu código para validar.

Retornos

Promise<TokenResponse>

Um objeto TokenResponse .

signOutUser(string, string, string)

Desconscreve o usuário com o servidor de token.

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

Parâmetros

userId

string

A ID de usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

Retornos

Promise<void>