Authentication

Service Account#

A service account is a non-human account used by applications, scripts, or services to access the Bytebase API. The service account follows the same permission model as the normal user account. The only exception is service account can't be added to a group as it's an anti-pattern.

In Users & Groups under Security & Policy section, Add User on the upper-right. Choose Service Account Type, fill in the email and Confirm. Then you can see your service account in the list. Copy Service Key right away.

Login to fetch the token#

You need to obtain the exchange token before calling the API.

export bytebase_url=http://bytebase.example.com
export bytebase_account=<<your_service_account>>@service.bytebase.com
export bytebase_password=<<your_service_key>>

bytebase_token=$(curl -v ${bytebase_url}/v1/auth/login \
    --data-raw '{"email":"'${bytebase_account}'","password":"'${bytebase_password}'","web":true}' \
    --compressed 2>&1 | grep token | grep -o 'access-token=[^;]*;' | grep -o '[^;]*' | sed 's/access-token=//g; s/;//g')

Test API#

# List projects
curl --request GET ${bytebase_url}/v1/projects \
  --header 'Authorization: Bearer '${bytebase_token}