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

Description

Returns the current portal LDAP settings.

Parameters

This method doesn't have any parameters.

Example

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

Returns

LDAP settings

Example Response

application/json

{
  "status": 0,
  "response": {
    "EnableLdapAuthentication": true,
    "StartTls": true,
    "Ssl": true,
    "SendWelcomeEmail": true,
    "Server": "Server",
    "UserDN": "UserDN",
    "PortNumber": 1,
    "UserFilter": "UserFilter",
    "LoginAttribute": "LoginAttribute",
    "LdapMapping": null,
    "AccessRights": null,
    "FirstNameAttribute": "FirstNameAttribute",
    "SecondNameAttribute": "SecondNameAttribute",
    "MailAttribute": "MailAttribute",
    "TitleAttribute": "TitleAttribute",
    "MobilePhoneAttribute": "MobilePhoneAttribute",
    "LocationAttribute": "LocationAttribute",
    "GroupMembership": true,
    "GroupDN": "GroupDN",
    "GroupNameAttribute": "GroupNameAttribute",
    "GroupFilter": "GroupFilter",
    "UserAttribute": "UserAttribute",
    "GroupAttribute": "GroupAttribute",
    "Authentication": true,
    "Login": "Login",
    "Password": "Password",
    "PasswordBytes": [
      1
    ],
    "IsDefault": true,
    "AcceptCertificate": true,
    "AcceptCertificateHash": "AcceptCertificateHash"
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <EnableLdapAuthentication>True</EnableLdapAuthentication>
    <StartTls>True</StartTls>
    <Ssl>True</Ssl>
    <SendWelcomeEmail>True</SendWelcomeEmail>
    <Server>Server</Server>
    <UserDN>UserDN</UserDN>
    <PortNumber>1</PortNumber>
    <UserFilter>UserFilter</UserFilter>
    <LoginAttribute>LoginAttribute</LoginAttribute>
    <LdapMapping />
    <AccessRights />
    <FirstNameAttribute>FirstNameAttribute</FirstNameAttribute>
    <SecondNameAttribute>SecondNameAttribute</SecondNameAttribute>
    <MailAttribute>MailAttribute</MailAttribute>
    <TitleAttribute>TitleAttribute</TitleAttribute>
    <MobilePhoneAttribute>MobilePhoneAttribute</MobilePhoneAttribute>
    <LocationAttribute>LocationAttribute</LocationAttribute>
    <GroupMembership>True</GroupMembership>
    <GroupDN>GroupDN</GroupDN>
    <GroupNameAttribute>GroupNameAttribute</GroupNameAttribute>
    <GroupFilter>GroupFilter</GroupFilter>
    <UserAttribute>UserAttribute</UserAttribute>
    <GroupAttribute>GroupAttribute</GroupAttribute>
    <Authentication>True</Authentication>
    <Login>Login</Login>
    <Password>Password</Password>
    <PasswordBytes>1</PasswordBytes>
    <IsDefault>True</IsDefault>
    <AcceptCertificate>True</AcceptCertificate>
    <AcceptCertificateHash>AcceptCertificateHash</AcceptCertificateHash>
  </response>
</result>