Creating service accounts
A quick guide on how to create a Service Account for our REST API.
Overview
We will here create a new a new Service Account using either the web application or our REST API.
Prerequisites
In order to create the initial service account, the logged in user needs to have a role of Admin.
Create using app
The first service account needs to be created using our App. Whereas subsequent accounts may be created using the REST API.
Navigate to Service account settings
Click Add
Give the account a meaningful name and decide whether you want to enable Basic Auth
Click Save
Add 1 or more service account keys that may be used for Authentication
Copy the details.
Make sure the secret is safely stored. Delete the key if you think it has been compromised in any way.

Create using REST API
Service accounts may be created, and keys may be rotated deleted using the REST API shown below. See our API reference for more operations
Creates a new serviceAccount and sends an email confirmation request to the supplied email.
Pin to organization.Organization.id
Whether Basic Auth can be used with this service account
true
Name of the serviceAccount
John Doe
POST /api/service-account/v1/service-account HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"enableBasicAuth": true,
"name": "John Doe"
}
{
"created": 1636044728,
"enableBasicAuth": true,
"id": "1235",
"keys": [
{
"created": 1636044728,
"keyId": "1235"
}
],
"name": "John Doe"
}
ServiceAccount id
Pin to organization.Organization.id
DELETE /api/service-account/v1/service-account/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Creates a new serviceAccount key
ServiceAccount id
Pin to organization.Organization.id
POST /api/service-account/v1/service-account/{id}/key HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2
{}
{
"created": 1636044728,
"keyId": "1235",
"secret": "secret-key"
}
ServiceAccount id
The id of the key to delete
Pin to organization.Organization.id
DELETE /api/service-account/v1/service-account/{id}/key/{key-id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated