Creating an extended integration for Brex users

Let Oomnitza be your single source of truth!

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

Connect Oomnitza and Brex 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 the details of an existing Brex user or inviting a new user to Brex
  • Creating a user card
  • Activating and deactivating Brex users
  • Locking and terminating a user card

Navigation

Adding the credentials

Creating the user integration

Creating custom mappings

Creating workflows

Creating user workflows with the API block

Brex Get User Details

Brex Invite User

Brex Activate User

Brex Deactivate User

Brex List User Cards

Brex Lock Card

Brex Terminate Card

Brex Create User Card

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

Brex uses API key authentication and requires an API key to be added in Oomnitza. To obtain your API key, sign in to your Brex dashboard and go to Developer>Settings>Create Token. Add your token name and set the role permissions to Read for Users and to Read/Write for Cards. Follow the prompts to generate and copy your API token. For further information, refer to the Brex API Documentation.

Important
User tokens will expire if they are not used to make an API call for 30 days. If your token is compromised, or you no longer need it, revoke the user token from the developer page in your Brex dashboard. Once revoked, any calls made with this token will immediately begin to fail. For further information, refer to the Brex API Documentation.

Adding the credentials

To stream Brex 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. On the INFORMATION tab, complete these actions:
   1. Add the name of the credential.
   2. Add the name of the owner. 
2. Ensure that API Key is selected as the Authorization type.
3. Ensure that the Token Name is Authorization 
4. Enter Bearer followed by the API Key. For example,Bearer aefgd-adw3n-jknadd78l1kjndc.
5. Ensure that Add to Header is selected.
6. Save your changes.

Next

You use the credentials that you added to create and customize your Brex 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 Brex 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. Map the Brex Id to the Username field in Oomnitza (required for integration).
3. Map the Brex Id to a second field. This field will be a custom Oomnitza field named Brex User Id. To create the custom field: 
   1. Click the down arrow on the Id field.
   2. Select Add new Oomnitza users field.
   3. Change the name of the field to Brex User Id.
   4. Select the Unique checkbox.
   5. Click CREATE. 
4. Ensure that the Email is mapped to the Email field on the Oomnitza side (required for integration).
5. Assign a sync key to a unique field, such as the Email.
6. Select the Role field on the Oomnitza mapping side.
7. Choose a suitable role from the list (a defined role is necessary for the integration)
8. Click UPDATE.

Standard Brex to Oomnitza mappings

The following Brex fields can be mapped to Oomnitza:

Connector Sync Time
Email
First Name
Id
Last Name

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. Edit an API block, then search and select a preset from the list below: 

Brex Get User Details
Brex Invite User
Brex Activate User
Brex Deactivate User
Brex List User Cards
Brex Lock Card
Brex Terminate Card
Brex Create User Card

When you select a Brex preset, you must ensure that you supply your Brex Credentials that you created in Adding the credentials.

Using the Brex Get User Details preset

The Brex Get User preset shows the details of a user, by ID. When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Brex user id is assumed to be stored in the variable{{brex_user_id}} that you created in Creating custom mappings. If this is not correct, you can replace the variable {{brex_user_id}}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. Once you have the entire response, you should then map individual JSON values to custom fields, as per the example below.
   

For further information, and for an overview of the values returned in the Get User Details response, refer to the Brex API documentation: Get user.

Using the Brex Invite User preset

The Brex Invite User preset invites a new user as an employee.

Tip
You can configure the Begin block to invite all new Oomnitza users to Brex. For information on creating schedules, refer to Using the Begin block.

When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. In the Body tab, you can modify, update or add fields that will be used in the request payload. In the example below, the department id and location id of the new user is also added to the message body. For information on the fields that are permitted in the request payload, refer to the Brex API documentation: Invite user.
   
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. Once you have the entire response, you should then map individual JSON values to custom fields.
   

Refer to the Brex API documentation: Invite user for further information.

Using the Brex Activate User preset

The Brex Activate User preset activates a user.

Tip
You can use the Brex Activate or Deactivate User preset in conjunction with the Brex Get User Details preset.   For example, you could run the Activate Brex User preset to activate an account that was found active after running the Brex Get User Details preset.

When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Brex user id is assumed to be stored in the variable{{brex_user_id}}.
3. The Body tab contains the new user status.
4. 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. Once you have the entire response, you should then map individual JSON values to custom fields.
   

For further information on the request payload refer to the Brex API documentation: Update user.

