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?: CommunicationIdentityOptions): CommunicationIdentityClient
new CommunicationIdentityClient(url: string, credential: KeyCredential, options?: CommunicationIdentityOptions): CommunicationIdentityClient
new CommunicationIdentityClient(url: string, credential: TokenCredential, options?: CommunicationIdentityOptions): CommunicationIdentityClient

- Defined in communicationIdentityClient.ts:43
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 communicationIdentityClient.ts:51
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
- Defined in communicationIdentityClient.ts:63
Initializes a new instance of the CommunicationIdentity class using a TokenCredential.

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

Methods

createUser

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

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

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

createUserWithToken

createUserWithToken(scopes: TokenScope[], options?: OperationOptions): Promise<CreateUserWithTokenResponse>

- Defined in communicationIdentityClient.ts:206
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<CreateUserWithTokenResponse>

deleteUser

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

- Defined in communicationIdentityClient.ts:241
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<VoidResponse>

issueToken

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

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

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

revokeTokens

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

- Defined in communicationIdentityClient.ts:154
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<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

Parameters

url: string

credential: TokenCredential

Optional options: CommunicationIdentityOptions

Returns CommunicationIdentityClient

Methods

createUser

Parameters

Default value options: OperationOptions = {}

Returns Promise<CreateUserResponse>

createUserWithToken

Parameters

scopes: TokenScope[]

Default value options: OperationOptions = {}

Returns Promise<CreateUserWithTokenResponse>

deleteUser

Parameters

user: CommunicationUserIdentifier

Default value options: OperationOptions = {}

Returns Promise<VoidResponse>

issueToken

Parameters

user: CommunicationUserIdentifier

scopes: TokenScope[]

Default value options: OperationOptions = {}

Returns Promise<IssueTokenResponse>

revokeTokens

Parameters

user: CommunicationUserIdentifier

Default value options: OperationOptions = {}

Returns Promise<VoidResponse>