This documentation is related to an older version of Firebolt. For the most current documentation, see Firebolt documentation.

Creating a service account (Beta)

A service account user can access Firebolt programmatically only.

SQL commands for managing service account users

To create a service account user, follow these steps:

1. Create a service account user using the CREATE SERVICE ACCOUNT USER command. Make a note of the service account ID - you will need that to authenticate later. The ID can always be retrieved by querying the service_account_users view in Firebolt’s information schema - for more information see Service account users in information schema.

2. Generate a secret for the service account user with the generation function described below. Make a note of the secret - it can’t be retrieved later. In case the secret is lost (or needs to be rotated), you can always generate a new secret, calling the same generation function.

3. Use the service account ID and the secret to access Firebolt programmatically via Firebolt’s REST API.

To delete a service account user, use the DROP SERVICE ACCOUNT command.

Create a service account user

CREATE SERVICE ACCOUNT <name> ROLE = <role> [DESCRIPTION = <description>]

Creates a service account user, where:

Example

CREATE SERVICE ACCOUNT tableau_user ROLE='viewer' DESCRIPTION='Used for Tableau dashboards';

Generate a secret for the service account user

CALL firebolt.GENERATESERVICEACCOUNTKEY('<name>');

Generate a secret for the service account user, where:

Example CALL firebolt.GENERATESERVICEACCOUNTKEY('tableau_user');

The command returns both the service account ID and secret.

Generating a new secret for your service account user replaces any previous secret (which cannot be used once a new one is generated). Make a note of the secret and keep it in a secured location.

Delete a service account user

DROP SERVICE ACCOUNT <name>;

Deletes a service account user by its name. The name can be retrieved by running the SELECT * FROM INFORMATION_SCHEMA.SERVICE_ACCOUNT_USERS command, where:

Example DROP SERVICE ACCOUNT tableau_user;

Service account users in information_schema

SELECT * FROM information_schema.service_account_users;

Returns a list of service account users.

The command returns the following properties for each service account user:

Example

SELECT * FROM INFORMATION_SCHEMA.SERVICE_ACCOUNT_USERS;

Returns

Authenticate with a service account via the REST API

• Create a service account with organization admin privilege set to true.
• Create a user with roles that will allow the service account to perform desired operations. Associate the user with the service account.
• Generate a secret for the service account.
• Generate an access token using the service account secret.

Finally, use the obtained service account ID and secret to authenticate with Firebolt via Firebolt’s REST API, send the following request to receive an authentication token:

curl --location --request POST 'https://api.app.firebolt.io/auth/v1/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=<service account id>' \
--data-urlencode 'client_secret=<service account secret>' \
--data-urlencode 'grant_type=client_credentials'

Where:

Use the returned access_token to authenticate with Firebolt.

Known limitations and future release plans

IP allowed/blocked lists At this time, using IP allowed/blocked lists (Beta) with service account users is not supported. This will be supported in the future.

Information_schema running queries view At this time, the user_id column in the information_schema.running_queries view does not contain the service account ID (it contains an empty TEXT instead). This will be supported in future versions.