Product Documentation

authenticationloginschema

Sep 01, 2016

Configuration for 0 resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the new login schema. Login schema defines the way login form is rendered. It provides a way to customize the fields that are shown to the user. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
Minimum length = 1
authenticationschema
<String>
Read-write
Name of the file for reading authentication schema to be sent for Login Page UI. This file should contain xml definition of elements as per Citrix Forms Authentication Protocol to be able to render login form. If administrator does not want to prompt users for additional credentials but continue with previously obtained credentials, then "noschema" can be given as argument. Please note that this applies only to loginSchemas that are used with user-defined factors, and not the vserver factor.
Minimum length = 1
userexpression
<String>
Read-write
Expression for username extraction during login. This can be any relevant advanced policy expression.
Minimum length = 1
passwdexpression
<String>
Read-write
Expression for password extraction during login. This can be any relevant advanced policy expression.
Minimum length = 1
usercredentialindex
<Double>
Read-write
The index at which user entered username should be stored in session.
Minimum value = 1
Maximum value = 16
passwordcredentialindex
<Double>
Read-write
The index at which user entered password should be stored in session.
Minimum value = 1
Maximum value = 16
authenticationstrength
<Double>
Read-write
Weight of the current authentication.
Minimum value = 0
Maximum value = 65535
builtin
<String[]>
Read-only
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__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/authenticationloginschema

HTTP Method: POST

Request Headers:

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

Request Payload:

{"authenticationloginschema":{
      "name":<String_value>,
      "authenticationschema":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>,
      "usercredentialindex":<Double_value>,
      "passwordcredentialindex":<Double_value>,
      "authenticationstrength":<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/authenticationloginschema/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/authenticationloginschema

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"authenticationloginschema":{
      "name":<String_value>,
      "authenticationschema":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>,
      "usercredentialindex":<Double_value>,
      "passwordcredentialindex":<Double_value>,
      "authenticationstrength":<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/authenticationloginschema?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"authenticationloginschema":{
      "name":<String_value>,
      "userexpression":true,
      "passwdexpression":true,
      "usercredentialindex":true,
      "passwordcredentialindex":true,
      "authenticationstrength":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/authenticationloginschema

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

{ "authenticationloginschema": [ {
      "name":<String_value>,
      "authenticationschema":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>,
      "usercredentialindex":<Double_value>,
      "passwordcredentialindex":<Double_value>,
      "authenticationstrength":<Double_value>,
      "builtin":<String[]_value>
}]}

get

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

Query-parameters:

attrs

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

{ "authenticationloginschema": [ {
      "name":<String_value>,
      "authenticationschema":<String_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>,
      "usercredentialindex":<Double_value>,
      "passwordcredentialindex":<Double_value>,
      "authenticationstrength":<Double_value>,
      "builtin":<String[]_value>
}]}

count

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

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