GitHub

Create an integration to manage access to GitHub repositories

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

Item
Description

Apono Connector

On-prem connection serving as a bridge between a GitHub database instance and Apono:

Minimum Required Version: 1.3.2

GitHub Organization Account

GitHub organization account that possesses admin repository and user permissions

Company Email of User

(Non-Enterprise subscription) Company email associated with the user's GitHub profile

For non-Enterprise organizations, set the user email to public in GitHub. If the email is private, Apono will not be able to locate the user.

Synced IdP

(Enterprise subscription) Identity provider (IdP) connected with your GitHub account

For Enterprise organizations, sync GitHub with your IdP.

GitHub Token

GitHub 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 Secret

Value 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.

Integrate Github

You can also use the steps below to integrate with Apono using Terraform.

In step 10, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

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, Azure, GCP, Kubernetes).

  1. Click Next. The Integration Config page appears.

  2. 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

  3. Click Next. The Secret Store section expands.

  4. Associate the secret or credentials.

  5. Click Next. The Get more with Apono section expands.

  6. 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.

    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.

    1. 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.

  7. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

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

PreviousDevelopment ToolsNextRancher

Last updated