v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB

Configuration - Authentication

Create LDAP server

Create a new LDAP server.

post/ldap-servers

Request body

namestring required

The LDAP server name

descriptionstring

The LDAP server description(optional)

enable_tlsboolean required

To enable TLS or not, if ture, caCertificateId, clientCertificateId and clientKeyId must be specified

bind_dnstring required

The LDAP server bind DN name

bind_dn_passwordstring required

The LDAP server bind DN password

base_dnstring required

The RADIUS user base DN

l3_address_profile_idinteger required

The L3 address profile ID

protocol_type'LDAP' | 'LDAPS' required

LDAP server protocol type

enable_strip_realm_nameboolean required

enable strip realm name or not

destination_portinteger required

The LDAP server destination port (1 ~ 65535)

verification_mode'TRY' | 'NEVER' | 'DEMAND' required

The LDAP server verification mode

ca_certificate_idinteger

The CA certificate ID, refer to XiqCertificate

client_certificate_idinteger

The client certificate ID, refer to XiqCertificate

client_key_idinteger

The client key ID, refer to XiqCertificate

client_key_passwordstring

The LDAP server client key password

Response

Created

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

namestring required

The LDAP server name

descriptionstring

The LDAP server description

enable_tlsboolean

The LDAP server is enabled TLS or not

bind_dnstring

The LDAP server bind DN name

bind_dn_passwordstring

The LDAP server bind DN password

base_dnstring

The RADIUS user base DN

l3_address_profile_idinteger

The L3 address profile ID

protocol_type'LDAP' | 'LDAPS'

LDAP server protocol type

enable_strip_realm_nameboolean

Enable strip realm name or not

destination_portinteger

The LDAP server destination port

verification_mode'TRY' | 'NEVER' | 'DEMAND'

The LDAP server verification mode

ca_certificate_idinteger

The CA certificate ID

client_certificate_idinteger

The client certificate ID

client_key_idinteger

The client key ID

client_key_passwordstring

The LDAP server client key password