| getauthenticationldapactionResult Structure Definition |
The getauthenticationldapactionResult structure defines the return type for getauthenticationldapaction API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
authenticationldapactionList |
List of authenticationldapactions |
| authenticationldapaction Structure Definition |
The authenticationldapaction structure defines the actual return type values for getauthenticationldapaction API. |
Syntax |
Members |
name |
Name of the LDAP profile. |
serverip |
IP address assigned to the LDAP server. |
servername |
LDAP server name as a FQDN. Mutually exclusive with LDAP IP address. |
serverport |
Port on which the LDAP server accepts connections. |
authtimeout |
Number of seconds the Citrix ADC waits for a response from the RADIUS server. |
ldapbinddn |
Full distinguished name (DN) that is used to bind to the LDAP server.
Default: cn=Manager,dc=netscaler,dc=com |
ldapbinddnpassword |
Password used to bind to the LDAP server. |
ldaploginname |
LDAP login name attribute.
The Citrix ADC uses the LDAP login name to query external LDAP servers or Active Directories. |
ldapbase |
Base (node) from which to start LDAP searches.
If the LDAP server is running locally, the default value of base is dc=netscaler, dc=com. |
searchfilter |
String to be combined with the default LDAP user search string to form the search value. For example, if the search filter "vpnallowed=true" is combined with the LDAP login name "samaccount" and the user-supplied username is "bob", the result is the LDAP search string ""&(vpnallowed=true)(samaccount=bob)"" (Be sure to enclose the search string in two sets of double quotation marks; both sets are needed.). |
groupattrname |
LDAP group attribute name.
Used for group extraction on the LDAP server. |
subattributename |
LDAP group sub-attribute name.
Used for group extraction from the LDAP server. |
sectype |
Type of security used for communications between the Citrix ADC and the LDAP server. For the PLAINTEXT setting, no encryption is required. |
svrtype |
The type of LDAP server. |
ssonameattribute |
LDAP single signon (SSO) attribute.
The Citrix ADC uses the SSO name attribute to query external LDAP servers or Active Directories for an alternate username. |
authentication |
Perform LDAP authentication.
If authentication is disabled, any LDAP authentication attempt returns authentication success if the user is found.
CAUTION! Authentication should be disabled only for authorization group extraction or where other (non-LDAP) authentication methods are in use and either bound to a primary list or flagged as secondary. |
requireuser |
Require a successful user search for authentication.
CAUTION! This field should be set to NO only if usersearch not required [Both username validation as well as password validation skipped] and (non-LDAP) authentication methods are in use and either bound to a primary list or flagged as secondary. |
success |
failure |
nestedgroupextraction |
Allow nested group extraction, in which the Citrix ADC queries external LDAP servers to determine whether a group is part of another group. |
maxnestinglevel |
If nested group extraction is ON, specifies the number of levels up to which group extraction is performed. |
followreferrals |
Setting this option to ON enables following LDAP referrals received from the LDAP server. |
maxldapreferrals |
Specifies the maximum number of nested referrals to follow. |
referraldnslookup |
Specifies the DNS Record lookup Type for the referrals |
mssrvrecordlocation |
MSSRV Specific parameter. Used to locate the DNS node to which the SRV record pertains in the domainname. The domainname is appended to it to form the srv record.
Example : For "dc._msdcs", the srv record formed is _ldap._tcp.dc._msdcs. |
validateservercert |
When to validate LDAP server certs |
ldaphostname |
Hostname for the LDAP server. If -validateServerCert is ON then this must be the host name on the certificate from the LDAP server.
A hostname mismatch will cause a connection failure. |
groupnameidentifier |
Name that uniquely identifies a group in LDAP or Active Directory. |
groupsearchattribute |
LDAP group search attribute.
Used to determine to which groups a group belongs. |
groupsearchsubattribute |
LDAP group search subattribute.
Used to determine to which groups a group belongs. |
groupsearchfilter |
String to be combined with the default LDAP group search string to form the search value. For example, the group search filter ""vpnallowed=true"" when combined with the group identifier ""samaccount"" and the group name ""g1"" yields the LDAP search string ""(&(vpnallowed=true)(samaccount=g1)"". If nestedGroupExtraction is ENABLED, the filter is applied on the first level group search as well, otherwise first level groups (of which user is a direct member of) will be fetched without applying this filter. (Be sure to enclose the search string in two sets of double quotation marks; both sets are needed.) |
passwdchange |
Allow password change requests. |
defaultauthenticationgroup |
This is the default group that is chosen when the authentication succeeds in addition to extracted groups. |
attribute1 |
Expression that would be evaluated to extract attribute1 from the ldap response |
attribute2 |
Expression that would be evaluated to extract attribute2 from the ldap response |
attribute3 |
Expression that would be evaluated to extract attribute3 from the ldap response |
attribute4 |
Expression that would be evaluated to extract attribute4 from the ldap response |
attribute5 |
Expression that would be evaluated to extract attribute5 from the ldap response |
attribute6 |
Expression that would be evaluated to extract attribute6 from the ldap response |
attribute7 |
Expression that would be evaluated to extract attribute7 from the ldap response |
attribute8 |
Expression that would be evaluated to extract attribute8 from the ldap response |
attribute9 |
Expression that would be evaluated to extract attribute9 from the ldap response |
attribute10 |
Expression that would be evaluated to extract attribute10 from the ldap response |
attribute11 |
Expression that would be evaluated to extract attribute11 from the ldap response |
attribute12 |
Expression that would be evaluated to extract attribute12 from the ldap response |
attribute13 |
Expression that would be evaluated to extract attribute13 from the ldap response |
attribute14 |
Expression that would be evaluated to extract attribute14 from the ldap response |
attribute15 |
Expression that would be evaluated to extract attribute15 from the ldap response |
attribute16 |
Expression that would be evaluated to extract attribute16 from the ldap response |
attributes |
List of attribute names separated by ',' which needs to be fetched from ldap server.
Note that preceeding and trailing spaces will be removed.
Attribute name can be 127 bytes and total length of this string should not cross 2047 bytes.
These attributes have multi-value support separated by ',' and stored as key-value pair in AAA session |
otpsecret |
OneTimePassword(OTP) Secret key attribute on AD. This attribute is used to store and retrieve secret key used for OTP check |
sshpublickey |
SSH PublicKey is attribute on AD. This attribute is used to retrieve ssh PublicKey for RBA authentication |
pushservice |
Name of the service used to send push notifications |
email |
The Citrix ADC uses the email attribute to query the Active Directory for the email id of a user |
kbattribute |
KnowledgeBasedAuthentication(KBA) attribute on AD. This attribute is used to store and retrieve preconfigured Question and Answer knowledge base used for KBA authentication. |
alternateemailattr |
The NetScaler appliance uses the alternateive email attribute to query the Active Directory for the alternative email id of a user |
cloudattributes |
The Citrix ADC uses the cloud attributes to extract additional attributes from LDAP servers required for Citrix Cloud operations |
passwordlessmgmtaccess |
This feature configures NetScaler management access to use LDAP exclusively for retrieving user group information. It ensures that LDAP is not used for authenticating user logins (i.e., verifying passwords) for NetScaler management access. |
_nextgenapiresource |
See Also |