DKBSignDocs

API reference

PUTRequires Bearer token

Save LDAP directory settings

/api/companies/{company}/ldap/save

Company-admin. Bind password is omitted from the response. Leave ldap_bind_password blank to keep the stored secret.

Path parameters

FieldTypeDescription
company
Required
stringPath parameter company.

Query parameters

This endpoint has no query parameters.

Request body

FieldTypeDescription
ldap_enabled
booleanEnable directory integration.
e.g. true
ldap_host
stringLDAP host.
e.g. "ldap.acme.test"
ldap_base_dn
stringBase DN.
e.g. "dc=acme,dc=test"
ldap_bind_username
stringBind username.
ldap_bind_password
stringBind password (omit to keep the stored secret).
ldap_user_filter
stringSingle-user filter (max 500).
ldap_users_filter
stringDirectory listing filter (max 500).
ldap_default_role_id
integerRole assigned in default mode.
ldap_role_mode
stringdefault or ad_groups.
e.g. "default"
ldap_role_group_prefix
stringOptional AD group prefix (max 100).

Responses

StatusMeaning
200Saved
401Missing or invalid Bearer token.

Request

curl
curl -X PUT 'https://api.dkbsigns.com/api/companies/company/ldap/save' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"ldap_enabled":true,"ldap_host":"ldap.acme.test","ldap_base_dn":"dc=acme,dc=test","ldap_bind_username":"example","ldap_bind_password":"P@ssw0rd!","ldap_user_filter":"example","ldap_users_filter":"example","ldap_default_role_id":1,"ldap_role_mode":"default","ldap_role_group_prefix":"example"}'

Response 200

json
{
  "message": "Configuration LDAP enregistrée",
  "ldap": {
    "ldap_enabled": true,
    "ldap_host": "ldap.acme.test"
  }
}