The service credential user

Abstract

The service credential is a user whose connected Git provider account (GitHub, GitLab or Bitbucket) is used to access those services for the purposes of Bitrise builds.

The service credential is a user whose connected Git provider account (GitHub, GitLab or Bitbucket) is used to access those Git services for certain actions that Bitrise can execute.

You need to set a service credential user, among other things, to:

Send build status reports back to your Git provider.
Use the Selective builds feature that allows you to specify certain files or directories in your repository that need to be modified to trigger an automatic Bitrise build.
Store the bitrise.yml file in your repository.

Actions and requirements

For the full list of actions and their access requirements, see Service credential user actions and their required repository access.

By default, the user who added the app to Bitrise is set as the service credential user. Even if you change it, it should always be a user who has access to the app's repository.

It isn't mandatory to have a service credential user: you can use the No service credential user setting to not have one. You'll still be able to run builds and trigger builds automatically but Bitrise won't be able to send build status reports to your Git provider, you won't be able to use the Selective builds feature or to store the bitrise.yml file in your repository.

Changing the service credential user

The service credential user can be changed at any time but each Bitrise user can only set themselves as the service credential user on the app.

Role requirement

To change the service credential user, you need to have Adminrole on the app's team on Bitrise.

To change the service credential user:

Log in to Bitrise with the account that will be the new service credential user.
Make sure that account has Admin role on the app's team.
Go to your Workspace's Dashboard.
Select the app where you want to change the service credential user
Click on the App Settings icon.
On the left, select Integrations from the menu options.
Scroll down to the Service credential user part.
Click Change to me.

Disabling OAuth application access restrictions for your GitHub organization

If you receive an error while trying to connect or change the service credential user for your app, make sure that the user has the appropriate access to the GitHub repository and that Third-party application access policy restrictions are disabled.

For more information on how to disable the Third-party application access policy on GitHub, check out Disabling OAuth App access restrictions for your organization.
To confirm, click Set service credential user.

Service credential user actions and their required repository access

The service credential user allows Bitrise to execute a number of different actions that require access to the app's Git repository. Different actions require different levels of access: for example, to use a bitrise.yml file from the repository requires read access on GitHub while registering a new SSH key requires admin access.

The following table contains all the actions that require the service credential user, as well as the access level of the service credential user's account at the the three main Git providers.

Table 1. Access requirements for the service credential user

Action	Required access level on GitHub	Required access level on Bitbucket	Required access level on GitLab
Using a `bitrise.yml` from the repository	read	read	reporter
List the branches of the repository	read	read	reporter
Selective builds	read	read	reporter
Sending Git status reports	write	write	GitLab.com: developer Self-hosted GitLab: maintainer
Registering SSH keys to the repository	admin	admin	maintainer
Register a webhook	admin	admin	maintainer
Checking the Git connection on bitrise.io	admin	admin	maintainer

In this section: