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

Let Oomnitza be your single source of truth!

The GitHub User Load uses the List organization members API, which lists all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. For further information, see GitHub Docs: List organization members. 

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

Create the user integration

Mappings

Before you start

Before you can create the integration with Oomnitza, you need to have added your GitHub credentials to Oomnitza.

You will also need to have added your GitHub organization name as a global variable. For further information, see Setting your GitHub Organization name as a global variable.

Creating the user integration

1. In Oomnitza, click Configuration > Integrations > Overview.
2. Click Block view .
3. On the Integrations page, scroll down to the Extended section for user integrations.
4. Click NEW INTEGRATION.
5. In the sidebar, search for the integration.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

• User only. Add user records.
• User plus SaaS user. Add user and SaaS user records. 

The benefit of adding SaaS user records is that you can run a workflow to validate the status and activity of SaaS users and retrieve information such as the role of the SaaS user. The information that can be retrieved depends on whether SaaS user workflows are available for the integration. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Editing the integration details

1. Click Edit .
2. Make your changes.

Editing the credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Selecting Edit integration to add rules for syncing data. Filtering integration results.  
 

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Mappings

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

Complete these actions:

1. Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
2. 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. 
3. Ensure that the Email is mapped to the Email field on the Oomnitza side (required for integration).
4. Ensure that the Email is mapped to the Username field on the Oomnitza side (required for integration).
5. Select the Role field on the Oomnitza mapping side.
6. Choose a suitable role from the list (a defined role is necessary for the integration)
7. Assign a sync key to a unique field, such as the Email.
8. Click UPDATE.

Warning
The Email value will be null or empty if the user does not have their email specified in their public profile. If the email value is null or empty and you have mapped it to an Oomnitza field, you will receive the following error message after you run the integration: Field email is not filled in. In this scenario, we recommend mapping the Login Name instead. 

Tracking information for user loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:   

• Connect: Credentials
• Connect: Organization Name

Standard GitHub to Oomnitza User Load mappings

Email
Id
Location
Login Name
Name
Site Admin?
User type

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

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 for more information.

Next steps

Now that you have created the extended integration, create workflows for GitHub users.