Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Duo provides secure, rapid transition to the cloud. Use Duo Beyond to protect your on-premises and hosted applications, while securing your mobile workforce and their chosen devices.

This document provides information about the Duo connector, which facilitates automated interactions, with a Duo server using FortiSOAR™ playbooks. Add the Duo connector as a step in FortiSOAR™ playbooks and perform automated operations, such as authenticating users, and retrieving the authorization status.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with Duo Version: 1.0 and later

 

Installing the connector

For the procedure to install a connector, click here.

 

Prerequisites to configuring the connector

  • You must have the API hostname of the Duo server to which you will connect and perform the automated operations and the integration key and secret key to access that server.
  • 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 Duo connector and click Configure to configure the following parameters:

 

Parameter Description
Address API hostname of the Duo server to which you will connect and perform the automated operations.
Integration Key Integration key that is configured for your account for the Duo server to which you will connect and perform the automated operations.
Secret Key Secret key that is configured for your account for the Duo 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 Preauth Details Retrieves pre-authentication details such as, device, phone, and capabilities, for a specific user from the Duo server, based on the username you have specified. get_details
Investigation
Authenticate User Performs second-factor authentication for a user by making a phone call or sending a push notification to the user's smartphone application. authenticate_user
Investigation
Get Auth Status Retrieves the authentication status of a specific users from the Duo server, based on the transaction ID you have specified.
The Authenticate User operation returns a Transaction ID using which you can check the authentication status for a specific user.
get_status
Investigation

 

operation: Get Preauth Details

Input parameters

 

Parameter Description
Username Name of the user for whom you want to retrieve pre-authentication details from the Duo server. Pre-authentication details include device, phone, and capabilities of the user.

 

Output

The JSON output contains all the information about the user retrieved from the Duo server, based on the username you have specified. If the username that you have specified is not found on the Duo server, then this operation returns a link that the user can use for enrollment.

Following image displays a sample output for a user who is enrolled on the Duo server:

 

Sample output of the Get Preauth Details operation

 

Following image displays a sample output for a user who is not enrolled on the Duo server:

 

Sample output of the Get Preauth Details - User not enrolled operation

 

operation: Authenticate User

Input parameters

 

Parameter Description
Device ID ID of the device associated with a user for whom you want to perform second-factor authentication.
Username Name of the user for whom you want to perform second-factor authentication.
Factor Factor to be used to perform second-factor authentication. You can choose from the following options:
- auto: Authenticates users using the out-of-band factor (push or phone). This option is recommended by Duo as the best for the user's devices.
- push: Authenticates users using the Duo Push.
- phone: Authenticates users using a phone callback.
IP Address (Optional) IP address associated with a user for whom you want to perform second-factor authentication. Enter the IP address in a dotted quad format.
If you enter the IP address, then this will cause an allow response to be sent, if appropriate, for requests from a trusted network.
Async If you do not select this checkbox then the function will only return a response when the authentication process has completed.
Otherwise, this function will immediately return a transaction ID, and your application will need to subsequently call the Get Auth Status method to get the status (and, eventually, result) of the authentication process.
By default, this checkbox is selected.

 

Output

The JSON output contains the transaction ID retrieved from the Duo server if you have selected the Async parameter. You can use this transaction ID for other operations such as retrieving the authentication status of users.

If you have not selected the Async parameter, then the operation will wait until the process of authentication is completed and then return the status of authentication for the specified user.

 

Following image displays a sample output:

 

Sample output of the Authenticate User operation

 

operation: Get Auth Status

Input parameters

 

Parameter Description
Transaction ID Transaction ID based on which you want to retrieve the authentication status from the Duo server.
The Authenticate User operation returns a Transaction ID using which you can check the authentication status for a specific user.

 

Output

The JSON output contains the authentication status retrieved from the Duo server, based on the transaction ID you have specified.

Following image displays a sample output:

 

