PATCH /providers/ldap/:id — authentik

LDAPProvider Viewset

idinteger required

A unique integer value identifying this LDAP Provider.

Request body

namestring

authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid

Flow used when authorizing this provider.

invalidation_flowstring uuid

Flow used ending the session from a provider.

property_mappingsstring[]

base_dnstring

DN under which objects are accessible.

certificatestring uuid nullable

tls_server_namestring

uid_start_numberinteger

The start for uidNumbers, this number is added to the user.pk to make sure that the numbers aren't too low for POSIX users. Default is 2000 to ensure that we don't collide with local users uidNumber

gid_start_numberinteger

The start for gidNumbers, this number is added to a number generated from the group.pk to make sure that the numbers aren't too low for POSIX groups. Default is 4000 to ensure that we don't collide with local groups or users primary groups gidNumber

search_mode'direct' | 'cached'

bind_mode'direct' | 'cached'

mfa_supportboolean

When enabled, code-based multi-factor authentication can be used by appending a semicolon and the TOTP code to the password. This should only be enabled if all users that will bind to this provider have a TOTP device configured, as otherwise a password may incorrectly be rejected if it contains a semicolon.

Response

pkinteger required

namestring required

authentication_flowstring uuid nullable

Flow used for authentication when the associated application is accessed by an un-authenticated user.

authorization_flowstring uuid required

Flow used when authorizing this provider.

invalidation_flowstring uuid required

Flow used ending the session from a provider.

property_mappingsstring[]

componentstring required

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

assigned_application_slugstring nullable required

Internal application name, used in URLs.

assigned_application_namestring nullable required

Application's display Name.

assigned_backchannel_application_slugstring nullable required

Internal application name, used in URLs.

assigned_backchannel_application_namestring nullable required

Application's display Name.

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