Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

This API call only applies to Armor Complete users.

The Enable SSL/VPN API allows allows an account administrator to enable (or disable) a user's ability to download and use SSL/VPN to access their environment. 

You can use the Get Locations API to find available locations to enable SSL/VPN.

You must first enable the SSL/VPN client before a user can download the client. .

Sample request

POST https://api.armor.com/sslvpn/enable
{
 "userId": 3,
 "locations": [
      {
        "zone": "dfw01-vc01"
      }
 ],
 "enable": true
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/sslvpn/enablePOST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
userIdThe ID of the user to enable (or disable) SSL/VPN accessStringRequired3
locationsThe collection of zones to enable a user's SSL/VPNStringRequireddfw01-vc01
enable

Enable or disable a user's SSL/VPN

  • To enable, enter true
  • To disable, enter false
BooleanRequiredtrue

Sample return

StatusResponse
202
Successful
400
Bad Request