Getting Started

HYPR SDK for iOS

HYPR iOS SDK Usages

HYPR iOS SDK can be used in the following scenarios:

  • FIDO Only
  • Customer Authentication
  • Workforce Access
  • The FIDO Client Adapter

📘

Supported Version

Please use HYPR iOS SDK 4.5.0+ to access all features described in this document.

The main differences between these options are in the functionality provided and in what interface component must be used.

Customer Authentication

This implementation involves using the HYPR iOS SDK to authenticate into a website. This is a full HYPR implementation.

  • Direct communication with HYPR RP Server / HYPR FIDO Server
  • Related Components: User Agent, FIDO Client, and Authenticators
  • Functionality: Out-of-band (OOB) Registration, Website Authentication, and FIDO Operations

📘

Learn More

To learn more about out-of-band customer authentication and how to integrate it into your app, see Web Authentication.

Workforce Access

This implementation involves using the HYPR iOS SDK to authenticate into a workstation. This is a full HYPR implementation.

  • Direct communication with HYPR RP Server / HYPR FIDO Server
  • Related Components: User Agent, FIDO Client, and Authenticators
  • Functionality: OOB Registration, Workstation Authentication, and FIDO Operations

📘

Learn More

To learn more about out-of-band employee access and how to integrate it into your app, see Workforce Access

This implementation involves using the HYPR iOS SDK to authenticate into an application and does not use any out-of-band authentication.

  • Direct communication with HYPR RP Server / HYPR FIDO Server
  • Related Components: User Agent, FIDO Client, and Authenticators
  • Functionality: FIDO Operations

FIDO Client Adapter

This implementation involves using the HYPR iOS SDK to authenticate into an iOS Application. It is a wrapper around the FIDO Client that replaces the User Agent. It is used for implementations where the customer only wants HYPR to generate the raw FIDO payload. They will then take that raw FIDO payload and manage the server communication themselves.

  • No direct communication with HYPR RP Server / HYPR FIDO Server
  • Related Components: User Agent, FIDO Client, and Authenticators
  • Functionality: FIDO Operations

📘

Learn More

To learn more about FIDO Client Adapter and how to integrate it into your app, go to the FIDO Client Adapter