SANS Phishing
App Vendor: SANS Phishing
App Category: Data Enrichment & Threat Intelligence
Connector Version: 1.0.0
API Version: 2.0.0
About App
SANS Phishing is designed to allow developers to build their own applications using the tools sans phishing offers. Using the SANS phishing API, you can generate reports, create groups, targets, and campaigns, and get enrollment information, among many other features.
The SANS Phishing app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Create Campaign | This action creates a campaign. |
Create Enrollment | This action creates an enrollment. |
Delete Account | This action deletes an account. |
Delete Campaign | This action deletes a campaign. |
Fetch Account Details | This action retrieves the details of an account. |
Fetch All Accounts | This action lists the accounts present in the SANS Phishing application. |
Fetch All Campaigns | This action lists the campaigns present in the SANS Phishing account. |
Fetch All Course Enrollments | This action lists the course enrollments. |
Fetch All Courses | This action lists the courses present in the SANS Phishing account. |
Fetch All Enrollments | This action lists the enrollments for an account in the SANS Phishing application. |
Fetch All Groups | This action lists the groups present in the SANS Phishing account. |
Fetch All Phishing Domains | This action lists the phishing domains present in the SANS Phishing account. |
Fetch Groups Targets | This action lists the targets of a group present in the SANS Phishing account. |
Generic Action | This is a generic action to perform any additional action on the SANS Phishing application. |
Get Campaign Details | This action retrieves the details of a campaign in the SANS Phishing account. |
Get Course Details | This action retrieves the details of a course. |
Get Course Enrollment for Student | This action retrieves the course enrollment for a student. |
Get Enrollment Details | This action retrieves the details of enrollment. |
Get Enrollments for Course | This action lists the enrollments for a course. |
Get Group Details | This action retrieves the details of a group. |
Get Group Report | This action retrieves the report of a group. |
Get Phishing Domain Details | This action retrieves the details of a phishing domain. |
Get Report Group Targets | This action retrieves the reports on targets for a group. |
Get Test Action Report Details | This action retrieves the details of a phishing test actions report. |
Get Test Report Details | This action retrieves the details of a phishing test report. |
Configuration Parameters
The following configuration parameters are required for the SANS Phishing app to communicate with the SANS Phishing enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the SANS Phishing base URL to connect to. | Text | Required | |
API Token | Enter the SANS Phishing API token to authenticate to the SANS Phishing API. | Password | Required | |
Verify SSL | Enter true to verify the SSL certificate. | Boolean | Required | Default value: false Allowed values:
|
Action: Create Campaign
This action creates a campaign.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Campaign Name | Enter the name of the campaign to create. | Text | Required | |
Campaign Start Date | Enter the start date and time of the campaign. Example: "2021-09-01 08:00:00" | Text | Required | |
Campaign Groups IDs | Enter a list of group UUIDs to be included in the campaign. | List | Required | |
Phishing Templates IDs | Enter a list of phishing template UUIDs to be included in the campaign. | List | Required | |
Auto Enroll On Fail | Choose to enroll the targets in a training course on failure. | Boolean | Optional | Default value: false Allowed values:
|
Notify Email | Enter the email of the admin to receive email updates. | Text | Optional | |
Notify PF | Choose to notify targets at the end of the campaign of failure or success. | Boolean | Optional | |
Extra Params | Enter the extra parameters. | Key Value | Optional | Allowed keys:
|
Action: Create Enrollment
This action creates an enrollment.
Important
Ensure that your account has permission to create enrollments.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Training ID | Enter the UUID of the course or program to enroll the group or target. | Text | Required | |
Group or Target ID | Enter the training ID of the group or target to enroll in a training. | Text | Required | |
Suppress Account Notification | Choose to suppress notification. when set to true, any new student will not receive a new account notification | Boolean | Required | |
Suppress Enroll Notification | Choose to email the candidate on enrollment. | Boolean | Required | Allowed values:
When set to true, students will not receive a new enrollment notification. |
Suppress Duplicates | Enter true to suppress duplicates. | Text | Required | Allowed values:
|
Suppress Start | Enter the beginning enrollment creation date to suppress duplicates. | Text | Required | This is used with the suppress_duplicates parameter set to "date_range". |
Suppress End | Enter the ending enrollment creation date to suppress duplicates. | Text | Required | This is used with the suppress_duplicates parameter set to "date_range". |
Extra Params | Enter the extra parameters. | Key Value | Optional | Allowed keys:
|
Action: Delete Account
This action deletes an account.
Important
Ensure that your account has permission to delete subaccounts.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account ID | Enter the ID of the account to delete. | Text | Required |
Action: Delete Campaign
This action deletes a campaign.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Campaign ID | Enter the ID of the campaign to delete. | Text | Required |
Action: Fetch Account Details
This action retrieves the details of an account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account ID | Enter the ID of the account to retrieve details. | Text | Optional | If no account ID is passed, then it returns your account information. |
Action: Fetch All Accounts
This action lists the accounts present in the SANS Phishing application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Fetch All Campaigns
This action lists the campaigns present in the SANS Phishing account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the enrollment ID. | Text | Optional | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Fetch All Course Enrollments
This action lists the course enrollment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollments ID | Enter the UUID of the account to list course enrollments. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Fetch All Courses
This action lists the courses present in the SANS Phishing account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the enrollment UUID of the account. | Text | Optional | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Fetch All Enrollments
This action lists the enrollments for an account in the SANS Phishing application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Account ID | Enter the UUID of the account to list the enrollments. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value:100 |
Offset | Enter the offset used for pagination. | Integer | Optional | Default value:0 |
Action: Fetch All Groups
This action lists the groups present in the SANS Phishing account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the group UUID of the account. | Text | Optional | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Fetch All Phishing Domains
This action lists the phishing domains present in the SANS Phishing account.
Action Input Parameters
This action does not require any action input parameter.
Action: Fetch Groups Targets
This action lists the targets of a group present in the SANS Phishing account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the UUID of the group to retrieve group targets. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Generic Action
This is a generic action to perform any additional action on the SANS Phishing application.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Endpoint | Enter the complete endpoint to perform an action. | Text | Required | |
HTTP method | Enter the HTTP endpoint method in uppercase. Example:
| Text | Required | |
Request Body | Enter the request body in JSON format. | Any | Optional | |
Query Params | Enter the query parameters. | Key Value | Optional |
Action: Get Campaign Details
This action retrieves the details of a campaign in the SANS Phishing account.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Campaign ID | Enter the ID of the campaign to retrieve its details. | Text | Required |
Action: Get Course Details
This action retrieves the details of a course.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Course ID | Enter the ID of the course to retrieve its details. | Text | Required | |
Account ID | Enter the UUID of an account. | Text | Optional |
Action: Get Course Enrollment for Student
This action retrieves the course enrollment for a student.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Student ID | Enter the UUID of the student. | Text | Required | |
Course ID | Enter the UUID of the course. | Text | Required |
Action: Get Enrollments for Course
This action lists the enrollments for a course.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Course ID | Enter the ID of the course to retrieve course enrollments. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Account ID | Enter the UUID of a subaccount. | Text | Optional |
Action: Get Group Details
This action retrieves the details of a group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the ID of the group to retrieve group details. | Text | Required |
Action: Get Group Report
This action retrieves the report of a group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter a group ID to retrieve the group report. | Text | Required |
Action: Get Phishing Domain Details
This action retrieves the details of a phishing domain.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the phishing domain to retrieve its details. | Text | Required |
Action: Get Report Group Targets
This action retrieves the reports on targets for a group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the UUID of the group to retrieve target reports. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | Default value: 100 |
Offset | Enter the offset value for pagination. | Integer | Optional | Default value: 0 |
Action: Get Test Action Report Details
This action retrieves the details of a phishing test actions report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Phishing Test ID | Enter the ID of the phishing test to retrieve the report. | Text | Required | |
Limit | Enter the number of records to retrieve. | Integer | Optional | |
Offset | Enter the offset value for pagination. | Integer | Optional | |
Date | Enter the date to select messages by a given date (yyyy-mm-dd). Example: "2002-01-01" | Text | Optional | |
Period | If a date is provided, select messages are sent in a given period by days (dd). | Integer | Optional | |
Filtered | Set this to true to return all the filtered actions. | Boolean | Optional | Allowed values:
|
Action: Get Test Report Details
This action retrieves the details of a phishing test report.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Phishing Test ID | Enter the ID of the phishing test to retrieve its report. | Text | Required |