Integrate with GitHub Enterprise Server

Integrating your Software Asset Management application with the GitHub Enterprise Server application help you track your software subscriptions and reclaim unused licenses.

Important: Minimize security risks and protect information by granting access only to the necessary user or API permissions.

Generate an API access token for GitHub Enterprise Server

Generate a token that you can use to access the GitHub Enterprise Server API.

Before you begin

GitHub Role required: site administrator

About this task

The GitHub repository hosting service uses personal access tokens to grant users access to the GitHub API. Personal access tokens function similarly to OAuth access tokens by authorizing API requests. By generating a personal access token to authorize your GitHub Enterprise Server API requests, you can gain access to the GitHub Enterprise Server API.

Procedure

1. From a web browser, open your GitHub Enterprise Server instance.

2. Sign in to your GitHub account.

3. On the GitHub page header, select your profile photo and then select Settings.

   Your profile settings open.

4. From the left navigation pane, select Developer Settings.

   Your developer settings open.

5. From the left navigation pane, select Personal access tokens.

6. On the Personal access tokens page, select Generate new token.

7. If you’re prompted to confirm your password before proceeding, enter your GitHub password and then select Confirm password.

8. On the New personal access token form, describe the purpose of the token in the Note field.

9. In the Select scopes form section, enable the site_admin OAuth scope by selecting the site_admin check box.

   OAuth scopes limit the level of access that the application has to your protected resources. The site_admin OAuth scope enables you to manage your enterprise users, organizations, and repositories.

10. Select Generate token.

    Your personal access token generates.

11. Copy the access token and save it in a secure location for later use.

Create a GitHub Enterprise Server integration profile

Create a GitHub Enterprise Server integration profile to track software subscriptions and optimize licensing for your GitHub Enterprise Server applications.

Before you begin

To create a GitHub Enterprise Server integration profile, request the Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) from the ServiceNow Store.

ServiceNow Role required: sam_integrator

Important: You must select the GitHub Spoke check box for this integration while installing optional features on the Application Manager page. For more information about choosing the required SaaS applications, see Request SaaS License Management.

About this task

If you’re using Software Asset Workspace, the option to create the GitHub Server integration profile in Core UI is inactive.

Procedure

1. Navigate to the integration profile.

1. On the form, fill in the fields.

1. In the Process configuration section, review the required user roles or API permissions specified in the Vendor configuration field for each process to minimize security risks and optimize SaaS licenses.

   Note: For more information about the required roles and scopes, see Minimal user permissions table.

   • The Download subscriptions check box is selected by default and you can't clear it.

   • Note: The Download Activity check box is selected by default. If you clear it, the activity scheduled job SAM - Refresh <displayname> Activity isn't created.

     In the Analyze user activity field, you can also select the date and time starting from when you want to analyze the user activity. By default, you can analyze user activity up to 60 days prior to the current date and view events performed by individual users from the time you create this profile.

     Note: Software Asset Management pulls the events from the time that you start analyzing user activity irrespective of the profile creation date.

     You can modify this value in the Last activity threshold field of your software reclamation rules. For more information, see Review a software reclamation rule.

   • The Reclaim subscriptions check box is selected by default. If you don't want to reclaim subscriptions, you can clear this check box. If you clear it, the removal candidates are created but the reclaim subscription subflow isn't triggered or the reclamation process isn't initiated.

2. Select Save.

   Your ServiceNow instance creates a draft integration profile.

   The Connection & Credential field appears and is automatically set to sn_github_spoke.GitHub_Server.

3. Open the connection & credential aliases record by selecting the preview icon

next to the Connection & Credential field and then selecting Open Record in the record preview.

1. On the Connection & Credential Aliases form, select the Create New Connection & Credential related link.

2. In the Create Connection and Credential dialog box, fill in the fields.