Sign in
sources

LDAP Source Viewset

post/sources/ldap/

Request body

namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean
promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]
group_property_mappingsstring[]
policy_engine_mode'all' | 'any'
user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'
user_path_templatestring
iconstring
server_uristring uri required
peer_certificatestring uuid nullable

Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair.

client_certificatestring uuid nullable

Client certificate to authenticate against the LDAP Server's Certificate.

bind_cnstring
bind_passwordstring
start_tlsboolean
sniboolean
base_dnstring required
additional_user_dnstring

Prepended to Base DN for User-queries.

additional_group_dnstring

Prepended to Base DN for Group-queries.

user_object_filterstring

Consider Objects matching this filter to be Users.

group_object_filterstring

Consider Objects matching this filter to be Groups.

group_membership_fieldstring

Field which contains members of a group.

user_membership_attributestring

Attribute which matches the value of group_membership_field.

object_uniqueness_fieldstring

Field which contains a unique Identifier.

password_login_update_internal_passwordboolean

Update internal authentik password when login succeeds with LDAP

sync_usersboolean
sync_users_passwordboolean

When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.

sync_groupsboolean
sync_parent_groupstring uuid nullable
lookup_groups_from_userboolean

Lookup group membership based on a user attribute instead of a group attribute. This allows nested group resolution on systems like FreeIPA and Active Directory

delete_not_found_objectsboolean

Delete authentik users and groups which were previously supplied by this source, but are now missing from it.

sync_outgoing_trigger_mode'none' | 'immediate' | 'deferred_end'
sync_group_hierarchyboolean

Sync group parentage/hierarchy from LDAP directories.

Response

pkstring uuid required
namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean
promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]
group_property_mappingsstring[]
componentstring required

Get object component so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

policy_engine_mode'all' | 'any'
user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'
managedstring nullable required

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

user_path_templatestring
iconstring
icon_urlstring required
server_uristring uri required
peer_certificatestring uuid nullable

Optionally verify the LDAP Server's Certificate against the CA Chain in this keypair.

client_certificatestring uuid nullable

Client certificate to authenticate against the LDAP Server's Certificate.

bind_cnstring
start_tlsboolean
sniboolean
base_dnstring required
additional_user_dnstring

Prepended to Base DN for User-queries.

additional_group_dnstring

Prepended to Base DN for Group-queries.

user_object_filterstring

Consider Objects matching this filter to be Users.

group_object_filterstring

Consider Objects matching this filter to be Groups.

group_membership_fieldstring

Field which contains members of a group.

user_membership_attributestring

Attribute which matches the value of group_membership_field.

object_uniqueness_fieldstring

Field which contains a unique Identifier.

password_login_update_internal_passwordboolean

Update internal authentik password when login succeeds with LDAP

sync_usersboolean
sync_users_passwordboolean

When a user changes their password, sync it back to LDAP. This can only be enabled on a single LDAP source.

sync_groupsboolean
sync_parent_groupstring uuid nullable
connectivityobject nullable required

Get cached source connectivity

lookup_groups_from_userboolean

Lookup group membership based on a user attribute instead of a group attribute. This allows nested group resolution on systems like FreeIPA and Active Directory

delete_not_found_objectsboolean

Delete authentik users and groups which were previously supplied by this source, but are now missing from it.

sync_outgoing_trigger_mode'none' | 'immediate' | 'deferred_end'
sync_group_hierarchyboolean

Sync group parentage/hierarchy from LDAP directories.

Changes

No recorded changes to this endpoint across all 1 revision of this API.