Skip to main content

​
Go to the API tab

Note: Only App Admins can access the API tab. Learn about user roles.
  1. Select Admin (Admin icon) near the bottom of the MindBridge sidebar on the left side of the screen. You will go to the User Management tab in the Admin settings by default.
  2. Go to the API tab. You will see a list of API tokens created by your team (if any exist).

​
Create a new API token

  1. Select Create token (located near the top-right corner of the page). You will go to the token creation page.
  2. During token creation, provide the following details:
  • Name (required): Enter a unique name for the API token.
  • Expiration (required): Use the menu to choose when the token should expire.
  • Permissions (required): Check the boxes next to the permissions users should have for each endpoint.
    Note: The API reference documentation linked on the API tab provides details about each request’s basic body and schema.
  • Allow list (recommended): Enter IP address(es) or CIDR that will be allowed to access the MindBridge API. If no restrictions are specified, then no filtering will be applied.
  1. When you are satisfied, select Create token (located at the bottom-right corner of the page). You will be notified of the token creation status and provided a token ID number to access the MindBridge API.
  2. Copy the API token and store it in a secure location. The API token can only be viewed and copied once and cannot be reproduced. If the token number is lost or the token settings need updating, you must create a new token. A given token will remain active until the expiry date, or until it is manually deleted.
Note: The security of your generated token is paramount, and much like your personal passwords, should never be shared. If a token is compromised, the token must be disabled and re-issued immediately.