Skip to main content

sources_ldap_list

GET 
/api/v3//sources/ldap/

LDAP Source Viewset

Request​

Query Parameters

    additional_group_dn string
    additional_user_dn string
    base_dn string
    bind_cn string
    client_certificate uuid
    enabled boolean
    group_membership_field string
    group_object_filter string
    group_property_mappings uuid[]
    name string
    object_uniqueness_field string
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    page_size integer

    Number of results to return per page.

    password_login_update_internal_password boolean
    pbm_uuid uuid
    peer_certificate uuid
    search string

    A search term.

    server_uri string
    slug string
    sni boolean
    start_tls boolean
    sync_groups boolean
    sync_parent_group uuid
    sync_users boolean
    sync_users_password boolean
    user_object_filter string
    user_property_mappings uuid[]

Responses​

Schema
    pagination objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
    • pkuuidrequired
    namestringrequired

    Source's display Name.

    slugstringrequired

    Internal source name, used in URLs.

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

    enabledboolean
    authentication_flowuuidnullable

    Flow to use when authenticating existing users.

    enrollment_flowuuidnullable

    Flow to use when enrolling new users.

    user_property_mappingsuuid[]
    group_property_mappingsuuid[]
    componentstringrequired

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

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    user_matching_modeUserMatchingModeEnum (string)

    How the source determines if an existing user should be authenticated or a new user enrolled.

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

    managedManaged 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_templatestring
    iconstringrequired
    server_uriurirequired
    peer_certificateuuidnullable

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

    client_certificateuuidnullable

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

    bind_cnstring
    start_tlsEnable Start TLS (boolean)
    sniUse Server URI for SNI verification (boolean)
    base_dnstringrequired
    additional_user_dnAddition User DN (string)

    Prepended to Base DN for User-queries.

    additional_group_dnAddition Group DN (string)

    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.

    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_groupuuidnullable
    connectivity objectnullablerequired

    Get cached source connectivity

    property name* object
    property name*string
  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/sources/ldap/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query