Connectors

HYPR Connector

The HYPR connector lets you use HYPR for passwordless authentication in your PingOne DaVinci flow.

Setup

Resources

For more information and setup help, see the following:

Requirements

To use the connector, you’ll need:

  • A configured HYPR environment

  • A HYPR user account and mobile app to use for testing

Configuring the HYPR connector

Add the connector in DaVinci as shown in Adding a connector, then configure it as follows.

Connector configuration

To get your API URL and credentials, speak to a HYPR representative.

API URL

The API URL provided to you by HYPR.

Client ID

The client ID provided to you by HYPR.

Client secret

The client secret provided to you by HYPR.

Scope

The OpenID Connect scopes to send to HYPR to customize the verification process. Separate multiple scopes with a space, such as openid email profile.

Using the connector in a flow

Authenticating users with HYPR

A screen capture of the complete authentication flow.

This flow asks the user to enter their username in an HTML form, redirects the user to HYPR for authentication, then shows the results on an HTML page.

  1. Download the HYPR Authentication flow template. For help, see Using DaVinci flow templates.

  2. (Optional) Customize the sign on form:

    A screen capture of the HTML Form asking for a username.

    1. Select the Sign On Form node.

    2. (Optional) Customize the Title field.

    3. (Optional) Customize the Next Button Text field.

    4. Click Apply.

  3. (Optional) Show a HYPR sign-on button rather than automatically redirecting the user to HYPR:

    This approach lets you include a HYPR sign-on button alongside other sign-on options in an IDP Container connector or as part of a custom HTML page using an HTTP connector.

    1. Select the HYPR node.

    2. Turn off Skip Button Press.

    3. In the Display Name field, enter the button text, such as Sign on with HYPR.

    4. (Optional) In the CSS field, add CSS to customize the appearance of the prompt.

    5. (Optional) Turn on Show Powered By to display Powered by Ping Identity at the bottom of the prompt page.

  4. Test the flow:

    1. Click Save, Deploy, then Run.

    2. On the Sign On page, enter the username for your HYPR test user account. Click Sign On.

      The browser redirects to the HYPR, which prompts you to authenticate.

      A screen capture of the HYPR authentication prompt.

    3. Complete the MFA process with HYPR.

      A screen capture showing the HYPR authentication challenge.

      HYPR shows a success message and then redirects the browser back to DaVinci.

      Your Custom HTML Message shows the complete response from HYPR.

      A screen capture that shows the Custom HTML Message node with the output from HYPR.

Capabilities

Authenticate

Show details

  • Properties

  • Input Schema

  • Output Schema

Username textField

The username of the authenticating user.

Display Name button
showPoweredBy toggleSwitch
skipButtonPress toggleSwitch

  • default object

    • properties object

      • username string

      • clientId string required

      • clientSecret string required

      • scope string required

      • apiUrl string required

  • output object

    • statusCode integer

    • rawResponse object

    • tokenResponse object

      • id_token string

      • access_token string

      • token_type string

      • expires_in number