Download full document:

aaacertparams

Configuration for certificate parameter resource.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
usernamefield	<String>	Read-write	Client certificate field that contains the username, in the format ;lt;field;gt;:;lt;subfield;gt;. .
groupnamefield	<String>	Read-write	Client certificate field that specifies the group, in the format ;lt;field;gt;:;lt;subfield;gt;.
defaultauthenticationgroup	<String>	Read-write	This is the default group that is chosen when the authentication succeeds in addition to extracted groups.<br>Maximum length = 64
twofactor	<String>	Read-only	The state of the two-factor authentication.<br>Possible values = ON, OFF

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 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>.

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload:

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"aaacertparams":{
      "usernamefield":<String_value>,
      "groupnamefield":<String_value>,
      "defaultauthenticationgroup":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload:

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"aaacertparams":{
      "usernamefield":true,
      "groupnamefield":true,
      "defaultauthenticationgroup":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/aaacertparams

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "aaacertparams": [ {
      "twofactor":<String_value>,
      "usernamefield":<String_value>,
      "groupnamefield":<String_value>,
      "defaultauthenticationgroup":<String_value>

}]}