Sign in
Plugins

Create a LdapAuth plugin

Create a LdapAuth plugin

post/v2/control-planes/{controlPlaneId}/core-entities/plugins#LdapAuth

Request body

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

Response

Created LdapAuth 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' 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 15 of the 52 revisions of this API.30278

  • 62c54f1094bb11See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/path became required

      request-property-became-required

    • ○

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

      response-property-became-required

  • 7d6a643707d92See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/condition

      new-optional-request-property

    • ○

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

      response-optional-property-added

  • 19e869275e282See the full diff
    • ▲

      the allOf[LdapAuthPluginConfig]/name request property type/format changed from string/ to /

      request-property-type-changed

    • ▲

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

      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

  • f030590166225See the full diff
    • ▲

      the request property allOf[PluginBase]/partials/items/name became not nullable

      request-property-became-not-nullable

    • ▲

      the request property allOf[PluginBase]/partials/items/path became not nullable

      request-property-became-not-nullable

    • ▲

      the allOf[PluginBase]/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the allOf[PluginBase]/partials/items/id request property's minLength was increased from 0 to 1

      request-property-min-length-increased

  • 96118a9cd7f4426See the full diff
    • ▲

      the response property allOf[LdapAuthPluginConfig]/config/anonymous became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthPluginConfig]/config/realm became nullable for the status 201

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ○

      the request property allOf[LdapAuthPluginConfig]/config/anonymous became nullable

      request-property-became-nullable

    • ○

      the request property allOf[LdapAuthPluginConfig]/config/realm became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/name became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/partials/items/path became nullable

      request-property-became-nullable

    • ○

      the cache_ttl request property default value 60 was added

      request-property-default-value-added

    • ○

      the enabled request property default value true was added

      request-property-default-value-added

    • ○

      the header_type request property default value ldap was added

      request-property-default-value-added

    • ○

      the hide_credentials request property default value false was added

      request-property-default-value-added

    • ○

      the keepalive request property default value 60000 was added

      request-property-default-value-added

    • ○

      the ldap_port request property default value 389 was added

      request-property-default-value-added

    • ○

      the ldaps request property default value false was added

      request-property-default-value-added

    • ○

      the protocols request property default value grpc grpcs http https ws wss was added

      request-property-default-value-added

    • ○

      the start_tls request property default value false was added

      request-property-default-value-added

    • ○

      the timeout request property default value 10000 was added

      request-property-default-value-added

    • ○

      the verify_ldap_host request property default value false was added

      request-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      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

  • 2c77aeaee5fb55See the full diff
    • ▲

      the request property allOf[LdapAuthPluginConfig]/config became required

      request-property-became-required

    • ▲

      the request property allOf[LdapAuthPluginConfig]/config/attribute became required

      request-property-became-required

    • ▲

      the request property allOf[LdapAuthPluginConfig]/config/base_dn became required

      request-property-became-required

    • ▲

      the request property allOf[LdapAuthPluginConfig]/config/ldap_host became required

      request-property-became-required

    • ▲

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

      response-property-became-nullable

    • ○

      the request property allOf[PluginBase]/tags became nullable

      request-property-became-nullable

    • ○

      the response property allOf[LdapAuthPluginConfig]/config became required for the status 201

      response-property-became-required

    • ○

      the response property allOf[LdapAuthPluginConfig]/config/attribute became required for the status 201

      response-property-became-required

    • ○

      the response property allOf[LdapAuthPluginConfig]/config/base_dn became required for the status 201

      response-property-became-required

    • ○

      the response property allOf[LdapAuthPluginConfig]/config/ldap_host became required for the status 201

      response-property-became-required

  • c308b7426a7c2See the full diff
    • ▲

      the allOf[LdapAuthPluginConfig]/protocols request property type/format changed from array/ to array/set

      request-property-type-changed

    • ▲

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

      response-property-type-changed

  • 69704304ad5f2See the full diff
    • ○

      added the new optional request property allOf[PluginBase]/partials

      new-optional-request-property

    • ○

      added the optional property allOf[PluginBase]/partials to the response with the 201 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

  • fc6abbc537f326See the full diff
    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ○

      the request optional property allOf[PluginBase]/created_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request optional property allOf[PluginBase]/updated_at became not read-only

      request-optional-property-became-not-read-only

    • ○

      the request property allOf[PluginBase]/created_at became nullable

      request-property-became-nullable

    • ○

      the request property allOf[PluginBase]/updated_at became nullable

      request-property-became-nullable

    • ○

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

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

    • ○

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

      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

  • ceb04846895422See the full diff
    • ▲

      the response property allOf[LdapAuthPluginConfig]/route became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property allOf[LdapAuthPluginConfig]/service became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property allOf[LdapAuthPluginConfig]/route became nullable

      request-property-became-nullable

    • ○

      the request property allOf[LdapAuthPluginConfig]/service became nullable

      request-property-became-nullable

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