Native
Synchronous
No Custom Parameters
AuthenticateUser will connect and bind to an LDAP server to test the credentials of a user.
The boolean Authenticated result data parameter should only be used if the action returns Success. Any other case indicates that the operation failed for other reasons, such as connectivity or an unexpected LDAP-protocol error.
The branch condition returned provides useful information in determining the cause of failure:
ConnectionFailure indicates that it was not possible to connect to the LDAP server.
Failureor that the action failed unexpectedly for a non-LDAP protocol related reason.
None.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| LdapServerHost * | System.String | The IP address or host name of the LDAP server. | |
| LdapServerPort | System.UInt32 | 0 | The port of the LDAP server. |
| Username | System.String | A user to test. | |
| Password | System.String | The password of the user specified in the Username action parameter. | |
| Version | System.Int32 | 3 | The version of the LDAP server being connected to. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| Authenticated | System.Boolean | Indicates if the credentials were used successfully to bind to the LDAP server. Only valid on Success. |
| ErrorCode | System.Int32 | An LDAP protocol-specific error code if the action fails due to ConnectionFailure. Note that in the case of ConnectionFailure, it is not guaranteed that the error code will be populated. The error code will be 0 in the case that no LDAP-specific error code could be found. |
| ErrorMessage | System.String | An LDAP protocol-specific error message if the action fails due to ConnectionFailure. Note that in the case of ConnectionFailure, it is not guaranteed that the error message will be populated. The error code will be null in the case that no LDAP-specific error message could be found. |
Branch Conditions
No description.
No description.
No description.