Skip to main content
POST
cURL
Check out the configuration docs for LDAP Connections to learn how to obtain the required credentials.

Body

application/json
method
enum<string>
required

The method used to authenticate with LDAP.

Available options:
simple-bind
credentials
object
required

The credentials used to connect with LDAP.

name
string
required

The name of the LDAP Connection to create. Must be slug-friendly.

Required string length: 1 - 64
description
string | null

An optional description for the LDAP Connection.

Maximum string length: 256
projectId
string

The ID of the project to create the LDAP Connection in.

isPlatformManagedCredentials
enum<boolean>

Not supported for LDAP Connections.

Available options:
false
gatewayId
string<uuid> | null

The Gateway ID to use for this connection.

gatewayPoolId
string<uuid> | null

The Gateway Pool ID to use for this connection.

isAutoRotationEnabled
boolean

Whether or not automatic credential rotation is enabled for the LDAP Connection.

rotation
object

The credential rotation configuration for the LDAP Connection.

Response

Default Response

appConnection
LDAP (Simple Bind) · object
required