mpsuser

Configuration for System User resource.

Read/write properties

id<String>

Id is system generated key for all the system users.

session_timeout_unit<String>

Session timeout unit for the user.

password<String>

Password.
Minimum length = 1
Maximum length = 128

tenant_id<String>

Tenant Id of the system users.
Minimum length = 1
Maximum length = 128

external_group_mapping_oid<String>

Mapping of user associated with External Group Id.

enable_session_timeout<Boolean>

Enables session timeout for user.

name<String>

User Name.
Minimum length = 1
Maximum length = 128

session_timeout<Integer>

Session timeout for the user.

mpsuser_name<String>

User Name.
Maximum length = 128

external_authentication<Boolean>

Enable external authentication.

groups<String[]>

Groups to which user belongs.

unlock<Boolean>

A flag to unlock the user.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

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

add update delete get (all)get

add

URL:https://<MGMT-IP>/nitro/v2/config/mpsuser?onerror=<String_value>

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"mpsuser": {
      "password":<String_value>,
      "name":<String_value>,
      "mpsuser_name":<String_value>,
      "id":<String_value>,
      "external_group_mapping_oid":<String_value>,
      "groups":<String_value[]>,
      "session_timeout_unit":<String_value>,
      "enable_session_timeout":<Boolean_value>,
      "tenant_id":<String_value>,
      "unlock":<Boolean_value>,
      "external_authentication":<Boolean_value>,
      "session_timeout":<Integer_value>}}

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

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

update

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

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"mpsuser":{
      "id":<String_value>,
      "enable_session_timeout":<Boolean_value>,
      "unlock":<Boolean_value>,
      "tenant_id":<String_value>,
      "password":<String_value>,
      "external_authentication":<Boolean_value>,
      "name":<String_value>,
      "session_timeout":<Integer_value>,
      "session_timeout_unit":<String_value>,
      "external_group_mapping_oid":<String_value>,
      "mpsuser_name":<String_value>,
      "groups":<String_value[]>}}

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

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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

{ "errorcode": 0, "message": "Done", "severity": <String_value> }

get (all)

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

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/mpsuser?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of mpsuser 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/mpsuser?pagesize=#no&pageno=#no

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

count

https://<MGMT-IP>/nitro/v2/config/mpsuser?count=yes

Use this query-parameter to get the count of mpsuser resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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

get

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

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