Functions -
ldap
doAuthenticate |
Authenticates with the username and password. |
externDoAuthenticate |
|
externInitLdapConnectionContext |
|
getGroups |
Retrieves the group(s) of the user related to the provided username. |
initLdapConnectionContext |
Initailizes the LDAP connection context. |
doAuthenticate
(LdapConnection ldapConnection, string username, string password)
returns boolean | ErrorAuthenticates with the username and password.
boolean|ldap:Error result = ldap:doAuthenticate(ldapConnection, username, password);
Parameters
- ldapConnection LdapConnection
-
The
ldap:LdapConnection
instance
- username string
-
Username of the user to be authenticated
- password string
-
Password of the user to be authenticated
-
Return Type
(boolean | Error) true
if authentication is successful,false
otherwise, or else anldap:Error
if an error occurred
externDoAuthenticate
(LdapConnection ldapConnection, handle username, handle password)
returns boolean | Error-
Return Type
(boolean | Error)
externInitLdapConnectionContext
(LdapConnectionConfig ldapConnectionConfig, handle instanceId)
returns LdapConnection | Error-
Return Type
(LdapConnection | Error)
Retrieves the group(s) of the user related to the provided username.
string[]|ldap:Error groups = ldap:getGroups(ldapConnection, username);
Parameters
- ldapConnection LdapConnection
-
The
ldap:LdapConnection
instance
- username string
-
Username of the user to be checked for the groups
-
Return Type
(string[] | Error) Array of groups of the provided user or else an
ldap:Error
if it fails
initLdapConnectionContext
(LdapConnectionConfig ldapConnectionConfig, string instanceId)
returns LdapConnection | ErrorInitailizes the LDAP connection context.
ldap:LdapConnection|ldap:Error connection = ldap:initLdapConnectionContext(ldapConnectionConfig, instanceId);
Parameters
- ldapConnectionConfig LdapConnectionConfig
-
The
ldap:LdapConnectionConfig
instance
- instanceId string
-
Instance ID of the endpoint
-
Return Type
(LdapConnection | Error) The
ldap:LdapConnection
instance or else anldap:Error
if an error occurred