CommunicationIdentityClient | @azure/communication-administration

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

Hierarchy

CommunicationIdentityClient

Index

Constructors

constructor

Methods

Constructors

constructor

new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityOptions): CommunicationIdentityClient
new CommunicationIdentityClient(url: string, credential: KeyCredential, options?: CommunicationIdentityOptions): CommunicationIdentityClient

- Defined in communicationIdentity/communicationIdentityClient.ts:48
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: CommunicationIdentityOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns CommunicationIdentityClient
- Defined in communicationIdentity/communicationIdentityClient.ts:56
Initializes a new instance of the CommunicationIdentity class using an Azure KeyCredential.

Parameters
- url: 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: CommunicationIdentityOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns CommunicationIdentityClient

Methods

createUser

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

- Defined in communicationIdentity/communicationIdentityClient.ts:186
Creates a single user.

Parameters
- Default value options: OperationOptions = {}
Returns Promise<CreateUserResponse>

deleteUser

deleteUser(user: CommunicationUser, options?: OperationOptions): Promise<VoidResponse>

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

Parameters
- user: CommunicationUser
  
  The user being deleted.
- Default value options: OperationOptions = {}
Returns Promise<VoidResponse>

issueToken

issueToken(user: CommunicationUser, scopes: TokenScope[], options?: OperationOptions): Promise<IssueTokenResponse>

- Defined in communicationIdentity/communicationIdentityClient.ts:121
Creates a scoped user token.

Parameters
- user: CommunicationUser
  
  The user whose tokens are being revoked.
- scopes: TokenScope[]
  
  Scopes to include in the token.
- Default value options: OperationOptions = {}
Returns Promise<IssueTokenResponse>

revokeTokens

revokeTokens(user: CommunicationUser, tokensValidFrom?: Date, options?: OperationOptions): Promise<VoidResponse>

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

Parameters
- user: CommunicationUser
  
  The user whose tokens are being revoked.
- Default value tokensValidFrom: Date = new Date()
  
  Tokens issued before this time will be revoked.
- Default value options: OperationOptions = {}
Returns Promise<VoidResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionString: string

Optional options: CommunicationIdentityOptions

Returns CommunicationIdentityClient

Parameters

url: string

credential: KeyCredential

Optional options: CommunicationIdentityOptions

Returns CommunicationIdentityClient

Methods

createUser

Parameters

Default value options: OperationOptions = {}

Returns Promise<CreateUserResponse>

deleteUser

Parameters

user: CommunicationUser

Default value options: OperationOptions = {}

Returns Promise<VoidResponse>

issueToken

Parameters

user: CommunicationUser

scopes: TokenScope[]

Default value options: OperationOptions = {}

Returns Promise<IssueTokenResponse>

revokeTokens

Parameters

user: CommunicationUser

Default value tokensValidFrom: Date = new Date()

Default value options: OperationOptions = {}

Returns Promise<VoidResponse>