Creating an extended integration for Puppet users

Connect Oomnitza and Puppet 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 user workflows that you can easily create for deactivating users

Navigation

Creating the user integration

Creating custom mappings

Creating user workflows

Before you start

Before you can create the user integration with Oomnitza, you will need the following:

Your Puppet API key

Puppet Token-based authentication

Your Puppet fully-qualified domain name, or FQDN

For example, if your URL is https://example.server.region.companyname.network:1234/path/to/resource, ensure that you:

• Ignore the leading https://.
• Enter only the domain and subdomain. 
• Disregard the paths or port numbers after the domain.

This means you only need to include example.server.region.companyname.network

Note
Integrations do not support self-signed certificates. Ensure that your domain has a valid certificate issued by a recognized certificate authority, otherwise you will encounter errors when running the integration.

Integration errors

Your Puppet Port

Your Puppet Port, such as 8081.

Tip
Add the FQDN and Port numbers as global variables. It’ll save you time when you create workflows. See Adding global settings. Add two new global settings called Puppet.Api Domain and Puppet.Api Port as keys and enter your actual FQDN and port as values.

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. 

Creating custom mappings

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

1. Click SMART MAPPING. The Connector Sync Time and the Email fields are automatically mapped to Oomnitza.
2. Click the down arrow on the Email field and map it to the Oomnitza Email and Username fields. Then, select Username as the sync key.
3. Select Employee from the Role field.

To map the other Puppet fields to Oomnitza, complete these steps:

1. Click the down arrow on the Puppet field and select Add Oomnitza user field.
2. Change the name of the field.
3. Click CREATE. 

Standard Puppet to Oomnitza mappings

The following Puppet fields can be mapped to Oomnitza: 

Connector Sync Time
Display Name
Email
Group Ids List
Id
Inherited Role Ids List
Is Group
Is Remote
Is Revoked
Is Superuser
Last Login
Login
Role Ids List

Ensure that you select one of the fields as the Sync Key such as the email address of the user. 

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

Use presets to create user workflows

To reduce costs by automating repetitive and complex tasks, take advantage of the built-in presets that Oomnitza provides.

To choose a preset, complete these steps:  

1. Click Configuration > Workflows 
2. Click Add (+) and select Users from the list.
3. Drag and drop the API block onto the Sandbox.
4. Click Edit on the API block and enter Puppet in the search field. 
5. Select the Delete User preset.
6. Click >, configure the API Block, and save your changes.
7. To trigger the workflow, edit the Begin Block.
8. Connect the Blocks. 
9. Save, validate, and activate your workflow.

Reference articles for workflows

• Mapping positive and negative responses
• Troubleshooting workflows 
• Using the API block