Attributes
name (string): A unique identifier for the user group.
allCovered (boolean): Set to true if all VPN regions are accessible. Any new regions added will automatically be accessible to this group.
internetAccess (string): Determines the internet access level for the user group. Supported values:
RESTRICTED_INTERNET: Private and trusted internet traffic is tunneled; all other internet traffic is blocked.
SPLIT_TUNNEL_OFF: All traffic is tunneled; internet traffic exits from selected Internet Gateways.
SPLIT_TUNNEL_ON: Private and trusted internet traffic is tunneled; all other internet traffic uses local internet.
maxDevice (integer): The maximum number of devices allowed per user in this group.
connectAuth (string): The authentication mode for connections. Supported values:
NO_AUTH: No authentication required.
ON_PRIOR_AUTH: Authentication is required on prior timeout.
EVERY_TIME: Authentication is required each time.
allRegionsIncluded (boolean): Set to true to include all current and future regions by default.
gatewaysIds (string): The network gateway’s unique identifier. Leave empty if internet access is restricted or Split Tunnel On used for a User Group.
Body parameter
{
"name": "string",
"vpnRegionIds": [
"string"
],
"internetAccess": "SPLIT_TUNNEL_ON",
"maxDevice": 0,
"connectAuth": "NO_AUTH",
"allRegionsIncluded": true,
"gatewaysIds": [
"string"
]
}
Name | In | Type | Required | Description |
|---|---|---|---|---|
body | body | true | none | |
» name | body | string | false | none |
» vpnRegionIds | body | [string] | false | none |
» internetAccess | body | string | false | none |
» maxDevice | body | integer(int32) | false | none |
» connectAuth | body | string | false | none |
» allRegionsIncluded | body | boolean | false | none |
» gatewaysIds | body | [string] | false | none |
Parameter | Value |
|---|---|
» internetAccess | SPLIT_TUNNEL_ON |
» internetAccess | SPLIT_TUNNEL_OFF |
» internetAccess | RESTRICTED_INTERNET |
» connectAuth | NO_AUTH |
» connectAuth | ON_PRIOR_AUTH |
» connectAuth | EVERY_TIME |
Status | Meaning | Description | Schema |
|---|---|---|---|
201 | Created |
To perform this operation, you must be authenticated by means of one of the following methods: oauth