Accounts
Accounts are passive entities that store quota information for resources consumed by associated profiles. An account is created for a user when they first sign up.
Objects
Account
| Path | JSON Type | Format | Description |
|---|---|---|---|
id | string | Version 4 UUID | The account ID |
created | string | ISO 8601 timestamp | The instant at which the account was created |
lastModified | string | ISO 8601 timestamp | The instant at which the account was last modified |
company | string | The name of the company associated with the account | |
ownerEmail | string | Email address | The email address of the owner profile |
ownerProfileId | string | The ID of the owner profile | |
maxWorkspaces | number | Unsigned integer | The maximum number of workspaces that can be created under the account |
maxRows | number | Unsigned integer | The maximum number of managed database rows available to the account |
minutesPerMonth | number | Unsigned integer | The number of pipeline run minutes available to the account per month |
minutesUsed | number | Unsigned integer | The number of pipeline run minutes used by the account per month |
maxClients | number | Unsigned integer | The number of API key clients available to the account |
Requests
View all accounts
GET /api/accounts
Returns all accounts the authenticated user profile is an owner of.
Response
200 OK
Account collection with HAL links.
View an account
GET /api/accounts/{account-id}
Returns the account {account-id}.
Prerequisites
- Account
{account-id}must exist - The authenticated user profile must be an owner of the account
{account-id}
Response
200 OK
Account with HAL links.
Initialise a new account
POST /api/accounts/new
Initialises a new account.
Response
200 OK
Account with HAL links.
Create an account
PUT /api/accounts/{account-id}
Creates the account {account-id}.
Prerequisites
- The
ownerEmailmust match the authenticated user profile's email address
Body
Account resource.
Response
201 Created
Account with HAL links.
Update an account
PUT /api/accounts/{account-id}
Updates the account {account-id}.
Prerequisites
- Account
{account-id}must exist - The authenticated user profile must be an owner of the account
{account-id}
Body
Account resource.
Response
200 OK
Account with HAL links.
View all account admins
GET /api/accounts/{account-id}/admins
Returns all admins of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id}
Response
200 OK
Profile collection with HAL links.
Add an account admin
PUT /api/accounts/{account-id}/admins/{profile-id}
Adds the profile {profile-id} as an admin of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must exist
Response
200 OK
Account with HAL links.
Remove an account admin
DELETE /api/accounts/{account-id}/admins/{profile-id}
Removes the profile {profile-id} as an admin of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must be an admin of the account{account-id}
Response
204 No Content
No response body provided.
Set an account owner
PUT /api/accounts/{account-id}/owner/{profile-id}
Sets the profile {profile-id} as the primary owner of the account {account-id}.
Prerequisites
- The authenticated user profile must be an owner of the account
{account-id} - Profile
{profile-id}must be an admin of the account{account-id}
Response
200 OK
Account with HAL links.