Connections
The Connections page is a feature where we can check and edit the connections of the Git providers we are connected to. You can access this page from the left bar in the Build module.
On this page, you can view OAuth and PAT (Personal Access Token) connections.
If you have not previously connected to a Git provider on Appcircle, i.e., created a profile and not connected a repository, you will not see any connection on this page.
Managing OAuth Connections
Revoke OAuth Connections
Revoke Token revokes the token of the Git provider on the Appcircle side. On the Git provider side, the token is still active and available. Appcircle cannot revoke the token from the provider.
A revoked connection disconnects all build profiles connected to the respective Git provider. In this case, Appcircle shows a clear warning message. Here, you can see all the affected profiles.
When we revoke a Git provider successfully, the "Revoke Token" button disappears. If we reconnect using the Refresh Token button, the "Revoke Token" button will appear again.
If we open one of the affected build profiles after applying a revoke for a Git provider, we should see the disconnected build profile state in the UI.
If we reconnect this profile, not only the related build profile but also all other build profiles belonging to that Git provider will be connected.
Reconnect OAuth Connections
If we want to reconnect to the Git provider, we can use the Refresh Token button.
The refresh token is received while connecting to the Git provider, and it's used when needed, for instance, in reconnection or token expiration cases.
The refreshing connection action reconnects all previously linked and disconnected build profiles of the corresponding Git provider in Appcircle. Here again, all affected build profiles will be shown.
When the Refresh Token button is clicked, Appcircle redirects to the relevant Git provider's page. After giving the necessary permissions there, the connection will be restored.
If the connection to the Git provider is active and the Refresh Token button is clicked, Appcircle will re-establish the connection.
Managing PAT Connections
The PAT connection list section on the right-hand side has a list of connections that were made using a personal access token.
The list first shows the logo of the Git provider we're connecting to, then the name we gave to the connection (when multiple instances are used), and finally the URL of the Git provider we're connecting to.
Adding PAT Connection
The "Add New" button at the top of the PAT connection list on the right side allows us to add PAT (Personal Access Token) without creating a new build profile. Then you can use that PAT connection on existing build profiles or while adding a new build profile.
After clicking on the "Add New" button, Appcircle will ask us to select a Git provider and fill in the necessary information according to the Git provider, just like in the build profile PAT connection.
The name you defined in the Connection Name section must be unique for each Git provider.
For example, if you have created a PAT named "my-secret-pat" for GitHub, you cannot create another PAT with the same name for GitHub.
But you can create a PAT named "my-secret-pat" for GitLab or Bitbucket, for instance.
In Azure DevOps Server connections, the Owner Username field on Appcircle corresponds to the Collection Name on Azure.
Now you're ready to use the added PAT connection in your build profiles. While making a new connection, you can see the PAT connection in the available connections list after selecting Git provider.
Editing PAT Connections
We can see the details of the PAT connection with the Edit button on the right side. These are Provider, Instance URL, Token Owner, Token, and PAT.
In the Connection Edit, we can change the PAT (Personal Access Token) value.
However, we must make sure that the value we change here is correct and that it was created on the Git provider correctly. Otherwise, the affected build profile or profiles will not be connected.
In the Connection Edit, you can see the build profiles where PAT is used under "Affected Build Profiles".
Changing a PAT value will affect all the build profiles shown here.
While editing PAT connections, you can also write the PAT value using environment variables.
You can review Using Environment Variables For SSH And PAT (Personal Access Token) Connections page for details.
Deleting PAT Connections
You can delete a Personal Access Token (PAT) connection by clicking on the Delete next to the respective entry in your list of PAT connections.
Upon clicking the Delete button, Appcircle will prompt you to enter the name of the PAT Connection to confirm the deletion operation. After entering the connection name, simply click Delete on the pop-up screen.
If you have an existing Build profile that would be affected by the deletion of the PAT Connection, Appcircle will display a warning message listing the affected builds.
You will need to disconnect them before you can delete the PAT Connection.
For more information about disconnecting a Build profile please refer to the related documentation.
