Skip to main content

Responses are generated using AI and may contain mistakes.

Context ManagementContext Management Administration Guide

Create a REST API Context Table

Before beginning this procedure, review the prerequisites. Make sure you have accessed the extracted data schema in the corresponding cloud collector for information about how to configure the source attributes you want to include.

To onboard a REST API context table:

  1. Log into the New-Scale Security Operations Platform with your registered credentials.

  2. Find the Security Management tab and click the Context Management tile.

  3. Navigate to the Context Library tab and click one of the REST API tiles. Options include the following:

    • REST API User – Creates a table with context information about users.

    • REST API Device – Creates a table with context information about network devices, such as computer or work stations.

    When you select one of the above tiles, a REST API Context Table panel opens.

  4. In the Configuration section, complete the Definition step by entering the following information:

    • Context Table Name – Enter a name for the new REST API context table you're creating.

    • REST API Collector – In the Data Source section, choose a data source for your new context table. The drop down menu displays a list of the REST API Context cloud collectors that are currently configured and running in the Exabeam Cloud Collectors ser

      Note

      The menu only provides REST API Context collectors that match the data type you selected for the new context table (User or Device).

      vice. In the list, select a collector from which your new context table will process user or device attribute data.

      If no REST API Context cloud collectors are listed, follow the steps in the Configure the REST API Context Cloud Collector in the Get Started with Collector Onboarding Guide.

  5. Click Next. The Review Attributes step opens and displays an empty Review Attribute Mapping table. This table is where you will enter source attributes, based on the extracted data schema from the collector, and map them to target attributes.

    The attribute mapping table includes the following columns:

    • icon-visible.png – Shows whether a specific attribute is visible as a column in the context table. Use the icon next to each attribute to toggle the display on or off.

    • Source Attribute – A column where you will add the attributes extracted from the source API endpoints that you want to map for the new context table.

    • Target Attribute – A column where you will select the target attributes you want to map to the source attributes, either available Exabeam common information model attributes or custom attributes.

    • icon-key.png – Indicates that an attribute is designated as the key attribute for the context table. The designated key and its mapping cannot be changed.

    • icon-lock.png – Indicates that an attribute and its mapping cannot be changed.

  6. In the Source Attributes column of the Review Attribute Mapping table, click Add New Attribute. A small Attribute Name dialog box opens.

  7. Enter the name of a source attribute that you want to include. Be sure to consult the extracted data schema to enter the the field with the appropriate JSON path syntax. See the syntax on the left below, configured for the JSON samples on the right.

    First level field – Use the field name alone. Example: lastUpdated

    JSON-schema.png

    Nested field – Use a dot (.) between JSON levels. Examples:

    • profile.email

    • credentials.provider.type

    Array field – Add $. before the name of the array field. Example: user_account.affected_systems.$.files_accessed

    JSON-schema-array.png
  8. After you enter the attribute, click the plus icon to the right to add the attribute to the Source Attributes column

  9. In the Target Attributes column, click Add Target Attribute. The Available Attributes drop down list is displayed. Do one of the following to map a target attribute to the source attribute you just added:

    • Select a default attribute (icon-default-attribute.png).

    • Select an existing custom attribute (icon-custom-attribute.png).

    • Click Add Custom Attribute and create a new target attribute to be mapped. A small Attribute Name dialog box opens. Enter a name for the new custom attribute and select a data type from the Type drop down list. Then click the plus icon (icon-add-attribute.png) to add the new attribute to the Target Attributes column with a custom icon (icon-custom-attribute.png).

  10. Repeat steps 6 through 9 to add all of the desired source attributes to the table and map them to appropriate target attributes.

  11. Click the key icon (icon-key.png) next to one of the attributes to select it as the primary key for the table. The completed mapping table should look similar to the example below.

    attribute-map-rest-api.png
  12. You can modify the mapping of any of the configured attributes, that is not a key or a locked attribute, in the following ways:

    • Hover over an attribute row where you want to change the mapping.

    • Click the delete icon (icon-delete.png) to remove the currently mapped target attribute.

    • Then click Add Target Attributes and do one of the following:

      • Search for and select an existing target attribute to map it as the target.

      • Click Add Custom Attribute and create a new target attribute to be mapped. A small Attribute Name dialog box opens. Enter a name for the new custom attribute and select a data type from the Type drop down list. Then click the plus icon (icon-add-attribute.png) to add the new attribute to the Target Attributes column with a custom icon (icon-custom-attribute.png).

  13. When you are satisfied with the attribute mapping, click Create to onboard the new REST API context table. A success message is displayed.

    Click Go to Overview to return to the Overview tab that lists all the context tables currently available. The new context table should appear in the list. When you open the table, it displays the user or device objects processed from the source cloud collector.