Compartir a través de

UserTokenClient class

  • Referencia
Paquete:
botframework-connector

Cliente para el servicio de token de usuario de acceso.

Métodos

exchangeToken(string, string, string, TokenExchangeRequest)

Realiza una operación de intercambio de tokens, como para el inicio de sesión único.
getAadTokens(string, string, string[], string)

Recupera tokens de Azure Active Directory para determinados recursos en una conexión configurada.
getSignInResource(string, Activity, string)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para que inicie sesión para un nombre de conexión.
getTokenStatus(string, string, string)

Recupera el estado del token para cada conexión configurada para el usuario especificado.
getUserToken(string, string, string, string)

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión.
signOutUser(string, string, string)

Cierra la sesión del usuario con el servidor de tokens.

Detalles del método

exchangeToken(string, string, string, TokenExchangeRequest)

Realiza una operación de intercambio de tokens, como para el inicio de sesión único.

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

Parámetros

userId

string

Identificador de usuario que se asociará al token.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

channelId

string

Identificador de canal que se asociará al token.

exchangeRequest

TokenExchangeRequest

Los detalles de la solicitud de intercambio, ya sea un token para intercambiar o un URI que se va a intercambiar.

Devoluciones

Promise<TokenResponse>

Objeto TokenResponse .

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

Recupera tokens de Azure Active Directory para determinados recursos en una conexión configurada.

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

Parámetros

userId

string

Identificador de usuario que se asociará al token.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

resourceUrls

string[]

Lista de direcciones URL de recursos para las que se van a recuperar tokens.

channelId

string

Identificador de canal que se asociará al token.

Devoluciones

Promise<Record<string, TokenResponse>>

Diccionario de resourceUrls al tokenResponse correspondiente.

getSignInResource(string, Activity, string)

Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para que inicie sesión para un nombre de conexión.

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

Parámetros

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

activity

Activity

Actividad desde la que se deriva el estado de intercambio de tokens.

finalRediect

string

Dirección URL final a la que se redirigirá el flujo de OAuth.

Devoluciones

Promise<SignInUrlResponse>

SignInUrlResponse.

getTokenStatus(string, string, string)

Recupera el estado del token para cada conexión configurada para el usuario especificado.

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

Parámetros

userId

string

Identificador de usuario que se asociará al token.

channelId

string

Identificador de canal que se asociará al token.

includeFilter

string

IncludeFilter.

Devoluciones

Promise<TokenStatus[]>

Lista de objetos TokenStatus .

getUserToken(string, string, string, string)

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión.

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

Parámetros

userId

string

Identificador de usuario que se asociará al token.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

channelId

string

Identificador de canal que se asociará al token.

magicCode

string

(Opcional) El usuario opcional escribió código para validarlo.

Devoluciones

Promise<TokenResponse>

Objeto TokenResponse .

signOutUser(string, string, string)

Cierra la sesión del usuario con el servidor de tokens.

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

Parámetros

userId

string

Identificador de usuario que se asociará al token.

connectionName

string

Nombre de la conexión de autenticación que se va a usar.

channelId

string

Identificador de canal que se asociará al token.

Devoluciones

Promise<void>