HYPR Documentation
HYPR User GuidePostman APILegacy WFALegacy SDK

Endpoint Overrides

HYPR SDK for Android

Alter the endpoints used by the Mobile App unlock function. The endpoint paths are found in \mobileappunlock\src\main\java\com\hypr\mobileappunlock\MainActivity.kt under changeRelyingPartyEndpoints.

🚧

NOT AN OPTION

This method must be performed before any HYPR operation is executed.

To modify HYPR server endpoints, the following methods can be executed to set new/path/to to the new server endpoints. You can override only the endpoints described in the following example.

Example

private fun changeRelyingPartyEndpoints() {
  val hyprApiEndpoints = hyprWrapper.getCurAppProfile(this).hyprApiEndpoints
    hyprApiEndpoints.setOobVersionedRegReqEndpoint("https://website/new/path/to/rp/fido/get");
  // Fido Registration Response
  hyprApiEndpoints.setOobVersionedRegRespEndpoint("https://website/new/path/to/rp/fido/send/reg");
  // Fido Authentication Request
  hyprApiEndpoints.setOobVersionedAuthReqEndpoint("https://website/new/path/to/rp/fido/get");
  // Fido Authentication Response
  hyprApiEndpoints.setOobVersionedAuthRespEndpoint("https://website/new/path/to/rp/fido/send/auth");
  // Fido Deregistration
  hyprApiEndpoints.setOobVersionedDeregEndpoint("https://website/new/path/to/rp/fido/get");

  // OOB Device Setup
  hyprApiEndpoints.setOobVersionedDeviceSetupEndpoint("https://website/new/path/to/rp/versioned/device/setup");
  // OOB Device Registrations
  hyprApiEndpoints.setOobVersionedDeviceRegisterEndpoint("https://website/new/path/to/rp/versioned/device/registrations");

  // Workstation Unlock
  hyprApiEndpoints.setOobVersionedDeviceWsAuthorizeUnlockEndpoint("https://website/new/path/to/rp/versioned/device/authorize/ws/unlock");
  // Workstation Unlock Complete - trailing slash is needed only here
  hyprApiEndpoints.setOobVersionedDeviceWsAuthorizeCompleteEndpoint("https://website/new/path/to/rp/versioned/device/authorize/ws/complete/");
  // Workstation Cancel
  hyprApiEndpoints.setOobVersionedDeviceWsAuthorizeCancelEndpoint("https://website/new/path/to/rp/versioned/device/authorize/ws/cancel");
  // Workstation Deregister
  hyprApiEndpoints.setOobVersionedDeviceWsDeregisterEndpoint("https://website/new/path/to/rp/versioned/device/ws/deregister");
  // Workstation Status
  hyprApiEndpoints.setOobVersionedDeviceWsStatusEndpoint("https://website/new/path/to/rp/versioned/device/query/ws/status");

  // Website Delete
  hyprApiEndpoints.setOobVersionedDeviceBrowserDeregisterEndpoint("https://website/new/path/to/rp/versioned/device/deregister");

  // Audit
  hyprApiEndpoints.setVersionedAuditEndpoint("https://website/new/path/to/rp/versioned/audit");
}

Updated 12 months ago