Docmost Octri Preview
POST/sso/ldap/{providerId}/login

Authenticate via LDAP

Authenticates a user against an LDAP provider. Supply the provider ID and the user's LDAP credentials; the login result may require an additional MFA step.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
providerIdstringrequired
The unique identifier of the LDAP provider, in UUID format.

LDAP credentials used to authenticate through the specified provider.

passwordstringrequired
LDAP password.
usernamestringrequired
LDAP username or Distinguished Name.

3 status codes
200Returns the LDAP login result, which may indicate that MFA is required.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when the credentials are invalid or the provider configuration is invalid.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
403Returned when the account is deactivated.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned for invalid credentials or provider configuration. A 403 is returned when the account is deactivated. username and password are required, and the providerId path parameter must be a UUID.