Topics included in this article:
Overview
API keys allow you to authenticate with the Rhombus API so you can build custom integrations, automate workflows, and connect third-party tools to your Rhombus organization. This article walks you through creating a new API key in the Rhombus Console.
Prerequisites
- Rhombus Console account
- Appropriate user permissions to manage integrations and developer resources (typically an Administrator role)
Create an API Key
1. Log in to the Rhombus Console, navigate to "Settings," then click "Integrations & Developer Resources."
2. On the "Integrations & Developer Resources" page, click "API Tokens" along the top of the page.
3. Click "Add API Key" in the upper-left corner.
4. Complete the form with the following details:
- Enter a descriptive Name for the API key (e.g., "Access Control Integration" or "Reporting Automation")
- Select API Token as the type (Can use Cert instead if desired)
- Assign the appropriate Role to define the key's permission level
When finished, click Save (or Create) to generate the key.
Step 6: Store your API key securely
Once the key is generated, copy it and store it in a secure environment, such as a password manager or secrets vault.
⚠️ Important: Treat your API key like a password. Do not share it publicly, commit it to source code repositories, or send it over unsecured channels. Anyone with access to your API key can act on your organization's behalf according to the role assigned to the key.
Best Practices
- Use descriptive names so you can easily identify what each key is used for.
- Assign the least-privileged role required for the integration's purpose.
- Rotate keys periodically and delete any keys that are no longer in use.
- Never hard-code keys directly into scripts or applications — use environment variables or a secrets manager instead.
Helpful Links
Contact Support or Sales
Have more questions? Contact Rhombus Support at +1 (877) 746-6797 option 2 or support@rhombus.com.
Interested in learning more? Contact Rhombus Sales at +1 (877) 746-6797 option 1 or sales@rhombus.com.
Comments
0 comments
Article is closed for comments.