• SonicOS 7.1
• About SonicOS
  • Working with SonicOS
  • SonicOS Workflow
  • How to Use the SonicOS Administration Guides
  • Guide Conventions
• About User Management
  • Using Local Users and Groups for Authentication
    • About User Databases
    • About User Groups
  • Using RADIUS for Authentication
  • Using LDAP/Active Directory/eDirectory Authentication
    • LDAP Terms
    • LDAP Directory Services Supported in SonicOS
    • LDAP User Group Mirroring
      • Integrating LDAP into the SonicOS Network Security Appliance
        • Preparing Your LDAP Server for Integration
        • Configuring the CA on the Active Directory Server
        • Exporting the CA Certificate from the Active Directory Server
        • Importing the CA Certificate into SonicOS
      • LDAP Group Membership by Organizational Unit
  • Using RADIUS
  • Using TACACS+
  • Using Single Sign-On
    • What is Single Sign-On?
    • Benefits of SonicWall SSO
    • Platforms and Supported Standards
    • How Does Single Sign-On Work?
      • SonicWall SSO Authentication Using the SSO Agent
      • SonicWall SSO Authentication Using the Terminal Services Agent
      • SonicWall SSO Authentication Using Browser NTLM Authentication
    • How Does SSO Agent Work?
      • Logging
    • How Does Terminal Services Agent Work?
      • Multiple TSA Support
      • Encryption of TSA Messages and Use of Session IDs
      • Connections to Local Subnets
      • Non-Domain User Traffic from the Terminal Server
    • How Does Browser NTLM Authentication Work?
      • NTLM Authentication of Domain Users
      • NTLM Authentication of Non-Domain Users
      • Credentials for NTLM Authentication in the Browser
    • How Does RADIUS Accounting for Single-Sign-On Work?
      • RADIUS Accounting Messages
      • SonicWall Compatibility with Third-Party Network Appliances
      • Proxy Forwarding
      • Non-Domain Users
      • IPv6 Considerations
      • RADIUS Accounting Server Port
    • Installing the Single Sign-On Agent and/or Terminal Services Agent
      • Installing the SonicWall SSO Agent
      • Installing the SonicWall Terminal Services Agent
        • Accessing the SonicWall Terminal Services Agent
        • Creating a SonicWall TSA Troubleshooting Report
    • Single Sign-On Advanced Features
      • Viewing SSO Mouseover Statistics
      • Using the Single Sign-On Statistics in the TSR
      • Examining the Agent
      • Remedies
    • Configuring Access Rules
      • Automatically Generated Rules for SonicWall SSO
      • Accommodating Mac and Linux Users
        • Using SSO on Mac and Linux With Samba
        • Using SSO on Mac and Linux Without Samba
      • Allowing ICMP Pings from a Terminal Server
    • Managing SonicOS with HTTP Login from a Terminal Server
    • Viewing and Managing SSO User Sessions
      • Logging Out SSO Users
      • Configuring Additional SSO User Settings
      • Viewing SSO and LDAP Messages with Packet Monitor
      • Capturing SSO Messages
      • Capturing LDAP Over TLS Messages
    • Multiple Administrator Support
      • Preempting Administrators
      • Logging in with Administrator Rights
        • Disabling the User Login Status Popup
      • Configuring Multiple Administrator Support
        • Configuring Additional Administrator User Profiles
        • Configuring Administrators Locally when Using LDAP or RADIUS
        • Verifying Multiple Administrators Support Configuration
        • Viewing Multiple Administrator Related Log Messages
• Configuring Users Status
  • Displaying Inactive Users
  • Displaying Unauthenticated Users
  • Displaying the User Count
  • Refreshing the Users List
  • Logging Out Users
    • Logging Out a Single User
    • Logging Out Multiple Users
• Configuring User Settings
  • User Login Settings
    • Setting the Authentication Method for Login
    • Configuring RADIUS Authentication
      • Configuring RADIUS Settings
      • Configuring RADIUS Users Settings
      • Testing RADIUS Settings
    • Configuring LDAP
      • Configuring LDAP Setting
      • Configuring Referrals
      • LDAP User Settings
      • Enabling LDAP Relay
      • Testing LDAP Settings
    • Configuring TACACS+
      • Configuring TACAS+ Settings
      • Configuring TACACS+ User Settings
      • Testing TACACS+ Settings
    • Requiring User Names be Treated as Case-Sensitive
    • Preventing Users From Logging in from More than One Location
    • Forcing Users to Log In Immediately After Changing Their Passwords
    • Displaying User Login Information Since the Last Login
  • Setting the Single-Sign-On Methods
    • Configuring SSO
      • SSO Agents
      • Users
      • Enforcement
      • Terminal Services
      • NTLM
      • RADIUS Accounting
      • 3rd Party API
      • Capture Client
      • Test
  • One-Time Password Settings
  • Configuring the User Web Login Settings
    • Setting the Timeout for the Authentication Page
    • Setting How the Browser is Redirected
    • Managing Redirections to the Login Page
    • Using a CHAP challenge to Authenticate Users
    • Redirecting Unauthenticated Users
    • Authenticating user's multiple IP addresses
  • Adding URLs to Authentication Bypass
  • User Session Settings
    • User Session Settings for SSO-Authenticated Users
    • User Session Settings for Web Login
  • Accounting
    • Configuring RADIUS Accounting
      • Sending RADIUS Accounting Information to Servers
      • Configuring User Accounting
      • Testing RADIUS Accounting
      • Editing RADIUS Servers
      • Deleting RADIUS Servers
    • Configuring TACACS+ Accounting
      • Configuring User Accounting
      • Testing TACACS Accounting
      • Editing TACACS Servers
      • Deleting TACACS Servers
  • [[[Missing Linked File System.LinkedTitle]]]
    • • Post-Login Acceptable Use Policy Example Template
      • Post-Login Acceptable Use Policy Preview Message
