-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
tmsessionparameter
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
tmsessionparameter
Configuration for session parameter resource.
Properties
(click to see Operations)
Name | Data Type | Permissions | Description |
---|---|---|---|
sesstimeout |
|
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 |
|
Read-write | Allow or deny access to content for which there is no specific authorization policy. Default value: ALLOW Possible values = ALLOW, DENY |
sso |
|
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 |
|
Read-write | Use primary or secondary authentication credentials for single sign-on. Default value: PRIMARY Possible values = PRIMARY, SECONDARY |
ssodomain |
|
Read-write | Domain to use for single sign-on. Minimum length = 1 Maximum length = 32 |
kcdaccount |
|
Read-write | Kerberos constrained delegation account name. Minimum length = 1 Maximum length = 32 |
httponlycookie |
|
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 |
|
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 |
|
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 |
|
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 |
|
Read-only | . |
tmsessionpolicybindtype |
|
Read-only | Indicates current bind type (Classic/Advanced) for TM session policy across all bind entities. Default value: Advanced Policy Possible values = Classic Policy, Advanced Policy |
tmsessionpolicycount |
|
Read-only | Count of TM session policies across all bind entities. |
Operations
(click to see Properties)
UPDATE | UNSET | GET (ALL) |
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 Citrix ADC appliance, the URL is as follows:
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/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
}}
<!--NeedCopy-->
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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>,
"tmsessionpolicybindtype":<String_value>,
"tmsessionpolicycount":<Double_value>
}]}
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.