Managing API Key Access

Overview

API keys allow secure access to selected TrustWorks API endpoints without requiring user login credentials. They are commonly used to integrate TrustWorks with external systems while maintaining controlled, role-based access.

🔑 Creating an API Key

Administrators can create API keys directly from the platform settings.

1. Navigate to Settings → Keys Management.
2. Click New Key.

Select a user as the Owner of the API key.

The API key inherits the same access level as the selected user:

• Admin → admin-level access
• Member → member-level access
• Contributor → contributor-level access
• Any resources created using this API key will list the selected user as the author.
3. Click Create.

⚠️ Copy and Store the API Key

Once the key is generated, it is displayed only once.

1. Copy the API key immediately.
2. Store it securely in your password manager or secrets vault.
3. Click Copy and Close to finish.

If the key is lost, it cannot be recovered and must be regenerated.

🔐 Using API Keys

To authenticate an API request, include the API key in the request headers:

x-tw-api-key: YOUR_API_KEY  

Only endpoints that support API key authentication can be accessed using this method.

✅ Best Practices

• Assign API key ownership based on the minimum required permissions.
• Rotate API keys regularly to reduce security risks.
• Never expose API keys in client-side code or public repositories.
• Regenerate keys immediately if they are compromised.

Conclusion

API keys provide a secure and flexible way to integrate external systems with TrustWorks. By assigning the correct owner and following best practices, teams can ensure controlled access while maintaining auditability and compliance.

If you need further guidance, our Support Team is available to help.