Setting up an API User

How to create a user for API access. This is useful for machine to machine applications where the Oauth2.0 authorization code flow may not be suitable.

Create an API Role

1. Open Knak Builder and navigate to Admin (top left button).

   

2. Navigate to Company > Roles > + Create Role

   

3. Add the Can Manage API Tokens permission, along with any other permissions that are required for your specific use case.

4. Click Create

Create an API User

1. Navigate to Company > Users > Invite User

   

2. Enter an Email, First name and Last name. You can use + in the email address (e.g. youremail+api@domain.com)

   

3. In Select Roles, choose the role created earlier

   

4. Click Save User and Send Invite

   

Tip

If you are unable to accept the invite and log in (for example if you exclusively use sso login), we can link the api user account to an existing user account. Please contact support@knak.com for assistance.

Once set up, this will allow you to continue with setting up an access token by selecting the profile icon -> linked users.

More info here: Add/Remove Users

Authentication

To allow your platform to access data in Knak, we recommend using a permanent API key. Use the API User created earlier. Generate your key here: https://enterprise.knak.io/account/api-access

Learn how to use API tokens in requests: Authentication Documentation