CommunicationIdentityAsyncClient Class

Package:

com.azure.communication.administration

Maven Artifact:

com.azure:azure-communication-administration:1.0.0-beta.3

• java.lang.Object
• • com.azure.communication.administration.CommunicationIdentityAsyncClient

public final class CommunicationIdentityAsyncClient

Asynchronous client interface for Azure Communication Services identity operations

Method Summary

Modifier and Type	Method and Description
Mono<com.azure.communication.common.CommunicationUser>	createUser() Creates a new CommunicationUser.
Mono<Response<com.azure.communication.common.CommunicationUser>>	createUser(Context context) Creates a new CommunicationUser.
Mono<Response<com.azure.communication.common.CommunicationUser>>	createUserWithResponse() Creates a new CommunicationUser.
Mono<Void>	deleteUser(CommunicationUser communicationUser) Deletes a CommunicationUser, revokes its tokens and deletes its data.
Mono<Response<Void>>	deleteUser(CommunicationUser communicationUser, Context context) Deletes a CommunicationUser, revokes its tokens and deletes its data.
Mono<Response<Void>>	deleteUserWithResponse(CommunicationUser communicationUser) Deletes a CommunicationUser, revokes its tokens and deletes its data.
Mono<CommunicationUserToken>	issueToken(CommunicationUser communicationUser, List<String> scopes) Generates a new token for an identity.
Mono<Response<CommunicationUserToken>>	issueToken(CommunicationUser communicationUser, List<String> scopes, Context context) Generates a new token for an identity.
Mono<Response<CommunicationUserToken>>	issueTokenWithResponse(CommunicationUser communicationUser, List<String> scopes) Generates a new token for an identity.
Mono<Void>	revokeTokens(CommunicationUser communicationUser, OffsetDateTime issuedBefore) Revokes all the tokens created for a user before a specific date.
Mono<Response<Void>>	revokeTokens(CommunicationUser communicationUser, OffsetDateTime issuedBefore, Context context) Revokes all the tokens created for a user before a specific date.
Mono<Response<Void>>	revokeTokensWithResponse(CommunicationUser communicationUser, OffsetDateTime issuedBefore) Revokes all the tokens created for a user before a specific date.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createUser

public Mono<CommunicationUser> createUser()

Creates a new CommunicationUser.

Returns:

the created Communication User.

createUser

public Mono<Response<CommunicationUser>> createUser(Context context)

Creates a new CommunicationUser.

Parameters:

context - the context of the request. Can also be null or Context.NONE.

Returns:

the created Communication User.

createUserWithResponse

public Mono<Response<CommunicationUser>> createUserWithResponse()

Creates a new CommunicationUser.

Returns:

the created Communication User.

deleteUser

public Mono<Void> deleteUser(CommunicationUser communicationUser)

Deletes a CommunicationUser, revokes its tokens and deletes its data.

Parameters:

communicationUser - The user to be deleted.

Returns:

the response.

deleteUser

public Mono<Response<Void>> deleteUser(CommunicationUser communicationUser, Context context)

Deletes a CommunicationUser, revokes its tokens and deletes its data.

Parameters:

communicationUser - The user to be deleted.

context - the context of the request. Can also be null or Context.NONE.

Returns:

the response.

deleteUserWithResponse

public Mono<Response<Void>> deleteUserWithResponse(CommunicationUser communicationUser)

Deletes a CommunicationUser, revokes its tokens and deletes its data.

Parameters:

communicationUser - The user to be deleted.

Returns:

the response.

issueToken

public Mono<CommunicationUserToken> issueToken(CommunicationUser communicationUser, List<String> scopes)

Generates a new token for an identity.

Parameters:

communicationUser - The CommunicationUser from whom to issue a token.

scopes - The scopes that the token should have.

Returns:

the object with the issued token.

issueToken

public Mono<Response<CommunicationUserToken>> issueToken(CommunicationUser communicationUser, List<String> scopes, Context context)

Generates a new token for an identity.

Parameters:

communicationUser - The CommunicationUser from whom to issue a token.

scopes - The scopes that the token should have.

context - the context of the request. Can also be null or Context.NONE.

Returns:

the object with the issued token.

issueTokenWithResponse

public Mono<Response<CommunicationUserToken>> issueTokenWithResponse(CommunicationUser communicationUser, List<String> scopes)

Generates a new token for an identity.

Parameters:

communicationUser - The CommunicationUser from whom to issue a token.

scopes - The scopes that the token should have.

Returns:

the object with the issued token.

revokeTokens

public Mono<Void> revokeTokens(CommunicationUser communicationUser, OffsetDateTime issuedBefore)

Revokes all the tokens created for a user before a specific date.

Parameters:

communicationUser - The CommunicationUser whose tokens will be revoked.

issuedBefore - All tokens that are issued prior to this time should get revoked.

Returns:

the response.

revokeTokens

public Mono<Response<Void>> revokeTokens(CommunicationUser communicationUser, OffsetDateTime issuedBefore, Context context)

Revokes all the tokens created for a user before a specific date.

Parameters:

communicationUser - The CommunicationUser whose tokens will be revoked.

issuedBefore - All tokens that are issued prior to this time should get revoked.

context - the context of the request. Can also be null or Context.NONE.

Returns:

the response.

revokeTokensWithResponse

public Mono<Response<Void>> revokeTokensWithResponse(CommunicationUser communicationUser, OffsetDateTime issuedBefore)

Revokes all the tokens created for a user before a specific date.

Parameters:

communicationUser - The CommunicationUser whose tokens will be revoked.

issuedBefore - All tokens that are issued prior to this time should get revoked.

Returns:

the response.