Get Started
API backend
API system
More information

GET api/2.0/settings/ldap/default This function requires authentication

Description

Returns the LDAP default settings.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/settings/ldap/default
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

LDAP default settings: enable LDAP authentication or not, start TLS or not, enable SSL or not, send welcome email or not, server name, user name, port number, user filter, login attribute, LDAP settings mapping, access rights, user is a group member or not, group name, user attribute, group filter, group attribute, group name attribute, authentication is enabled or not, login, password, accept certificate or not

Example Response

application/json

{
  "status": 0,
  "response": {
    "EnableLdapAuthentication": true,
    "StartTls": true,
    "Ssl": true,
    "SendWelcomeEmail": true,
    "Server": "some text",
    "UserDN": "some text",
    "PortNumber": 1234,
    "UserFilter": "some text",
    "LoginAttribute": "some text",
    "GroupMembership": true,
    "GroupDN": "some text",
    "UserAttribute": "some text",
    "GroupAttribute": "some text",
    "GroupNameAttribute": "some text",
    "Authentication": true,
    "Login": "some text",
    "Password": "some text",
    "AcceptCertificate": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <EnableLdapAuthentication>True</EnableLdapAuthentication>
    <StartTls>True</StartTls>
    <Ssl>True</Ssl>
    <SendWelcomeEmail>True</SendWelcomeEmail>
    <Server>some text</Server>
    <UserDN>some text</UserDN>
    <PortNumber>1234</PortNumber>
    <UserFilter>some text</UserFilter>
    <LoginAttribute>some text</LoginAttribute>
    <GroupMembership>True</GroupMembership>
    <GroupDN>some text</GroupDN>
    <UserAttribute>some text</UserAttribute>
    <GroupAttribute>some text</GroupAttribute>
    <GroupNameAttribute>some text</GroupNameAttribute>
    <Authentication>True</Authentication>
    <Login>some text</Login>
    <Password>some text</Password>
    <AcceptCertificate>True</AcceptCertificate>
  </response>
</result>