Get the LDAP settings

GET /api/2.0/settings/ldap

Request

Returns the current portal LDAP settings.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Examples

GET /api/2.0/settings/ldap HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/settings/ldap \
  --header 'Accept: application/json'

Responses

200

LDAP settings

EnableLdapAuthenticationboolean
StartTlsboolean
Sslboolean
SendWelcomeEmailboolean
Serverstring
UserDNstring
PortNumberintegerformat: int32
UserFilterstring
LoginAttributestring
LdapMappingobject
AccessRightsobject
FirstNameAttributestring
SecondNameAttributestring
MailAttributestring
TitleAttributestring
MobilePhoneAttributestring
LocationAttributestring
GroupMembershipboolean
GroupDNstring
GroupNameAttributestring
GroupFilterstring
UserAttributestring
GroupAttributestring
Authenticationboolean
Loginstring
Passwordstring
PasswordBytesarray of object
IsDefaultboolean
AcceptCertificateboolean
AcceptCertificateHashstring

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).