Sign in
Plugins

Get a LdapAuthAdvanced plugin

Get a LdapAuthAdvanced plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#LdapAuthAdvanced

Response

LdapAuthAdvanced plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

name'ldap-auth-advanced' required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Changes

Changed in 12 of the 52 revisions of this API.1646

  • 62c54f1094bb1See the full diff
    • ○

      the response property allOf[PluginBase]/partials/items/path became required for the status 200

      response-property-became-required

  • 7d6a643707d91See the full diff
    • ○

      added the optional property allOf[PluginBase]/condition to the response with the 200 status

      response-optional-property-added

  • 19e869275e281See the full diff
    • ▲

      the allOf[LdapAuthAdvancedPluginConfig]/name response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f4816See the full diff
    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/bind_dn became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/group_base_dn became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/group_name_attribute became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/groups_required became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/ldap_password became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/realm became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/partials/items/name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/partials/items/path became nullable for the status 200

      response-property-became-nullable

    • ○

      the anonymous response's property default value was added for the status 200

      response-property-default-value-added

    • ○

      the cache_ttl response's property default value 60 was added for the status 200

      response-property-default-value-added

    • ○

      the consumer_by response's property default value custom_id username was added for the status 200

      response-property-default-value-added

    • ○

      the consumer_optional response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the group_member_attribute response's property default value memberOf was added for the status 200

      response-property-default-value-added

    • ○

      the header_type response's property default value ldap was added for the status 200

      response-property-default-value-added

    • ○

      the hide_credentials response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the keepalive response's property default value 60000 was added for the status 200

      response-property-default-value-added

    • ○

      the ldap_port response's property default value 389 was added for the status 200

      response-property-default-value-added

    • ○

      the ldaps response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the log_search_results response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the protocols response's property default value grpc grpcs http https ws wss was added for the status 200

      response-property-default-value-added

    • ○

      the start_tls response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the timeout response's property default value 10000 was added for the status 200

      response-property-default-value-added

    • ○

      the verify_ldap_host response's property default value false was added for the status 200

      response-property-default-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb14See the full diff
    • ▲

      the response property allOf[PluginBase]/tags became nullable for the status 200

      response-property-became-nullable

    • ○

      the response property allOf[LdapAuthAdvancedPluginConfig]/config became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/attribute became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/base_dn became required for the status 200

      response-property-became-required

    • ○

      the response property allOf[LdapAuthAdvancedPluginConfig]/config/ldap_host became required for the status 200

      response-property-became-required

  • c308b7426a7c1See the full diff
    • ▲

      the allOf[LdapAuthAdvancedPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200

      response-property-type-changed

  • 69704304ad5f1See the full diff
    • ○

      added the optional property allOf[PluginBase]/partials to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fc6abbc537f322See the full diff
    • ▲

      the response property allOf[PluginBase]/created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[PluginBase]/updated_at became nullable for the status 200

      response-property-became-nullable

    • ○

      the response optional property allOf[PluginBase]/created_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property allOf[PluginBase]/updated_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ceb0484689542See the full diff
    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/route became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthAdvancedPluginConfig]/service became nullable for the status 200

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d833d4dbb1fa5See the full diff
    • ○

      added PluginBase to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed Plugin from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property allOf[LdapAuthAdvancedPluginConfig]/protocols to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[LdapAuthAdvancedPluginConfig]/route to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[LdapAuthAdvancedPluginConfig]/service to the response with the 200 status

      response-optional-property-added