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)

  • instanceId string
  • Instance ID of the endpoint

Methods

Authenticates the base64-encoded username:password credentials.

Fields

  • instanceId string
  • Instance ID of the endpoint

authenticate

(string credential)

returns boolean | Error

Authenticates the base64-encoded username:password credentials.

 boolean|auth:Error result = inboundLdapAuthProvider.authenticate("<credential>");

Parameters

  • credential string
  • Base64-encoded username:password value

  • Return Type

    (boolean | Error)
  • true if authentication is successful, false otherwise, or else an auth:Error occurred while authenticating the credentials