Product Documentation

tmsessionparameter

Sep 08, 2016

Configuration for session parameter resource.

Properties (click to see Operations)

Name Data Type Permissions Description
sesstimeout
<Double>
Read-write
Session timeout, in minutes. If there is no traffic during the timeout period, the user is disconnected and must reauthenticate to access the intranet resources.
Default value: 30
Minimum value = 1
defaultauthorizationaction
<String>
Read-write
Allow or deny access to content for which there is no specific authorization policy.
Default value: ALLOW
Possible values = ALLOW, DENY
sso
<String>
Read-write
Log users on to all web applications automatically after they authenticate, or pass users to the web application logon page to authenticate for each application.
Default value: OFF
Possible values = ON, OFF
ssocredential
<String>
Read-write
Use primary or secondary authentication credentials for single sign-on.
Default value: PRIMARY
Possible values = PRIMARY, SECONDARY
ssodomain
<String>
Read-write
Domain to use for single sign-on.
Minimum length = 1
Maximum length = 32
kcdaccount
<String>
Read-write
Kerberos constrained delegation account name.
Minimum length = 1
Maximum length = 32
httponlycookie
<String>
Read-write
Allow only an HTTP session cookie, in which case the cookie cannot be accessed by scripts.
Default value: YES
Possible values = YES, NO
persistentcookie
<String>
Read-write
Use persistent SSO cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Default value: OFF
Possible values = ON, OFF
persistentcookievalidity
<Double>
Read-write
Integer specifying the number of minutes for which the persistent cookie remains valid. Can be set only if the persistence cookie setting is enabled.
Minimum value = 1
homepage
<String>
Read-write
Web address of the home page that a user is displayed when authentication vserver is bookmarked and used to login.
Default value: "None"
name
<String>
Read-only
.

Operations (click to see Properties)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

update

URL: http://<netscaler-ip-address>/nitro/v1/config/tmsessionparameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"tmsessionparameter":{
      "sesstimeout":<Double_value>,
      "defaultauthorizationaction":<String_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "ssodomain":<String_value>,
      "kcdaccount":<String_value>,
      "httponlycookie":<String_value>,
      "persistentcookie":<String_value>,
      "persistentcookievalidity":<Double_value>,
      "homepage":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/tmsessionparameter?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"tmsessionparameter":{
      "sesstimeout":true,
      "sso":true,
      "ssodomain":true,
      "kcdaccount":true,
      "persistentcookie":true,
      "homepage":true,
      "defaultauthorizationaction":true,
      "ssocredential":true,
      "httponlycookie":true,
      "persistentcookievalidity":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/tmsessionparameter

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "tmsessionparameter": [ {
      "name":<String_value>,
      "sesstimeout":<Double_value>,
      "defaultauthorizationaction":<String_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "ssodomain":<String_value>,
      "kcdaccount":<String_value>,
      "httponlycookie":<String_value>,
      "homepage":<String_value>,
      "persistentcookie":<String_value>,
      "persistentcookievalidity":<Double_value>
}]}