Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Pipl provides a way to get work and social contact information of people.

This document provides information about the Pipl connector, which facilitates automated interactions, with a Pipl server using FortiSOAR™ playbooks. Add the Pipl connector as a step in FortiSOAR™ playbooks and perform automated operations such as, retrieving details of a user, based on parameters you have specified.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

Pipl Version Tested on: 1.0

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-pipl

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

Prerequisites to configuring the connector

  • You must have the API Key of the Pipl server to which you will connect and perform the automated operations.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™ , on the Connectors page, select the Pipl connector and click Configure to configure the following parameters:

Parameter Description
API Key API Key of the Pipl server to which you will connect and perform the automated operations.

 

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
Get User Details Retrieves the work and social contact information of a user from Pipl, based on the input parameters you have specified. get_user
Investigation

 

operation: Get User Details

Input parameters

Note: You must specify at least one of the input parameters. If you do not specify any input parameter then this operation will return null.

Parameter Description
Username Username of the user whose details you want to retrieve from Pipl.
User ID ID of the user whose details you want to retrieve from Pipl.
First Name First name of the user whose details you want to retrieve from Pipl.
Middle Name Middle name of the user whose details you want to retrieve from Pipl.
Last Name Last name of the user whose details you want to retrieve from Pipl.
Raw Name Raw name of the user whose details you want to retrieve from Pipl.
Email ID Email ID of the user whose details you want to retrieve from Pipl.
Phone Number Phone number of the user whose details you want to retrieve from Pipl.
Country Country of the user whose details you want to retrieve from Pipl.
State State of the user whose details you want to retrieve from Pipl.
City City of the user whose details you want to retrieve from Pipl.
Raw Address Raw address of the user whose details you want to retrieve from Pipl.

Output

The JSON output contains the work and social contact information of a user based on the input parameters you have specified, retrieved from Pipl.

Output can be vary according to input. Following are some output schemas:

Example 1:

 

"output_schema": 
    {
        "query": {},
        "@persons_count":"",
        "@search_id":"",
        "@available_sources":"",
        "available_data": {},
        "possible_persons": [],
        "@http_status_code":"",
        "@visible_sources":""
    }

 

Example 2:

 

