API Access

The API Access screen allows you to securely generate client credentials (Client ID and Client Secret) to integrate external systems or services with Timus. These credentials are used to authorize and authenticate API calls from third-party applications.

Whether you're building a custom dashboard, automating user provisioning, or integrating identity providers, this screen is where you manage the tokens required to make those secure connections.

๐Ÿ“ To access this screen, go to Settings โ†’ Configurations โ†’ API Access

Each card represents an existing API access configuration and includes:

Column Description
Title A label you set to identify the integration
Expiration Date When the token will become invalid
Client ID The public identifier for the integration
Client Secret The private token used for authentication (can be revealed and copied)

You can manage multiple configurations at once, each tied to a different use case.


Create a New API Access

Click Create New to open the setup modal. You'll need to provide two values:

Field Description
Title Name of your integration. Keep it descriptive to distinguish between tokens (max 70 characters)
Application Type Select the system youโ€™re integrating:
  • Active Directory: Use this when integrating with your AD setup.
  • Custom: Use this for internal tools, scripts, or other services not listed. |

Need help integrating with Active Directory?

Go to Active Directory Integration Guide 

Once saved, a Client ID and Client Secret will be generated. Use these in your external applicationโ€™s API headers for secure communication.


โœ… Best Practices

  • Keep your Client Secret safe. It grants full access on behalf of the integration.
  • Rotate tokens periodically for security. You can regenerate keys via the API or by creating a new entry.
  • Label clearly. Use meaningful titles to avoid confusion as your system scales.

Updated

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.