Sample output of the Get Auth Status operation

 

Included playbooks

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

  • Authenticate User
  • Get Auth Status
  • Get Preauth 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

Duo provides secure, rapid transition to the cloud. Use Duo Beyond to protect your on-premises and hosted applications, while securing your mobile workforce and their chosen devices.

This document provides information about the Duo connector, which facilitates automated interactions, with a Duo server using FortiSOAR™ playbooks. Add the Duo connector as a step in FortiSOAR™ playbooks and perform automated operations, such as authenticating users, and retrieving the authorization status.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with Duo Version: 1.0 and later

 

Installing the connector

For the 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 Duo connector and click Configure to configure the following parameters:

 

Parameter Description
Address API hostname of the Duo server to which you will connect and perform the automated operations.
Integration Key Integration key that is configured for your account for the Duo server to which you will connect and perform the automated operations.
Secret Key Secret key that is configured for your account for the Duo 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 Preauth Details Retrieves pre-authentication details such as, device, phone, and capabilities, for a specific user from the Duo server, based on the username you have specified. get_details
Investigation
Authenticate User Performs second-factor authentication for a user by making a phone call or sending a push notification to the user's smartphone application. authenticate_user
Investigation
Get Auth Status Retrieves the authentication status of a specific users from the Duo server, based on the transaction ID you have specified.
The Authenticate User operation returns a Transaction ID using which you can check the authentication status for a specific user.
get_status
Investigation

 

operation: Get Preauth Details

Input parameters

 

Parameter Description
Username Name of the user for whom you want to retrieve pre-authentication details from the Duo server. Pre-authentication details include device, phone, and capabilities of the user.

 

Output

The JSON output contains all the information about the user retrieved from the Duo server, based on the username you have specified. If the username that you have specified is not found on the Duo server, then this operation returns a link that the user can use for enrollment.

Following image displays a sample output for a user who is enrolled on the Duo server:

 

Sample output of the Get Preauth Details operation

 

Following image displays a sample output for a user who is not enrolled on the Duo server:

 

Sample output of the Get Preauth Details - User not enrolled operation

 

operation: Authenticate User

Input parameters

 

Parameter Description
Device ID ID of the device associated with a user for whom you want to perform second-factor authentication.
Username Name of the user for whom you want to perform second-factor authentication.
Factor Factor to be used to perform second-factor authentication. You can choose from the following options:
- auto: Authenticates users using the out-of-band factor (push or phone). This option is recommended by Duo as the best for the user's devices.
- push: Authenticates users using the Duo Push.
- phone: Authenticates users using a phone callback.
IP Address (Optional) IP address associated with a user for whom you want to perform second-factor authentication. Enter the IP address in a dotted quad format.
If you enter the IP address, then this will cause an allow response to be sent, if appropriate, for requests from a trusted network.
Async If you do not select this checkbox then the function will only return a response when the authentication process has completed.
Otherwise, this function will immediately return a transaction ID, and your application will need to subsequently call the Get Auth Status method to get the status (and, eventually, result) of the authentication process.
By default, this checkbox is selected.

 

Output

The JSON output contains the transaction ID retrieved from the Duo server if you have selected the Async parameter. You can use this transaction ID for other operations such as retrieving the authentication status of users.

If you have not selected the Async parameter, then the operation will wait until the process of authentication is completed and then return the status of authentication for the specified user.

 

Following image displays a sample output:

 

Sample output of the Authenticate User operation

 

operation: Get Auth Status

Input parameters

 

Parameter Description
Transaction ID Transaction ID based on which you want to retrieve the authentication status from the Duo server.
The Authenticate User operation returns a Transaction ID using which you can check the authentication status for a specific user.

 

Output

The JSON output contains the authentication status retrieved from the Duo server, based on the transaction ID you have specified.

Following image displays a sample output:

 

Sample output of the Get Auth Status operation

 

Included playbooks

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