Package com.azure.communication.identity

Class CommunicationIdentityAsyncClient

java.lang.Object
com.azure.communication.identity.CommunicationIdentityAsyncClient
public final class CommunicationIdentityAsyncClient extends Object
Asynchronous client interface for Azure Communication Services Identity operations

Instantiating an asynchronous Azure Communication Service Identity Client

 // You can find your endpoint and access key from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 AzureKeyCredential keyCredential = new AzureKeyCredential("<access-key>");

 CommunicationIdentityAsyncClient communicationIdentityAsyncClient = new CommunicationIdentityClientBuilder()
         .endpoint(endpoint)
         .credential(keyCredential)
         .buildAsyncClient();

View this for additional ways to construct the client.

See Also:

  • Method Details

    • createUser

      public Mono<com.azure.communication.common.CommunicationUserIdentifier> createUser()
      Creates a new CommunicationUserIdentifier.
      Returns:
      The created communication user.

    • createUserWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.communication.common.CommunicationUserIdentifier>> createUserWithResponse()
      Creates a new CommunicationUserIdentifier with response.
      Returns:
      The created communication user with response.

    • createUserAndToken

      public Mono<CommunicationUserIdentifierAndToken> createUserAndToken(Iterable<CommunicationTokenScope> scopes, Duration tokenExpiresIn)
      Creates a new CommunicationUserIdentifier with token.
      Parameters:
      scopes - The list of scopes for the token.
      tokenExpiresIn - Custom validity period of the Communication Identity access token within [1,24] hours range. If not provided, the default value of 24 hours will be used.
      Returns:
      The created communication user and token.

    • createUserAndToken

      public Mono<CommunicationUserIdentifierAndToken> createUserAndToken(Iterable<CommunicationTokenScope> scopes)
      Creates a new CommunicationUserIdentifier with token.
      Parameters:
      scopes - The list of scopes for the token.
      Returns:
      The created communication user and token.

    • createUserAndTokenWithResponse

      public Mono<com.azure.core.http.rest.Response<CommunicationUserIdentifierAndToken>> createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes, Duration tokenExpiresIn)
      Creates a new CommunicationUserIdentifier with token with response.
      Parameters:
      scopes - The list of scopes for the token.
      tokenExpiresIn - Custom validity period of the Communication Identity access token within [1,24] hours range. If not provided, the default value of 24 hours will be used.
      Returns:
      The result with created communication user and token with response.

    • createUserAndTokenWithResponse

      public Mono<com.azure.core.http.rest.Response<CommunicationUserIdentifierAndToken>> createUserAndTokenWithResponse(Iterable<CommunicationTokenScope> scopes)
      Creates a new CommunicationUserIdentifier with token with response.
      Parameters:
      scopes - The list of scopes for the token.
      Returns:
      The result with created communication user and token with response.

    • deleteUser

      public Mono<Void> deleteUser(com.azure.communication.common.CommunicationUserIdentifier communicationUser)
      Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data.
      Parameters:
      communicationUser - The user to be deleted.
      Returns:
      A reactive response signalling completion.

    • deleteUserWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> deleteUserWithResponse(com.azure.communication.common.CommunicationUserIdentifier communicationUser)
      Deletes a CommunicationUserIdentifier, revokes its tokens and deletes its data with response.
      Parameters:
      communicationUser - The user to be deleted.
      Returns:
      The response with void.

    • revokeTokens

      public Mono<Void> revokeTokens(com.azure.communication.common.CommunicationUserIdentifier communicationUser)
      Revokes all the tokens created for an identifier.
      Parameters:
      communicationUser - The user to be revoked access tokens.
      Returns:
      A reactive response signalling completion.

    • revokeTokensWithResponse

      public Mono<com.azure.core.http.rest.Response<Void>> revokeTokensWithResponse(com.azure.communication.common.CommunicationUserIdentifier communicationUser)
      Revokes all the tokens created for an identifier with response.
      Parameters:
      communicationUser - The user to be revoked tokens.
      Returns:
      The response with void.

    • getToken

      public Mono<com.azure.core.credential.AccessToken> getToken(com.azure.communication.common.CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Duration tokenExpiresIn)
      Gets a Communication Identity access token for a CommunicationUserIdentifier.
      Parameters:
      communicationUser - A CommunicationUserIdentifier from whom to issue a Communication Identity access token.
      scopes - List of CommunicationTokenScope scopes for the Communication Identity access token.
      tokenExpiresIn - Custom validity period of the Communication Identity access token within [1,24] hours range. If not provided, the default value of 24 hours will be used.
      Returns:
      the Communication Identity access token.

    • getToken

      public Mono<com.azure.core.credential.AccessToken> getToken(com.azure.communication.common.CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)
      Gets a Communication Identity access token for a CommunicationUserIdentifier.
      Parameters:
      communicationUser - A CommunicationUserIdentifier from whom to issue a Communication Identity access token.
      scopes - List of CommunicationTokenScope scopes for the Communication Identity access token.
      Returns:
      the Communication Identity access token.

    • getTokenWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.credential.AccessToken>> getTokenWithResponse(com.azure.communication.common.CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes, Duration tokenExpiresIn)
      Gets a Communication Identity access token for a CommunicationUserIdentifier.
      Parameters:
      communicationUser - A CommunicationUserIdentifier from whom to issue a Communication Identity access token.
      scopes - List of CommunicationTokenScope scopes for the Communication Identity access token.
      tokenExpiresIn - Custom validity period of the Communication Identity access token within [1,24] hours range. If not provided, the default value of 24 hours will be used.
      Returns:
      the Communication Identity access token with response.

    • getTokenWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.credential.AccessToken>> getTokenWithResponse(com.azure.communication.common.CommunicationUserIdentifier communicationUser, Iterable<CommunicationTokenScope> scopes)
      Gets a Communication Identity access token for a CommunicationUserIdentifier.
      Parameters:
      communicationUser - A CommunicationUserIdentifier from whom to issue a Communication Identity access token.
      scopes - List of CommunicationTokenScope scopes for the Communication Identity access token.
      Returns:
      the Communication Identity access token with response.

    • getTokenForTeamsUser

      public Mono<com.azure.core.credential.AccessToken> getTokenForTeamsUser(GetTokenForTeamsUserOptions options)
      Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
      Parameters:
      options - GetTokenForTeamsUserOptions request options used to exchange an Azure AD access token of a Teams User for a new Communication Identity access token.
      Returns:
      Communication Identity access token.

    • getTokenForTeamsUserWithResponse

      public Mono<com.azure.core.http.rest.Response<com.azure.core.credential.AccessToken>> getTokenForTeamsUserWithResponse(GetTokenForTeamsUserOptions options)
      Exchanges an Azure AD access token of a Teams User for a new Communication Identity access token.
      Parameters:
      options - GetTokenForTeamsUserOptions request options used to exchange an Azure AD access token of a Teams User for a new Communication Identity access token.
      Returns:
      Communication Identity access token with response.