API Tokens - MindBridge Documentation

API Tokens

API tokens are used to authenticate requests made to the MindBridge API. During creation, each token is assigned permissions that control the actions it can perform. API tokens are valid until their expiry date, after which they can no longer be used. A token may be active for a maximum of 2 years from the date of creation. Additionally, API tokens can be configured to limit access to specific IP addresses or CIDR blocks by setting the allowedAddresses property to a valid IPv4 or IPv6 address, or CIDR range.

API Token Users

Once an API token is created, an API Token User is automatically created and assigned to the API token. This non-human user account represents the API token, and any action that the API takes will be attributed to that user. Because each API Token User is linked to a unique API token, these accounts cannot be deleted or disabled, except by deleting the associated API token itself.

Permissions

Create API Token

Create a new API token. The creation response will include a token field with the newly created token. This token is only returned on creation, and cannot be re-generated afterwards. When an API token is created, an API Token User is automatically created and assigned to the API token. This non-human user account represents the API token, and any action that the API takes will be attributed to that account. The API Token User can be identified through the userId property in the API Token entity.