Configuring Git accounts

Configure your Git account information to securely connect to your private Git repositories from your tenant, facilitating the storage of your project assets.

Before you begin

  • Create a new empty Git repository and make sure that you have read and write permissions. The name of the repository must be in the following format: RepoNameProject, where RepoName indicates the name of the repository and must start with an uppercase letter. Make sure that the repository name must be the same as the name that you are going to use for your new project.
    Note: The repository must not contain any files or commits before you link it to your project.
  • Create a personal access token for the Git account with access to the repository. Make sure that the repo scope is selected at a minimum. For detailed instructions on creating a personal access token, refer to the Git provider's documentation.
    Note: For Bitbucket, use an App Password instead, which can be created in the user's personal settings section.

Procedure

  1. From the navigation pane, click Settings.
    A list of various settings applicable for the tenant is displayed.
  2. Click Version Control.
    Note: Git accounts linked to projects before version 11.0.7 are considered shared and only Administrators can view and manage them. Users who want to commit changes to such a project are prompted to enter a Git username and access token when you commit the files for the first time.
    The Version Control page is displayed, listing all Git accounts that the user owns and the Git accounts shared with the user.
  3. In the Version Control page, click Add.
    The Add git account page is displayed.
  4. In the Add git account page, provide the following details:
    Source Control
    Name for the account. The account name must contain alphanumeric characters, underscores, and spaces. It cannot begin with a space and exceed 36 characters.
    Username
    Username used to access the Git server.
    Git provider
    Name of the Git repository provider.
    Hostname
    Name of the Git server.
    Note: Do not add http:// or https:// before the hostname. For example, for GitHub, enter github.com or github.enterprise.com, where enterprise is the name of your organization.
    Shared
    Select Shared to share an account with other users. The shared accounts can be used only for pulling the changes such as adding custom packages to projects. The shared accounts cannot be used for committing any changes to Git repositories or creating projects.

    When you share an account, all users can use it for pull operations. A user can have a single private account but multiple shared accounts.

  5. Perform this step to configure the authentication-specific details for GitHub.
    1. In Authentication Type, select one of the authentication methods.
    2. If using a Personal Access Token (PAT), specify the personal access token for the Git account. This token is an alternative to using your Git password for authentication to access repositories.
    3. If you want to use a bearer token for a GitHub app, specify the following values:
      Note:

      If using an OAuth app, use the acquired bearer (access) token in the same way as a PAT. OAuth app access tokens are valid for a longer period and token refresh details are not required.

      Access Token
      The token that is used for authentication by the authorization server. The authorization server issues the token after successful authentication and is passed in API requests to prove the identity and permissions of the client. For bearer token authentication, webMethods Integration implicitly gets an access token after you save the account.
      Client ID
      The authorization server issues a public identifier to the client application, and the client uses it to identify itself during authentication.
      Client Secret
      A client secret is a confidential string that is issued to the client application by the authorization server. It is used along with the Client ID to authenticate the client during token exchange.
      Refresh Token
      A credential that is used to obtain a new access token without requiring the user to reauthenticate. It is typically issued alongside the access token and is used when the access token expires.
      Refresh URL
      The endpoint that is provided by the authorization server where the client sends the refresh token to obtain a new access token. This URL is the provider-specific URL to refresh an access token.
  6. Perform this step to configure the authentication-specific details for Bitbucket accounts.
    API Token
    A secure, unique string that is used to authenticate and authorize access to Bitbucket without requiring to use your username and password directly. The API Token field applies only when the Bitbucket provider is selected.

    For self-hosted Bitbucket instances, that are running on your own servers or data centres, it is recommended that you use HTTP access tokens.

    Tip: A secure string used to authenticate access without a password. To prevent unintentional access to all organization repositories, limit scopes and specify repository names when tokens are generated.
    Email ID
    The primary email address that is linked to the Bitbucket user account. When API tokens are used for authentication with provider-specific APIs, the email ID must be passed in place of the username. The system uses this email ID to validate the account, retrieve repository branches, check whether the repository is empty, verify the manifest file, and determine whether the repository contains a project package. Using the Bitbucket username rather than the email can cause authentication failures for these operations.
  7. Perform this step to configure the authentication-specific details for Azure and GitLab repositories.
    1. In the Personal Access Token field, specify the access token that is used to authenticate your account.
  8. Click Validate.
    If the token validation is successful, then the Token Expiry Date field and the Add button are enabled.
  9. In the Token Expiry Date field, enter the date when the token expires. The date is available in your Git repository.
    • If the Token Expiry Date field displays a date, verify that the date is the correct date when the personal access token expires. If not, update the correct date.
    • For GitHub accounts, the date is automatically retrieved from the repository.
    • For Azure repos, the expiry date is not retrieved from the repository. Either keep it blank or enter a date.
      Note: For Azure repos, the non-expiring token is not supported.
    • For Bitbucket repos, the system does not retrieve or display the token expiry date from the repository. As a result, No Expiry is shown in the Token Expiry Date field. To make sure that you do not lose track of token validity, it is advised to save the expiry date in a secure location on your local system for future reference.
  10. Click Add.

Results

The Git repository account is saved and listed in the Version Control page. You can do one of the following actions on the Git accounts by using the options that are listed in the Action(s) column.
Edit or Delete
Administrators or Git account owners can edit or delete Git accounts. Git accounts that are shared with you cannot be updated or deleted. You cannot delete an account that is linked to an existing project. To delete an account, you must first remove all projects that are linked to the account.

For older Bitbucket accounts that still use the Personal Access Token (PAT), click Edit to add your API token and email details to keep using the account without issues.

Refresh Status
  • You can use the Refresh Status option to view the most recent status of a token. The following errors might occur.
    Unauthorized to access the resource
    This error is displayed when the Git accounts with valid tokens do not have permission to access the resource, or when the resource is not available.
    Unauthorized: Invalid credentials
    This error is displayed when the Git token has expired.