Comment on page
Learn how to register your application as a HyperID Client
This guide will walk you through the process of obtaining the critical credentials:
clientSecret. These credentials are essential for authorizing your application within the HyperID ecosystem.
clientIDserves as a unique identifier for your application, allowing HyperID to recognize and authorize it. The
clientSecret, on the other hand, acts as a secure key used in the authentication process between your application and HyperID.
Please note that this guide assumes you're developing a server-side application and are ready to use a basic authentication method. For more details on client authentication and advanced options, refer to our documentation here.
Let's dive into the process of obtaining the
- 2.If you already have a HyperID account, sign in using your existing credentials. If you do not have one, you can conveniently create an account during this process using the method of your choice.
HyperID account will give you access to the Developer Portal. Here you can continue the client registration process.
To create a project, enter its name. The project name is for internal developer use only. It won't be visible to your users.
A redirect URI is the endpoint to which the authorization server redirects users after they've successfully authenticated and authorized your application. This is a crucial step in the authorization code flow, as it involves passing the authorization code from the server to your application.
Here are a few of examples of what redirect URIs look like:
https://yourapp.com/auth/callback: In this scenario, upon successful authorization, the user is redirected back to the
auth/callbackendpoint of your application's domain.
com.yourapp.mobile:/callback: For mobile applications, custom URI schemes such as
com.yourapp.mobileare often in use. In this case, upon authorization, the user is returned to the
callbackendpoint within your mobile app.
Once you've created your project, you'll be directed to the project configuration page. Here you will need to create at least one client that will interact with HyperID. To do this, navigate to the Client page and select "Create New Client".
You will be prompted to configure your future client. For this quick guide, you'll only need to provide a name (which will be displayed to users on the HyperID page as the application's name during authorization) and enter the redirect URI from Step 3. Leave all other options as they are.
Note, however, that HyperID will only allow the use of redirect URIs that you have configured in your project's client settings. This helps ensure the security and integrity of the authorization process.
Click "Create Client" to complete this step.
Congratulations! You've successfully created the client for your application. At any time, you can return to its settings to copy the
clientSecretthat you will need to implement the authorization flow.
List of clients
The client's details
DO NOT share your
clientSecretwith any third party. Keep them safe and private to ensure the security of your application.