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
- Accept
enum 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
- EnableLdapAuthentication
boolean
- StartTls
boolean
- Ssl
boolean
- SendWelcomeEmail
boolean
- Server
string
- UserDN
string
- PortNumber
integer
int32 - UserFilter
string
- LoginAttribute
string
- LdapMapping
object
- AccessRights
object
- FirstNameAttribute
string
- SecondNameAttribute
string
- MailAttribute
string
- TitleAttribute
string
- MobilePhoneAttribute
string
- LocationAttribute
string
- GroupMembership
boolean
- GroupDN
string
- GroupNameAttribute
string
- GroupFilter
string
- UserAttribute
string
- GroupAttribute
string
- Authentication
boolean
- Login
string
- Password
string
- PasswordBytes
array of object
- IsDefault
boolean
- AcceptCertificate
boolean
- AcceptCertificateHash
string
401
Unauthorized