Object -
ldap
:
InboundLdapAuthProvider
Represents the inbound LDAP auth provider. This connects to an active directory or an LDAP, retrieves the necessary
user information, and performs authentication and authorization.
The ldap:InboundLdapAuthProvider is another implementation of the auth:InboundAuthProvider interface.
ldap:InboundLdapAuthProvider inboundLdapAuthProvider = new(ldapConfig, "instanceId");
Constructor
__init
(LdapConnectionConfig ldapConnectionConfig, string instanceId)
- ldapConnectionConfig LdapConnectionConfig
-
The
ldap:LdapConnectionConfiginstance
- instanceId string
-
Instance ID of the endpoint
Methods
Authenticates the base64-encoded username:password credentials.
Fields
- instanceId string
-
Instance ID of the endpoint
- ldapConnection LdapConnection
-
LDAP connection instance
- ldapConnectionConfig LdapConnectionConfig
-
LDAP connection configurations
Authenticates the base64-encoded username:password credentials.
boolean|auth:Error result = inboundLdapAuthProvider.authenticate("<credential>");
Parameters
- credential string
-
Base64-encoded
username:passwordvalue
-
Return Type
(boolean | Error) trueif authentication is successful,falseotherwise, or else anauth:Erroroccurred while authenticating the credentials