aaapreauthenticationparameter
Configuration for pre authentication parameter resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| preauthenticationaction | <String> | Read-write | Deny or allow login on the basis of end point analysis results.
Possible values = ALLOW, DENY
|
| rule | <String> | Read-write | Name of the Citrix ADC named rule, or an expression, to be evaluated by the EPA tool. |
| killprocess | <String> | Read-write | String specifying the name of a process to be terminated by the EPA tool. |
| deletefiles | <String> | Read-write | String specifying the path(s) to and name(s) of the files to be deleted by the EPA tool, as a string of between 1 and 1023 characters. |
Operations
(click to see Properties)
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 Citrix ADC appliance, the URL is as follows:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yesIf 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 Citrix ADC 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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/aaapreauthenticationparameter
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"aaapreauthenticationparameter":{
"preauthenticationaction":<String_value>,
"rule":<String_value>,
"killprocess":<String_value>,
"deletefiles":<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 Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/aaapreauthenticationparameter?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"aaapreauthenticationparameter":{
"rule":true,
"preauthenticationaction":true,
"killprocess":true,
"deletefiles":true
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/aaapreauthenticationparameter
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "aaapreauthenticationparameter": [ {
"preauthenticationaction":<String_value>,
"rule":<String_value>,
"killprocess":<String_value>,
"deletefiles":<String_value>
}]}