Megosztás a következőn keresztül:

Azure Communication Identity ügyfélkódtár JavaScripthez – 1.3.1-es verzió

  • Cikk

Az identitástár a Azure Communication Services felhasználóinak és jogkivonatainak kezelésére szolgál.

Első lépések

Előfeltételek

Telepítés

npm install @azure/communication-identity

Böngészőtámogatás

JavaScript-csomag

Ahhoz, hogy ezt az ügyfélkódtárat a böngészőben használhassa, először egy kötegelőt kell használnia. Ennek módjáról a csomagkontraszt dokumentációjában talál további információt.

Fő fogalmak

Ügyfelek

A CommunicationIdentityClient a felhasználók és jogkivonataik kezelésére szolgáló módszereket biztosít.

Példák

Hitelesítés

Kulcs és/vagy kapcsolati karakterlánc az Azure Portalon található Communication Services-erőforrásból szerezheti be. Miután rendelkezik egy kulccsal, a CommunicationIdentityClient következő módszerek bármelyikével hitelesítheti:

Létrehozás KeyCredential az AzureKeyCredential ügyfél inicializálása előtt

import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationIdentityClient } from "@azure/communication-identity";

const credential = new AzureKeyCredential(KEY);
const client = new CommunicationIdentityClient(ENDPOINT, credential);

Kapcsolati karakterlánc használata

import { CommunicationIdentityClient } from "@azure/communication-identity";

const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationIdentityClient(connectionString);

Egy TokenCredential

import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationIdentityClient } from "@azure/communication-identity";

const credential = new DefaultAzureCredential();
const client = new CommunicationIdentityClient(ENDPOINT, credential);

Ha kulcs használatával inicializálja az ügyfelet, meg kell adnia a megfelelő végpontot is. Ezt a végpontot a Communication Services-erőforrásból szerezheti be az Azure Portalon.

Használat

A CommunicationIdentityClient példányának létrehozása

import { CommunicationIdentityClient } from "@azure/communication-identity";

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Új felhasználó létrehozása

createUser A metódus használatával hozzon létre egy új felhasználót.

const user = await client.createUser();

Felhasználói jogkivonat létrehozása és frissítése

A metódussal getToken kibocsáthat vagy frissíthet egy jogkivonatot egy meglévő felhasználó számára. A metódus a kommunikációs jogkivonat hatóköreinek listáját is felveszi. A hatókör beállításai a következők:

  • chat (Használja ezt a csevegési API-k teljes körű eléréséhez)
  • voip (Használja ezt a hívó API-k teljes hozzáféréséhez)
  • chat.join (Hozzáférés csevegési API-khoz, de a csevegési szálak létrehozására, törlésére vagy frissítésére vonatkozó engedély nélkül)
  • chat.join.limited (A chat.join egy korlátozottabb verziója, amely nem teszi lehetővé résztvevők hozzáadását vagy eltávolítását)
  • voip.join (Hozzáférés a hívó API-khoz, de új hívások indításának engedélyezése nélkül)
let { token } = await client.getToken(user, ["chat"]);

A felhasználói jogkivonat frissítéséhez állíts ki egy másik jogkivonatot ugyanazzal a felhasználóval.

let { token } = await client.getToken(user, ["chat"]);

Felhasználói jogkivonat létrehozása egyéni lejárattal

A lejárati idő testreszabásával kommunikációs identitás hozzáférési jogkivonatot is létrehozhat. A jogkivonat érvényességi időtartamának [60 1440] percen belül kell lennie. Ha nincs megadva, a rendszer az alapértelmezett 1440 perc (24 óra) értéket használja.

const tokenOptions: GetTokenOptions = { tokenExpiresInMinutes: 60 };
let { token } = await client.getToken(user, ["chat"], tokenOptions);

Felhasználó és jogkivonat létrehozása egyetlen kérelemben

Az egyszerűség kedvéért hozzon létre egy új felhasználót, createUserAndToken és adjon ki egy jogkivonatot egy függvényhívással. Ez egyetlen webes kérésre fordítható le, nem pedig egy felhasználó létrehozására, majd egy jogkivonat kiadására.

let { user, token } = await client.createUserAndToken(["chat"]);

Felhasználó és jogkivonat létrehozása egyéni lejárattal egyetlen kérelemben

A lejárati idő testreszabásával kommunikációs identitás hozzáférési jogkivonatot is létrehozhat. A jogkivonat érvényességi időtartamának [60 1440] percen belül kell lennie. Ha nincs megadva, a rendszer az alapértelmezett 1440 perc (24 óra) értéket használja.

const userAndTokenOptions: CreateUserAndTokenOptions = { tokenExpiresInMinutes: 60 };
let { user, token } = await client.createUserAndToken(["chat"], userAndTokenOptions);

Felhasználó jogkivonatainak visszavonása

A metódussal revokeTokens visszavonhatja a felhasználó összes kibocsátott jogkivonatát.

await client.revokeTokens(user);

Felhasználó törlése

A metódussal deleteUser törölhet egy felhasználót.

await client.deleteUser(user);

Teams-felhasználó Azure AD hozzáférési jogkivonatának cseréje kommunikációs hozzáférési jogkivonatra

Egy getTokenForTeamsUser Teams-felhasználó Azure AD hozzáférési jogkivonatának cseréje egy új, egyező lejárati idővel rendelkező új CommunicationAccessToken jogkivonat cseréjére.

await client.getTokenForTeamsUser({
  teamsUserAadToken: "<aad-access-token-of-a-teams-user>",
  clientId: "<cliend-id-of-an-aad-application>",
  userObjectId: "<aad-object-id-of-a-teams-user>",
});

Hibaelhárítás

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintakönyvtárat.

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót , amelyből többet is megtudhat a kód buildeléséhez és teszteléséhez.

Megjelenések