Getting Started

This Getting Started guides you through the steps you need to take to start using the MIRACL Trust authentication service.

# Register and Log in to the MIRACL Trust Portal

  1. Register on the MIRACL Trust Portal: https://miracl.com/get-started/.

  2. Fill in your details and click Submit. The enrolment screen shows up.

If you are using in-browser authentication, follow these steps:

  1. Click Register. A verification email is sent to the email address you have provided.

  2. Open the email on the same device and click CLICK TO REGISTER THIS DEVICE. The MIRACL Trust PIN Pad appears.

  3. Choose a 4-digit PIN.

  4. Confirm your PIN.

If you want to use mobile app authentication, do the following:

  1. Click Log In Using Mobile in the bottom right.

  2. Scan the QR code with the MIRACL Trust app or a normal QR reader. If you don’t have the app installed on your mobile device, you are prompted to install it and use it to scan the QR code. The Register Device screen appears.

  3. Click Continue. A verification email is sent to the email address you have provided.

  4. Open the email on your mobile device.

  5. Click CLICK TO REGISTER THIS DEVICE. The MIRACL Trust PIN Pad appears.

  6. Choose a 4-digit PIN.

  7. Confirm your PIN.

When you start the registration on a device, make sure you finish it on the same device. Otherwise, you will receive a warning, and if you choose to continue with the registration, you will be registered only on the second device. Note that every browser is considered a separate device.

To access the MIRACL Trust Portal after you have registered, go to: <trust.miracl.cloud>.

# Create an Application

Once you register, you can proceed to create an application to use for integration within the MIRACL Trust platform.

  1. After you log in, go to your project.

  2. Select Applications on the sidebar.

  3. Click + Add App.

  4. Enter the details for your app:

    • App Type
    • App Name
    • Redirect URL (only for OIDC) - the URL which sends the user back to your app once authentication has been approved, to enable the final retrieval of user details. If your app runs locally on http://127.0.0.1:5000, then the redirect URL is http://127.0.0.1:5000/login, where the login endpoint usually handles the OIDC code exchange for ID and access tokens.

  5. Click Add App. Your app keys (Client ID and Client Secret) are displayed.

# Client ID and Client Secret

When you create an app, you are issued Client ID and Client Secret credentials. You need them when building your app to configure your OpenID Connect integration. The Client Secret is shown to you only once when you create the app, so make sure you copy and save it when first displayed.

To see the Client ID and Project ID, go to the app’s settings:

  1. Click Applications on the sidebar. A list of your apps is displayed.

  2. Click Settings next to the app you are interested in.

# Generate New Client ID and Client Secret

If you haven’t saved your app’s Client Secret, you can generate new app keys:

  1. Go to the app’s settings (as described above).

  2. Click the Generate New Keys button in the Danger Zone section. A dialog box is displayed asking if you wish to proceed.

  3. Click Yes.

  4. Copy the newly generated Client Secret either by using the copy button at the end of the field or by selecting and copying it manually.

Once you generate new keys, the old ones are invalidated.

# Next Steps

Now that you have registered on the MIRACL Trust Portal and created an app, you can integrate through OIDC, integrate with mobile apps, or add custom user verification.