Product Documentation

authenticationauthnprofile

Sep 01, 2016

Configuration for Authentication profile resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the authentication profile.
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. Cannot be changed after the RADIUS action is added.
Minimum length = 1
authnvsname
<String>
Read-write
Name of the authentication vserver at which authentication should be done.
Minimum length = 1
Maximum length = 128
authenticationhost
<String>
Read-write
Hostname of the authentication vserver to which user must be redirected for authentication.
Minimum length = 1
Maximum length = 256
authenticationdomain
<String>
Read-write
Domain for which TM cookie must to be set. If unspecified, cookie will be set for FQDN.
Minimum length = 1
Maximum length = 256
authenticationlevel
<Double>
Read-write
Authentication weight or level of the vserver to which this will bound. This is used to order TM vservers based on the protection required. A session that is created by authenticating against TM vserver at given level cannot be used to access TM vserver at a higher level.
Minimum value = 0
Maximum value = 255
__count
<Double>
Read-only
count parameter

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

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"authenticationauthnprofile":{
      "name":<String_value>,
      "authnvsname":<String_value>,
      "authenticationhost":<String_value>,
      "authenticationdomain":<String_value>,
      "authenticationlevel":<Double_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/authenticationauthnprofile/name_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

update

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"authenticationauthnprofile":{
      "name":<String_value>,
      "authnvsname":<String_value>,
      "authenticationhost":<String_value>,
      "authenticationdomain":<String_value>,
      "authenticationlevel":<Double_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/authenticationauthnprofile?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"authenticationauthnprofile":{
      "name":<String_value>,
      "authenticationdomain":true,
      "authenticationlevel":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/authenticationauthnprofile

Query-parameters:

attrs

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

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

view

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

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

pagination

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

Use this query-parameter to get the authenticationauthnprofile 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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationauthnprofile": [ {
      "name":<String_value>,
      "authnvsname":<String_value>,
      "authenticationhost":<String_value>,
      "authenticationdomain":<String_value>,
      "authenticationlevel":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationauthnprofile/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/authenticationauthnprofile/name_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/authenticationauthnprofile/name_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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationauthnprofile": [ {
      "name":<String_value>,
      "authnvsname":<String_value>,
      "authenticationhost":<String_value>,
      "authenticationdomain":<String_value>,
      "authenticationlevel":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationauthnprofile?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 error

Response Headers:

Content-Type:application/json

Response Payload:

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