v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
LDAP SSO

Update LDAP config

patch/api/v1/ldap/config

Request body

isActiveboolean

Whether to enable or disable this LDAP configuration.

urlstring

The LDAP server to connect to such as ldap://ldap.your-org.com, ldaps://ldap.myorg.com:636 (for connection over SSL/TLS), etc.

bindDNstring

The distinguished name of object to bind when performing the user search such as cn=infisical,ou=Users,dc=acme,dc=com

bindPassstring

The password to use along with Bind DN when performing the user search.

uniqueUserAttributestring

The attribute to use as the unique identifier of LDAP users such as sAMAccountName, cn, uid, objectGUID. If left blank, defaults to uidNumber

searchBasestring

The base DN to use for the user search such as ou=Users,dc=acme,dc=com

searchFilterstring

The template used to construct the LDAP user search filter such as (uid={{username}}) uses literal {{username}} to have the given username used in the search. The default is (uid={{username}}) which is compatible with several common directory schemas.

groupSearchBasestring

LDAP search base to use for group membership search such as ou=Groups,dc=acme,dc=com

groupSearchFilterstring

The template used when constructing the group membership query such as (&(objectClass=posixGroup)(memberUid={{.Username}})). The template can access the following context variables: [UserDN, UserName]. The default is (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})) which is compatible with several common directory schemas.

caCertstring

The CA certificate to use when verifying the LDAP server certificate.

clientCertificatestring

PEM-encoded client certificate presented during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientKeyCertificate.

clientKeyCertificatestring

PEM-encoded private key matching the client certificate, used during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientCertificate.

organizationIdstring required

The ID of the organization to update the LDAP config for.

Response

Default Response

updatedAtstring date-time required
createdAtstring date-time required
isActiveboolean required
orgIdstring uuid required
idstring uuid required
urlstring required
searchBasestring required
searchFilterstring
groupSearchBasestring
uniqueUserAttributestring
groupSearchFilterstring