Skip to content

authenticationvserver_binding

Binding object which returns the resources bound to authenticationvserver.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the authentication virtual server.
Minimum length = 1
authenticationvserver_auditnslogpolicy_binding<authenticationvserver_auditnslogpolicy_binding[]>Read-onlyauditnslogpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationpolicy_binding<authenticationvserver_authenticationpolicy_binding[]>Read-onlyauthenticationpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationradiuspolicy_binding<authenticationvserver_authenticationradiuspolicy_binding[]>Read-onlyauthenticationradiuspolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationldappolicy_binding<authenticationvserver_authenticationldappolicy_binding[]>Read-onlyauthenticationldappolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationsamlidppolicy_binding<authenticationvserver_authenticationsamlidppolicy_binding[]>Read-onlyauthenticationsamlidppolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationwebauthpolicy_binding<authenticationvserver_authenticationwebauthpolicy_binding[]>Read-onlyauthenticationwebauthpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationlocalpolicy_binding<authenticationvserver_authenticationlocalpolicy_binding[]>Read-onlyauthenticationlocalpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationnegotiatepolicy_binding<authenticationvserver_authenticationnegotiatepolicy_binding[]>Read-onlyauthenticationnegotiatepolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationtacacspolicy_binding<authenticationvserver_authenticationtacacspolicy_binding[]>Read-onlyauthenticationtacacspolicy that can be bound to authenticationvserver.
authenticationvserver_vpnportaltheme_binding<authenticationvserver_vpnportaltheme_binding[]>Read-onlyvpnportaltheme that can be bound to authenticationvserver.
authenticationvserver_authenticationsamlpolicy_binding<authenticationvserver_authenticationsamlpolicy_binding[]>Read-onlyauthenticationsamlpolicy that can be bound to authenticationvserver.
authenticationvserver_cspolicy_binding<authenticationvserver_cspolicy_binding[]>Read-onlycspolicy that can be bound to authenticationvserver.
authenticationvserver_auditsyslogpolicy_binding<authenticationvserver_auditsyslogpolicy_binding[]>Read-onlyauditsyslogpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationloginschemapolicy_binding<authenticationvserver_authenticationloginschemapolicy_binding[]>Read-onlyauthenticationloginschemapolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationcertpolicy_binding<authenticationvserver_authenticationcertpolicy_binding[]>Read-onlyauthenticationcertpolicy that can be bound to authenticationvserver.
authenticationvserver_tmsessionpolicy_binding<authenticationvserver_tmsessionpolicy_binding[]>Read-onlytmsessionpolicy that can be bound to authenticationvserver.
authenticationvserver_authenticationoauthidppolicy_binding<authenticationvserver_authenticationoauthidppolicy_binding[]>Read-onlyauthenticationoauthidppolicy that can be bound to authenticationvserver.

Operations

(click to see Properties)

GET| 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 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>.

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationvserver_binding/name_value<String>

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:

{ "authenticationvserver_binding": [ {
"name":<String_value>,
"authenticationvserver_authenticationlocalpolicy_binding":<authenticationvserver_authenticationlocalpolicy_binding[]_value>,
"authenticationvserver_tmsessionpolicy_binding":<authenticationvserver_tmsessionpolicy_binding[]_value>,
"authenticationvserver_cspolicy_binding":<authenticationvserver_cspolicy_binding[]_value>,
"authenticationvserver_auditsyslogpolicy_binding":<authenticationvserver_auditsyslogpolicy_binding[]_value>,
"authenticationvserver_authenticationsamlidppolicy_binding":<authenticationvserver_authenticationsamlidppolicy_binding[]_value>,
"authenticationvserver_auditnslogpolicy_binding":<authenticationvserver_auditnslogpolicy_binding[]_value>,
"authenticationvserver_authenticationldappolicy_binding":<authenticationvserver_authenticationldappolicy_binding[]_value>,
"authenticationvserver_authenticationcertpolicy_binding":<authenticationvserver_authenticationcertpolicy_binding[]_value>,
"authenticationvserver_authenticationsamlpolicy_binding":<authenticationvserver_authenticationsamlpolicy_binding[]_value>,
"authenticationvserver_authenticationpolicy_binding":<authenticationvserver_authenticationpolicy_binding[]_value>,
"authenticationvserver_vpnportaltheme_binding":<authenticationvserver_vpnportaltheme_binding[]_value>,
"authenticationvserver_authenticationoauthidppolicy_binding":<authenticationvserver_authenticationoauthidppolicy_binding[]_value>,
"authenticationvserver_authenticationradiuspolicy_binding":<authenticationvserver_authenticationradiuspolicy_binding[]_value>,
"authenticationvserver_authenticationloginschemapolicy_binding":<authenticationvserver_authenticationloginschemapolicy_binding[]_value>,
"authenticationvserver_authenticationtacacspolicy_binding":<authenticationvserver_authenticationtacacspolicy_binding[]_value>,
"authenticationvserver_authenticationwebauthpolicy_binding":<authenticationvserver_authenticationwebauthpolicy_binding[]_value>,
"authenticationvserver_authenticationnegotiatepolicy_binding":<authenticationvserver_authenticationnegotiatepolicy_binding[]_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationvserver_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationvserver_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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:

{ "authenticationvserver_binding": [ {
"name":<String_value>,
"authenticationvserver_authenticationlocalpolicy_binding":<authenticationvserver_authenticationlocalpolicy_binding[]_value>,
"authenticationvserver_tmsessionpolicy_binding":<authenticationvserver_tmsessionpolicy_binding[]_value>,
"authenticationvserver_cspolicy_binding":<authenticationvserver_cspolicy_binding[]_value>,
"authenticationvserver_auditsyslogpolicy_binding":<authenticationvserver_auditsyslogpolicy_binding[]_value>,
"authenticationvserver_authenticationsamlidppolicy_binding":<authenticationvserver_authenticationsamlidppolicy_binding[]_value>,
"authenticationvserver_auditnslogpolicy_binding":<authenticationvserver_auditnslogpolicy_binding[]_value>,
"authenticationvserver_authenticationldappolicy_binding":<authenticationvserver_authenticationldappolicy_binding[]_value>,
"authenticationvserver_authenticationcertpolicy_binding":<authenticationvserver_authenticationcertpolicy_binding[]_value>,
"authenticationvserver_authenticationsamlpolicy_binding":<authenticationvserver_authenticationsamlpolicy_binding[]_value>,
"authenticationvserver_authenticationpolicy_binding":<authenticationvserver_authenticationpolicy_binding[]_value>,
"authenticationvserver_vpnportaltheme_binding":<authenticationvserver_vpnportaltheme_binding[]_value>,
"authenticationvserver_authenticationoauthidppolicy_binding":<authenticationvserver_authenticationoauthidppolicy_binding[]_value>,
"authenticationvserver_authenticationradiuspolicy_binding":<authenticationvserver_authenticationradiuspolicy_binding[]_value>,
"authenticationvserver_authenticationloginschemapolicy_binding":<authenticationvserver_authenticationloginschemapolicy_binding[]_value>,
"authenticationvserver_authenticationtacacspolicy_binding":<authenticationvserver_authenticationtacacspolicy_binding[]_value>,
"authenticationvserver_authenticationwebauthpolicy_binding":<authenticationvserver_authenticationwebauthpolicy_binding[]_value>,
"authenticationvserver_authenticationnegotiatepolicy_binding":<authenticationvserver_authenticationnegotiatepolicy_binding[]_value>
}]}