Locoia API Authentication - Personal Access Token

Authentication with our API of Locoia itself

Creating a Personal Access Token
In order to create a personal access token the following endpoint needs to be used:
post
https://api.locoia.com
/v1/personal-access-tokens
Create personal access token
The token itself is only visible right after creating a personal access token, after that it is impossible to retrieve it from the API.
You can also create it directly in Locoia with this Community Library Flow.
One can regenerate a token with by sending the following POST request:
post
https://api.locoia.com
/v1/personal-access-tokens/{{ token_id }}/regenerate
Regenerate personal access token
You can list all token with
get
https://api.locoia.com
/v1/personal-access-tokens
Get personal access tokens
Scopes
The following scopes are available:
Scope Name
Entites
automation
Flows
Flow Runs
Flow Run Steps
Run Flows
Connector Auths (Read only)
Env Variables (Read only)
File Uploads (Read only)
company
Env Variables
File Uploads
Teams
Users
connector_auth
Connector Auths
connectors
Connectors
Connector Actions
dashboard
​
Dashboards
Data Sources
Forecasts
Insights
Transforms
embed
Embeds
There are different access levels based on the scope extension:
Scope Extension
Supported Scopes
Operations
Example
None (leave empty)
automation
company
connector_auth
connectors
dashboard
embed
CRUD - Create, Read, Update, Delete
connector_auth - the token can create, read, update, and delete all Connector Auths to which the user who created the token has access to
:manage
automation
company
connector_auth
connectors
dashboard
embed
CRU - Create, Read, Update
connector_auth:manage - the user can do all of the above, except for deleting
:view
automation
company
connector_auth
connectors
dashboard
embed
R - Read
connector_auth:view - the user can only read the Connector Auths
webhook_run
automation
Trigger Webhook Flows
automation - the token can trigger all Webhook Flows in the account (alternative to Flow specific webhook tokens)
Using Personal Access Token
To authenticate with the token, simply specify it in the Authorization header like this: Authorization: Bearer {{ token }} or setup a Connector Auth for Locoia within the Locoia app and then use the token there.

Scope Name	Entites
automation	Flows Flow Runs Flow Run Steps Run Flows Connector Auths (Read only) Env Variables (Read only) File Uploads (Read only)
company	Env Variables File Uploads Teams Users
connector_auth	Connector Auths
connectors	Connectors Connector Actions
dashboard	Dashboards Data Sources Forecasts Insights Transforms
embed	Embeds

Scope Extension	Supported Scopes	Operations	Example
None (leave empty)	automation company connector_auth connectors dashboard embed	CRUD - Create, Read, Update, Delete	`connector_auth` - the token can create, read, update, and delete all Connector Auths to which the user who created the token has access to
:manage	automation company connector_auth connectors dashboard embed	CRU - Create, Read, Update	`connector_auth:manage` - the user can do all of the above, except for deleting
:view	automation company connector_auth connectors dashboard embed	R - Read	`connector_auth:view` - the user can only read the Connector Auths
webhook_run	automation	Trigger Webhook Flows	`automation` - the token can trigger all Webhook Flows in the account (alternative to Flow specific webhook tokens)

Best Practice Guides - Previous

FAQ

Next - API

Create Connector Authentication

Last modified 2mo ago