konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.getGatewayPluginSaml
Explore with Pulumi AI
Using getGatewayPluginSaml
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGatewayPluginSaml(args: GetGatewayPluginSamlArgs, opts?: InvokeOptions): Promise<GetGatewayPluginSamlResult>
function getGatewayPluginSamlOutput(args: GetGatewayPluginSamlOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginSamlResult>def get_gateway_plugin_saml(control_plane_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetGatewayPluginSamlResult
def get_gateway_plugin_saml_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginSamlResult]func LookupGatewayPluginSaml(ctx *Context, args *LookupGatewayPluginSamlArgs, opts ...InvokeOption) (*LookupGatewayPluginSamlResult, error)
func LookupGatewayPluginSamlOutput(ctx *Context, args *LookupGatewayPluginSamlOutputArgs, opts ...InvokeOption) LookupGatewayPluginSamlResultOutput> Note: This function is named LookupGatewayPluginSaml in the Go SDK.
public static class GetGatewayPluginSaml 
{
    public static Task<GetGatewayPluginSamlResult> InvokeAsync(GetGatewayPluginSamlArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginSamlResult> Invoke(GetGatewayPluginSamlInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGatewayPluginSamlResult> getGatewayPluginSaml(GetGatewayPluginSamlArgs args, InvokeOptions options)
public static Output<GetGatewayPluginSamlResult> getGatewayPluginSaml(GetGatewayPluginSamlArgs args, InvokeOptions options)
fn::invoke:
  function: konnect:index/getGatewayPluginSaml:getGatewayPluginSaml
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ControlPlane stringId 
- ControlPlane stringId 
- controlPlane StringId 
- controlPlane stringId 
- control_plane_ strid 
- controlPlane StringId 
getGatewayPluginSaml Result
The following output properties are available:
- Config
GetGateway Plugin Saml Config 
- ControlPlane stringId 
- CreatedAt double
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Saml Ordering 
- Protocols List<string>
- Route
GetGateway Plugin Saml Route 
- Service
GetGateway Plugin Saml Service 
- List<string>
- UpdatedAt double
- Config
GetGateway Plugin Saml Config 
- ControlPlane stringId 
- CreatedAt float64
- Enabled bool
- Id string
- InstanceName string
- Ordering
GetGateway Plugin Saml Ordering 
- Protocols []string
- Route
GetGateway Plugin Saml Route 
- Service
GetGateway Plugin Saml Service 
- []string
- UpdatedAt float64
- config
GetGateway Plugin Saml Config 
- controlPlane StringId 
- createdAt Double
- enabled Boolean
- id String
- instanceName String
- ordering
GetGateway Plugin Saml Ordering 
- protocols List<String>
- route
GetGateway Plugin Saml Route 
- service
GetGateway Plugin Saml Service 
- List<String>
- updatedAt Double
- config
GetGateway Plugin Saml Config 
- controlPlane stringId 
- createdAt number
- enabled boolean
- id string
- instanceName string
- ordering
GetGateway Plugin Saml Ordering 
- protocols string[]
- route
GetGateway Plugin Saml Route 
- service
GetGateway Plugin Saml Service 
- string[]
- updatedAt number
- config
GetGateway Plugin Saml Config 
- control_plane_ strid 
- created_at float
- enabled bool
- id str
- instance_name str
- ordering
GetGateway Plugin Saml Ordering 
- protocols Sequence[str]
- route
GetGateway Plugin Saml Route 
- service
GetGateway Plugin Saml Service 
- Sequence[str]
- updated_at float
- config Property Map
- controlPlane StringId 
- createdAt Number
- enabled Boolean
- id String
- instanceName String
- ordering Property Map
- protocols List<String>
- route Property Map
- service Property Map
- List<String>
- updatedAt Number
Supporting Types
GetGatewayPluginSamlConfig    
- Anonymous string
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- AssertionConsumer stringPath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- IdpCertificate string
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- IdpSso stringUrl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Issuer string
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- NameidFormat string
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- Redis
GetGateway Plugin Saml Config Redis 
- RequestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- RequestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- RequestSigning stringCertificate 
- The certificate for signing requests.
- RequestSigning stringKey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- ResponseDigest stringAlgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- ResponseEncryption stringKey 
- The private encryption key required to decrypt encrypted assertions.
- ResponseSignature stringAlgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- SessionAbsolute doubleTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- SessionAudience string
- The session audience, for example "my-application"
- string
- The session cookie domain flag.
- bool
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- string
- The session cookie name.
- string
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- string
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- bool
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- SessionEnforce boolSame Subject 
- When set to true, audiences are forced to share the same subject.
- SessionHash boolStorage Key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- SessionHash boolSubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- SessionIdling doubleTimeout 
- The session cookie idle time in seconds.
- SessionMemcached stringHost 
- The memcached host.
- SessionMemcached doublePort 
- An integer representing a port number between 0 and 65535, inclusive.
- SessionMemcached stringPrefix 
- The memcached session key prefix.
- SessionMemcached stringSocket 
- The memcached unix socket path.
- SessionRemember bool
- Enables or disables persistent sessions
- SessionRemember doubleAbsolute Timeout 
- Persistent session absolute timeout in seconds.
- string
- Persistent session cookie name
- SessionRemember doubleRolling Timeout 
- Persistent session rolling timeout in seconds.
- SessionRequest List<string>Headers 
- SessionResponse List<string>Headers 
- SessionRolling doubleTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- SessionSecret string
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- SessionStorage string
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- SessionStore boolMetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- ValidateAssertion boolSignature 
- Enable signature validation for SAML responses.
- Anonymous string
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- AssertionConsumer stringPath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- IdpCertificate string
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- IdpSso stringUrl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- Issuer string
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- NameidFormat string
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- Redis
GetGateway Plugin Saml Config Redis 
- RequestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- RequestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- RequestSigning stringCertificate 
- The certificate for signing requests.
- RequestSigning stringKey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- ResponseDigest stringAlgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- ResponseEncryption stringKey 
- The private encryption key required to decrypt encrypted assertions.
- ResponseSignature stringAlgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- SessionAbsolute float64Timeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- SessionAudience string
- The session audience, for example "my-application"
- string
- The session cookie domain flag.
- bool
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- string
- The session cookie name.
- string
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- string
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- bool
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- SessionEnforce boolSame Subject 
- When set to true, audiences are forced to share the same subject.
- SessionHash boolStorage Key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- SessionHash boolSubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- SessionIdling float64Timeout 
- The session cookie idle time in seconds.
- SessionMemcached stringHost 
- The memcached host.
- SessionMemcached float64Port 
- An integer representing a port number between 0 and 65535, inclusive.
- SessionMemcached stringPrefix 
- The memcached session key prefix.
- SessionMemcached stringSocket 
- The memcached unix socket path.
- SessionRemember bool
- Enables or disables persistent sessions
- SessionRemember float64Absolute Timeout 
- Persistent session absolute timeout in seconds.
- string
- Persistent session cookie name
- SessionRemember float64Rolling Timeout 
- Persistent session rolling timeout in seconds.
- SessionRequest []stringHeaders 
- SessionResponse []stringHeaders 
- SessionRolling float64Timeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- SessionSecret string
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- SessionStorage string
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- SessionStore boolMetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- ValidateAssertion boolSignature 
- Enable signature validation for SAML responses.
- anonymous String
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- assertionConsumer StringPath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- idpCertificate String
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- idpSso StringUrl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- issuer String
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- nameidFormat String
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- redis
GetGateway Plugin Saml Config Redis 
- requestDigest StringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- requestSignature StringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- requestSigning StringCertificate 
- The certificate for signing requests.
- requestSigning StringKey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- responseDigest StringAlgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- responseEncryption StringKey 
- The private encryption key required to decrypt encrypted assertions.
- responseSignature StringAlgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- sessionAbsolute DoubleTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionAudience String
- The session audience, for example "my-application"
- String
- The session cookie domain flag.
- Boolean
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- String
- The session cookie name.
- String
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- String
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- Boolean
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- sessionEnforce BooleanSame Subject 
- When set to true, audiences are forced to share the same subject.
- sessionHash BooleanStorage Key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- sessionHash BooleanSubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- sessionIdling DoubleTimeout 
- The session cookie idle time in seconds.
- sessionMemcached StringHost 
- The memcached host.
- sessionMemcached DoublePort 
- An integer representing a port number between 0 and 65535, inclusive.
- sessionMemcached StringPrefix 
- The memcached session key prefix.
- sessionMemcached StringSocket 
- The memcached unix socket path.
- sessionRemember Boolean
- Enables or disables persistent sessions
- sessionRemember DoubleAbsolute Timeout 
- Persistent session absolute timeout in seconds.
- String
- Persistent session cookie name
- sessionRemember DoubleRolling Timeout 
- Persistent session rolling timeout in seconds.
- sessionRequest List<String>Headers 
- sessionResponse List<String>Headers 
- sessionRolling DoubleTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionSecret String
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- sessionStorage String
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- sessionStore BooleanMetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- validateAssertion BooleanSignature 
- Enable signature validation for SAML responses.
- anonymous string
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- assertionConsumer stringPath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- idpCertificate string
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- idpSso stringUrl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- issuer string
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- nameidFormat string
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- redis
GetGateway Plugin Saml Config Redis 
- requestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- requestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- requestSigning stringCertificate 
- The certificate for signing requests.
- requestSigning stringKey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- responseDigest stringAlgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- responseEncryption stringKey 
- The private encryption key required to decrypt encrypted assertions.
- responseSignature stringAlgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- sessionAbsolute numberTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionAudience string
- The session audience, for example "my-application"
- string
- The session cookie domain flag.
- boolean
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- string
- The session cookie name.
- string
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- string
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- boolean
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- sessionEnforce booleanSame Subject 
- When set to true, audiences are forced to share the same subject.
- sessionHash booleanStorage Key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- sessionHash booleanSubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- sessionIdling numberTimeout 
- The session cookie idle time in seconds.
- sessionMemcached stringHost 
- The memcached host.
- sessionMemcached numberPort 
- An integer representing a port number between 0 and 65535, inclusive.
- sessionMemcached stringPrefix 
- The memcached session key prefix.
- sessionMemcached stringSocket 
- The memcached unix socket path.
- sessionRemember boolean
- Enables or disables persistent sessions
- sessionRemember numberAbsolute Timeout 
- Persistent session absolute timeout in seconds.
- string
- Persistent session cookie name
- sessionRemember numberRolling Timeout 
- Persistent session rolling timeout in seconds.
- sessionRequest string[]Headers 
- sessionResponse string[]Headers 
- sessionRolling numberTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionSecret string
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- sessionStorage string
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- sessionStore booleanMetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- validateAssertion booleanSignature 
- Enable signature validation for SAML responses.
- anonymous str
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- assertion_consumer_ strpath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- idp_certificate str
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- idp_sso_ strurl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- issuer str
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- nameid_format str
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- redis
GetGateway Plugin Saml Config Redis 
- request_digest_ stralgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- request_signature_ stralgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- request_signing_ strcertificate 
- The certificate for signing requests.
- request_signing_ strkey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- response_digest_ stralgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- response_encryption_ strkey 
- The private encryption key required to decrypt encrypted assertions.
- response_signature_ stralgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- session_absolute_ floattimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- session_audience str
- The session audience, for example "my-application"
- str
- The session cookie domain flag.
- bool
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- str
- The session cookie name.
- str
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- str
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- bool
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- session_enforce_ boolsame_ subject 
- When set to true, audiences are forced to share the same subject.
- session_hash_ boolstorage_ key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- session_hash_ boolsubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- session_idling_ floattimeout 
- The session cookie idle time in seconds.
- session_memcached_ strhost 
- The memcached host.
- session_memcached_ floatport 
- An integer representing a port number between 0 and 65535, inclusive.
- session_memcached_ strprefix 
- The memcached session key prefix.
- session_memcached_ strsocket 
- The memcached unix socket path.
- session_remember bool
- Enables or disables persistent sessions
- session_remember_ floatabsolute_ timeout 
- Persistent session absolute timeout in seconds.
- str
- Persistent session cookie name
- session_remember_ floatrolling_ timeout 
- Persistent session rolling timeout in seconds.
- session_request_ Sequence[str]headers 
- session_response_ Sequence[str]headers 
- session_rolling_ floattimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- session_secret str
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- session_storage str
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- session_store_ boolmetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- validate_assertion_ boolsignature 
- Enable signature validation for SAML responses.
- anonymous String
- An optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
- assertionConsumer StringPath 
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- idpCertificate String
- The public certificate provided by the IdP. This is used to validate responses from the IdP. Only include the contents of the certificate. Do not include the header (BEGIN CERTIFICATE) and footer (END CERTIFICATE) lines.
- idpSso StringUrl 
- A string representing a URL, such as https://example.com/path/to/resource?q=search.
- issuer String
- The unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
- nameidFormat String
- The requested NameIdformat. Options available are: -Unspecified-EmailAddress-Persistent-Transient
- redis Property Map
- requestDigest StringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1
- requestSignature StringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512
- requestSigning StringCertificate 
- The certificate for signing requests.
- requestSigning StringKey 
- The private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The request_signing_certificateparameter must be set as well.
- responseDigest StringAlgorithm 
- The algorithm for verifying digest in SAML responses: - SHA256-SHA1
- responseEncryption StringKey 
- The private encryption key required to decrypt encrypted assertions.
- responseSignature StringAlgorithm 
- The algorithm for validating signatures in SAML responses. Options available are: - SHA256-SHA384-SHA512
- sessionAbsolute NumberTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionAudience String
- The session audience, for example "my-application"
- String
- The session cookie domain flag.
- Boolean
- Forbids JavaScript from accessing the cookie, for example, through the Document.cookieproperty.
- String
- The session cookie name.
- String
- A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
- String
- Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks.
- Boolean
- The cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
- sessionEnforce BooleanSame Subject 
- When set to true, audiences are forced to share the same subject.
- sessionHash BooleanStorage Key 
- When set to true, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
- sessionHash BooleanSubject 
- When set to true, the value of subject is hashed before being stored. Only applies whensession_store_metadatais enabled.
- sessionIdling NumberTimeout 
- The session cookie idle time in seconds.
- sessionMemcached StringHost 
- The memcached host.
- sessionMemcached NumberPort 
- An integer representing a port number between 0 and 65535, inclusive.
- sessionMemcached StringPrefix 
- The memcached session key prefix.
- sessionMemcached StringSocket 
- The memcached unix socket path.
- sessionRemember Boolean
- Enables or disables persistent sessions
- sessionRemember NumberAbsolute Timeout 
- Persistent session absolute timeout in seconds.
- String
- Persistent session cookie name
- sessionRemember NumberRolling Timeout 
- Persistent session rolling timeout in seconds.
- sessionRequest List<String>Headers 
- sessionResponse List<String>Headers 
- sessionRolling NumberTimeout 
- The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
- sessionSecret String
- The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers, /,_and+). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
- sessionStorage String
- The session storage for session data: - cookie: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn't require a database. -memcached: stores session data in memcached -redis: stores session data in Redis
- sessionStore BooleanMetadata 
- Configures whether or not session metadata should be stored. This includes information about the active sessions for the specific_audiencebelonging to a specific subject.
- validateAssertion BooleanSignature 
- Enable signature validation for SAML responses.
GetGatewayPluginSamlConfigRedis     
- ClusterMax doubleRedirections 
- Maximum retry attempts for redirection.
- ClusterNodes List<GetGateway Plugin Saml Config Redis Cluster Node> 
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- ConnectTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- ConnectionIs boolProxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- Database double
- Database to use for the Redis connection when using the redisstrategy
- Host string
- A string representing a host name, such as example.com.
- KeepaliveBacklog double
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- KeepalivePool doubleSize 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- Password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port double
- An integer representing a port number between 0 and 65535, inclusive.
- Prefix string
- The Redis session key prefix.
- ReadTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- SendTimeout double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- SentinelMaster string
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- SentinelNodes List<GetGateway Plugin Saml Config Redis Sentinel Node> 
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- SentinelPassword string
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- SentinelRole string
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- SentinelUsername string
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- ServerName string
- A string representing an SNI (server name indication) value for TLS.
- Socket string
- The Redis unix socket path.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- SslVerify bool
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- Username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
- ClusterMax float64Redirections 
- Maximum retry attempts for redirection.
- ClusterNodes []GetGateway Plugin Saml Config Redis Cluster Node 
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- ConnectTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- ConnectionIs boolProxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- Database float64
- Database to use for the Redis connection when using the redisstrategy
- Host string
- A string representing a host name, such as example.com.
- KeepaliveBacklog float64
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- KeepalivePool float64Size 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- Password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port float64
- An integer representing a port number between 0 and 65535, inclusive.
- Prefix string
- The Redis session key prefix.
- ReadTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- SendTimeout float64
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- SentinelMaster string
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- SentinelNodes []GetGateway Plugin Saml Config Redis Sentinel Node 
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- SentinelPassword string
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- SentinelRole string
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- SentinelUsername string
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- ServerName string
- A string representing an SNI (server name indication) value for TLS.
- Socket string
- The Redis unix socket path.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- SslVerify bool
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- Username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
- clusterMax DoubleRedirections 
- Maximum retry attempts for redirection.
- clusterNodes List<GetGateway Plugin Saml Config Redis Cluster Node> 
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- connectTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connectionIs BooleanProxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- database Double
- Database to use for the Redis connection when using the redisstrategy
- host String
- A string representing a host name, such as example.com.
- keepaliveBacklog Double
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- keepalivePool DoubleSize 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- password String
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port Double
- An integer representing a port number between 0 and 65535, inclusive.
- prefix String
- The Redis session key prefix.
- readTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sendTimeout Double
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinelMaster String
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinelNodes List<GetGateway Plugin Saml Config Redis Sentinel Node> 
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- sentinelPassword String
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinelRole String
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- sentinelUsername String
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- serverName String
- A string representing an SNI (server name indication) value for TLS.
- socket String
- The Redis unix socket path.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- sslVerify Boolean
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- username String
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
- clusterMax numberRedirections 
- Maximum retry attempts for redirection.
- clusterNodes GetGateway Plugin Saml Config Redis Cluster Node[] 
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- connectTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connectionIs booleanProxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- database number
- Database to use for the Redis connection when using the redisstrategy
- host string
- A string representing a host name, such as example.com.
- keepaliveBacklog number
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- keepalivePool numberSize 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port number
- An integer representing a port number between 0 and 65535, inclusive.
- prefix string
- The Redis session key prefix.
- readTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sendTimeout number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinelMaster string
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinelNodes GetGateway Plugin Saml Config Redis Sentinel Node[] 
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- sentinelPassword string
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinelRole string
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- sentinelUsername string
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- serverName string
- A string representing an SNI (server name indication) value for TLS.
- socket string
- The Redis unix socket path.
- ssl boolean
- If set to true, uses SSL to connect to Redis.
- sslVerify boolean
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
- cluster_max_ floatredirections 
- Maximum retry attempts for redirection.
- cluster_nodes Sequence[GetGateway Plugin Saml Config Redis Cluster Node] 
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- connect_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection_is_ boolproxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- database float
- Database to use for the Redis connection when using the redisstrategy
- host str
- A string representing a host name, such as example.com.
- keepalive_backlog float
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- keepalive_pool_ floatsize 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- password str
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port float
- An integer representing a port number between 0 and 65535, inclusive.
- prefix str
- The Redis session key prefix.
- read_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send_timeout float
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel_master str
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel_nodes Sequence[GetGateway Plugin Saml Config Redis Sentinel Node] 
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- sentinel_password str
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel_role str
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- sentinel_username str
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server_name str
- A string representing an SNI (server name indication) value for TLS.
- socket str
- The Redis unix socket path.
- ssl bool
- If set to true, uses SSL to connect to Redis.
- ssl_verify bool
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- username str
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
- clusterMax NumberRedirections 
- Maximum retry attempts for redirection.
- clusterNodes List<Property Map>
- Cluster addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
- connectTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connectionIs BooleanProxied 
- If the connection to Redis is proxied (e.g. Envoy), set it true. Set thehostandportto point to the proxy address.
- database Number
- Database to use for the Redis connection when using the redisstrategy
- host String
- A string representing a host name, such as example.com.
- keepaliveBacklog Number
- Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size.
- keepalivePool NumberSize 
- The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
- password String
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port Number
- An integer representing a port number between 0 and 65535, inclusive.
- prefix String
- The Redis session key prefix.
- readTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sendTimeout Number
- An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinelMaster String
- Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinelNodes List<Property Map>
- Sentinel node addresses to use for Redis connections when the redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
- sentinelPassword String
- Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinelRole String
- Sentinel role to use for Redis connections when the redisstrategy is defined. Defining this value implies using Redis Sentinel.
- sentinelUsername String
- Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- serverName String
- A string representing an SNI (server name indication) value for TLS.
- socket String
- The Redis unix socket path.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- sslVerify Boolean
- If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly.
- username String
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
GetGatewayPluginSamlConfigRedisClusterNode       
GetGatewayPluginSamlConfigRedisSentinelNode       
GetGatewayPluginSamlOrdering    
GetGatewayPluginSamlOrderingAfter     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginSamlOrderingBefore     
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GetGatewayPluginSamlRoute    
- Id string
- Id string
- id String
- id string
- id str
- id String
GetGatewayPluginSamlService    
- Id string
- Id string
- id String
- id string
- id str
- id String
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the konnectTerraform Provider.