Target audience: Workspace administrators and developers
Overview
An admin service account lets scripts and integrations call the LucidLink API without using a person's login. It has the full permissions of a workspace administrator, so it can use all API functionality. This article shows you how to create one, create a secret key, and send your first API request. To compare it with the collaborator type, see Service accounts overview.
Create an admin service account and a secret key
Open the service accounts page: In the web or desktop app, open your workspace settings and select Service accounts.
Create the account: Select Create a service account and choose Admin service account. Enter a name that says what the account is for, up to 254 characters. You can't rename it later. LucidLink records the creation date and who created it.
Create a secret key: Creating the account in the app doesn't create a secret key. Open the account's Secret keys tab and create one. The expiration defaults to 90 days. You can pick another date or remove the expiration, but you can't change it after the secret key is created.
Copy the secret key: LucidLink shows it once. Copy it and store it somewhere safe, such as a password manager or secrets manager.
You can't view the secret key again. If you lose it, create a new secret key on the same service account.
An account can have more than one secret key. For how to replace one without interrupting your automation, see Manage service account keys.
Authenticate with the API
To successfully call the LucidLink API, you must include an active Service Account key (login token) in the Authorization header of your HTTP request using the Bearer scheme.
Header Format:
Authorization: Bearer [your service key]Example (using cURL):
curl -i -X GET 'http://localhost:3003/api/v1/filespaces' \
-H 'Authorization: Bearer [your service key]' \
-H 'Content-Type: application/json'Replace [your service key] with the active secret key obtained from your Service Account management console.
Manage service accounts with the API
An admin service account secret key can call these endpoints.
For all of the actions: https://developer.lucidlink.com/docs/lucid-api/key-functionalities
How to manage service accounts via the API: https://developer.lucidlink.com/docs/lucid-api/reference/service-accounts#post-service-accounts
How to manage service account keys via the API: https://developer.lucidlink.com/docs/lucid-api/reference/service-account-keys
Frequently Asked Questions
Who can create an admin service account?
Workspace owners and workspace administrators, in the web or desktop app. Filespace administrators can't. An admin service account can't create another admin service account.
Can I limit what it can do?
No. An admin service account always has full workspace administrator access. If the job needs only certain folders, use a collaborator service account instead.
Can an admin service account manage collaborator service accounts?
Yes, through the API. It can create and delete collaborator service accounts, create secret keys for them, and grant them access. It can't create secret keys for itself or for other admin service accounts.
What happens if I delete it?
All of its secret keys stop working immediately.