Skip to main content

providers_ldap_list

GET 
/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.

    search_group__group_uuid__iexact uuid
    search_group__name__iexact string
    tls_server_name__iexact string
    uid_start_number__iexact integer

Responses​

Schema

    pagination

    object

    required

    next numberrequired
    previous numberrequired
    count numberrequired
    current numberrequired
    total_pages numberrequired
    start_index numberrequired
    end_index numberrequired

    results

    object[]

    required

  • Array [

    • pk ID (integer)required
    name stringrequired
    authentication_flow uuidnullable

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

    authorization_flow uuidrequired

    Flow used when authorizing this provider.

    property_mappings uuid[]
    component stringrequired

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

    assigned_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_application_name stringrequired

    Application's display Name.

    assigned_backchannel_application_slug stringrequired

    Internal application name, used in URLs.

    assigned_backchannel_application_name stringrequired

    Application's display Name.

    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

    base_dn string

    DN under which objects are accessible.

    search_group uuidnullable

    Users in this group can do search queries. If not set, every user can execute search queries.

    certificate uuidnullable
    tls_server_name string
    uid_start_number integer

    Possible values: >= -2147483648 and <= 2147483647

    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_number integer

    Possible values: >= -2147483648 and <= 2147483647

    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

    outpost_set string[]required
    search_mode LDAPAPIAccessMode (string)

    Possible values: [direct, cached]

    bind_mode LDAPAPIAccessMode (string)

    Possible values: [direct, cached]

    mfa_support boolean

    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.

  • ]

Loading...