Creating an extended integration for SendGrid users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and SendGrid 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 getting and deleting users

Navigation

Updating the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

SendGrid Delete Teammate

Creating Saas user workflows

SendGrid User Role preset

Before you start

To add credentials to the vault in Oomnitza and integrate SendGrid with Oomnitza, you need to have the following information to hand:

• Your SendGrid API key. For the integration with Oomnitza, we recommend that you create a dedicated user account.

For more information, see SendGrid API Documentation: Creating an API key.

Updating the credentials

To stream SendGrid user data into Oomnitza, complete the following steps:

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Add your API key.
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that API Key is selected as the Authorization type.
4. Ensure that the Token Name is Authorization 
5. Enter Bearer followed by a space and the API Key in the API Key field. For example,Bearer l35xxxxxxxxxxxxxxxxsae05.
6. Ensure that Add to Header is selected.
7. Click Create.

Next

You use the credentials that you added to create and customize your SendGrid integrations with Oomnitza.

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 SendGrid 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 a custom mapping for the SendGrid Username field. This is to prevent other connectors from overwriting this information Oomnitza. To to this, complete the following steps:
   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 to SendGrid Username.
   4. Select the Unique checkbox.
   5. Click CREATE. 
3. Ensure that the Email is mapped to the Email field on the Oomnitza side (required for integration).
4. Ensure that the Username 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.

Standard SendGrid to Oomnitza mappings

The following SendGrid fields can be mapped to Oomnitza:

Address
Connector Sync Time
Email
First Name
Is Admin
Last Name
Username
Address2 City
Company
Connect : Credentials
Country
Is Sso
Phone
State
User Type
Website
Zip

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

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Using the API block. When creating the user workflows with the API block for SendGrid, the following specific configuration is required:

• To locate the available presets, enter SendGrid in the Select Preset search field.
• In the Configure section, select the SendGrid credentials that you created in Update credentials. 

The SendGrid API block workflow comes with one available preset, the SendGrid Delete Teammate preset.

Using the SendGrid Delete Teammate preset

This SendGrid Delete Teammate preset allows you to delete a user from SendGrid. For this preset, only the parent user or an admin can delete another user. When constructing a workflow that uses this preset, you can use the Advanced Mode to configure the message payload. To do this, complete the following steps:

1. In the API block window, click the Advanced Mode button located in the upper right of the window.
2. In the Information tab, you will notice that the Rapid7 User ID is referenced in the field {{sendgrid_username}}that you created in Creating custom mappings.  If this is not correct, you can replace the variable {{sendgrid_username}} in the URL field with the correct variable or user id. 
3. Select the Response tab. You can map the entire response by placing {{response}} in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. For further information on how to map an API response, see Mapping positive and negative responses.

For further information see SendGrid - Delete Teammate.

Reference articles for workflows

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

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. When creating the SaaS User workflow for SendGrid, the following specific configuration is required:

• To locate the available presets, enter SendGrid in the Select Preset search field.

The SendGrid SaaS User workflow block comes with one available preset, the SendGrid User Role API.

SendGrid User Role preset

The SendGrid User Role preset enables you to read a user’s role from SendGrid. When you select this preset, enter the following details in the Configure section:

• Your SendGrid credentials that you created in Update credentials. 

For further information see SendGrid - Users API.

Reference articles for creating workflows

• Creating SaaS user workflows.
• Offboarding SaaS users.

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.