WildFly Full 23 Model Reference

  1. home
  2. core-service=management
  3. ldap-connection
Deprecated Since 1.7.0
The ldap-connection configuration is deprecated and may be removed or moved in future versions.

A connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.

Children (1)

  • property A custom property to use when establishing the LDAP connection.

Attributes (9)

  • always-send-client-cert If true, the client SSL certificate will be sent to LDAP server with every request; otherwise the client SSL certificate will not be sent when verifying the user credentials
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • handles-referrals-for List of URLs that this connection handles referrals for.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • initial-context-factory The initial context factory to establish the LdapContext.
    • Attribute Value
    Default Value com.sun.jndi.ldap.LdapCtxFactory
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • referrals The referral handling mode for this connection.
    • Attribute Value
    Default Value IGNORE
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values FOLLOW
    IGNORE
    THROW
  • search-credential The credential to use when connecting to perform a search.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • search-credential-reference The reference to the search credential stored in CredentialStore under defined alias or clear text password.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • search-dn The distinguished name to use when connecting to the LDAP server to perform searches.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • security-realm The security realm to reference to obtain a configured SSLContext to use when establishing the connection.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • url The URL to use to connect to the LDAP server.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (2)

  • add Adds a connection factory that can be used by a security realm to access an LDAP server as a source of authentication and authorization information.
    Request Parameter Type Required Expressions Allowed Default value Description
    always-send-client-cert BOOLEAN false true false If true, the client SSL certificate will be sent to LDAP server with every request; otherwise the client SSL certificate will not be sent when verifying the user credentials
    handles-referrals-for LIST false true List of URLs that this connection handles referrals for.
    initial-context-factory STRING false true com.sun.jndi.ldap.LdapCtxFactory The initial context factory to establish the LdapContext.
    referrals STRING false true IGNORE The referral handling mode for this connection.
    search-credential STRING false true The credential to use when connecting to perform a search.
    search-credential-reference OBJECT false false The reference to the search credential stored in CredentialStore under defined alias or clear text password.
    search-dn STRING false true The distinguished name to use when connecting to the LDAP server to perform searches.
    security-realm STRING false false The security realm to reference to obtain a configured SSLContext to use when establishing the connection.
    url STRING true true The URL to use to connect to the LDAP server.
  • remove Removes a connection factory that was usable by a security realm to access an LDAP server as a source of authentication and authorization information.