Fortinet Document Library

Version:


Table of Contents

Know Thy Customer

1.0.0
Copy Link

About the connector

The KnowThyCustomer API allows you to search for details about People, Phone Numbers, Emails, and Properties.

This document provides information about the Know Thy Customer connector, which facilitates automated interactions with Know Thy Customer using FortiSOAR™ playbooks. Add the Know Thy Customer connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information about a person based on name and address and/or their phone number from Know Thy Customer or retrieving information about an email address from Know Thy Customer.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-knowthycustomer

For the detailed procedure to install a connector, click here.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Lookup Person Retrieves information about a person based on name and address and/or phone number that you have specified from Know Thy Customer. lookup_person
Investigation
Lookup Address Retrieves information about a street address that you have specified from Know Thy Customer. lookup_property
Investigation
Lookup Email Retrieves information about an email address that you have specified from Know Thy Customer. lookup_email
Investigation
Lookup Phone Number Retrieves information about a phone number that you have specified from Know Thy Customer. lookup_phone
Investigation

 

Included playbooks

The Sample - Know Thy Customer - 1.0.0 playbook collection comes bundled with the Know Thy Customer connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Know Thy Customer connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

The KnowThyCustomer API allows you to search for details about People, Phone Numbers, Emails, and Properties.

This document provides information about the Know Thy Customer connector, which facilitates automated interactions with Know Thy Customer using FortiSOAR™ playbooks. Add the Know Thy Customer connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information about a person based on name and address and/or their phone number from Know Thy Customer or retrieving information about an email address from Know Thy Customer.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-knowthycustomer

For the detailed procedure to install a connector, click here.

 

Configuring the connector

For the procedure to configure a connector, click here.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Lookup Person Retrieves information about a person based on name and address and/or phone number that you have specified from Know Thy Customer. lookup_person
Investigation
Lookup Address Retrieves information about a street address that you have specified from Know Thy Customer. lookup_property
Investigation
Lookup Email Retrieves information about an email address that you have specified from Know Thy Customer. lookup_email
Investigation
Lookup Phone Number Retrieves information about a phone number that you have specified from Know Thy Customer. lookup_phone
Investigation

 

Included playbooks

The Sample - Know Thy Customer - 1.0.0 playbook collection comes bundled with the Know Thy Customer connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Know Thy Customer connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.