Partager via

CommunicationIdentityClient class

  • Référence
Paquet:
@azure/communication-identity

Classe cliente pour interagir avec Azure Communication Services gestion des jetons utilisateur.

Constructeurs

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity à l’aide d’azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity à l’aide d’un TokenCredential.

Méthodes

createUser(OperationOptions)

Crée un seul utilisateur.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Crée un seul utilisateur et un jeton simultanément.
deleteUser(CommunicationUserIdentifier, OperationOptions)

Déclenche un événement de révocation pour l’utilisateur et supprime toutes ses données.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Crée un jeton utilisateur délimité.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Échange un jeton d’accès Azure AD d’un utilisateur Teams contre un nouveau jeton d’accès d’identité de communication avec un délai d’expiration correspondant.
revokeTokens(CommunicationUserIdentifier, OperationOptions)

Révoque toutes les données et jetons créés pour un utilisateur.

Détails du constructeur

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity.

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

Paramètres

connectionString

string

Chaîne de connexion pour se connecter à une ressource Azure Communication Service. Exemple : « endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret »;

options
CommunicationIdentityClientOptions

Optionnel. Options de configuration du pipeline HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity à l’aide d’azure KeyCredential.

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

Paramètres

endpoint

string

Point de terminaison du service (ex : https://contoso.eastus.communications.azure.net).

credential
KeyCredential

Objet utilisé pour authentifier les demandes adressées au service. Utilisez AzureKeyCredential ou @azure/identity pour créer des informations d’identification.

options
CommunicationIdentityClientOptions

Optionnel. Options de configuration du pipeline HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Initialise une nouvelle instance de la classe CommunicationIdentity à l’aide d’un TokenCredential.

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

Paramètres

endpoint

string

Point de terminaison du service (par exemple : https://contoso.eastus.communications.azure.net)

credential
TokenCredential

TokenCredential utilisé pour authentifier les demandes adressées au service.

options
CommunicationIdentityClientOptions

Optionnel. Options de configuration du pipeline HTTP.

Détails de la méthode

createUser(OperationOptions)

Crée un seul utilisateur.

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

Paramètres

options
OperationOptions

Options supplémentaires pour la demande.

Retours

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Crée un seul utilisateur et un jeton simultanément.

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

Paramètres

scopes

TokenScope[]

Étendues à inclure dans le jeton.

options
CreateUserAndTokenOptions

Options supplémentaires pour la demande.

Retours

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Déclenche un événement de révocation pour l’utilisateur et supprime toutes ses données.

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

Paramètres

user
CommunicationUserIdentifier

Utilisateur en cours de suppression.

options
OperationOptions

Options supplémentaires pour la demande.

Retours

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Crée un jeton utilisateur délimité.

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

Paramètres

user
CommunicationUserIdentifier

Utilisateur dont les jetons sont émis.

scopes

TokenScope[]

Étendues à inclure dans le jeton.

options
GetTokenOptions

Options supplémentaires pour la demande.

Retours

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Échange un jeton d’accès Azure AD d’un utilisateur Teams contre un nouveau jeton d’accès d’identité de communication avec un délai d’expiration correspondant.

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

Paramètres

options
GetTokenForTeamsUserOptions

Options utilisées pour échanger un jeton d’accès Azure AD d’un utilisateur Teams contre un nouveau jeton d’accès d’identité de communication.

Retours

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Révoque toutes les données et jetons créés pour un utilisateur.

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

Paramètres

user
CommunicationUserIdentifier

Utilisateur dont les jetons sont révoqués.

options
OperationOptions

Options supplémentaires pour la demande.

Retours

Promise<void>