Condividi tramite

CommunicationIdentityClient class

  • Riferimento
Pacchetto:
@azure/communication-identity

Classe client per l'interazione con Servizi di comunicazione di Azure Gestione token utente.

Costruttori

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity usando un'istanza di Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity usando un tokenCredential.

Metodi

createUser(OperationOptions)

Crea un singolo utente.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Crea un singolo utente e un token contemporaneamente.
deleteUser(CommunicationUserIdentifier, OperationOptions)

Attiva l'evento di revoca per l'utente ed elimina tutti i dati.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Crea un token utente con ambito.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Scambia un token di accesso di Azure AD di un utente di Teams per un nuovo token di accesso alle identità di comunicazione con una scadenza corrispondente.
revokeTokens(CommunicationUserIdentifier, OperationOptions)

Revoca tutti i dati e i token creati per un utente.

Dettagli costruttore

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity.

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

Parametri

connectionString

string

Stringa di connessione per connettersi a una risorsa del servizio di comunicazione di Azure. Esempio: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";

options
CommunicationIdentityClientOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity usando un'istanza di Azure KeyCredential.

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

Parametri

endpoint

string

Endpoint del servizio (ad esempio: https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Oggetto utilizzato per autenticare le richieste al servizio. Usare AzureKeyCredential o @azure/identity per creare una credenziale.

options
CommunicationIdentityClientOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Inizializza una nuova istanza della classe CommunicationIdentity usando un tokenCredential.

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

Parametri

endpoint

string

Endpoint del servizio (ad esempio: https://contoso.eastus.communications.azure.net).

credential

TokenCredential

Oggetto utilizzato per autenticare le richieste al servizio. Usare AzureKeyCredential o @azure/identity per creare una credenziale.

options
CommunicationIdentityClientOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

Dettagli metodo

createUser(OperationOptions)

Crea un singolo utente.

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

Parametri

options

OperationOptions

Opzioni aggiuntive per la richiesta.

Restituisce

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Crea un singolo utente e un token contemporaneamente.

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

Parametri

scopes

TokenScope[]

Ambiti da includere nel token.

options
CreateUserAndTokenOptions

Opzioni aggiuntive per la richiesta.

Restituisce

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Attiva l'evento di revoca per l'utente ed elimina tutti i dati.

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

Parametri

user

CommunicationUserIdentifier

L'utente eliminato.

options

OperationOptions

Opzioni aggiuntive per la richiesta.

Restituisce

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Crea un token utente con ambito.

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

Parametri

user

CommunicationUserIdentifier

Utente il cui token viene emesso.

scopes

TokenScope[]

Ambiti da includere nel token.

options
GetTokenOptions

Opzioni aggiuntive per la richiesta.

Restituisce

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Scambia un token di accesso di Azure AD di un utente di Teams per un nuovo token di accesso alle identità di comunicazione con una scadenza corrispondente.

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

Parametri

options
GetTokenForTeamsUserOptions

Opzioni usate per scambiare un token di accesso di Azure AD di un utente di Teams per un nuovo token di accesso alle identità di comunicazione.

Restituisce

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Revoca tutti i dati e i token creati per un utente.

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

Parametri

user

CommunicationUserIdentifier

L'utente il cui token viene revocato.

options

OperationOptions

Opzioni aggiuntive per la richiesta.

Restituisce

Promise<void>