Integrate with GitHub Enterprise Cloud

Integrate with GitHub Enterprise Cloud Integrate with GitHub Enterprise Cloud

You can integrate your ServiceNow instance with the GitHub Enterprise Cloud application to track your software subscriptions and reclaim unused licenses.

Generate an API access token for GitHub Enterprise Cloud

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

GitHub Role required: organization owner

The user account that you use for authentication should be able to read all repositories in the organization they are a part of.

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 Cloud API requests, you can gain access to the GitHub Enterprise Cloud API.

From a web browser, open GitHub . Sign in to your GitHub account. On the GitHub page header, click your profile photo and then select Settings . Your profile settings open. From the left navigation pane, select Developer Settings . Your developer settings open. From the left navigation pane, select Personal access tokens . Select Tokens (classic) . On the Personal access tokens page, click Generate new token . Select Generate new token (classic) . If you are prompted to confirm your password before proceeding, enter your GitHub password and then click Confirm password . On the New personal access token form, describe the purpose of the token in the Note field. To give your token an expiration, select the Expiration drop-down menu and select a default value or use the calendar picker. In the Select scopes form section, enable the repo and admin:org OAuth scopes. OAuth scopes limit the level of access that the application has to your protected resources. The repo OAuth scope gives you full control of your private repositories. The admin:org OAuth scope enables you to manage your entire organization, including all teams, projects, and memberships. See Scopes for OAuth Apps for more information about GitHub OAuth scopes. Enable the repo OAuth scope by selecting the repo check box. By enabling this OAuth scope, you automatically enable the repo:status, repo_deployment, public_repo, repo:invite, and security_events OAuth scopes. Enable the admin:org OAuth scope by selecting the admin:org check box. By enabling this OAuth scope, you automatically enable both the write:org and read:org OAuth scopes.

Click Generate token . Your personal access token generates. Copy the access token and save it in a secure location for later use. To use your token to access resources owned by an organization that uses SAML single sign-on, authorize the token. For more information, see Authorizing a personal access token for use with SAML single sign-on .

Create a GitHub Enterprise Cloud connection

Create a connection between your GitHub Enterprise Cloud applications and your ServiceNow instance.

If you want to use a MID Server for communication between your ServiceNow instance and your GitHub Enterprise Cloud applications, you must first set up a MID Server on your instance. See MID Server for detailed instructions.

ServiceNow Role required: admin

From your ServiceNow instance, navigate to Process Automation > Flow Designer . The Flow Designer launches in a new tab. Select the Connections tab. Click View Details for your GitHub connection. From the list of available connections, locate GitHub and then click Configure . The Configure Connection dialog box opens. In the dialog box, fill in the fields. Table 1. Configure Connection dialog box Field Description Connection Name Name of the GitHub connection. Connection URL URL of the GitHub API endpoint. Enter https://api.github.com. Use MID Server Option that enables your ServiceNow instance to use a MID Server for communication with your GitHub Enterprise Cloud applications. If your instance requires a MID Server , set this field to true. If your instance does not require a MID Server , leave this field empty. Important: To enable this option, you must already have a MID Server set up on your instance. See MID Server for detailed instructions. API Key Personal access token that enables you to access the GitHub Enterprise Cloud API. If the GitHub spoke version installed is 2.2.5 or higher, enter . If the GitHub spoke version installed is lower than 2.2.5, enter Bearer . The api-key > is the personal access token that you generated in Generate an API access token for GitHub Enterprise Cloud

Click Configure Connection .

Create a GitHub Enterprise Cloud integration profile

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

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

ServiceNow Role required: sam_integrator or admin

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

Navigate to the integration profile. Interface Action Core UI Navigate to All > Software Asset > SaaS License > Direct Integration Profiles . Select New . Select GitHub Cloud Integration Profile .

Software Asset Workspace Navigate to License operations > User Subscriptions > Direct integration profiles . Select New . Select GitHub Cloud from the drop-down list. Select Continue .

On the form, fill in the fields. Table 2. Integration Profile form Field Description Display Name Name of the integration profile. For example, GitHub Cloud Integration. Connection & Credential Connection and credential alias for the GitHub spoke. This field is automatically set to sn_github_spoke.GitHub . Status Status of the integration profile. If you have not published the integration profile, this field is automatically set to Draft . If you have already published the integration profile, this field is automatically set to Published . Profile type Type of integration profile. This field is automatically set to github_cloud_subscription .

On the Download Subscription Subflow tab, verify that the Subflow field is set to GitHub Cloud Download Subscriptions . On the Calculate Activity Subflow tab, verify that the Subflow field is set to GitHub Cloud Update User Activity . You can also select the date and time that you want to analyze user activity from in the Analyze user activity from field. 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 .

Tip: To avoid performance issues with this subflow, ServiceNow recommends setting the Analyze user activity from field to a maximum of seven days prior to the current date.

On the Reclaim Subscription Subflow tab, verify that the Subflow field is set to GitHub Cloud Reclaim Subscription . Click Save . Your ServiceNow instance creates a draft integration profile. The integration profile uses the GitHub Cloud Download Subscriptions, GitHub Cloud Update User Activity, and GitHub Cloud Reclaim Subscription subflows to retrieve user data from your GitHub Enterprise Cloud applications. After the form reloads, click Publish . The Publish Confirmation dialog box opens. In the dialog box, click OK . After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and user subscriptions that are refreshed daily.

Review all automatically generated reclamation rules to ensure that they meet your specifications for reclaiming user subscriptions. For more information, see Review a software reclamation rule .

Create software entitlements for the automatically generated software models to track used software against owned software. For more information on creating software entitlements in the Software Asset Management classic application, see Create entitlements in Software Asset Management classic . For more information on creating software entitlements in the Software Asset Workspace, see Create entitlements in workspace . For more information on creating software entitlements using the Software Asset Management Playbook, see Create entitlements using the guided walk-through .

Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench ( Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance. For more information on running reconciliation in the Software Asset Management classic application, see Run software reconciliation . For more information on running reconciliation in the Software Asset Workspace, see Run software reconciliation in the workspace .