Package ch.nevis.mobile.sdk.api.operation

Interface Deregistration

All Superinterfaces:
HttpOperation<Deregistration>, Operation
public interface Deregistration extends HttpOperation<Deregistration>
The object that can be used to trigger a deregistration operation.

Usage example: 

  private void deregister(Operations operations,
                        String username,
                        String aaid,
                        AuthorizationProvider authorizationProvider) {
      operations.deregistration()
                .username(username)
                .aaid(aaid)
                .authorizationProvider(authorizationProvider)
                .onError(error -> {
                    // handle error
                })
                .onSuccess(() -> {
                    // handle success
                })
                .execute();
  }

  • Method Details

    • username

      @NonNull Deregistration username(@NonNull String username)
      Specifies the username whose authenticator must be deregistered.

      Providing the username is required.

      Parameters:
      username - the username
      Returns:
      a Deregistration

    • aaid

      @NonNull Deregistration aaid(@NonNull String aaid)
      Specifies the AAID of the Authenticator that must be deregistered. If no AAID is provided, then all the authenticators associated with the username will be deleted.
      Parameters:
      aaid - the AAID of the authenticator (for instance Authenticator.PIN_AUTHENTICATOR_AAID).
      Returns:
      a Deregistration

    • authorizationProvider

      @NonNull Deregistration authorizationProvider(@NonNull AuthorizationProvider authorizationProvider)
      Specifies the authorization provider that must be used to deregister the authenticator. If no AuthorizationProvider is given, then an AuthorizationProvider.EmptyAuthorizationProvider will be used.

      This does not have to be provided on Authentication Cloud environment.

      If the backend uses nevisFIDO 7.2402.** or later, use a AuthorizationProvider.JwsAuthorizationProvider to do deregistration without asking the user to authenticate.

      Parameters:
      authorizationProvider - the AuthorizationProvider
      Returns:
      a Deregistration

    • onError

      @NonNull Deregistration onError(@NonNull Consumer<OperationError> errorConsumer)
      Specifies the object that will be invoked if the deregistration failed. The specified object will receive an OperationError. This object will be invoked in the main/UI thread.

      Providing the object handling the error is required.

      Parameters:
      errorConsumer - the consumer of an OperationError
      Returns:
      a Deregistration

    • onSuccess

      @NonNull Deregistration onSuccess(@NonNull Runnable onSuccess)
      Specifies the object that will be invoked if the authenticator was deleted successfully. This object will be invoked in the main/UI thread.

      Providing the object handling the success is required.

      Parameters:
      onSuccess - the object invoked on successful deregistration.
      Returns:
      a Deregistration