Skip to main content

providers_ldap_update

PUT 
/providers/ldap/:id/

LDAPProvider Viewset

Request​

Path Parameters

    id integerrequired

    A unique integer value identifying this LDAP Provider.

Body

required

    name stringrequired

    Possible values: non-empty

    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[]
    base_dn string

    Possible values: non-empty

    DN under which objects are accessible.

    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

    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.

Responses​

Schema

    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.

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