Plugins

Get a Saml plugin

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

Response

Saml 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'saml' 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 set of strings representing HTTP protocols.

Changes

Changed in 14 of the 52 revisions of this API.341477

Jun 26, 20264a39c7f8550911See the full diff
- ▲
  the allOf[SamlPluginConfig]/config/redis/port response's property type/format changed from integer/ to string/ for status 200
  response-property-type-changed
- ○
  the port response's property default value changed from 6379 to 6379 for the status 200
  response-property-default-value-changed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 11, 202662c54f1094bb1See the full diff
- ○
  the response property allOf[PluginBase]/partials/items/path became required for the status 200
  response-property-became-required
Apr 24, 20267d6a643707d91See the full diff
- ○
  added the optional property allOf[PluginBase]/condition to the response with the 200 status
  response-optional-property-added
Jan 13, 2026ad02b4e24eb21See the full diff
- ○
  added the optional property allOf[SamlPluginConfig]/config/redis/cloud_authentication to the response with the 200 status
  response-optional-property-added
Oct 29, 202519e869275e2811See the full diff
- ▲
  the allOf[SamlPluginConfig]/name response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  the allOf[SamlPluginConfig]/config/session_secret response's property pattern ^[0-9a-zA-Z/_+]+$ was removed for the status 200
  response-property-pattern-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 202596118a9cd7f42542See the full diff
- ▲
  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 response property allOf[SamlPluginConfig]/config/anonymous became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/idp_certificate became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/cluster_nodes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/keepalive_backlog became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/prefix became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/sentinel_master became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/sentinel_nodes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/sentinel_password became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/sentinel_username became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/server_name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/socket became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/redis/username became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/request_signing_certificate became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/request_signing_key became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/response_encryption_key became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_cookie_domain became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_cookie_secure became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_memcached_prefix became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_memcached_socket became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_request_headers became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[SamlPluginConfig]/config/session_response_headers became nullable for the status 200
  response-property-became-nullable
- ○
  the cluster_max_redirections response's property default value 5 was added for the status 200
  response-property-default-value-added
- ○
  the connect_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the connection_is_proxied response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the database response's property default value 0 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 host response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the host response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the ip response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the keepalive_pool_size response's property default value 256 was added for the status 200
  response-property-default-value-added
- ○
  the nameid_format response's property default value EmailAddress was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the port response's property default value 6379 was added for the status 200
  response-property-default-value-added
- ○
  the protocols response's property default value grpc grpcs http https was added for the status 200
  response-property-default-value-added
- ○
  the read_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the request_digest_algorithm response's property default value SHA256 was added for the status 200
  response-property-default-value-added
- ○
  the request_signature_algorithm response's property default value SHA256 was added for the status 200
  response-property-default-value-added
- ○
  the response_digest_algorithm response's property default value SHA256 was added for the status 200
  response-property-default-value-added
- ○
  the response_signature_algorithm response's property default value SHA256 was added for the status 200
  response-property-default-value-added
- ○
  the send_timeout response's property default value 2000 was added for the status 200
  response-property-default-value-added
- ○
  the session_absolute_timeout response's property default value 86400 was added for the status 200
  response-property-default-value-added
- ○
  the session_audience response's property default value default was added for the status 200
  response-property-default-value-added
- ○
  the session_cookie_http_only response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the session_cookie_name response's property default value session was added for the status 200
  response-property-default-value-added
- ○
  the session_cookie_path response's property default value / was added for the status 200
  response-property-default-value-added
- ○
  the session_cookie_same_site response's property default value Lax was added for the status 200
  response-property-default-value-added
- ○
  the session_enforce_same_subject response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the session_hash_storage_key response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the session_hash_subject response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the session_idling_timeout response's property default value 900 was added for the status 200
  response-property-default-value-added
- ○
  the session_memcached_host response's property default value 127.0.0.1 was added for the status 200
  response-property-default-value-added
- ○
  the session_memcached_port response's property default value 11211 was added for the status 200
  response-property-default-value-added
- ○
  the session_remember response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the session_remember_absolute_timeout response's property default value 2592000 was added for the status 200
  response-property-default-value-added
- ○
  the session_remember_cookie_name response's property default value remember was added for the status 200
  response-property-default-value-added
- ○
  the session_remember_rolling_timeout response's property default value 604800 was added for the status 200
  response-property-default-value-added
- ○
  the session_rolling_timeout response's property default value 3600 was added for the status 200
  response-property-default-value-added
- ○
  the session_storage response's property default value cookie was added for the status 200
  response-property-default-value-added
- ○
  the session_store_metadata response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the ssl response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the ssl_verify response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the validate_assertion_signature response's property default value true 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
Jul 22, 20252c77aeaee5fb15See the full diff
- ▲
  the response property allOf[PluginBase]/tags became nullable for the status 200
  response-property-became-nullable
- ○
  the response property allOf[SamlPluginConfig]/config became required for the status 200
  response-property-became-required
- ○
  the response property allOf[SamlPluginConfig]/config/assertion_consumer_path became required for the status 200
  response-property-became-required
- ○
  the response property allOf[SamlPluginConfig]/config/idp_sso_url became required for the status 200
  response-property-became-required
- ○
  the response property allOf[SamlPluginConfig]/config/issuer became required for the status 200
  response-property-became-required
- ○
  the response property allOf[SamlPluginConfig]/config/session_secret became required for the status 200
  response-property-became-required
Jun 17, 2025c308b7426a7c1See the full diff
- ▲
  the allOf[SamlPluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200
  response-property-type-changed
May 21, 202569704304ad5f1See 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
Apr 15, 2025fc6abbc537f322See 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

Full history (14 revisions)