Download full document:

authenticationpolicylabel

Configuration for authentication policy label resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
labelname<String>Read-writeName for the new authentication policy label.
Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my authentication policy label" or 'authentication policy label').
type<String>Read-writeType of feature (aaatm or rba) against which to match the policies bound to this policy label.
Default value: AAATM_REQ
Possible values = AAATM_REQ, RBA_REQ
comment<String>Read-writeAny comments to preserve information about this authentication policy label.
loginschema<String>Read-writeLogin schema associated with authentication policy label. Login schema defines the UI rendering by providing customization option of the fields. If user intervention is not needed for a given factor such as group extraction, a loginSchema whose authentication schema is "noschema" should be used.
newname<String>Read-writeThe new name of the auth policy label.
Minimum length = 1
numpol<Double>Read-onlyNumber of polices bound to label.
hits<Double>Read-onlyNumber of times policy label was invoked.
policyname<String>Read-onlyName of the authentication policy to bind to the policy label.
priority<Double>Read-onlySpecifies the priority of the policy.
gotopriorityexpression<String>Read-onlyExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
flowtype<Double>Read-onlyFlowtype of the bound authentication policy.
description<String>Read-onlyDescription of the policylabel.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| DELETE| RENAME| 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 redand placeholder content is marked in <green>.

add

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

HTTP Method:POST

Request Headers:

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

Request Payload:

{"authenticationpolicylabel":{
<b>"labelname":<String_value>,
</b>"type":<String_value>,
"comment":<String_value>,
"loginschema":<String_value>
}}

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/authenticationpolicylabel/labelname_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

rename

URL:http://<netscaler-ip-address>/nitro/v1/config/authenticationpolicylabel?action=rename

HTTP Method:POST

Request Headers:

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

Request Payload:

{"authenticationpolicylabel":{
<b>"labelname":<String_value>,
</b><b>"newname":<String_value>
</b>}}

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

Query-parameters:

attrs

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

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

view

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

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/authenticationpolicylabel?pagesize=#no;pageno=#no

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

Content-Type:application/json

Response Payload:

{ "authenticationpolicylabel": [ {
"labelname":<String_value>,
"numpol":<Double_value>,
"hits":<Double_value>,
"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"flowtype":<Double_value>,
"description":<String_value>,
"comment":<String_value>,
"loginschema":<String_value>,
"type":<String_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/config/authenticationpolicylabel/labelname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/authenticationpolicylabel/labelname_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/authenticationpolicylabel/labelname_value<String>?view=summary

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

Content-Type:application/json

Response Payload:

{ "authenticationpolicylabel": [ {
"labelname":<String_value>,
"numpol":<Double_value>,
"hits":<Double_value>,
"policyname":<String_value>,
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"flowtype":<Double_value>,
"description":<String_value>,
"comment":<String_value>,
"loginschema":<String_value>,
"type":<String_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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