"output_schema": 
    {
    "query": {
      "names": [
        {
          "first": "",
          "display": "",
          "last": "",
          "middle": ""
        }
      ],
      "addresses": [
        {
          "country": "",
          "display": ""
        }
      ],
      "user_ids": [
        {
          "content": ""
        }
      ],
      "emails": [
        {
          "address_md5": "",
          "address": ""
        }
      ],
      "usernames": [
        {
          "content": ""
        }
      ]
    },
    "@http_status_code": "",
    "person": {
      "names": [
        {
          "first": "",
          "last": "",
          "display": ""
        }
      ],
      "urls": [
        {
          "@category": "",
          "@source_id": "",
          "@name": "",
          "url": "",
          "@domain": ""
        }
      ],
      "languages": [
        {
          "region": "",
          "language": "",
          "display": ""
        }
      ],
      "emails": [
        {
          "address_md5": "",
          "@type": "",
          "address": "",
          "@email_provider": ""
        }
      ],
      "phones": [
        {
          "display_international": "",
          "@type": "",
          "number": "",
          "country_code": "",
          "display": ""
        }
      ],
      "usernames": [
        {
          "content": ""
        }
      ],
      "addresses": [
        {
          "apartment": "",
          "@valid_since": "",
          "@type": "",
          "city": "",
          "state": "",
          "street": "",
          "display": "",
          "country": "",
          "house": ""
        }
      ],
      "educations": [
        {
          "school": "",
          "date_range": {
            "start": "",
            "end": ""
          },
          "degree": "",
          "display": ""
        }
      ],
      "user_ids": [
        {
          "content": ""
        }
      ],
      "@search_pointer": "",
      "jobs": [
        {
          "display": "",
          "date_range": {
            "start": "",
            "end": ""
          },
          "industry": "",
          "organization": "",
          "title": ""
        }
      ],
      "gender": {
        "content": ""
      },
      "ethnicities": [
        {
          "content": ""
        }
      ],
      "dob": {
        "date_range": {
          "start": "",
          "end": ""
        },
        "display": ""
      },
      "origin_countries": [
        {
          "country": ""
        }
      ],
      "images": [
        {
          "url": ""
        }
      ],
      "@id": "",
      "@match": "",
      "relationships": [
        {
          "names": [
            {
              "first": "",
              "last": "",
              "display": ""
            }
          ],
          "@subtype": "",
          "@type": "",
          "emails": [
            {
              "address_md5": "",
              "address": "",
              "@email_provider": ""
            }
          ]
        }
      ]
    },
    "@visible_sources": "",
    "@available_sources": "",
    "available_data": {
      "premium": {
        "names": "",
        "landline_phones": "",
        "languages": "",
        "emails": "",
        "phones": "",
        "usernames": "",
        "addresses": "",
        "educations": "",
        "dobs": "",
        "jobs": "",
        "ethnicities": "",
        "user_ids": "",
        "origin_countries": "",
        "images": "",
        "genders": "",
        "social_profiles": "",
        "relationships": ""
      }
    }

 

Following image displays a sample output:

Sample output of the Get User Details operation

Included playbooks

The Sample - Pipl - 1.0.0 playbook collection comes bundled with the Pipl 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 Pipl connector.

  • Get User Details

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

Pipl provides a way to get work and social contact information of people.

This document provides information about the Pipl connector, which facilitates automated interactions, with a Pipl server using FortiSOAR™ playbooks. Add the Pipl connector as a step in FortiSOAR™ playbooks and perform automated operations such as, retrieving details of a user, based on parameters you have specified.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.11.0-1161

Pipl Version Tested on: 1.0

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-pipl

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

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™ , on the Connectors page, select the Pipl connector and click Configure to configure the following parameters:

Parameter Description
API Key API Key of the Pipl server to which you will connect and perform the automated operations.

 

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
Get User Details Retrieves the work and social contact information of a user from Pipl, based on the input parameters you have specified. get_user
Investigation

 

operation: Get User Details

Input parameters

Note: You must specify at least one of the input parameters. If you do not specify any input parameter then this operation will return null.

Parameter Description
Username Username of the user whose details you want to retrieve from Pipl.
User ID ID of the user whose details you want to retrieve from Pipl.
First Name First name of the user whose details you want to retrieve from Pipl.
Middle Name Middle name of the user whose details you want to retrieve from Pipl.
Last Name Last name of the user whose details you want to retrieve from Pipl.
Raw Name Raw name of the user whose details you want to retrieve from Pipl.
Email ID Email ID of the user whose details you want to retrieve from Pipl.
Phone Number Phone number of the user whose details you want to retrieve from Pipl.
Country Country of the user whose details you want to retrieve from Pipl.
State State of the user whose details you want to retrieve from Pipl.
City City of the user whose details you want to retrieve from Pipl.
Raw Address Raw address of the user whose details you want to retrieve from Pipl.

Output

The JSON output contains the work and social contact information of a user based on the input parameters you have specified, retrieved from Pipl.

Output can be vary according to input. Following are some output schemas:

Example 1:

 

"output_schema": 
    {
        "query": {},
        "@persons_count":"",
        "@search_id":"",
        "@available_sources":"",
        "available_data": {},
        "possible_persons": [],
        "@http_status_code":"",
        "@visible_sources":""
    }

 

Example 2:

 

"output_schema": 
    {
    "query": {
      "names": [
        {
          "first": "",
          "display": "",
          "last": "",
          "middle": ""
        }
      ],
      "addresses": [
        {
          "country": "",
          "display": ""
        }
      ],
      "user_ids": [
        {
          "content": ""
        }
      ],
      "emails": [
        {
          "address_md5": "",
          "address": ""
        }
      ],
      "usernames": [
        {
          "content": ""
        }
      ]
    },
    "@http_status_code": "",
    "person": {
      "names": [
        {
          "first": "",
          "last": "",
          "display": ""
        }
      ],
      "urls": [
        {
          "@category": "",
          "@source_id": "",
          "@name": "",
          "url": "",
          "@domain": ""
        }
      ],
      "languages": [
        {
          "region": "",
          "language": "",
          "display": ""
        }
      ],
      "emails": [
        {
          "address_md5": "",
          "@type": "",
          "address": "",
          "@email_provider": ""
        }
      ],
      "phones": [
        {
          "display_international": "",
          "@type": "",
          "number": "",
          "country_code": "",
          "display": ""
        }
      ],
      "usernames": [
        {
          "content": ""
        }
      ],
      "addresses": [
        {
          "apartment": "",
          "@valid_since": "",
          "@type": "",
          "city": "",
          "state": "",
          "street": "",
          "display": "",
          "country": "",
          "house": ""
        }
      ],
      "educations": [
        {
          "school": "",
          "date_range": {
            "start": "",
            "end": ""
          },
          "degree": "",
          "display": ""
        }
      ],
      "user_ids": [
        {
          "content": ""
        }
      ],
      "@search_pointer": "",
      "jobs": [
        {
          "display": "",
          "date_range": {
            "start": "",
            "end": ""
          },
          "industry": "",
          "organization": "",
          "title": ""
        }
      ],
      "gender": {
        "content": ""
      },
      "ethnicities": [
        {
          "content": ""
        }
      ],
      "dob": {
        "date_range": {
          "start": "",
          "end": ""
        },
        "display": ""
      },
      "origin_countries": [
        {
          "country": ""
        }
      ],
      "images": [
        {
          "url": ""
        }
      ],
      "@id": "",
      "@match": "",
      "relationships": [
        {
          "names": [
            {
              "first": "",
              "last": "",
              "display": ""
            }
          ],
          "@subtype": "",
          "@type": "",
          "emails": [
            {
              "address_md5": "",
              "address": "",
              "@email_provider": ""
            }
          ]
        }
      ]
    },
    "@visible_sources": "",
    "@available_sources": "",
    "available_data": {
      "premium": {
        "names": "",
        "landline_phones": "",
        "languages": "",
        "emails": "",
        "phones": "",
        "usernames": "",
        "addresses": "",
        "educations": "",
        "dobs": "",
        "jobs": "",
        "ethnicities": "",
        "user_ids": "",
        "origin_countries": "",
        "images": "",
        "genders": "",
        "social_profiles": "",
        "relationships": ""
      }
    }

 

Following image displays a sample output:

Sample output of the Get User Details operation

Included playbooks

The Sample - Pipl - 1.0.0 playbook collection comes bundled with the Pipl 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 Pipl 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.