Connection and Authentication

List

get

Retrieve a list of all the settings for RAS authentication

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the settings for RAS authentication (optional)

Responses

200

Success

application/json; api-version=1.0

RAS Authentication Settings

authTypestring[Flag] · enumOptional

Authentication Type

Possible values:

allTrustedDomainsbooleanOptional

Whether to use all trusted domains.

domainstring · nullableOptional

Domain name.

useClientDomainbooleanOptional

Whether to use the client domain, if specified.

forceNetBIOSCredsbooleanOptional

Whether to force clients to use NetBIOS credentials.

replicateSettingsbooleanOptional

Whether to replicate settings to other sites.

useChangePasswordURLbooleanOptional

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

changePasswordURLstring · nullableOptional

Custom link for the "Change domain password" option.

siteIdinteger · int32Optional

The site ID to which the RAS authentication settings refer.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/ConnectionAuthentication

HTTPcURLJavaScriptPython

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

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

Update

put

Update RAS authentication settings

Query parameters

SiteIdinteger · int32Optional

ID of the site for which the RAS authentication settings will be updated

Body

application/json; api-version=1.0

Update the authentication settings

authTypestring[Flag] · enumOptional

Authentication Type

Possible values:

allTrustedDomainsboolean · nullableOptional

Whether to use all trusted domains.

domainstring · min: 1 · max: 64 · nullableOptional

Domain name.

useClientDomainboolean · nullableOptional

Whether to use the client domain, if specified.

forceNetBIOSCredsboolean · nullableOptional

Whether to force clients to use NetBIOS credentials.

replicateSettingsboolean · nullableOptional

Whether to replicate settings to other sites.

useChangePasswordURLboolean · nullableOptional

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

changePasswordURLstring · nullableOptional

Custom link for the "Change domain password" option.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/ConnectionAuthentication

HTTPcURLJavaScriptPython

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

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

No content

List

get

Retrieve a list of all the Trusted Domains.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve all the Trusted Domains (optional)

Responses

200

Success

application/json; api-version=1.0

string[]Optional

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/ConnectionAuthentication/TrustedDomain

HTTPcURLJavaScriptPython

GET /api/ConnectionAuthentication/TrustedDomain HTTP/1.1
Accept: */*

[
  "text"
]