Skip to content

mpsuser

Configuration for System User resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
session_timeout<Integer>Read-writeSession timeout for the user.
permission<String>Read-writeThis property is not supported, permission will be taken from groups only;ltbr;gtActions that this user is authorized to perform.
Maximum length = 128
name<String>Read-writeUser Name.
Minimum length = 1
Maximum length = 128
session_timeout_unit<String>Read-writeSession timeout unit for the user.
external_authentication<Boolean>Read-writeEnable external authentication.
enable_session_timeout<Boolean>Read-writeEnables session timeout for user.
tenant_id<String>Read-writeTenant Id of the system users.
Minimum length = 1
Maximum length = 128
password<String>Read-writePassword.
Minimum length = 1
Maximum length = 128
id<String>Read-writeId is system generated key for all the system users.
groups<String[]>Read-writeGroups to which user belongs.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

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: https://<MGMT-IP>/nitro/v1/config/mpsuser?onerror=<String_value>

HTTP Method: null

Request Payload:

{mpsuser: {
<b>"name":<String_value></b>,
<b>"password":<String_value></b>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"tenant_id":<String_value>,
"groups":<String_value[]>,
"id":<String_value>,
"permission":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsuser":[{
"is_default":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"tenant_id":<String_value>,
"password":<String_value>,
"one_way_password":<String_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"encrypted":<Boolean_value>,
"groups":<String_value>,
"nsroot_user":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/mpsuser/id_value<String>

HTTP Method: null

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/mpsuser

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsuser":[{
"is_default":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"tenant_id":<String_value>,
"password":<String_value>,
"one_way_password":<String_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"encrypted":<Boolean_value>,
"groups":<String_value>,
"nsroot_user":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/mpsuser/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsuser":[{
"is_default":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"tenant_id":<String_value>,
"password":<String_value>,
"one_way_password":<String_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"encrypted":<Boolean_value>,
"groups":<String_value>,
"nsroot_user":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/mpsuser/id_value<String>

HTTP Method: null

Request Payload:

{mpsuser:{
<b>"id":<String_value></b>,
"session_timeout":<Integer_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"groups":<String_value[]>,
"name":<String_value>,
"permission":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpsuser":[{
"is_default":<Boolean_value>,
"session_timeout":<Integer_value>,
"permission":<String_value>,
"name":<String_value>,
"session_timeout_unit":<String_value>,
"external_authentication":<Boolean_value>,
"enable_session_timeout":<Boolean_value>,
"tenant_id":<String_value>,
"password":<String_value>,
"one_way_password":<String_value>,
"id":<String_value>,
"tenant_name":<String_value>,
"encrypted":<Boolean_value>,
"groups":<String_value>,
"nsroot_user":<String_value>}]}