Invitation Emails

Get

get

Retrieve the Invitation Email Settings

Responses

200

Success

application/json; api-version=1.0

InvitationEmailSettings

connModestring · enumOptional

Invitation Connection Mode

Possible values:

pubGatewayIPstring · nullableOptional

Published Gateway IP

emailstring · nullableOptional

Email

ssostring · nullableOptional

SSO

ssoEnabledbooleanOptional

Whether SSO is Enabled or not

authTypestring · enumOptional

Invitation Authentication Type

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/InvitationEmailSettings

HTTPcURLJavaScriptPython

GET /api/InvitationEmailSettings HTTP/1.1
Accept: */*

{
  "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",
    "4 = WebCredentials"
  ]
}

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

application/json; api-version=1.0

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 · max: 255 · nullableOptional

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

ssostring · max: 255 · nullableOptional

Third party credentials provider GUID (SSO).

ssoEnabledboolean · nullableOptional

Force to wrap third party SSO component.

connModestring · enumOptional

Invitation Connection Mode

Possible values:

authTypestring · enumOptional

Invitation Authentication Type

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/InvitationEmailSettings

HTTPcURLJavaScriptPython

PUT /api/InvitationEmailSettings HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 365

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

No content