ADC NITRO APIs

systemuser

August 17, 2023

Contributed by:

Configuration for system user resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
username		Read-write	Name for a user. Must begin with a letter, number, or the underscore (_) character, and must contain only alphanumeric, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), and underscore characters. Cannot be changed after the user is added. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my user” or ‘my user’). Minimum length = 1
password		Read-write	Password for the system user. Can include any ASCII character. Minimum length = 1
externalauth		Read-write	Whether to use external authentication servers for the system user authentication or not. Default value: ENABLED Possible values = ENABLED, DISABLED
promptstring		Read-write	String to display at the command-line prompt. Can consist of letters, numbers, hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore (_), and the following variables %u - Will be replaced by the user name. %h - Will be replaced by the hostname of the Citrix ADC. %t - Will be replaced by the current time in 12-hour format. %T - Will be replaced by the current time in 24-hour format. %d - Will be replaced by the current date. %s - Will be replaced by the state of the Citrix ADC. Note: The 63-character limit for the length of the string does not apply to the characters that replace the variables. Minimum length = 1
timeout		Read-write	CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system parameter is enabled, Timeout can have values in the range [300-86400] seconds. If Restrictedtimeout argument of system parameter is disabled, Timeout can have values in the range [0, 10-100000000] seconds. Default value is 900 seconds.
logging		Read-write	Users logging privilege. Default value: DISABLED Possible values = ENABLED, DISABLED
maxsession		Read-write	Maximum number of client connection allowed per user. Default value: 20 Minimum value = 1 Maximum value = 40
allowedmanagementinterface	<String[]>	Read-write	Allowed Management interfaces to the system user. By default user is allowed from both API and CLI interfaces. If management interface for a user is set to API, then user is not allowed to access NS through CLI. GUI interface will come under API interface. Default value: NS_INTERFACE_ALL Possible values = CLI, API
encrypted		Read-only	.
hashmethod		Read-only	. Possible values = SHA1, SHA512, PBKDF2
promptinheritedfrom		Read-only	From where the prompt has been inherited. Possible values = User, Group, Global, Climode
timeoutkind		Read-only	From where the timeout has been inherited. Possible values = User, Group, Global, Climode
allowedmanagementinterfacekind		Read-only	Value of allowed interface which can be inherited from Global, Group or User. Possible values = User, Group, Global, Climode
__count		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/systemuser

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemuser":{
<b>      "username":<String_value>,
</b><b>      "password":<String_value>,
</b>      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "timeout":<Double_value>,
      "logging":<String_value>,
      "maxsession":<Double_value>,
      "allowedmanagementinterface":<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/systemuser/ username_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/systemuser

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemuser":{
<b>      "username":<String_value>,
</b>      "password":<String_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "timeout":<Double_value>,
      "logging":<String_value>,
      "maxsession":<Double_value>,
      "allowedmanagementinterface":<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/systemuser? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemuser":{
      "allowedmanagementinterface":true,
<b>      "username":<String_value>,
</b>      "externalauth":true,
      "promptstring":true,
      "timeout":true,
      "logging":true,
      "maxsession":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/systemuser

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/systemuser? 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/systemuser? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of systemuser 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/systemuser? pagesize=#no;pageno=#no

Use this query-parameter to get the systemuser 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:

{ "systemuser": [ {
      "username":<String_value>,
      "password":<String_value>,
      "encrypted":<Boolean_value>,
      "hashmethod":<String_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "promptinheritedfrom":<String_value>,
      "timeout":<Double_value>,
      "timeoutkind":<String_value>,
      "logging":<String_value>,
      "maxsession":<Double_value>,
      "allowedmanagementinterface":<String[]_value>,
      "allowedmanagementinterfacekind":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemuser/ username_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/systemuser/ username_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/systemuser/ username_value<String> ? view=summary

Use this query-parameter to get the summary output of systemuser 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:

{  "systemuser": [ {
      "username":<String_value>,
      "password":<String_value>,
      "encrypted":<Boolean_value>,
      "hashmethod":<String_value>,
      "externalauth":<String_value>,
      "promptstring":<String_value>,
      "promptinheritedfrom":<String_value>,
      "timeout":<Double_value>,
      "timeoutkind":<String_value>,
      "logging":<String_value>,
      "maxsession":<Double_value>,
      "allowedmanagementinterface":<String[]_value>,
      "allowedmanagementinterfacekind":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemuser? 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:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

systemuser

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

systemuser

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article