Skip to content

Generate an access token

Saturn needs an access token to authenticate at the API of the host and push changes to repositories.

The following guides describe how to create an access token for the supported hosts.

Bitbucket

  1. Create a new account for the bot user or use an existing account.
  2. Add a new API token at https://id.atlassian.com/manage-profile/security/api-tokens.
  3. Create the API token with the following scopes:
    • read:user:bitbucket
    • read:repository:bitbucket
    • read:pullrequest:bitbucket
    • read:workspace:bitbucket
    • write:repository:bitbucket
    • write:pullrequest:bitbucket
  4. Set bitbucketToken to the API token. Set bitbucketUsername to the e-mail address of the account.

Forgejo

  1. Create an access token at https://<forgejo instance>/user/settings/applications.
  2. Create the token with the scopes write:issue, write:repository and read:user.
  3. Set forgejoToken to the new token.

GitHub

  1. Create a Personal Access Token.
  2. Create the token with scopes repo and user:email.
  3. Configure githubToken.

GitLab

  1. Depending on your use case, follow Create a personal access token or Create a group access token.
  2. Create the token with scopes api and write_repository.
  3. Configure gitlabToken.