Creating your own API connectors in Security Posture Control
Summarize
Summary of Creating Your Own API Connectors in Security Posture Control
Creating your own API connectors within the Security Posture Control (SPC) application allows for seamless integration with security tools and the ability to import asset data tailored to your specific environment. This functionality helps in monitoring your security posture and identifying assets lacking critical security tools.
Show less
Key Features
- A user-friendly connector builder framework that guides you through the creation process.
- A centralized location to build and manage all SPC integrations for importing custom data into your CMDB.
- Monitoring capabilities for published API connectors via the SPC API Integrations tab in the Security Posture Control workspace.
Prerequisites
Before creating an API connector, ensure that you have the necessary service credentials and API documentation ready. The required applications and plugins must be downloaded and activated from the ServiceNow® Store, with admin roles assigned for installation and activation.
Required Applications and Plugins
The following applications and plugins are essential:
- Security Posture Control API Connectors (snspccxf v2.0.0)
- Security Posture Control (snsecspccore v7.0.1)
- Asset Security Posture Management (snseccaasm v5.5.1)
- Mitigation Controls Monitoring (snsecmitctrl v4.1.4)
- Integrations Commons for CMDB (sncmdbintutil v2.20.0)
Additionally, the IntegrationHub Action Template - Data Stream plugin (com.glide.hub.actiontype.datastream) is required.
Roles Required
Assign the snsecspccore.developer role for users who need to view and configure SPC API connectors. For advanced scripting capabilities, assign the snspccxf.admin role.
Create your own Security Posture Control (SPC) API connectors using the connector framework that is included with the application.
Overview for the connector builder framework
Benefits
Create your own SPC API connectors quickly to help you integrate with security tools and import asset data that is based on the unique requirements of your environment. Use imported data to help you monitor your overall security posture and identify assets that are missing key security tools.
The connector framework includes the following features.
- A step-by-step process to guide you through the connector builder.
- A single place to build and maintain all your SPC integrations to import custom data into your CMDB.
- After you publish them, monitor your API connectors on the SPC API Integrations tab in the Security Posture Control workspace.
The API connector builder
You use the Connector builder in the Security Posture Control workspace to create and publish your customized API connectors.
Prerequisites
Before you start creating your API connector, you might prefer to set up any credentials for the service (vendor) that you want to implement with and have their API documentation and credentials handy as you work through the Connector builder. See Enter metadata for more information.
Required applications and plugins
The following applications and plugins are required.
Role required: admin for download, installation, and activation of all applications and plugins.
| Application | Application ID and version |
|---|---|
| Security Posture Control API Connectors | sn_spc_cxf v2.0.0 |
| Security Posture Control | sn_sec_spc_core v7.0.1 |
| Asset Security Posture Management | sn_sec_caasm v5.5.1 |
| Mitigation Controls Monitoring | sn_sec_mit_ctrl v4.1.4 |
| Integrations Commons for CMDB | sn_cmdb_int_util v2.20.0 |
| Plugin | Plugin ID |
|---|---|
| IntergationHub Action Template - Data Stream | com.glide.hub.action_type.datastream |
Required roles
Role required: admin
Assign the sn_sec_spc_core.developer role to the users who you want to view and configure SPC API connectors with the Connector builder in the Security Posture Control workspace.
Assign the sn_spc_cxf.admin role if you want users to configure SPC API connectors with advance scripting with the Connector builder.
See Install the supported applications for Security Posture Control for information about assigning roles to Security Posture Control groups.