---
title: "Create LDAP server"
method: POST
path: "/ldap-servers"
tags: ["Configuration - Authentication"]
---

# Create LDAP server

`POST /ldap-servers`

Create a new LDAP server.

## Request body

- XiqCreateLdapServerRequest
  - `name` string, required — The LDAP server name
  - `description` string — The LDAP server description(optional)
  - `enable_tls` boolean, required — To enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified
  - `bind_dn` string, required — The LDAP server bind DN name
  - `bind_dn_password` string, required — The LDAP server bind DN password
  - `base_dn` string, required — The RADIUS user base DN
  - `l3_address_profile_id` integer, required — The L3 address profile ID
  - `protocol_type` 'LDAP' | 'LDAPS', required — LDAP server protocol type
  - `enable_strip_realm_name` boolean, required — enable strip realm name or not
  - `destination_port` integer, required — The LDAP server destination port (1 ~ 65535)
  - `verification_mode` 'TRY' | 'NEVER' | 'DEMAND', required — The LDAP server verification mode
  - `ca_certificate_id` integer — The CA certificate ID, refer to XiqCertificate
  - `client_certificate_id` integer — The client certificate ID, refer to XiqCertificate
  - `client_key_id` integer — The client key ID, refer to XiqCertificate
  - `client_key_password` string — The LDAP server client key password

## Response `201`

Created

- XiqLdapServer — The common object - LDAP server
  - `id` integer, required — The unique identifier
  - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
  - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
  - `name` string, required — The LDAP server name
  - `description` string — The LDAP server description
  - `enable_tls` boolean — The LDAP server is enabled TLS or not
  - `bind_dn` string — The LDAP server bind DN name
  - `bind_dn_password` string — The LDAP server bind DN password
  - `base_dn` string — The RADIUS user base DN
  - `l3_address_profile_id` integer — The L3 address profile ID
  - `protocol_type` 'LDAP' | 'LDAPS' — LDAP server protocol type
  - `enable_strip_realm_name` boolean — Enable strip realm name or not
  - `destination_port` integer — The LDAP server destination port
  - `verification_mode` 'TRY' | 'NEVER' | 'DEMAND' — The LDAP server verification mode
  - `ca_certificate_id` integer — The CA certificate ID
  - `client_certificate_id` integer — The client certificate ID
  - `client_key_id` integer — The client key ID
  - `client_key_password` string — The LDAP server client key password

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)