Invitation Emails

Get

Retrieve the Invitation Email Settings

GET/api/InvitationEmailSettings

Response

200401404

Success

Body

application/json; api-version=1.0

targetDeviceLstnullable array of InviteTargetDev (enum)

connModeInviteConnMode (enum)

Invitation Connection Mode

0 = Gateway,1 = Direct,2 = GatewaySSL,3 = DirectSSL

pubGatewayIPnullable string

emailnullable string

ssonullable string

ssoEnabledboolean

authTypeInviteAuthType (enum)

Invitation Authentication Type

0 = Credentials,1 = SSO,2 = SmartCard,3 = Web

Request

JavaScriptCurlPython

const response = await fetch('/api/InvitationEmailSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "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": false,
  "authType": [
    "0 = Credentials",
    "1 = SSO",
    "2 = SmartCard",
    "3 = Web"
  ]
}

Update

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

PUT/api/InvitationEmailSettings

Body

application/json; api-version=1.0

Invitation Email Settings

apLockboolean

emailnullable string

The email content to be sent in the invitation.

defaultEmailContentboolean

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

pubGatewayIPnullable string

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

ssonullable string

Third party credentials provider GUID (SSO).

targetDevicenullable array of InviteTargetDev (enum)

Target Device List.

ssoEnablednullable boolean

Force to wrap third party SSO component.

connModeInviteConnMode (enum)

Invitation Connection Mode

0 = Gateway,1 = Direct,2 = GatewaySSL,3 = DirectSSL

authTypeInviteAuthType (enum)

Invitation Authentication Type

0 = Credentials,1 = SSO,2 = SmartCard,3 = Web

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/InvitationEmailSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}