Authentication

To use the Product Name, it is essential to obtain a valid and appropriate license from Cambrionix. This license grants access to the API's full range of features and ensures that your organisation complies with the terms of service. When making requests to the Product Name, your organisation must be authenticated to validate the license and confirm that it has the necessary permissions to interact with the API.

Authentication is a crucial step in ensuring secure and authorised access to the API, and Cambrionix offers several methods to manage this process effectively. Proper authentication not only verifies your organisation's license but also protects your data and devices from unauthorised access.

There are several ways to manage and implement authentication for the Product Name, ensuring that your organisation's API requests are valid and secure:

Endpoint	Description
Add Authentication	This endpoint is used to add or register an organisation’s authentication details to the Product Name. When an organisation is onboarded, this step links the organisation’s credentials to their Cambrionix account. This process ensures that all future API requests made by the organisation are properly authenticated and validated against the assigned license.
Remove Authentication	This method allows the removal of an organisation’s authentication details from the Product Name. If an organisation no longer requires access or if credentials need to be revoked (due to security concerns, expired licenses, or other factors), this method will remove the associated authentication information. Once removed, the organisation will no longer be able to authenticate API requests until new credentials are added.
Get Authentication	This method retrieves the current authentication configuration for an organisation. It provides details about the active authentication mechanisms that are linked to the organisation's account. This method is useful for reviewing the authentication setup, ensuring credentials are up to date, and troubleshooting any authentication issues that may arise during API interactions.