Connection Settings
Retrieve a list of all remote session settings.
Query parameters
SiteIdinteger · int32Optional
Site ID for which to retrieve all remote session settings (optional).
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/ConnectionSettings HTTP/1.1
Host:
Accept: */*
{
"fipsMode": [
"0 = Disabled",
"1 = Allowed",
"2 = Enforced"
],
"remoteIdleSessionTimeout": 1,
"logoffIdleSessionTimeout": 1,
"cachedSessionTimeout": 1,
"replicateSettings": true,
"siteId": 1
}
Update settings of a remote session
Query parameters
SiteIdinteger · int32Optional
ID of the site for which the remote session settings will be updated
Body
Update user session settings
remoteIdleSessionTimeoutinteger · int32 | nullableOptional
Set the session idle timeout (in seconds).
logoffIdleSessionTimeoutinteger · int32 | nullableOptional
Set the client logoff timeout (in seconds).
cachedSessionTimeoutinteger · int32 | nullableOptional
Set the cached session timeout (in seconds).
fipsModestring · enumOptionalPossible values:
FIPS Mode Setting
replicateSettingsboolean | nullableOptional
Whether to replicate settings to other sites.
Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
put
PUT /api/ConnectionSettings HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 166
{
"remoteIdleSessionTimeout": 1,
"logoffIdleSessionTimeout": 1,
"cachedSessionTimeout": 1,
"fipsMode": [
"0 = Disabled",
"1 = Allowed",
"2 = Enforced"
],
"replicateSettings": true
}
No content
Last updated
Was this helpful?