Download full document:

aaacertparams

Configuration for certificate parameter resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
usernamefield<String>Read-writeClient certificate field that contains the username, in the format <field>:<subfield>. .
groupnamefield<String>Read-writeClient certificate field that specifies the group, in the format <field>:<subfield>.
defaultauthenticationgroup<String>Read-writeThis is the default group that is chosen when the authentication succeeds in addition to extracted groups.
Maximum length = 64
twofactor<String>Read-onlyThe state of the two-factor authentication.
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 redand placeholder content is marked in <green>.

update

URL:http://<netscaler-ip-address>/nitro/v1/config/aaacertparams

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"aaacertparams":{
"usernamefield":<String_value>,
"groupnamefield":<String_value>,
"defaultauthenticationgroup":<String_value>
}}

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/aaacertparams?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"aaacertparams":{
"usernamefield":true,
"groupnamefield":true,
"defaultauthenticationgroup":true
}}

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/aaacertparams

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "aaacertparams": [ {
"twofactor":<String_value>,
"usernamefield":<String_value>,
"groupnamefield":<String_value>,
"defaultauthenticationgroup":<String_value>
}]}