CommunicationIdentityClient class

Paket:

@azure/communication-identity

Kelas klien untuk berinteraksi dengan Manajemen Token Pengguna Azure Communication Services.

Konstruktor

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Menginisialisasi instans baru kelas CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Menginisialisasi instans baru kelas CommunicationIdentity menggunakan Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Menginisialisasi instans baru kelas CommunicationIdentity menggunakan TokenCredential.

Metode

createUser(OperationOptions)	Membuat satu pengguna.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Membuat satu pengguna dan token secara bersamaan.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Memicu peristiwa pencabutan untuk pengguna dan menghapus semua datanya.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Membuat token pengguna terlingkup.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Menukar token akses Microsoft Azure Active Directory pengguna Teams dengan token akses Identitas Komunikasi baru dengan waktu kedaluwarsa yang cocok.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Mencabut semua data dan token yang dibuat untuk pengguna.

Detail Konstruktor

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Menginisialisasi instans baru kelas CommunicationIdentity.

new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityClientOptions)

Parameter

connectionString

string

String koneksi untuk menyambungkan ke sumber daya Azure Communication Service. Contoh: "titik akhir=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

CommunicationIdentityClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Menginisialisasi instans baru kelas CommunicationIdentity menggunakan Azure KeyCredential.

new CommunicationIdentityClient(endpoint: string, credential: KeyCredential, options?: CommunicationIdentityClientOptions)

Parameter

endpoint

string

Titik akhir layanan (misalnya: https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Objek yang digunakan untuk mengautentikasi permintaan ke layanan. Gunakan AzureKeyCredential atau @azure/identity untuk membuat kredensial.

options

CommunicationIdentityClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Menginisialisasi instans baru kelas CommunicationIdentity menggunakan TokenCredential.

new CommunicationIdentityClient(endpoint: string, credential: TokenCredential, options?: CommunicationIdentityClientOptions)

Parameter

endpoint

string

Titik akhir layanan (misalnya: https://contoso.eastus.communications.azure.net)

credential

TokenCredential

TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan.

options

CommunicationIdentityClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

Detail Metode

createUser(OperationOptions)

Membuat satu pengguna.

function createUser(options?: OperationOptions): Promise<CommunicationUserIdentifier>

Parameter

options

OperationOptions

Opsi tambahan untuk permintaan.

Mengembalikan

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Membuat satu pengguna dan token secara bersamaan.

function createUserAndToken(scopes: TokenScope[], options?: CreateUserAndTokenOptions): Promise<CommunicationUserToken>

Parameter

scopes

TokenScope[]

Cakupan untuk disertakan dalam token.

options

CreateUserAndTokenOptions

Opsi tambahan untuk permintaan.

Mengembalikan

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Memicu peristiwa pencabutan untuk pengguna dan menghapus semua datanya.

function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Parameter

user

CommunicationUserIdentifier

Pengguna sedang dihapus.

options

OperationOptions

Opsi tambahan untuk permintaan.

Mengembalikan

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Membuat token pengguna terlingkup.

function getToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: GetTokenOptions): Promise<CommunicationAccessToken>

Parameter

user

CommunicationUserIdentifier

Pengguna yang tokennya dikeluarkan.

scopes

TokenScope[]

Cakupan untuk disertakan dalam token.

options

GetTokenOptions

Opsi tambahan untuk permintaan.

Mengembalikan

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Menukar token akses Microsoft Azure Active Directory pengguna Teams dengan token akses Identitas Komunikasi baru dengan waktu kedaluwarsa yang cocok.

function getTokenForTeamsUser(options: GetTokenForTeamsUserOptions): Promise<CommunicationAccessToken>

Parameter

options

GetTokenForTeamsUserOptions

Opsi yang digunakan untuk menukar token akses Microsoft Azure AD pengguna Teams dengan token akses Identitas Komunikasi baru.

Mengembalikan

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Mencabut semua data dan token yang dibuat untuk pengguna.

function revokeTokens(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Parameter

user

CommunicationUserIdentifier

Pengguna yang tokennya sedang dicabut.

options

OperationOptions

Opsi tambahan untuk permintaan.

Mengembalikan

Promise<void>