Developer Documentation
Citrix ADM NITRO API Reference

mpssession

June 20, 2023
Contributed by: 
C

Configuration for Client Session resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
is_external_auth Read-write Is session created by using external authentication.
id Read-write Id is system generated key for all the client sessions.
tenant_name Read-only Tenant Name.
expire_after Read-only Session will expire after these many seconds.
login_time Read-only Session was initiated at this time.
permission Read-only Permission to identify who created the session.
session_timeout Read-only Session Timeout set for this session.
port Read-only Port from where this session was initiated.
username Read-only User Name who initiated this session.
client_type Read-only Client Type.
last_activity_time Read-only Last Activity Time for this session.
ip_address Read-only IP Aaddress from where this session was initiated.
is_self Read-only true, if this session is for current logged-in user.

Operations

(click to see Properties )

  • GET (ALL)
  • GET
  • DELETE

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/mpssession Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/mpssession ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of mpssession resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/mpssession ?pagesize=#no;pageno=#no Use this query-parameter to get the mpssession resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/mpssession ?count=yes Use this query-parameter to get the count of mpssession resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "mpssession":[{
"tenant_name":<String_value>,
"expire_after":<Integer_value>,
"login_time":<Integer_value>,
"permission":<String_value>,
"session_timeout":<Integer_value>,
"port":<Integer_value>,
"username":<String_value>,
"client_type":<String_value>,
"last_activity_time":<Integer_value>,
"session_creator":<String_value>,
"is_external_auth":<Boolean_value>,
"id":<String_value>,
"ip_address":<String_value>,
"token":<String_value>,
"sessionid":<String_value>,
"is_self":<Boolean_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/mpssession/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "mpssession":[{
"tenant_name":<String_value>,
"expire_after":<Integer_value>,
"login_time":<Integer_value>,
"permission":<String_value>,
"session_timeout":<Integer_value>,
"port":<Integer_value>,
"username":<String_value>,
"client_type":<String_value>,
"last_activity_time":<Integer_value>,
"session_creator":<String_value>,
"is_external_auth":<Boolean_value>,
"id":<String_value>,
"ip_address":<String_value>,
"token":<String_value>,
"sessionid":<String_value>,
"is_self":<Boolean_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/mpssession/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->
mpssession
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

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