Service accounts are a useful way to manage your Flow integrations and API keys. There are three common uses for service accounts:
- Using a Git and ticket vendor service account
- Using a service account for automated processes
- Using a Flow user service account
Using a Git and ticket vendor service account
Creating a service account allows you to import all of your organization's repos and manage API keys under one generic user and integration without having to worry about exposing access to personal repositories, permission changes, staffing changes, loss of repo access, etc.
Note: Use a dedicated service account to connect to Flow. This helps you avoid unnecessary rate limits or other data import delays.
To create a Git or ticket vendor service account:
- Create a service account email address within your organization. A unique email address is a common requirement for user accounts with most Git vendors. Use an email that is easy to identify such as,
flow-integrations@myorg.com. - From the Git or ticket vendor, create a user account with owner or contributor permissions. Required permissions depend on the Git or ticket vendor.
- Use the service account email and other information in the integration to connect Flow to the Git or ticket vendor.
- Store the credentials in your organization's knowledge base.
Tip: This service email needs the appropriate permissions within your Git or ticket host in order to be able to import and manage your repos within Flow.
Update Git integrations for automated processes
If you have any automated process as part of your development pipeline, it's best to use a service account for those systems. This allows you to separate the automated activity from the contributor activity.
To create a service account:
- Create a service account email address within your organization. A unique email address is a common requirement for user accounts with most Git vendors. Use an email that's easy to identify, like
automation@myorg.com. - From the Git vendor, create a user account with owner or contributor permissions. Required permissions depend on the Git vendor.
- Use the service account email in the integration to connect the Git vendor to the automated processes.
- Store the credentials in your organization's knowledge base.
Using a Flow user service account for APIs
Using a Flow user service account allows you to maintain your Flow organization's configuration and integrations, regardless of staffing changes.
To create a Flow user service account:
- Create a service account email address within your organization. A unique email address is a requirement for login user accounts in Flow.
- From Flow, invite the user to the organization using that email address. It's recommended you use username and password rather than SSO for this account in Flow.
- Assign Admin role or grant all permissions to this user.
- Store the credentials in your organization's knowledge base.