Connection and Authentication

List

Retrieve a list of all the settings for RAS authentication

GET/api/ConnectionAuthentication

Query parameters

Response

200401404

OK

Body

application/json; api-version=1.0

authTypeAuthenticationTypes (enum)

Authentication Type

1 = UsernamePassword,2 = SmartCard,3 = UsernamePasswordOrSmartCard,4 = Web,8 = WebCredentials

allTrustedDomainsboolean

Whether to use all trusted domains.

domainnullable string

Domain name.

useClientDomainboolean

Whether to use the client domain, if specified.

forceNetBIOSCredsboolean

Whether to force clients to use NetBIOS credentials.

replicateSettingsboolean

Whether to replicate settings to other sites.

useChangePasswordURLboolean

Enable use custom link for the "Change domain password" option.

changePasswordURLnullable string

Custom link for the "Change domain password" option.

siteIdinteger (int32)

The site ID to which the RAS authentication settings refer.

Request

JavaScriptCurlPython

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

Response

200401404

{
  "authType": [
    "1 = UsernamePassword",
    "2 = SmartCard",
    "3 = UsernamePasswordOrSmartCard",
    "4 = Web",
    "8 = WebCredentials"
  ],
  "allTrustedDomains": false,
  "domain": "text",
  "useClientDomain": false,
  "forceNetBIOSCreds": false,
  "replicateSettings": false,
  "useChangePasswordURL": false,
  "changePasswordURL": "text"
}

Update

Update RAS authentication settings

PUT/api/ConnectionAuthentication

Query parameters

Body

application/json; api-version=1.0

RAS allowed device settings

authTypeAuthenticationTypes (enum)

Authentication Type

1 = UsernamePassword,2 = SmartCard,3 = UsernamePasswordOrSmartCard,4 = Web,8 = WebCredentials

allTrustedDomainsnullable boolean

Whether to use all trusted domains.

domainnullable string

Domain name.

useClientDomainnullable boolean

Whether to use the client domain, if specified.

forceNetBIOSCredsnullable boolean

Whether to force clients to use NetBIOS credentials.

replicateSettingsnullable boolean

Whether to replicate settings to other sites.

useChangePasswordURLnullable boolean

Enable use custom link for the "Change domain password" option.

changePasswordURLnullable string

Custom link for the "Change domain password" option.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ConnectionAuthentication', {
    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"
}

List

Retrieve a list of all the Trusted Domains.

GET/api/ConnectionAuthentication/TrustedDomain

Query parameters

Response

200401404

OK

Body

application/json; api-version=1.0

itemsstring

Request

JavaScriptCurlPython

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

Response

200401404

[
  "text"
]