LdapIdentitySourceServer

Ldap Identity Source Server

Connection details for the LDAP server backing an identity source.

JSON Example

{
    "url": "string",
    "certificates": [
        "string"
    ],
    "bind_identity": "string",
    "password": "string",
    "enabled": false
}

string

url

Required

The LDAP server URL, including scheme and port (for example ldaps://ldap.corp.example.com:636). Use the ldaps:// scheme for TLS.

array of string

certificates

Optional

PEM-encoded certificate(s) to trust when connecting to the LDAP server. Required when creating an LDAP identity source.

string

bind_identity

Optional

The account Installer uses to search the directory for users and groups, and to look up a user's distinguished name from their login name. Required when creating an LDAP identity source.

The expected format depends on ldap_type:

• Active Directory: a userPrincipalName (e.g. [email protected]) or the full distinguished name.
• OpenLDAP: the distinguished name of the user (e.g. uid=admin,cn=corp,dc=com).

string

password

Optional

The password for bind_identity. Not returned in any response.

boolean

enabled

Optional

Whether this server is actively used to authenticate users. Set to false to keep the configuration without allowing logins through it, for example while troubleshooting.