Skip to main content

outposts_ldap_list

GET 

/api/v3//outposts/ldap/

LDAPProvider Viewset

Request

Query Parameters

    name 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.

Responses

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

    DN under which objects are accessible.

    bind_flow_slugstringrequired
    unbind_flow_slugstringnullablerequired

    Get slug for unbind flow, defaulting to brand's default flow.

    application_slugstringrequired

    Prioritise backchannel slug over direct application slug

    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

    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/outposts/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