@azure/communication-identity package

Classes

CommunicationIdentityClient

Client class for interacting with Azure Communication Services User Token Management.

Interfaces

CommunicationAccessToken

The access token for a user.

CommunicationIdentityClientOptions

Client options used to configure the CommunicationIdentity API requests.

CommunicationUserToken

The issued token and the user it was issued for.

CreateUserAndTokenOptions

Options to create a single user and a token simultaneously.

CreateUserOptions

Options to create a single user.

GetTokenForTeamsUserOptions

Options used to exchange an AAD access token of a Teams user for a new Communication Identity access token.

GetTokenOptions

Options to create a scoped user token.

Type Aliases

TokenScope

Represents the scope of the token.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type