Cyware Security Orchestration Layer (CSOL)
App Vendor: Cyware
App Category: Cyware Product
Connector Version: 1.0.1
API Version: 1.0.0
About App
Orchestrate is a security orchestration platform that allows organizations to integrate security practitioners, diverse processes, and technologies into a single platform. The Orchestrate app enables security teams to integrate with the Orchestrate enterprise application to execute on-demand or event-triggered tasks across deployment environments at machine speeds.
The Orchestrate app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Create Event | The action creates an event. |
Execute App Action | This action executes an app action. |
Get App Action ID | This action retrieves an app action ID. |
Get App Actions | This action retrieves a list of app actions. |
Get App Instances | This action retrieves a list of app instances. |
Get Apps | This action retrieves a list of all apps. |
Get Individual App Details | This action retrieves the details of an app. |
Get Individual App Instances | This action retrieves the instances of an app. |
Get Playbook Result | This action retrieves the results of all the playbooks. |
Get a Single Playbook Result | This action retrieves a results of a playbook. |
Trigger Playbook | This action triggers a playbook. |
Configuration Parameters
The following configuration parameters are required for the Orchestrate app to communicate with the Orchestrate enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL. Example: "https://test.com:cimms.com/openapi". | Text | Required | |
Access ID | Enter the access ID. | Password | Required | |
Secret Key | Enter the secret key. | Password | Required |
Action: Create Event
The action creates an event.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Title | Enter the title. | Text | Required | |
App identifier | Enter the app identifier. | Text | Required | |
Action identifier | Enter the action identifier. | Text | Required | |
Data | Enter the data of the event. | Any | Optional |
Action: Execute App Action
This action executes an app action.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
App name | Enter the app name. | Text | Required | |
Action name | Enter the action name. | Text | Required | |
Instance Slug | Enter the instance slug. | Text | Required | |
Data | Enter the data of the action. | Text | Optional |
Action: Get App Action ID
This action retrieves an app action ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Action ID | Enter the app action ID. | Text | Required |
Action: Get App Actions
This action retrieves the actions of an app.
Action Input Parameters
This action does not require any input parameter.
Action: Get App Instances
This action retrieves the instances of an app.
Action Input Parameters
This action does not require any input parameter.
Action: Get Apps
This action retrieves a list of all apps.
Action Input Parameters
This action does not require any input parameter.
Action: Get Individual App Details
This action retrieves the details of an app.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
App ID | Enter the app ID. | Text | Required |
Action: Get Individual App Instances
This action retrieves the instances of an app.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Instance ID | Enter the instance ID. | Text | Required |
Action: Get Playbook Result
This action retrieves the results of all the playbooks.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Start Date | Enter start date and time. Example: "01/07/2021 00:00:00" | Text | Optional | Default value: none |
End Date | Enter end date and time. Example: "01/07/2021 00:00:00" | Text | Optional | Default value: none |
Page | Enter page number. | Integer | Optional | Default value: 1 |
Page Size | Enter page size. | Integer | Optional | Default value: 10 |
Source Playbook Result is Null | Select true or false for source playbook result is null. Example: true | Boolean | Optional | Allowed values:
Default value: true |
Action: Get a Single Playbook Result
This action retrieves the results of a playbook.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Playbook Runlog ID | Enter the playbook runlog ID. | Text | Required |
Action: Trigger Playbook
This action triggers a playbook.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Playbook ID | Enter the playbook ID. | Text | Required |