Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

aaapreauthenticationparameter

May 23, 2024
Contributed by: 
C

Configuration for pre authentication parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
preauthenticationaction Read-write Deny or allow login on the basis of end point analysis results.

Possible values = ALLOW, DENY
rule Read-write Name of the Citrix ADC named rule, or an expression, to be evaluated by the EPA tool.
killprocess Read-write String specifying the name of a process to be terminated by the EPA tool.
deletefiles 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.
builtin <String[]> Read-only Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature Read-only The feature to be checked while applying this config.

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

unset

URL: http:// <netscaler-ip-address> /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
}}

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

update

URL: http:// <netscaler-ip-address> /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>
}}

<!--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/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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{ "aaapreauthenticationparameter": [ {
"preauthenticationaction":<String_value>,
"rule":<String_value>,
"killprocess":<String_value>,
"deletefiles":<String_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->
aaapreauthenticationparameter
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.