Skip to main content
Version: 10.1.0

HyprApiActionAdapter

Class HyprApiActionAdapter

  • java.lang.Object
    • com.hypr.hyprandroidcommon.uiadapter.adapters.HyprApiActionAdapter

  • public class HyprApiActionAdapter
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor and Description
      HyprApiActionAdapter()

    • Method Summary

      All Methods 
      Modifier and TypeMethod and Description
      static voidaddAppProfile(android.app.Activity activity, HyprAddAppData hyprAddAppData)
      Start action to create an App Profile.
      static voidaddMachineToAppProfileWithEncryptedPinDirect(android.app.Activity activity, java.lang.String appProfileDbId, java.lang.String encryptedPin)
      Start pairing a new machine with the specified App Profile using a passed in encrypted PIN.
      static voidaddMachineToAppProfileWithMagicLink(android.app.Activity activity)
      Start pairing a new machine with the specified App Profile using a Magic Link (deeplink) URI.
      static voidaddMachineToAppProfileWithPinDirect(android.app.Activity activity, java.lang.String appProfileDbId, java.lang.String pin)
      Start pairing a new machine with the specified App Profile using a passed in single PIN or PIN JSON Object.
      static voidaddMachineToAppProfileWithPinEntry(android.app.Activity activity, java.lang.String appProfileDbId)
      Open PIN entry screen to pair a new machine with the specified App Profile.
      static voidaddMachineToAppProfileWithQrScanner(android.app.Activity activity, java.lang.String appProfileDbId)
      Open QR Scanner to pair a new machine with the specified App Profile.
      static voidaddUserProfile(android.app.Activity activity, java.lang.String appProfileDbId, java.lang.String userProfileName)
      Start action to create a User Profile.
      static voidauthenticateAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to authenticate App Profile.
      static voidauthenticateTransactionAppProfile(android.app.Activity activity, java.lang.String appProfileDbId, java.lang.String transactionText)
      Start action to authenticate App Profile.
      static voiddeleteAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to delete App Profile.
      static voiddeleteUserProfile(android.app.Activity activity, java.lang.String userProfileDbId)
      Start action to delete User Profile.
      static voiddeleteWebAccount(android.app.Activity activity, java.lang.String webAccountDbId)
      Start action to delete a web account.
      static voiddeleteWebAccounts(android.app.Activity activity, java.util.List<java.lang.String> webAccountDbIds)
      Start action to delete multiple web accounts.
      static voiddeleteWorkstation(android.app.Activity activity, java.lang.String workstationDbId)
      Start action to delete a workstation.
      static voiddeleteWorkstations(android.app.Activity activity, java.util.List<java.lang.String> workstationDbIds)
      Start action to delete multiple workstations.
      static voidderegisterAaidsUserProfile(android.app.Activity activity, java.lang.String userProfileDbId, java.util.List<java.lang.String> aaids)
      Start action to deregister a set of Authenticators (AAIDs) for a User Profile.
      static voidderegisterAuthenticatorsForAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to deregister App Profile.
      static voidgetRegisteredAuthenticatorsForAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Get a list of registered authenticators for App Profile.
      static voidlockWorkstation(android.app.Activity activity, java.lang.String workstationDbId)
      Start action to lock a workstation.
      static voidofflineUnlockWorkstation(android.app.Activity activity, java.lang.String workstationDbId)
      Start action to unlock a workstation using offline mode.
      static voidrefreshFeatureFlags(android.app.Activity activity)
      Start action to update Feature Flags in all App Profiles that exist in the Application.
      static voidrefreshMachineStatus(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to update Machine Status for App Profile.
      static voidrefreshWorkstationStatus

      (android.app.Activity activity, java.lang.String appProfileDbId)

      Deprecated as of 6.2.0.
      This will be removed in 7.0.0. Use refreshMachineStatus(Activity, String) instead.
      static voidregisterAuthenticatorsForAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to register App Profile.
      static voidresetApplication(android.app.Activity activity)
      Start action to reset entire HYPR Application DB.
      static voidresetAppProfile(android.app.Activity activity, java.lang.String appProfileDbId)
      Start action to reset App Profile.
      static voidresetUserProfile(android.app.Activity activity, java.lang.String userProfileDbId)
      Start action to reset User Profile.
      static voidstartPushAuthentication(android.app.Activity activity)
      Start action to handle push authentication request.
      static voidstartPushTransaction(android.app.Activity activity)
      Start action to handle push transaction request.
      static voidunlockWorkstation(android.app.Activity activity, java.lang.String workstationDbId)
      Start action to unlock a workstation.
      static voidupdatePushToken(android.app.Activity activity, java.lang.String pushToken)
      Start action to update the Push Token in all App Profiles that exist in the Application.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Constructor Detail

        • HyprApiActionAdapter

          public HyprApiActionAdapter()

      • Method Detail

        • addMachineToAppProfileWithQrScanner

          public static void addMachineToAppProfileWithQrScanner(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Open QR Scanner to pair a new machine with the specified App Profile.

          requestCode: HYPR_OOB_DEVICE_SETUP_ACT_REQ_CODE

          NOTE: The machine must be the same type as the App Profile (Workstations must be added to the Workstation App Profile, Web apps to a Web Profile).
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to add the machine to

        • addMachineToAppProfileWithPinEntry

          public static void addMachineToAppProfileWithPinEntry(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Open PIN entry screen to pair a new machine with the specified App Profile.

          requestCode: HYPR_OOB_DEVICE_SETUP_ACT_REQ_CODE

          NOTE: The machine must be the same type as the App Profile (Workstations must be added to the Workstation App Profile, Web apps to a Web Profile).
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to add the machine to

        • addMachineToAppProfileWithPinDirect

          public static void addMachineToAppProfileWithPinDirect(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId,
@NonNull
java.lang.String pin)
          Start pairing a new machine with the specified App Profile using a passed-in single PIN or PIN JSON Object. This can be used for deeplinks (e.g., the user clicks a link from an email or text to start the pairing process).

          requestCode:HYPR_OOB_DEVICE_SETUP_ACT_REQ_CODE

          NOTE: The machine must be the same type as the App Profile (Workstation must be added to a Workstation App Profile, Web to a Web Profile).
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to add the machine to
          pin - Out-of-band PIN or PIN JSON object

        • addMachineToAppProfileWithEncryptedPinDirect

          public static void addMachineToAppProfileWithEncryptedPinDirect(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId,
@NonNull
java.lang.String encryptedPin)
          Start pairing a new machine with the specified App Profile using a passed-in encrypted PIN. This can be used for deeplinks (e.g., the user clicks a link from an email or text to start the pairing process).

          requestCode: HYPR_OOB_DEVICE_SETUP_ACT_REQ_CODE

          NOTE: The machine must be the same type as the App Profile (Workstations must be added to the Workstation App Profile, Web apps to a Web Profile)
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of the App Profile to add the machine to
          encryptedPin - Out-of-band encrypted PIN

        • addMachineToAppProfileWithMagicLink

          public static void addMachineToAppProfileWithMagicLink(@NonNull
android.app.Activity activity)
          Start pairing a new machine with the specified App Profile using a Magic Link (deeplink) URI. This can be used for deeplinks (e.g., the user clicks a link from an email or text to start the pairing process).

          requestCode: HYPR_OOB_DEVICE_SETUP_ACT_REQ_CODE

          Parameters
          activity - Activity that is kicking off the action and handling the result

        • getRegisteredAuthenticatorsForAppProfile

          public static void getRegisteredAuthenticatorsForAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Get a list of registered authenticators for the App Profile

          requestCode: HYPR_ACT_GETREG_REQ_CODE

          NOTE: This should only be used if your app isn't managing multiple users in an App Profile.
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to check

        • registerAuthenticatorsForAppProfile

          public static void registerAuthenticatorsForAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to register App Profile

          requestCode: HYPR_REGISTER_ACT_REQ_CODE

          NOTE: This should only be used if your app isn't managing multiple users in an App Profile.
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to register

        • authenticateAppProfile

          public static void authenticateAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to authenticate App Profile.

          requestCode: HYPR_AUTHENTICATE_ACT_REQ_CODE

          NOTE: This should only be used if your app isn't managing multiple users in an App Profile.
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to authenticate

        • authenticateTransactionAppProfile

          public static void authenticateTransactionAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId,
@NonNull
java.lang.String transactionText)
          Start action to authenticate App Profile.

          requestCode: HYPR_AUTHENTICATE_ACT_REQ_CODE

          NOTE: This should only be used if your app isn't managing multiple users in an App Profile.
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to authenticate

        • deregisterAuthenticatorsForAppProfile

          public static void deregisterAuthenticatorsForAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to deregister App Profile.

          requestCode: HYPR_DEREGISTER_ACT_REQ_CODE

          NOTE: This should only be used if your app isn't managing multiple users in an App Profile.
          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to deregister

        • addAppProfile

          public static void addAppProfile(@NonNull
android.app.Activity activity,
@NonNull
HyprAddAppData hyprAddAppData)
          Start action to create an App Profile.

          requestCode: HYPR_ADD_APP_PROFILE_ACT_REQ_CODE

          Parameters
          activity - Activity that is kicking off the action and handling the result
          hyprAddAppData - HyprAddAppData that includes parameters for Adding an App Profile

        • resetAppProfile

          public static void resetAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to reset App Profile. This will deregister all authenticators and all machine profiles

          requestCode: HYPR_RESET_APP_PROFILE_ACT_REQ_CODE

          Parameters
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to reset

        • deleteAppProfile

          public static void deleteAppProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to delete App Profile. This will delete the App Profile, any User Profiles under the App Profile, deregister all authenticators and machine profiles under the App Profile.

          requestCode: HYPR_DELETE_APP_PROFILE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to delete

        • resetApplication

          public static void resetApplication(@NonNull
android.app.Activity activity)
          Start action to reset entire HYPR Application DB. This will delete all App Profiles, User Profiles, deregister all authenticators and deregister all machine profiles.

          requestCode: HYPR_ACT_RESET_APP_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result

        • addUserProfile

          public static void addUserProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId,
@NonNull
java.lang.String userProfileName)
          Start action to create a User Profile.

          requestCode: HYPR_ADD_USER_PROFILE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of App Profile to add the user.

        • resetUserProfile

          public static void resetUserProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String userProfileDbId)
          Start action to reset User Profile. This will deregister all authenticators and all machine profiles under the User Profile.

          requestCode: HYPR_RESET_USER_PROFILE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          userProfileDbId - DB ID of User Profile to reset

        • deleteUserProfile

          public static void deleteUserProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String userProfileDbId)
          Start action to delete User Profile. This will delete the User Profile and deregister all authenticators and machine profiles under the User Profile.

          requestCode: HYPR_DELETE_USER_PROFILE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          userProfileDbId - DB ID of User Profile to delete

        • deregisterAaidsUserProfile

          public static void deregisterAaidsUserProfile(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String userProfileDbId,
@NonNull
java.util.List<java.lang.String> aaids)
          Start action to deregister a set of Authenticators (AAIDs) for a User Profile. This action will only FIDO deregister a set of Authenticators. If all of the Authenticators are deregistered as a result of this action, the User Profile will still exist and will not be deleted.

          requestCode: HYPR_DEREGISTER_AAIDS_USER_PROFILE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          userProfileDbId - DB ID of User Profile
          aaids - Set of AAIDs to deregister

        • refreshMachineStatus

          public static void refreshMachineStatus(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Start action to update Machine Status for App Profile.

          requestCode: HYPR_UPDATE_MACHINE_STATUS_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of Machine App Profile

        • refreshWorkstationStatus

          @Deprecated
public static void refreshWorkstationStatus(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String appProfileDbId)
          Deprecated as of 6.2.0. This will be removed in 7.0.0. Use refreshMachineStatus(Activity, String) instead.
          Start action to update Workstation Status for App Profile.

          requestCode: HYPR_UPDATE_WORKSTATION_STATUS_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          appProfileDbId - DB ID of Workstation App Profile

        • unlockWorkstation

          public static void unlockWorkstation(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String workstationDbId)
          Start action to unlock a workstation

          requestCode: HYPR_LOGIN_ACT_UNLOCK_MACHINE_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          workstationDbId - DB ID of Workstation to unlock

        • lockWorkstation

          public static void lockWorkstation(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String workstationDbId)
          Start action to lock a workstation

          requestCode: HYPR_LOGIN_ACT_LOCK_MACHINE_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          workstationDbId - DB ID of Workstation to lock

        • offlineUnlockWorkstation

          public static void offlineUnlockWorkstation(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String workstationDbId)
          Start action to unlock a workstation using offline mode

          requestCode: HYPR_LOGIN_ACT_UNLOCK_MACHINE_REQ_CODE

          If successful, you can get the offline PIN from the intent extras like this: ((HyprStatusResult) getIntent().getSerializableExtra(INTENT_KEY_HYPR_STATUS_RESULT)).getSuccessPayload();
          Parameters:
          activity - Activity that is kicking off the action and handling the result
          workstationDbId - DB ID of Workstation to unlock using offline mode

        • deleteWorkstation

          public static void deleteWorkstation(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String workstationDbId)
          Start action to delete a workstation

          requestCode: HYPR_DELETE_WORKSTATION_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          workstationDbId - DB ID of Workstation to delete

        • deleteWorkstations

          public static void deleteWorkstations(@NonNull
android.app.Activity activity,
@NonNull
java.util.List<java.lang.String> workstationDbIds)
          Start action to delete multiple workstations

          requestCode: HYPR_DELETE_WORKSTATION_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          workstationDbIds - List of DB IDs of Workstations to delete

        • startPushAuthentication

          public static void startPushAuthentication(@NonNull
android.app.Activity activity)
          Start action to handle push authentication request

          requestCode: HYPR_PUSH_AUTHENTICATE_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result

        • startPushTransaction

          public static void startPushTransaction(@NonNull
android.app.Activity activity)
          Start action to handle push transaction request

          requestCode: HYPR_PUSH_AUTHENTICATE_TRANS_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result

        • deleteWebAccount

          public static void deleteWebAccount(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String webAccountDbId)
          Start action to delete a web account

          requestCode: HYPR_DELETE_BROWSER_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          webAccountDbId - DB ID of Web Account to delete

        • deleteWebAccounts

          public static void deleteWebAccounts(@NonNull
android.app.Activity activity,
@NonNull
java.util.List<java.lang.String> webAccountDbIds)
          Start action to delete multiple web accounts

          requestCode: HYPR_DELETE_BROWSER_ACT_REQ_CODE

          Parameters:
          activity - Activity that is kicking off the action and handling the result
          webAccountDbIds - DB IDs of Web Accounts to delete

        • updatePushToken

          public static void updatePushToken(@NonNull
android.app.Activity activity,
@NonNull
java.lang.String pushToken)
          Start action to update Push Token in all App Profiles that exist in the Application. If there are websites registered on multiple RP Applications across multiple RP Servers, then all of them will get the Push Token updated. There is no UI Spinner for this operation on the SDK level.

          requestCode: HYPR_UPDATE_PUSH_TOKEN_ACT_REQ_CODE

          Parameters
          activity - Activity that is kicking off the action and handling the result
          pushToken - Push Token to update in the server

        • refreshFeatureFlags

          public static void refreshFeatureFlags(@NonNull
android.app.Activity activity)
          Start action to update Feature Flags in all App Profiles that exist in the Application. If there are machines registered on multiple RP Applications across multiple RP Servers, then all of them will get the Feature Flags updated. There is no UI Spinner for this operation on the SDK level.

          requestCode: HYPR_REFRESH_FEATURE_FLAGS_ACT_REQ_CODE

          Parameters
          activity - Activity that is kicking off the action and handling the result