Skip to main content

sources_ldap_create

POST 
/sources/ldap/

LDAP Source Viewset

Request​

Body

required

    name stringrequired

    Possible values: non-empty

    Source's display Name.

    slug stringrequired

    Possible values: non-empty and <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    Internal source name, used in URLs.

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    user_property_mappings uuid[]
    group_property_mappings uuid[]
    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (string)

    Possible values: [identifier, email_link, email_deny, username_link, username_deny]

    user_path_template string

    Possible values: non-empty

    server_uri urirequired

    Possible values: non-empty

    peer_certificate uuidnullable

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

    client_certificate uuidnullable

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

    bind_cn string
    bind_password string
    start_tls Enable Start TLS (boolean)
    sni Use Server URI for SNI verification (boolean)
    base_dn stringrequired

    Possible values: non-empty

    additional_user_dn Addition User DN (string)

    Prepended to Base DN for User-queries.

    additional_group_dn Addition Group DN (string)

    Prepended to Base DN for Group-queries.

    user_object_filter string

    Possible values: non-empty

    Consider Objects matching this filter to be Users.

    group_object_filter string

    Possible values: non-empty

    Consider Objects matching this filter to be Groups.

    group_membership_field string

    Possible values: non-empty

    Field which contains members of a group.

    object_uniqueness_field string

    Possible values: non-empty

    Field which contains a unique Identifier.

    password_login_update_internal_password boolean

    Update internal authentik password when login succeeds with LDAP

    sync_users boolean
    sync_users_password boolean

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

    sync_groups boolean
    sync_parent_group uuidnullable

Responses​

Schema

    pk uuidrequired
    name stringrequired

    Source's display Name.

    slug stringrequired

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    Internal source name, used in URLs.

    enabled boolean
    authentication_flow uuidnullable

    Flow to use when authenticating existing users.

    enrollment_flow uuidnullable

    Flow to use when enrolling new users.

    user_property_mappings uuid[]
    group_property_mappings uuid[]
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_mode UserMatchingModeEnum (string)

    Possible values: [identifier, email_link, email_deny, username_link, username_deny]

    managed Managed by authentik (string)nullablerequired

    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_template string
    icon stringrequired
    server_uri urirequired
    peer_certificate uuidnullable

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

    client_certificate uuidnullable

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

    bind_cn string
    start_tls Enable Start TLS (boolean)
    sni Use Server URI for SNI verification (boolean)
    base_dn stringrequired
    additional_user_dn Addition User DN (string)

    Prepended to Base DN for User-queries.

    additional_group_dn Addition Group DN (string)

    Prepended to Base DN for Group-queries.

    user_object_filter string

    Consider Objects matching this filter to be Users.

    group_object_filter string

    Consider Objects matching this filter to be Groups.

    group_membership_field string

    Field which contains members of a group.

    object_uniqueness_field string

    Field which contains a unique Identifier.

    password_login_update_internal_password boolean

    Update internal authentik password when login succeeds with LDAP

    sync_users boolean
    sync_users_password boolean

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

    sync_groups boolean
    sync_parent_group uuidnullable

    connectivity

    object

    nullable

    required

    Get cached source connectivity

    property name*

    object

    nullable

    property name* string
Loading...