Skip to main content

Adaptive Shield

Adaptive Shield is an identity management tool that helps remediate SaaS configuration issues. You can bring alert, integrated user, integration, and security check data from Adaptive Shield into Brinqa to construct a unified view of your attack surface, thus strengthening your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Adaptive Shield and how to obtain that information from Adaptive Shield. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select Adaptive Shield from the Connector drop-down. If you cannot find the connector in the drop-down, make sure you have installed it first. You must provide the following information to authenticate Adaptive Shield with Brinqa:

  • API URL: The Adaptive Shield API URL. The API URL depends on the region where your Adaptive Shield environment is deployed:

    • US: https://api.adaptive-shield.com

    • EU: https://eu.api.adaptive-shield.com

  • Access token: The API key associated with the Adaptive Shield account, which must have permissions to log in to the API server and return data.

    The API key inherits the scope and permissions of the associated Adaptive Shield user account, meaning it can only retrieve data that the user account can view in the Adaptive Shield UI.

Generate an Adaptive Shield API key

For the Adaptive Shield connector to retrieve data from the Adaptive Shield API, you must provide an API key. To do so, follow these steps:

  1. Log in to your organization's Adaptive Shield portal as an administrator.

  2. Navigate to your user profile and click User Settings

  3. Click the API tab and then click Generate new key.

    Generate new Adaptive Shield API key)

  4. Provide a Name for the key, and then click Create.

    Your new API key displays. You can not view the key again after this. Copy and save it to a secure location.

note

If you do not have permissions to generate an API key, contact your Adaptive Shield administrator. For additional information, see Adaptive Shield documentation.

Additional settings

The Adaptive Shield connector contains additional options for specific configuration:

  • Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.

  • Parallel requests: The maximum number of parallel API requests. The default setting is 4.

Types of data to retrieve

The Adaptive Shield connector can retrieve the following types of data from the Adaptive Shield API:

Table 1: Data retrieved from Adaptive Shield

Connector ObjectRequiredMaps to Data Model
AlertYesAlert,
Alert Definition
Integrated UserYesPerson
IntegrationYesCloud Resource
Security CheckYesViolation,
Violation Definition
info

The Adaptive Shield connector does not support operation options for the types of data it retrieves.

For detailed steps on how to view the data retrieved from Adaptive Shield in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

Alert

Table 2: Alert attribute mappings

Source Field NameMaps to Attribute
account_idLocal variable
affected_diffLocal variable
alert_typecategory
descriptiondescription
iduid
integration.aliasLocal variable
integration.idtargets
integration.nameLocal variable
is_archivedLocal variable
new_affected_countLocal variable
security_check_api_linkLocal variable
sourceLocal variable
source_idtype, uid
timestampsourceCreatedDate
user_who_archivedLocal variable
Integrated User

Table 3: Integrated User attribute mappings

Source Field NameMaps to Attribute
account_idLocal variable
companyLocal variable
countryLocal variable
departmentLocal variable
domainLocal variable
emailemails
enabledLocal variable
exposuresLocal variable
exposures_totalLocal variable
full_namename
integrationsLocal variable
integrations_totalLocal variable
login_namesLocal variable
rolesLocal variable
titledescription
user_item_identityuid
Integration

Table 4: Integration attribute mappings

Source Field NameMaps to Attribute
account_idLocal variable
aliasLocal variable
created_timesourceCreatedDate
enabledLocal variable
iduid
integration_statusstatus
issuesLocal variable
last_runlastScanned
saas_idLocal variable
saas_nameLocal variable
Security Check

Table 5: Security Check attribute mappings

Source Field NameMaps to Attribute
account_idLocal variable
affectedLocal variable
base_check_idLocal variable
created_byLocal variable
creation_datesourceCreatedDate
detailsdescription
dismiss_expiration_dateLocal variable
dismiss_reasonLocal variable
iduid
impactseverity, sourceSeverity, severityScore
integration_idtargets
is_globalLocal variable
namename
remediation_planrecommendation
saas_nameLocal variable
security_check_typecategory
security_domaintype, uid
statusstatus, sourceStatus, statusCategory
status_last_changed_datesourceLastModified
status_reasonLocal variable
user_who_dismissedLocal variable
info

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

APIs

The Adaptive Shield connector uses the Adaptive Shield API v1. Specifically, it uses the following endpoints:

Table 6: Adaptive Shield API Endpoints

Connector ObjectAPI Endpoint
AlertGET /api/v1/accounts
GET /api/v1/accounts/{accountId}/alerts
Integrated UserGET /api/v1/accounts
GET /api/v1/accounts/accountId}/user_inventory
IntegrationGET /api/v1/accounts
GET /api/v1/accounts/{accountId}/integrations
Security CheckGET /api/v1/accounts
GET /api/v1/accounts/{accountId}/security_checks
GET /api/v1/accounts/{accountId}/security_checks/{securityCheckId}/affected

Changelog

The Adaptive Shield connector has undergone the following changes:

Table 7: Adaptive Shield connector changelog

VersionDescription
3.0.0Initial Integration+ release.