Aliases and apex aliases are commonly referenced throughout the Flow platform and our help center. This document outlines what they are, and where they come from.
Who can use this?
An alias is a unique identifier for a user. A user can have multiple aliases in Flow. These aliases are drawn directly from the integrations that you setup in Flow. So a user can have a unique alias imported from each integration setup in your account. Let's take an example:
A user connected the following Integrations into their Flow account:
The User details page has all the aliases that were imported from each of these integrations. Each alias was used to either comment on a PR, create a commit, or create a ticket.
As seen in the image above, two aliases were pulled in from Jira. It is possible that the user commits on PRs with the other. The third alias was pulled in from the Github Cloud integration.
In addition to the aliases found when ingesting your data for the first time, Flow also creates a new alias for each user or contributor ingested. These aliases will look something like this: firstname.lastname@example.org. These aliases are automatically merged under their respective user. Flow generates these aliases to track whose data came from what integration.This is necessary if there are multiple integrations connected to the same Git host.
The above example user commits on the following three repos. In this example, please note that some repositories were imported under different integrations. See below:
- Repo A - Imported via integration 1
- Repo B - Imported via integration 1
- Fork Repo A - Imported via integration 2
From the last image, the example user already has three Aliases that have been ingested from Github and Jira. In addition to these three aliases they are also going to have a unique alias that is generated by Flow from each integration that their data has been imported from. In this case there will be two additional aliases.
Here is their total alias count:
- GitHub - one alias
- Jira - two aliases
- Integration 1 - one alias
- Integration 2 - two aliases
Total Alias Count: five
Each user that is imported from the connected integrations will have an apex alias. This is the primary alias that will be used to identify the user in your reports. This apex alias information can be changed by editing the user's email address or name on the User details page.
Undisclosed users appear in your reports or user list when Flow cannot identify the user. An undisclosed user’s email address is not provided when the githost is integrated with Flow. This can happen when a user’s account or email address is private.
When Flow integrates a githost or ticket system, it pulls information from an API. Sometimes Flow cannot access the account name or email in the API. This may happen because githosts and ticket systems do not provide the account name or email. Other times, the user’s account and email are set as private. In both instances, Flow creates an alias and labels the users as Undisclosed.
The undisclosed email appears as undisclosed@<external id>.id.gitprime.com or <userid>@<integrationid>.id.gitprime.com.
If you need help, please email Support (opens email form) for 24/7 assistance.