• Configuring and Managing Partitions
  • Authentication Partitioning Settings
  • Authentication Partitions
    • Adding Partitions and Subpartitions
    • Editing Partitions
    • Deleting Partitions and Subpartitions
      • Deleting All Partitions
      • Deleting Multiple Partitions
      • Deleting a Single Partition
  • Assigning Servers, Agents, and Clients
    • Manually Assigning Servers, Agents, and Clients
    • Automatically Assigning Servers, Agents, and Clients
  • Partition Selection Policies
    • Adding Partition Policies
    • Deleting Partitions Policies
      • Deleting All Partitions Policies
      • Deleting Multiple Partitions Policies
      • Deleting a Single Partition Policiy
• Configuring Local Users and Groups
  • About Authentication and Passwords
    • Using Two-Factor Authentication
    • Enforcing First Login Password Change
  • Configuring Local Users
    • Quota Control for all Users
    • Viewing Local Users
    • Adding Local Users
      • Configuring Local Users Settings
      • Configuring Local Users Groups
      • Configuring Local Users VPN Access
      • Configuring Local Users User Quota
    • Editing Local Users
  • Configuring Local Groups
    • Adding Local Groups
      • Configuring Local Groups Settings
      • Configuring Local Group Settings Members
      • Configuring Local Group Settings VPN Access
      • Configuring Local Group Settings Administration
    • Editing Local Groups
  • Settings
• Configuring Guest Services
  • Adding Guest Profiles
  • Editing Guest Profiles
  • Deleting Guest Profiles
• Configuring Guest Accounts
  • Adding Guest Accounts
  • Editing Guest Accounts
  • Deleting Guest Accounts
    • Deleting a Guest Account
    • Deleting Multiple Guest Accounts
    • Deleting All Guest Accounts
• Managing Guest Status
  • Logging Out Guests
  • Logging Out All Guests
• SonicWall Support
  • About This Document

3rd Party API

The SSO API is an XML/JSON based REST API for 3rd-Party devices or scripts to pass user login/logout notifications to the SonicWall.

1. Navigate to the Device > Users > Settings > Authentication page.
2. Next to Configure SSO, click Configure.

   The SSO Configuration page is displayed.

3. Click the 3rd Party API tab.

4. In the API Clients tab, click Add Client.

   1. Under the Settings tab, select the following:

      1. In the Host Name or IP Address(es) field, enter the name or IP address of the terminal server on which SonicWALL TSA is installed.

      2. If partitioning has been configured then in the Partition drop-down menu select the Default.

      3. In Authenticate the client via select one of the following:

         • Shared secret

         • Certificate

         • Both

      4. In the Shared Key field, enter the shared key that you created or generated in the SonicWALL TSA.

      5. Re-enter the shared key in the Confirm Shared Key field.

   2. Click Save.

   3. Under the Advanced tab, select the following:

      1. To select the level of security to use for verification of the shared secret, in Shared secret verification security level, select one of the following :

         • High with and select the checkboxes SHA256 and SHA512

         • Medium (SHA256 but no replay prevention)

         • Low (no shared secret verification)

      2. Select the Enable CSRF/replay prevention check box to prevent the Cross-Site Request Forgery.

      3. Enable the Restrict origins if client uses CORS check box to prevent if a client uses Cross-Origin Resource Sharing (CORS) then as an additional security precaution this can be set to restrict the origins of the XML/JSON data that it sends.

      4. Enter the URL of a domain in Allow origins.

      5. To allow to keep connections on the SSO API open across multiple requests enable the Allow persistent connections.

   4. Click Save.

5. In the General Settings, do the following:
   1. Select the Enable SSO 3rd-Party API option. This option is disabled by default.
   2. Select the Use the HTTPS Management port option. This option is enabled by default.
   3. Enter the HTTPS port number field. The default is 444.
6. Click Save.