Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

tmsessionaction

August 17, 2023
Contributed by: 
C

Configuration for TM session action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the session action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after a session action is created.



The following requirement applies only to the Citrix ADC CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

Minimum length = 1
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 intranet resources.

Minimum value = 1
defaultauthorizationaction <String> Read-write Allow or deny access to content for which there is no specific authorization policy.

Possible values = ALLOW, DENY
sso <String> Read-write Use single sign-on (SSO) to log users on to all web applications automatically after they authenticate, or pass users to the web application logon page to authenticate to each application individually.

Default value: OFF

Possible values = ON, OFF
ssocredential <String> Read-write Use the primary or secondary authentication credentials for single sign-on (SSO).

Possible values = PRIMARY, SECONDARY
ssodomain <String> Read-write Domain to use for single sign-on (SSO).

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
kcdaccount <String> Read-write Kerberos constrained delegation account name.

Minimum length = 1

Maximum length = 32
persistentcookie <String> Read-write Enable or disable persistent SSO cookies for the traffic management (TM) session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends. This setting is overwritten if a traffic action sets persistent cookie to OFF.

Note: If persistent cookie is enabled, make sure you set the persistent cookie validity.

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 persistent 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.
builtin <String[]> Read-only Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT

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>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

add

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"tmsessionaction":{
<b>      "name":<String_value>,
</b>      "sesstimeout":<Double_value>,
      "defaultauthorizationaction":<String_value>,
      "sso":<String_value>,
      "ssocredential":<String_value>,
      "ssodomain":<String_value>,
      "httponlycookie":<String_value>,
      "kcdaccount":<String_value>,
      "persistentcookie":<String_value>,
      "persistentcookievalidity":<Double_value>,
      "homepage":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"tmsessionaction":{
<b>      "name":<String_value>,
</b>      "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>
}}

<!--NeedCopy-->

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/tmsessionaction? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"tmsessionaction":{
<b>      "name":<String_value>,
</b>      "sesstimeout":true,
      "defaultauthorizationaction":true,
      "sso":true,
      "ssocredential":true,
      "ssodomain":true,
      "kcdaccount":true,
      "httponlycookie":true,
      "persistentcookie":true,
      "persistentcookievalidity":true,
      "homepage":true
}}

<!--NeedCopy-->

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/tmsessionaction

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of tmsessionaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction? view=summary

Use this query-parameter to get the summary output of tmsessionaction resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction? pagesize=#no;pageno=#no

Use this query-parameter to get the tmsessionaction resources in chunks.

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 Header:

Content-Type:application/json

Response Payload: 


{ "tmsessionaction": [ {
      "name":<String_value>,
      "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>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of tmsessionaction resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 Header:

Content-Type:application/json

Response Payload: 


{  "tmsessionaction": [ {
      "name":<String_value>,
      "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>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/tmsessionaction? count=yes

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 Header:

Content-Type:application/json

Response Payload: 


{ "tmsessionaction": [ { "__count": "#no"} ] }

<!--NeedCopy-->
tmsessionaction
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.