Skip to main content

providers_ldap_list

GET 
/api/v3//providers/ldap/

LDAPProvider Viewset

Request​

Query Parameters

    application__isnull boolean
    authorization_flow__slug__iexact string
    base_dn__iexact string
    certificate__kp_uuid__iexact uuid
    certificate__name__iexact string
    gid_start_number__iexact integer
    name__iexact 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.

    search string

    A search term.

    tls_server_name__iexact string
    uid_start_number__iexact integer

Responses​

Schema
    pagination objectrequired
    nextnumberrequired
    previousnumberrequired
    countnumberrequired
    currentnumberrequired
    total_pagesnumberrequired
    start_indexnumberrequired
    end_indexnumberrequired
    results object[]required
  • Array [
    • pkID (integer)required
    namestringrequired
    authentication_flowuuidnullable

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

    authorization_flowuuidrequired

    Flow used when authorizing this provider.

    invalidation_flowuuidrequired

    Flow used ending the session from a provider.

    property_mappingsuuid[]
    componentstringrequired

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

    assigned_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_application_namestringrequired

    Application's display Name.

    assigned_backchannel_application_slugstringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_namestringrequired

    Application's display Name.

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    base_dnstring

    DN under which objects are accessible.

    certificateuuidnullable
    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

    Possible values: >= -2147483648 and <= 2147483647

    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

    Possible values: >= -2147483648 and <= 2147483647

    outpost_setstring[]required
    search_modeLDAPAPIAccessMode (string)

    Possible values: [direct, cached]

    bind_modeLDAPAPIAccessMode (string)

    Possible values: [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.

  • ]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/providers/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