Lynx Risk Manager
App Vendor: Lynx Technology Partners
Connector Category: Data Loss and Prevention | Vulnerability Management
App Version in Orchestrate: 1.0.0
API Version: 1.0.0
About App
Lynx Risk Manager is an IT risk and compliance solution that allows security teams to improve the audit workflow and assess their IT risk posture against internal and external regulations. The Lynx Risk Manager app allows security teams to connect with the Lynx Risk Manager platform enabling them to efficiently manage and orchestrate the risk management process. Security teams can use the Lynx Risk manager connector to perform various actions to get an overview of subjects, risks, resources, and supporting data to effectively manage an organization's governance, risks, and compliance responsibilities.
The Lynx Risk Manager app is configured with the Orchestrate application to perform the following actions:
Action | Description |
|---|---|
Get Control References | This action retrieves all the references the control is linked to. |
Get Business Interest Types | This action retrieves the business interest types from Lynx Risk Manager. |
Get Risk Impacts | This action retrieves the risk impacts from Lynx Risk Manager. |
Get Score Types | This action retrieves the score types from Lynx Risk Manager. |
Get Supporting Data | This action retrieves the supported data from Lynx Risk Manager. |
List Resource Types | This action retrieves the resource types from Lynx Risk Manager. |
List Resource Types with Mapping to Indicators | This action retrieves the resource types with mapping indicator from Lynx Risk Manager. |
List Attributes | This action retrieves the attributes from Lynx Risk Manager. |
Update Subject | This action updates the subject. |
Create Subject | This action creates a subject. |
Add Subject Score To Assessment | This action adds a subject score to the assessment. |
Add Subject Group Score To Assessments | This action adds a subject group score to the assessments. |
Update Subject Group | This action updates a subject group. |
Create Subject Group | This action creates a subject group. |
Get Risk Remediation Tools | This action gets the remediation tools of a risk. |
Get Risk Subjects | This action retrieves subjects of a risk. |
Get Risk Treatment Controls | This action retrieves the treatment controls of a specific risk. |
Get Risk Business Interests | This action retrieves the risks of a business interest. |
Get Risk Summary | This action retrieves the summary of a risk. |
List Risks In Group | This action lists the risks in a particular group. |
List Risk Groups | This action lists the risk groups from Lynx Risk Manager. |
Configuration Parameters
The following configuration parameters are required for the Lynx Risk Manager app to communicate with the Lynx Risk Manager 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 of the Risk Manager instance. Example: "https://subdomain.lynxriskmanager.com/" | Text | Required | |
API Token | Enter the API token to authenticate with Lynx. Example: "XXXX972a2167c93df3372de34c2fb18bae5d319a" | Password | Required | |
API ID | Enter the API ID associated with the API key. Example: "6a3d5f6h" | Text | Required | |
Verify | Choose if you want to verify the SSL certificates. | Boolean | Optional | Allowed values:
Default value: No |
Action: Get Control References
This action retrieves all the references the control is linked to.
Action Input Parameters
This action does not require any input parameters.
Action: Get Business Interest Types
This action retrieves the business interest types from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: Get Risk Impacts
This action retrieves the risk impacts from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: Get Score Types
This action retrieves the score types from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: Get Supporting Data
This action retrieves the supported data from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: List Resource Types
This action retrieves the resource types from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: List Resource Types with Mapping to Indicators
This action retrieves the resource types with mapping indicator from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: List Attributes
This action retrieves the attributes from Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.
Action: Update Subject
This action updates the subject with the provided parameter details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Subject ID | Enter the subject ID to update. Example: "33e285ed-6f79-479e-8bdb-ce0c8ffc586b" | Text | Required | You can retrieve the subject ID using the Create Subject action. |
Name | Enter subject name. Example: "new subject-112" | Text | Required | |
Description | Enter the subject description. Example: "this is for sample" | Text | Required | |
Owner User ID | Enter the corresponding owner user ID. Example: "99fc20f9-7553-4f78-af0f-89cb012d0ad2" | Text | Required | |
Criticality | Enter the criticality of the subject to update. Example: "Medium" | Text | Required | Allowed values:
|
Resource Type ID | Enter the resource type ID. Example: "b3f49634-356b-49e9-8204-367acdcdcc84" | Text | Required | |
Subject Group ID | Enter the subject group ID. Example: "9ca02bd4-e1d1-481a-9eb1-f06ad65e565b" | Text | Required | You can retrieve the Subject Group ID using the Create Subject Group action. |
Calculate Criticality | Enter if to calculate criticality. Example: "True" | Boolean | Required | Allowed values:
|
Extra Params | Enter any extra parameters to update the subject. Example: externalId | Key Value | Optional | Allowed values:
|
Note:
You can also pass additional parameters such as Mitigating Control List, Attribute List and Business Interest List to update the subject.
Example Request
[
{
"name": "new subject-112",
"subject_id": "79fb39c2-0358-43d3-8672-78adf47fc6ab",
"criticality": "Medium",
"description": "this is for sample",
"extra_params": {},
"sub_group_id": "1a614749-f0d3-4bdf-8f50-57c82cd694a3",
"owner_user_id": "99fc20f9-7553-4f78-af0f-89cb012d0ad2",
"resource_type_id": "b3f49634-356b-49e9-8204-367acdcdcc84",
"calculate_criticality": false
}
]Action: Create Subject
This action creates a subject with the specified details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the subject name. Example: "new subject" | Text | Required | |
Description | Enter the subject description. Example: "test description" | Text | Required | |
Owner User ID | Enter the owner user ID. Example: 99fc20f9-7553-4f78-af0f-89cb012d0ad2 | Text | Required | |
Criticality | Enter the criticality of the subject. Example: "Low" | Text | Required | Allowed values:
|
Resource Type ID | Enter the resource type ID. Example: b3f49634-356b-49e9-8204-367acdcdcc84 | Text | Required | |
Subject Group ID | Enter the subject group ID. Example: 9ca02bd4-e1d1-481a-9eb1-f06ad65e565b. Eg: b3f49634-356b-49e9-8204-367acdcdcc84 | Text | Required | You can retrieve the Subject Group ID using the Create Subject Group action. |
Calculate Criticality | Choose if to calculate the criticality. Example: "True" | Boolean | Required | Allowed values:
|
Extra Params | Enter any extra params to add. Example: "externalId" | Key Value | Optional |
Note:
You can pass additional parameters such as Mitigating Control List, Attribute List, and Business Interest List to create a subject.
Example Request
[
{
"name": "new subject",
"criticality": "Low",
"description": "test description",
"sub_group_id": "1a614749-f0d3-4bdf-8f50-57c82cd694a3",
"owner_user_id": "99fc20f9-7553-4f78-af0f-89cb012d0ad2",
"resource_type_id": "b3f49634-356b-49e9-8204-367acdcdcc84",
"calculate_criticality": false
}
]Action: Add Subject Score To Assessment
This action adds a subject score to the assessment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Subject ID | Enter the subject ID to add the subject score. Example: "33e285ed-6f79-479e-8bdb-ce0c8ffc586b" | Text | Required | You can retrieve the subject ID using the Create Subject action. |
Assessment ID | Enter the assessment ID. Example: "1db2360b-4ab3-443d-8e7e-2375956fd4d0" | Text | Required |
Note:
You can pass additional parameters such as Non Compliant Only and Control Ref ID to add subject score to the assessment.
Example Request
[
{
"assessment_id": "53ee08a4-40f1-4305-ae64-2b402f657a0c",
"subject_group_id": "1a614749-f0d3-4bdf-8f50-57c82cd694a3",
"non_compliant_only": false
}
]Action: Add Subject Group Score To Assessments
This action adds a subject group score to the assessments.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Subject Group ID | Enter the subject group ID to add the subject group score to. Example: "9ca02bd4-e1d1-481a-9eb1-f06ad65e565b" | Text | Required | You can retrieve the Subject Group ID using the Create Subject Group action. |
Assessment ID | Enter the assessment ID. Example: "53ee08a4-40f1-4305-ae64-2b402f657a0c" | Text | Required |
Note:
You can pass additional parameters such as Non Compliant Only and Control Ref ID to add subject group score to the assessment.
Example Request
[
{
"subject_id": "33e285ed-6f79-479e-8bdb-ce0c8ffc586b",
"assessment_id": "1db2360b-4ab3-443d-8e7e-2375956fd4d0",
"non_compliant_only": false
}
]Action: Update Subject Group
This action updates a subject group with the specified details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the subject group ID to update. Example: "e7e89ff2-d0c1-46e9-bbaf-7c46a163d2bd" | Text | Required | You can retrieve the Group ID using the Create Subject Group action. |
Name | Enter the name of the subject group to update. | Text | Required | |
Description | Enter the description to update. | Text | Optional |
Note:
You can also pass additional parameters such as Parent ID and Attribute List to update the subject group.
Example Request
[
{
"name": "Subject Group - Tmp",
"group_id": "9ca02bd4-e1d1-481a-9eb1-f06ad65e565b",
"description": "This is a temp subject group"
}
]Action: Create Subject Group
This action creates a subject group with the specified details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the subject group to create. Example: "Subject Group - Tmp" | Text | Required | |
Description | Enter the description for the group. Example: "This is a temp subject group" | Text | Required | |
Parent ID | Enter the parent ID to link. Example: "oqq3q3-7c8d-982b-9017-134923vbk3" | Text | Optional |
Note:
You can also pass additional parameters such as Attribute List to create the subject group.
Example Request
[
{
"name": "Subject Group - Tmp",
"description": "This is a temp subject group"
}
]Action: Get Risk Remediation Tools
This action gets the remediation tools of a risk.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Risk ID | Enter the risk ID to retrieve the remediation tools of the associated risk. Example: "0c3abc93-7c8d-47cd-9017-112d3dc5b272" | Text | Required | You can retrieve the Risk ID using the List Risks in Group action. |
Example Request
[
{
"risk_id": "bff311cd-0889-4007-8cf5-2e0e38357482"
}
]Action: Get Risk Subjects
This action retrieves subjects of a risk.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Risk ID | Enter the risk ID to retrieve the associated subjects. Example: "0c3abc93-7c8d-47cd-9017-112d3dc5b272" | Text | Required | You can retrieve the Risk ID using the List Risks in Group action. |
Example Request
[
{
"risk_id": "bff311cd-0889-4007-8cf5-2e0e38357482"
}
]Action: Get Risk Treatment Controls
This action retrieves the treatment controls of a specific risk.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Risk ID | Enter the risk ID to retrieve the treatment controls associated with the risk. Example: "0c3abc93-7c8d-47cd-9017-112d3dc5b272" | Text | Required | You can retrieve the Risk ID using the List Risks in Group action. |
Example Request
[
{
"risk_id": "bff311cd-0889-4007-8cf5-2e0e38357482"
}
]Action: Get Risk Business Interests
This action retrieves the risks of a business interest.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Risk ID | Enter the risk ID to get the business interests of. Eg: 0c3abc93-7c8d-47cd-9017-112d3dc5b272 | Text | Required | You can retrieve the Risk ID using the List Risks in Group action. |
Example Request
[
{
"risk_id": "bff311cd-0889-4007-8cf5-2e0e38357482"
}
]Action: Get Risk Summary
This action retrieves the summary of a risk.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Risk ID | Enter the risk ID to retrieve the risk summary. Example: "0c3abc93-7c8d-47cd-9017-112d3dc5b272" | Text | Required | You can retrieve the Risk ID using the List Risks in Group action. |
Example Request
[
{
"risk_id": "bff311cd-0889-4007-8cf5-2e0e38357482"
}
]Action: List Risks in Group
This action list the risks in a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the group ID to list the associated risks. Example: "e7e89ff2-d0c1-46e9-bbaf-7c46a163d2bd" | Text | Required | You can retrieve the Group ID using the List Risk Groups action. |
Example Request
[
{
"group_id": "857525e6-3236-46d1-9ecb-b3660325afd5"
}
]Action: List Risk Groups
This action lists the risk groups from the Lynx Risk Manager.
Action Input Parameters
This action does not require any input parameters.