Creating an extended integration for GitHub (O Auth 2.0) users

Let Oomnitza be your single source of truth!

You'll get visibility of your GitHub users as data from GitHub is automatically transformed into consumable information and actionable insights.

Connect Oomnitza and GitHub in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

• Configurable dashboards and list views of key user information
• Configurable reports to share information about users with your colleagues and management
• Configurable workflows for adding and deleting users

Navigation

Add credentials to the vault in Oomnitza

Create the user integration

Mappings

Creating user workflows

Creating a workflow using the GitHub Member Role preset

Creating a workflow using the GitHub Remove Member from Org preset

GitHub User Role

Before you start

To stream GitHub user data into Oomnitza, you must add your GitHub OAuth 2.0 credentials to the vault in Oomnitza.

Follow the documentation links below to create an OAuth2.0 app and retain your Client ID, Client Secret and Scope for your credential setup within Oomnitza (Step 8)

Documentation:

GitHub Authentication: Overview

GitHub Authentication: Building OAuth2.0

GitHub API: Scopes. The scope required for User Role and Deactivate User isadmin:org

GitHub API: Authorizing OAuth2.0 Apps

Best practice
For the integration with Oomnitza, create a dedicated user account in GitHub. The user account that you create must have create, read, update, and delete privileges.

Add credentials to the vault in Oomnitza

To authorize connections between Oomnitza and GitHub, complete these steps:

1. Log into Oomnitza.
2. Click Settings > Credentials, and then click Add new credential (+).
3. Add the information details.
4. Click the AUTHORIZATION tab.
5. For the authorization type, select OAuth 2.0.
6. From the SaaS list, select GitHub.GitHub OAuth 2.0.
7. Enter the Client ID, Client Secret, and Scope.
8. Click Authenticate and log into GitHub to authorize the request.
9. Enter a Description to help you identify the credential (optional).
10. Click CREATE. 

You use the credentials that you added to create and customize your GitHub integration with Oomnitza.

Creating the user integration

Info and connect details

1. From the menu, click Settings.
2. Click Integrations List View .
3. On the Integrations page, scroll down to the Extended section for User Integrations.
4. Click NEW INTEGRATION.
5. In the New User Integration sidebar, click GitHub.
6. Click APPLY next to the GitHub User Load, and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

On the connect page, complete the following steps to connect the integration:

1. Enter a descriptive name for the integration such as GitHub User Load. This name will be displayed on the Integrations page once the setup is complete.
2. From the User Selection list, select User plus SaaS User.
3. From the Installation type list, select Cloud.
4. From the Credentials list, select your credentials.
5. From the Integration Preferences list, select Update only.   
6. Enter the name of the user of the integration.
7. Enter the GitHub Organisation ID.
8. Click Next.

Mappings

Map the GitHub fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

1. Create custom mappings to map any other field that you want to add to Oomnitza:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field.
   4. Click CREATE. 
2. Assign a sync key.
3. Click NEXT. 

Note: For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard GitHub to Oomnitza mappings

The following GitHub fields can be mapped to Oomnitza:

Id
Name
User type
Email
Login Name
Location
Site Admin
Connector Sync Time

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the GitHub to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

1. Configure your schedule.
2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings. 

Creating user workflows

Creating a workflow using the GitHub Member Role preset

You can create a Saas User workflow in Oomnitza using the GitHub Member Role preset. As GitHub does not currently provide the Last Login date/time, the GitHub Member Role preset can be used to provide you with confirmation of users that are actively using GitHub in your environment. All users that are confirmed as being part of your GitHub integration will appear as a User in the Role column of the SaaS Users UI.

To create a Saas User workflow using the GitHub Member Role preset, complete the following steps:

1. Click Software from the menu.
2. Select Saas Users from the Workflow dropdown list.
3. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
4. Enter the name and a description of the workflow. 
5. Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
6. Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
7. Click the Edit icon.
8. Enter GitHub in the search field and choose the GitHub Member Role preset.
9. Click the right arrow >.
10. Enter your Credentials.
11. Enter the GitHub Organisation ID.
12. Select the Deactivate User checkbox to deactivate the SaaS user in the Oomnitza system if they are not found in your GitHub instance.
13. Click SAVE.
14. Connect the blocks.
15. Validate, launch, and save your workflow.

To view active GitHub users in the SaaS Users UI, complete the following steps:

1. Click Software from the menu.
2. Select the Saas tab, and select your software entry for GitHub.
3. In the GitHub window, select the Users tab.
4. The Role column will be populated with the name User to confirm that this user has been found in your GitHub SaaS.

Creating a workflow using the GitHub Remove Member from Org preset

You can create a Saas User workflow in Oomnitza using the GitHub Remove Member from Org preset. This preset automatically removes a GitHub user account from your GitHub SaaS that was initially deactivated in Oomnitza. 

To create a Saas User workflow using the GitHub Remove Member from Org preset, complete the following steps:

1. Click Software from the menu.
2. Select Saas Users from the Workflow dropdown list.
3. Click Add (+). The Begin and End blocks are automatically added to the sandbox.
4. Enter the name and a description of the workflow. 
5. Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
6. Click the Blocks tab, and drag and drop the API block onto the canvas.
7. Click the Edit icon.
8. Enter GitHub in the search field and choose the GitHub Remove Member from Org preset.
9. Click the right arrow >.
10. Enter your Credentials.
11. Enter the GitHub OrgID (Organization Id).
12. Click SAVE.
13. Connect the blocks.
14. Validate, launch, and save your workflow.

Further information
Understanding workflows
 Workflow block overview

GitHub User Role

Coming soon

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

• Configure dashboards for your users and software
• Configure custom reports about your users and software
• Create workflows to automate tasks

See  Getting started