Rest API User Setup and Credential Generation
Manage credentials for Rest API users in Titan Maintenance
Table of Contents
Overview
Rest API users are Manager or Contractor/Supplier users that have been granted the appropriate permissions to access and use the Rest API functionality within the platform.
These users allow external systems to securely communicate with the platform through API calls, and are usually created to implement a specific integration.
To function correctly, a Rest API user must:
- Be configured as the correct type of user for the specific integration
- Be assigned Rest API access permissions
- Log in to the Titan Maintenance platform
- Generate an API Token and API Secret Key
These credentials are then used when configuring integrations between systems.
Best practice is to create a dedicated API user account rather than using a normal operational user account.
Create a Rest API User
Create the Management or Contractor user for the scenario.
- For a Titan Cloud Edge integration, create a Management user.
- Navigate to System > Users
- Click Operations and select Create
- For all other API access scenarios, create a Contractor user.
- Navigate to Manage > Contractors
- Locate and select the Contractor in list
- Click the Users tab
- Click Operations and select Create
Tip: For additional information on the user types, please see the User Management in Titan Maintenance article.
In the Create User window, click the Security tab.
Under Role Packages, use the arrows to move REST API and any other permissions required for the integration from the Available column to the Selected Column.

Tip: Titan Maintenance integrations require REST API and Management User permissions.
Click Save to create the user.
Recommended Best Practices
- Use a dedicated email address for the API account. For example:
api.integration@company.com system.api@clientdomain.com urgent.api@clientdomain.com
- Avoid using personal user accounts for integrations.
- Assign only the minimum permissions required.
Generate Credentials
Log in to the platform using the Rest API user account.
Click the person icon in the top-right corner of the screen to open the Account Settings menu.


Credential |
Description |
|---|---|
API Token |
Identifies the API user |
API Secret Key |
Used for secure authentication |
Security Best Practices
- Store these credentials securely.
- Do not expose them publicly or share them via unsecured channels.
- Only provide them to authorized integration systems.
- Regenerate credentials if security has been compromised.