CommunicationIdentityClient | @azure/communication-identity

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

Hierarchy

CommunicationIdentityClient

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in communicationIdentityClient.ts:41
Initializes a new instance of the CommunicationIdentity class.

Parameters
- connectionString: string
  
  Connection string to connect to an Azure Communication Service resource. Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
- Optional options: CommunicationIdentityClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns CommunicationIdentityClient
- Defined in communicationIdentityClient.ts:49
Initializes a new instance of the CommunicationIdentity class using an Azure KeyCredential.

Parameters
- endpoint: string
  
  The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
- credential: KeyCredential
  
  An object that is used to authenticate requests to the service. Use the AzureKeyCredential or @azure/identity to create a credential.
- Optional options: CommunicationIdentityClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns CommunicationIdentityClient
- Defined in communicationIdentityClient.ts:61
Initializes a new instance of the CommunicationIdentity class using a TokenCredential.

Parameters
- endpoint: string
  
  The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
- credential: TokenCredential
  
  An object that is used to authenticate requests to the service. Use the AzureKeyCredential or @azure/identity to create a credential.
- Optional options: CommunicationIdentityClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns CommunicationIdentityClient

Methods

createUser

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

- Defined in communicationIdentityClient.ts:175
Creates a single user.

Parameters
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<CommunicationUserIdentifier>

createUserAndToken

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

- Defined in communicationIdentityClient.ts:199
Creates a single user and a token simultaneously.

Parameters
- scopes: TokenScope[]
  
  Scopes to include in the token.
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<CommunicationUserToken>

deleteUser

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

- Defined in communicationIdentityClient.ts:233
Triggers revocation event for user and deletes all its data.

Parameters
- user: CommunicationUserIdentifier
  
  The user being deleted.
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<void>

getToken

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

- Defined in communicationIdentityClient.ts:119
Creates a scoped user token.

Parameters
- user: CommunicationUserIdentifier
  
  The user whose tokens are being issued.
- scopes: TokenScope[]
  
  Scopes to include in the token.
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<CommunicationAccessToken>

getTokenForTeamsUser

getTokenForTeamsUser(teamsUserAadToken: string, options?: OperationOptions): Promise<CommunicationAccessToken>

- Defined in communicationIdentityClient.ts:260
Exchanges an AAD access token of a Teams user for a new Communication Identity access token with a matching expiration time.

Parameters
- teamsUserAadToken: string
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<CommunicationAccessToken>

revokeTokens

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

- Defined in communicationIdentityClient.ts:149
Revokes all data and tokens created for a user.

Parameters
- user: CommunicationUserIdentifier
  
  The user whose tokens are being revoked.
- Default value options: OperationOptions = {}
  
  Additional options for the request.
Returns Promise<void>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionString: string

Optional options: CommunicationIdentityClientOptions

Returns CommunicationIdentityClient

Parameters

endpoint: string

credential: KeyCredential

Optional options: CommunicationIdentityClientOptions

Returns CommunicationIdentityClient

Parameters

endpoint: string

credential: TokenCredential

Optional options: CommunicationIdentityClientOptions

Returns CommunicationIdentityClient

Methods

createUser

Parameters

Default value options: OperationOptions = {}

Returns Promise<CommunicationUserIdentifier>

createUserAndToken

Parameters

scopes: TokenScope[]

Default value options: OperationOptions = {}

Returns Promise<CommunicationUserToken>

deleteUser

Parameters

user: CommunicationUserIdentifier

Default value options: OperationOptions = {}

Returns Promise<void>

getToken

Parameters

user: CommunicationUserIdentifier

scopes: TokenScope[]

Default value options: OperationOptions = {}

Returns Promise<CommunicationAccessToken>

getTokenForTeamsUser

Parameters

teamsUserAadToken: string

Default value options: OperationOptions = {}

Returns Promise<CommunicationAccessToken>

revokeTokens

Parameters

user: CommunicationUserIdentifier

Default value options: OperationOptions = {}

Returns Promise<void>