GitHub

Create an integration to manage access to GitHub repositories

Suggest Edits

GitHub is a code hosting and collaboration platform that enables developers to manage project versions, track changes, and collaborate on software development.

Through this integration, Apono helps you securely manage access to your GitHub repositories.


Prerequisites

ItemDescription
Apono ConnectorOn-prem connection serving as a bridge between a GitHub database instance and Apono:Minimum Required Version: 1.3.2
GitHub Organization AccountGitHub organization account that possesses admin repository and user permissions
User's Company EmailCompany email of the user linked to a GitHub profile

For GitHub Enterprise Cloud, make sure to sync GitHub with your IdP. For non-Enterprise organizations, the organization's user email must be set on the GitHub profile.
GitHub TokenGitHub authentication token

Under Select scopes, click the checkboxes next to the following parent scopes. By selecting each parent scope, all the children scopes will also be selected:
  • repo
  • admin:org
  • user
Apono SecretValue generated in one of the following environments:
Create a secret for the GitHub instance. For the key, use token. For the value, use the generated GitHub token.

"token": "<GITHUB_ACCESS_TOKEN>"

Apono does not store credentials. The Apono Connector uses the secret to communicate with services in your environment and separate the Apono web app from the environment for maximal security.

NOTE: Alternatively, you can use the GitHub token directly when adding the secret in the Secret Store section of the Apono UI. In step 7 of the Integrate GitHub section, follow the Apono instructions. However, we strongly recommend using a secret to ensure the security of your resources and data.

Integrate Github

Github tile

Github tile


Follow these steps to complete the integration:

  1. On the Catalog tab, click Github. The Connect Integration page appears.
  2. Click Next. The Apono connector section expands.
  3. From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

    💡

    If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, GCP, Kubernetes).

  4. Click Next. The Integration Config page appears.
  5. Define the Integration Config settings.
    Setting Description
    Integration Name Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow
    Organization GitHub organization name

  6. Click Next. The Secret Store section expands.
  7. Under Secret Store, associate the secret:
  8. Click Next. The Get more with Apono section expands.
  9. Define the Get more with Apono settings.
    Setting Description
    Custom Access Details (Optional) Instructions explaining how to access this integration's resources

    Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters.

    To view the message as it appears to end users, click Preview.

    NOTE: You can also add the custom_access_details parameter to the apono_integration schema using Terraform. For more information, learn how to integrate with Apono in the Terraform Registry.
    Integration Owner (Optional) Fallback approver if no resource owner is found

    Follow these steps to define one or several integration owners:
    1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.
    2. From the Value dropdown menu, select one or multiple users or groups.

    NOTE: When Resource Owner is defined, an Integration Owner must be defined.
    Resource Owner (Optional) Group or role responsible for managing access approvals or rejections for the resource

    Follow these steps to define one or several resource owners:
    1. Enter a Key name. This value is the name of the tag created in your cloud environment.

    2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated.

      Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

    NOTE: When this setting is defined, an Integration Owner must also be defined.

  1. Click Confirm.

Now that you have completed this integration, you can create access flows that grant permission to your GitHub instance.

Updated 3 days ago