Using the Brex Deactivate User preset

The Brex Deactivate User preset deactivates a user. Use the Advanced Mode to configure the message payload by following the steps in Using the Brex Activate User preset. For further information on the request payload refer to the Brex API documentation: Update user.

Using the Brex List User Cards preset

The Brex List User Card preset lists the cards associated with a user, by ID. When working with this preset, use the Advanced Mode to configure the message payload. 

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Information tab. The Brex user id is assumed to be stored in the variable{{brex_user_id}} that you created in Creating custom mappings. If this is not correct, you can replace the variable {{brex_user_id}}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}}or {{response['items']}}in the Response field and mapping it to a custom long text Oomnitza field, such as API Response. Once you have the entire response, you should then map individual JSON values to custom fields, as per the example below.
   
   

For further information on the request payload refer to the Brex API documentation: List cards.

Using the Brex Lock Card preset

The Brex Lock Card preset locks an unlocked card and notifies the card owner of this action.  When you select this preset you need to first supply your Card Id. You can enter the information manually, or map it from existing Oomnitza fields. If you are mapping the user information from an existing field you need to place the field name between curly braces, similar to the example below:

Tip
You can use the Brex List User Cards preset to first get the {{brex_user_card_id}} required for the Lock Card and Terminate Card preset.

In addition to the Card Id, the reason for locking the card is a mandatory parameter and must be updated in the message payload.

1. Click the Advanced Mode button located in the upper right of the window.
2. In Body tab, supply the reason for the card termination. Possible values include: CARD_DAMAGED CARD_LOST CARD_NOT_RECEIVED DO_NOT_NEED_PHYSICAL_CARD DO_NOT_NEED_VIRTUAL_CARD RAUD OTHER.
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. Once you have the entire response, you should then map individual JSON values to custom fields.
   

For further information on the request payload refer to the Brex API documentation: Lock card. 

Using the Brex Terminate Card preset

The Brex Terminate Card preset terminates a card and notifies the card owner of this action. The card id and the reason for locking the card are mandatory parameters and can be added in the by following the steps in Using the Brex Lock Card preset. For further information on the request payload refer to the Brex API documentation: Terminate card. 

Using the Brex Create User Card preset

The Brex Create User Card preset creates a new user card. The card owner information, the card name, card type, and limit type are mandatory parameters and can be added in the message payload.

1. Click the Advanced Mode button located in the upper right of the window.
2. Select the Headers tab. The Brex card id is stored in the variable{{brex_user_card_id}}as an idempotency-key. The idempotency-key needs to be a unique string to protect against accidental duplicate calls. You can use the unique value supplied in the {{brex_user_card_id}}, or replace it with another unique value.
3. In Body tab, you need to supply the owner{} card_name, card_type, and limit_type.You can also enter additional information, as detailed in the request sample below.
4. 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. Once you have the entire response, you should then map individual JSON values to custom fields.

Request Sample

Request Body Schema

{
  "owner": {
    "type": "USER",
    "user_id": "string"
  },
  "card_name": "string",
  "card_type": "VIRTUAL",
  "limit_type": "CARD",
  "spend_controls": {
    "spend_limit": {
      "amount": 0,
      "currency": "string"
    },
    "spend_duration": "MONTHLY",
    "reason": "string",
    "lock_after_date": "2019-08-24"
  },
  "mailing_address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postal_code": "string",
    "phone_number": "string"
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}

owner (required):Set the type to USER and specify the User Id

card_name (required):Enter a card name.

card_type (required):Can be either VIRTUAL or PHYSICAL

limit_type (required):Use CARDfor vendor cards. Vendor cards must have a card type of VIRTUAL and do not rely on the user specific limit. For corporate cards, set the limit_type to USER. For further information refer to the Brex documentation.

speed_controls (required or null):.When the limit_type equals CARD, spend controls must be set. When the limit_type equals USER, spend controls must be null.

mailing_address: Address must be in the US; no PO box or virtual/forwarding addresses permitted.

metadata: Do not store any personally identifiable or sensitive information here. Limitations: You can only specify a maximum of 50 keys. These keys cannot exceed 40 characters. Metadata values cannot exceed 500 characters.

Tip
You can enter the card information manually, or map it from existing Oomnitza fields. If you are mapping the user information from an existing field you need to place the field name between curly braces, for example {{last_name}}.

For further information on the request payload refer to the Brex API documentation: Create card.

Reference articles for workflows

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

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your users, 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.