UserTokenClient class

Paket:

botframework-connector

Klien untuk mengakses layanan token pengguna.

Metode

exchangeToken(string, string, string, TokenExchangeRequest)	Melakukan operasi pertukaran token seperti untuk akses menyeluruh.
getAadTokens(string, string, string[], string)	Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi.
getSignInResource(string, Activity, string)	Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.
getTokenStatus(string, string, string)	Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu.
getUserToken(string, string, string, string)	Mencoba mengambil token untuk pengguna yang berada dalam alur masuk.
signOutUser(string, string, string)	Mengeluarkan pengguna dengan server token.

Detail Metode

exchangeToken(string, string, string, TokenExchangeRequest)

Melakukan operasi pertukaran token seperti untuk akses menyeluruh.

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

Parameter

userId

string

Id pengguna yang akan dikaitkan dengan token.

connectionName

string

Nama koneksi autentikasi yang akan digunakan.

channelId

string

Id saluran yang akan dikaitkan dengan token.

exchangeRequest

TokenExchangeRequest

Detail permintaan pertukaran, baik token untuk ditukar atau uri untuk ditukar.

Mengembalikan

Promise<TokenResponse>

Objek TokenResponse .

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

Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi.

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

Parameter

userId

string

Id pengguna yang akan dikaitkan dengan token.

connectionName

string

Nama koneksi autentikasi yang akan digunakan.

resourceUrls

string[]

Daftar URL sumber daya untuk mengambil token.

channelId

string

Id saluran yang akan dikaitkan dengan token.

Mengembalikan

Promise<Record<string, TokenResponse>>

Kamus resourceUrls keTokenResponse yang sesuai.

getSignInResource(string, Activity, string)

Dapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.

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

Parameter

connectionName

string

Nama koneksi autentikasi yang akan digunakan.

activity

Activity

Aktivitas untuk memperoleh status pertukaran token.

finalRediect

string

URL akhir yang akan dialihkan oleh alur OAuth.

Mengembalikan

Promise<SignInUrlResponse>

SignInUrlResponse .

getTokenStatus(string, string, string)

Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu.

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

Parameter

userId

string

Id pengguna yang akan dikaitkan dengan token.

channelId

string

Id saluran yang akan dikaitkan dengan token.

includeFilter

string

IncludeFilter.

Mengembalikan

Promise<TokenStatus[]>

Daftar objek TokenStatus .

getUserToken(string, string, string, string)

Mencoba mengambil token untuk pengguna yang berada dalam alur masuk.

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

Parameter

userId

string

Id pengguna yang akan dikaitkan dengan token.

connectionName

string

Nama koneksi autentikasi yang akan digunakan.

channelId

string

Id saluran yang akan dikaitkan dengan token.

magicCode

string

(Opsional) Pengguna opsional memasukkan kode untuk divalidasi.

Mengembalikan

Promise<TokenResponse>

Objek TokenResponse .

signOutUser(string, string, string)

Mengeluarkan pengguna dengan server token.

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

Parameter

userId

string

Id pengguna yang akan dikaitkan dengan token.

connectionName

string

Nama koneksi autentikasi yang akan digunakan.

channelId

string

Id saluran yang akan dikaitkan dengan token.

Mengembalikan

Promise<void>