CommunicationIdentityClient class

Pakiet:

@azure/communication-identity

Klasa klienta do interakcji z zarządzaniem tokenami użytkownika Azure Communication Services.

Konstruktory

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Inicjuje nowe wystąpienie klasy CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Inicjuje nowe wystąpienie klasy CommunicationIdentity przy użyciu obiektu Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Inicjuje nowe wystąpienie klasy CommunicationIdentity przy użyciu tokenuCredential.

Metody

createUser(OperationOptions)	Tworzy jednego użytkownika.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Tworzy jednego użytkownika i token jednocześnie.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Wyzwala zdarzenie odwołania dla użytkownika i usuwa wszystkie jego dane.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Tworzy token użytkownika o określonym zakresie.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Wymienia Azure AD token dostępu użytkownika usługi Teams dla nowego tokenu dostępu tożsamości komunikacji z pasującym czasem wygaśnięcia.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Odwołuje wszystkie dane i tokeny utworzone dla użytkownika.

Szczegóły konstruktora

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Inicjuje nowe wystąpienie klasy CommunicationIdentity.

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

Parametry

connectionString

string

Parametry połączenia, aby nawiązać połączenie z zasobem usługi Azure Communication Service. Przykład: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";

options

CommunicationIdentityClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Inicjuje nowe wystąpienie klasy CommunicationIdentity przy użyciu obiektu Azure KeyCredential.

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

Parametry

endpoint

string

Punkt końcowy usługi (np. https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Obiekt używany do uwierzytelniania żądań w usłudze. Użyj elementu AzureKeyCredential lub @azure/identity utwórz poświadczenie.

options

CommunicationIdentityClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Inicjuje nowe wystąpienie klasy CommunicationIdentity przy użyciu tokenuCredential.

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

Parametry

endpoint

string

Punkt końcowy usługi (np. https://contoso.eastus.communications.azure.net).

credential

TokenCredential

Obiekt używany do uwierzytelniania żądań w usłudze. Użyj elementu AzureKeyCredential lub @azure/identity utwórz poświadczenie.

options

CommunicationIdentityClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Szczegóły metody

createUser(OperationOptions)

Tworzy jednego użytkownika.

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

Parametry

options

OperationOptions

Dodatkowe opcje żądania.

Zwraca

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Tworzy jednego użytkownika i token jednocześnie.

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

Parametry

scopes

TokenScope[]

Zakresy do uwzględnienia w tokenie.

options

CreateUserAndTokenOptions

Dodatkowe opcje żądania.

Zwraca

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Wyzwala zdarzenie odwołania dla użytkownika i usuwa wszystkie jego dane.

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

Parametry

user

CommunicationUserIdentifier

Użytkownik jest usuwany.

options

OperationOptions

Dodatkowe opcje żądania.

Zwraca

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Tworzy token użytkownika o określonym zakresie.

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

Parametry

user

CommunicationUserIdentifier

Użytkownik, którego tokeny są wystawiane.

scopes

TokenScope[]

Zakresy do uwzględnienia w tokenie.

options

GetTokenOptions

Dodatkowe opcje żądania.

Zwraca

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Wymienia Azure AD token dostępu użytkownika usługi Teams dla nowego tokenu dostępu tożsamości komunikacji z pasującym czasem wygaśnięcia.

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

Parametry

options

GetTokenForTeamsUserOptions

Opcje używane do wymiany Azure AD tokenu dostępu użytkownika usługi Teams dla nowego tokenu dostępu tożsamości komunikacji.

Zwraca

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Odwołuje wszystkie dane i tokeny utworzone dla użytkownika.

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

Parametry

user

CommunicationUserIdentifier

Użytkownik, którego tokeny są odwoływane.

options

OperationOptions

Dodatkowe opcje żądania.

Zwraca

Promise<void>