Azure Communication Identity-clientbibliotheek voor JavaScript - versie 1.3.1

De identiteitsbibliotheek wordt gebruikt voor het beheren van gebruikers en tokens voor Azure Communication Services.

Aan de slag

Vereisten

• Een Azure-abonnement.
• Een bestaande Communication Services-resource. Als u de resource wilt maken, kunt u de Azure-portal, de Azure PowerShell of de Azure CLI gebruiken.

Installeren

npm install @azure/communication-identity

Browserondersteuning

JavaScript-bundel

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze documentatie voor bundeling voor meer informatie over hoe u dit doet.

Belangrijkste concepten

Clients

De CommunicationIdentityClient biedt methoden voor het beheren van gebruikers en hun tokens.

Voorbeelden

Verificatie

U kunt een sleutel en/of verbindingsreeks ophalen uit uw Communication Services-resource in Azure Portal. Zodra u een sleutel hebt, kunt u de CommunicationIdentityClient verifiëren met een van de volgende methoden:

Maken KeyCredential met AzureKeyCredential voordat u de client initialiseert

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

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

Een verbindingsreeks gebruiken

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

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

Een TokenCredential

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

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

Als u een sleutel gebruikt om de client te initialiseren, moet u ook het juiste eindpunt opgeven. U kunt dit eindpunt ophalen uit uw Communication Services-resource in Azure Portal.

Gebruik

Een exemplaar van CommunicationIdentityClient maken

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

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Een nieuwe gebruiker maken

Gebruik de createUser methode om een nieuwe gebruiker te maken.

const user = await client.createUser();

Een gebruikerstoken maken en vernieuwen

Gebruik de getToken methode om een token uit te geven of te vernieuwen voor een bestaande gebruiker. De methode neemt ook een lijst met communicatietokenbereiken op. Bereikopties zijn onder andere:

• chat (Gebruik dit voor volledige toegang tot chat-API's)
• voip (Gebruik dit voor volledige toegang tot aanroepende API's)
• chat.join (Toegang tot chat-API's, maar zonder de autorisatie voor het maken, verwijderen of bijwerken van chat-threads)
• chat.join.limited (Een beperktere versie van chat.join die het toevoegen of verwijderen van deelnemers niet toestaat)
• voip.join (Toegang tot aanroep-API's, maar zonder autorisatie om nieuwe aanroepen te starten)

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

Als u het gebruikerstoken wilt vernieuwen, geeft u een ander token uit met dezelfde gebruiker.

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

Een gebruikerstoken met aangepaste vervaldatum maken

Het is ook mogelijk om een communicatie-id-toegangstoken te maken door de verlooptijd aan te passen. De geldigheidsperiode van het token moet binnen het bereik van [60.1440] minuten liggen. Als dit niet wordt opgegeven, wordt de standaardwaarde van 1440 minuten (24 uur) gebruikt.

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

Een gebruiker en een token maken in één aanvraag

Gebruik voor het createUserAndToken gemak om een nieuwe gebruiker te maken en een token uit te geven met één functieaanroep. Dit vertaalt zich in één webaanvraag in plaats van eerst een gebruiker te maken en vervolgens een token uit te geven.

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

Een gebruiker en een token met aangepaste vervaldatum maken in één aanvraag

Het is ook mogelijk om een communicatie-id-toegangstoken te maken door de verlooptijd aan te passen. De geldigheidsperiode van het token moet binnen het bereik van [60.1440] minuten liggen. Als dit niet wordt opgegeven, wordt de standaardwaarde van 1440 minuten (24 uur) gebruikt.

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

Tokens intrekken voor een gebruiker

Gebruik de revokeTokens methode om alle uitgegeven tokens voor een gebruiker in te trekken.

await client.revokeTokens(user);

Een gebruiker verwijderen

Gebruik de deleteUser methode om een gebruiker te verwijderen.

await client.deleteUser(user);

Azure AD toegangstoken van een Teams-gebruiker inwisselen voor een communicatietoegangstoken

Gebruik getTokenForTeamsUser de methode om een Azure AD toegangstoken van een Teams-gebruiker in te wisselen voor een nieuwe CommunicationAccessToken met een overeenkomende verlooptijd.

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>",
});

Problemen oplossen

Volgende stappen

Bekijk de map met voorbeelden voor gedetailleerde voorbeelden van het gebruik van deze bibliotheek.

Bijdragen

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de handleiding voor bijdragen voor meer informatie over het bouwen en testen van de code.

Verwante projecten

• Microsoft Azure SDK voor Javascript