Authentication

The Mimir API uses authentication tokens to authenticate all API requests. You must include your authentication token in the headers of all requests that you send to the API.

There are two forms of authentication token, user and organisation API tokens:

User tokens: Defined by a single user but will be become obsolete when the user leaves the organisation. Organisation token: bound to a single users.

Both of these authentication option can be disabled in the organisation settings.

Organisation API Tokens

You need to either be a organisation owner or admin to create organisation tokens.

Step one: Access admin settings

Navigate to your organisation settings (opens in a new tab) tab and select api.

Step two: Open create api key dialog

Click the 'Add new key' button located on the right.

Step three: Generate api key

Give the key a name and select the required permission i.e read-only or read-write. Then click the 'create' button to generate your token.

How to remove an organisation API key

Every token can be delete, click on the bin icon located under the actions column to delete a token.

User API Tokens

Beware that your organisation admin can disable access to internal resources from personal tokens. We recommend that you use organisation tokens as service accounts and not personal tokens. Personal tokens are designed mainly for testing and basic data retrieval.

Step one: Access user settings

From any page (opens in a new tab) open the side menu by selecting the menu icon and click on your profile.

Step two: Access the API key manager

Click 'Manage keys' button on the bottom left of the dialog.

Step three: Generate api key

Click the 'Generate key' button button to generate your token.

How to remove an user API key

Every token can be delete, click on the bin icon located under the actions column to delete a token.