Invitation Emails | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve the Invitation Email Settings

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/InvitationEmailSettings'

200

401

404

{
  "targetDeviceLst": [
    [
      "0 = Windows",
      "2 = Linux",
      "3 = Mac",
      "4 = iOS",
      "5 = Android",
      "6 = ChromeApp",
      "7 = HTML5"
    ]
  ],
  "connMode": [
    "0 = Gateway",
    "1 = Direct",
    "2 = GatewaySSL",
    "3 = DirectSSL"
  ],
  "pubGatewayIP": "text",
  "email": "text",
  "sso": "text",
  "ssoEnabled": true,
  "authType": [
    "0 = Credentials",
    "1 = SSO",
    "2 = SmartCard",
    "3 = Web"
  ]
}

Success

Update

put

Modify Invitation Email Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Body

apLockbooleanoptional

emailstring | nullableoptional

The email content to be sent in the invitation.

defaultEmailContentbooleanoptional

If this parameter is included, the body content will be replaced with the default body content.

Default: false

pubGatewayIPstring | nullableoptional

Public Secure Gateway IP (IP:Gateway Port/SSL Port).

ssostring | nullableoptional

Third party credentials provider GUID (SSO).

targetDevicestring · enum[] | nullableoptional

Target Device List.

ssoEnabledboolean | nullableoptional

Force to wrap third party SSO component.

connModestring · enumoptional

Invitation Connection Mode

Available options:

authTypestring · enumoptional

Invitation Authentication Type