Connection
HYPR on Hire2Retire uses Bearer Token.
A Bearer Token is a type of access token commonly used in authentication and authorization protocols, such as OAuth 2.0. It's a security credential that allows a user or application to access protected resources on a server, such as an API. The term "bearer" implies that whoever possesses the token is granted access, without requiring additional proof of identity. This is different from other forms of authentication, like sending a username and password with each request.
Please refer to the document Bearer token for rest APIs to know more about Bearer Token in HYPR.
We at RoboMQ pay utmost attention to keeping your account secure. See our Security and Privacy Policies to learn more about how RoboMQ handles your account access.
| Object | Permission |
|---|---|
| User | Can Provision and Deprovision Users |
Bearer Token and Instance URL in HYPR¶
Please follow the step below to obtain the API Access Token on HYPR.
Steps to Create an API Access Token¶
- After logging into your HYPR admin account, navigate to Control Center.
- In the left menu, click Access Tokens.
- Click Create Token.
- Enter a Token Name (e.g., "API Access Token").
- Select the application for which you need the token.
-
Select Token Type and choose API Token.
Figure 1. Create Bearer Token on HYPR -
Set the Permission Type to User Management.
- Click Next.
- Click Copy Token & Close to save the token.
Alternatively, you can follow the HYPR's official documentation to generate the API Access Token by following this link.
Find Your Instance URL¶
Your Instance URL follows this format:
https://yourcompany.hypr.com/cc/api/versioned/rpUser
For more details, check this link.
Link HYPR account on Hire2Retire¶
To link your HYPR account using Bearer Token, you have to specify your Instance URL, Bearer Token and App ID.
