Cluster

Update LDAP configuration

Changed on Sep 10, 2026

Set or partially update the LDAP configuration for the cluster

put/v1/cluster/ldap

Request

Base URL
https://localhost:9443
URL
https://localhost:9443/v1/cluster/ldap
Auth
API key in header r-auth-user

Request body

bind_dnstring

A DN to use when binding with the LDAP server to run queries

bind_passstring

A password to use when binding with the LDAP server to run queries. Returned as a masked value on GET.

ca_certstring

A PEM-encoded CA certificate(s) to use for validating TLS connections to the LDAP server

cache_ttlinteger

Maximum TTL of cached entries, in seconds

cbaboolean

Whether to allow LDAP as an identity source for certificate-based authentication

cba_identity_oidstring

The certificate subject OID to use when cba_identity_source is set to subject_oid

cba_identity_source'subject_cn' | 'subject_oid'

The certificate subject identity source to use for LDAP lookup

control_planeboolean

Whether to use LDAP for user authentication/authorization in the control-plane

data_planeboolean

Whether to use LDAP for user authentication/authorization in the data-plane

directory_timeout_sinteger

The connection timeout to the LDAP server when authenticating a user, in seconds

dn_group_attrstring

The name of an attribute of the LDAP user entity that contains a list of the groups that user belongs to. (Mutually exclusive with "dn_group_query")

retry_attemptsinteger

Number of retry attempts for retryable LDAP connectivity failures

retry_backoff_msinteger

Backoff between LDAP retry attempts, in milliseconds

starttlsboolean

Whether to use StartTLS negotiation for the LDAP connection

urisstring[]

URIs of LDAP servers containing only the schema, the host, and the port

user_dn_templatestring

A string template that maps between the username provided to the cluster for authentication, and the LDAP DN. The special substring "%u" shall be replaced with the username. (Mutually exclusive with "user_dn_query")

Response

LDAP configuration