Generating an API key

Background information

You can create API keys for co-workers or for robot users. These are the identification code that a user (or a developer), is using to access our API. API keys are used to follow and control the use of the API. The API key is both used as a unique identifier and as a secret token for the authentication. It contains a set of access rights .

Creating a new API key

To create a new API key, go to the Cogged wheel > Authentication, SSO and API > API Keys. If you don’t have the access rights, please contact the support team.


Please click Generate API key to create a key.


In the creation window, you can

  • Customize the name of the key
  • Select the permissions you wish to associate to this key

Advanced settings: you can personalize your key. However, you must abide by the GUID (globally unique identifier) format, which requires a unique identifier with a size of 16 bytes (example: {3F2504E0-4F89-11D3-9A0C-0305E82C3301}).


Once the key has been generated, you can copy the key by hovering the mouse over it.


Modify the rights of an existing key

If you wish to modify the rights of a key, go to  the roles administration by clicking on the blue link « role administration » :


Once the key has been created, you can use our API. To find out more about our different API, feel free to check out the API documentation.

Page content

Was this article helpful?
1 out of 1 found this helpful