CommunicationIdentityClient class
Kelas klien untuk berinteraksi dengan Manajemen Token Pengguna Azure Communication Services.
Konstruktor
| Communication |
Menginisialisasi instans baru kelas CommunicationIdentity. |
| Communication |
Menginisialisasi instans baru kelas CommunicationIdentity menggunakan Azure KeyCredential. |
| Communication |
Menginisialisasi instans baru kelas CommunicationIdentity menggunakan TokenCredential. |
Metode
| create |
Membuat satu pengguna. |
| delete |
Memicu peristiwa pencabutan untuk pengguna dan menghapus semua datanya. |
| issue |
Membuat token pengguna terlingkup. |
| revoke |
Mencabut semua data dan token yang dibuat untuk pengguna. |
Detail Konstruktor
CommunicationIdentityClient(string, CommunicationIdentityOptions)
Menginisialisasi instans baru kelas CommunicationIdentity.
new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityOptions)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
- CommunicationIdentityOptions
Fakultatif. Opsi untuk mengonfigurasi alur HTTP.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityOptions)
Menginisialisasi instans baru kelas CommunicationIdentity menggunakan Azure KeyCredential.
new CommunicationIdentityClient(url: string, credential: KeyCredential, options?: CommunicationIdentityOptions)Parameter
- url
-
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
- CommunicationIdentityOptions
Fakultatif. Opsi untuk mengonfigurasi alur HTTP.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityOptions)
Menginisialisasi instans baru kelas CommunicationIdentity menggunakan TokenCredential.
new CommunicationIdentityClient(url: string, credential: TokenCredential, options?: CommunicationIdentityOptions)Parameter
- url
-
string
Titik akhir layanan (misalnya: https://contoso.eastus.communications.azure.net)
- credential
- TokenCredential
TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan.
- options
- CommunicationIdentityOptions
Fakultatif. Opsi untuk mengonfigurasi alur HTTP.
Detail Metode
createUser(OperationOptions)
Membuat satu pengguna.
function createUser(options?: OperationOptions): Promise<CreateUserResponse>Parameter
- options
- OperationOptions
Opsi tambahan untuk permintaan.
Mengembalikan
Promise<CreateUserResponse>
deleteUser(CommunicationUserIdentifier, OperationOptions)
Memicu peristiwa pencabutan untuk pengguna dan menghapus semua datanya.
function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parameter
Pengguna sedang dihapus.
- options
- OperationOptions
Opsi tambahan untuk permintaan.
Mengembalikan
Promise<{ _response: HttpResponse }>
issueToken(CommunicationUserIdentifier, TokenScope[], OperationOptions)
Membuat token pengguna terlingkup.
function issueToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: OperationOptions): Promise<IssueTokenResponse>Parameter
Pengguna yang tokennya sedang dicabut.
- scopes
Cakupan untuk disertakan dalam token.
- options
- OperationOptions
Opsi tambahan untuk permintaan.
Mengembalikan
Promise<IssueTokenResponse>
revokeTokens(CommunicationUserIdentifier, Date, OperationOptions)
Mencabut semua data dan token yang dibuat untuk pengguna.
function revokeTokens(user: CommunicationUserIdentifier, tokensValidFrom?: Date, options?: OperationOptions): Promise<{ _response: HttpResponse }>Parameter
Pengguna yang tokennya sedang dicabut.
- tokensValidFrom
-
Date
Token yang diterbitkan sebelum waktu ini akan dicabut.
- options
- OperationOptions
Opsi tambahan untuk permintaan.
Mengembalikan
Promise<{ _response: HttpResponse }>
