Topics included in this article:
Overview
API keys allow you to authenticate with the Rhombus API to build custom integrations, automate workflows, and connect third-party tools to your organization. This article explains how to create an API key, assign its permissions, and securely manage it in the Rhombus Console.
Note: Your Rhombus Console user account must have the appropriate administrative permissions to create API keys. For more information on user access, see the Create and Manage Roles article.
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" at the top of the page.
3. Click "Add API Key" in the upper-left corner.
4. Enter a descriptive name for the API key, select "Api Token" as the authentication type, then assign the appropriate role to determine the API key's permissions. Click "Submit" when finished.
Securely Store Your API Key
Once the API key is generated, copy it and store it in a secure location, such as a password manager or secrets vault.
WARNING: Treat your API key like a password. Do not share it publicly, commit it to source code repositories, or send it through unsecured channels. Anyone with access to the API key can act on your organization's behalf based on the role assigned to the key.
Best Practices
- Use descriptive names to easily identify the purpose of each API key.
- Assign the least-privileged role required for the integration.
- Rotate API keys periodically and delete keys that are no longer in use.
- Never hard-code API 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.