konnect.GatewayPluginSaml
Explore with Pulumi AI
GatewayPluginSaml Resource
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginSaml;
import com.pulumi.konnect.GatewayPluginSamlArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlConfigRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginSamlServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var myGatewaypluginsaml = new GatewayPluginSaml("myGatewaypluginsaml", GatewayPluginSamlArgs.builder()
            .config(GatewayPluginSamlConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .assertion_consumer_path("...my_assertion_consumer_path...")
                .idp_certificate("...my_idp_certificate...")
                .idp_sso_url("...my_idp_sso_url...")
                .issuer("...my_issuer...")
                .nameid_format("EmailAddress")
                .redis(GatewayPluginSamlConfigRedisArgs.builder()
                    .clusterMaxRedirections(0)
                    .clusterNodes(GatewayPluginSamlConfigRedisClusterNodeArgs.builder()
                        .ip("...my_ip...")
                        .port(21415)
                        .build())
                    .connectTimeout(1914874679)
                    .connectionIsProxied(true)
                    .database(7)
                    .host("...my_host...")
                    .keepaliveBacklog(2023529059)
                    .keepalivePoolSize(1633101853)
                    .password("...my_password...")
                    .port(6907)
                    .prefix("...my_prefix...")
                    .readTimeout(1468960257)
                    .sendTimeout(1619402496)
                    .sentinelMaster("...my_sentinel_master...")
                    .sentinelNodes(GatewayPluginSamlConfigRedisSentinelNodeArgs.builder()
                        .host("...my_host...")
                        .port(44971)
                        .build())
                    .sentinelPassword("...my_sentinel_password...")
                    .sentinelRole("any")
                    .sentinelUsername("...my_sentinel_username...")
                    .serverName("...my_server_name...")
                    .socket("...my_socket...")
                    .ssl(true)
                    .sslVerify(false)
                    .username("...my_username...")
                    .build())
                .request_digest_algorithm("SHA256")
                .request_signature_algorithm("SHA384")
                .request_signing_certificate("...my_request_signing_certificate...")
                .request_signing_key("...my_request_signing_key...")
                .response_digest_algorithm("SHA256")
                .response_encryption_key("...my_response_encryption_key...")
                .response_signature_algorithm("SHA384")
                .session_absolute_timeout(8.17)
                .session_audience("...my_session_audience...")
                .session_cookie_domain("...my_session_cookie_domain...")
                .session_cookie_http_only(true)
                .session_cookie_name("...my_session_cookie_name...")
                .session_cookie_path("...my_session_cookie_path...")
                .session_cookie_same_site("None")
                .session_cookie_secure(true)
                .session_enforce_same_subject(true)
                .session_hash_storage_key(false)
                .session_hash_subject(false)
                .session_idling_timeout(3.44)
                .session_memcached_host("...my_session_memcached_host...")
                .session_memcached_port(59429)
                .session_memcached_prefix("...my_session_memcached_prefix...")
                .session_memcached_socket("...my_session_memcached_socket...")
                .session_remember(false)
                .session_remember_absolute_timeout(4.84)
                .session_remember_cookie_name("...my_session_remember_cookie_name...")
                .session_remember_rolling_timeout(7.93)
                .session_request_headers("absolute-timeout")
                .session_response_headers("absolute-timeout")
                .session_rolling_timeout(5.35)
                .session_secret("...my_session_secret...")
                .session_storage("cookie")
                .session_store_metadata(false)
                .validate_assertion_signature(true)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginSamlId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginSamlOrderingArgs.builder()
                .after(GatewayPluginSamlOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginSamlOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpc")
            .route(GatewayPluginSamlRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginSamlServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());
    }
}
resources:
  myGatewaypluginsaml:
    type: konnect:GatewayPluginSaml
    properties:
      config:
        anonymous: '...my_anonymous...'
        assertion_consumer_path: '...my_assertion_consumer_path...'
        idp_certificate: '...my_idp_certificate...'
        idp_sso_url: '...my_idp_sso_url...'
        issuer: '...my_issuer...'
        nameid_format: EmailAddress
        redis:
          clusterMaxRedirections: 0
          clusterNodes:
            - ip: '...my_ip...'
              port: 21415
          connectTimeout: 1.914874679e+09
          connectionIsProxied: true
          database: 7
          host: '...my_host...'
          keepaliveBacklog: 2.023529059e+09
          keepalivePoolSize: 1.633101853e+09
          password: '...my_password...'
          port: 6907
          prefix: '...my_prefix...'
          readTimeout: 1.468960257e+09
          sendTimeout: 1.619402496e+09
          sentinelMaster: '...my_sentinel_master...'
          sentinelNodes:
            - host: '...my_host...'
              port: 44971
          sentinelPassword: '...my_sentinel_password...'
          sentinelRole: any
          sentinelUsername: '...my_sentinel_username...'
          serverName: '...my_server_name...'
          socket: '...my_socket...'
          ssl: true
          sslVerify: false
          username: '...my_username...'
        request_digest_algorithm: SHA256
        request_signature_algorithm: SHA384
        request_signing_certificate: '...my_request_signing_certificate...'
        request_signing_key: '...my_request_signing_key...'
        response_digest_algorithm: SHA256
        response_encryption_key: '...my_response_encryption_key...'
        response_signature_algorithm: SHA384
        session_absolute_timeout: 8.17
        session_audience: '...my_session_audience...'
        session_cookie_domain: '...my_session_cookie_domain...'
        session_cookie_http_only: true
        session_cookie_name: '...my_session_cookie_name...'
        session_cookie_path: '...my_session_cookie_path...'
        session_cookie_same_site: None
        session_cookie_secure: true
        session_enforce_same_subject: true
        session_hash_storage_key: false
        session_hash_subject: false
        session_idling_timeout: 3.44
        session_memcached_host: '...my_session_memcached_host...'
        session_memcached_port: 59429
        session_memcached_prefix: '...my_session_memcached_prefix...'
        session_memcached_socket: '...my_session_memcached_socket...'
        session_remember: false
        session_remember_absolute_timeout: 4.84
        session_remember_cookie_name: '...my_session_remember_cookie_name...'
        session_remember_rolling_timeout: 7.93
        session_request_headers:
          - absolute-timeout
        session_response_headers:
          - absolute-timeout
        session_rolling_timeout: 5.35
        session_secret: '...my_session_secret...'
        session_storage: cookie
        session_store_metadata: false
        validate_assertion_signature: true
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginSamlId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpc
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
Create GatewayPluginSaml Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginSaml(name: string, args: GatewayPluginSamlArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginSaml(resource_name: str,
                      args: GatewayPluginSamlArgs,
                      opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginSaml(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      config: Optional[GatewayPluginSamlConfigArgs] = None,
                      control_plane_id: Optional[str] = None,
                      enabled: Optional[bool] = None,
                      gateway_plugin_saml_id: Optional[str] = None,
                      instance_name: Optional[str] = None,
                      ordering: Optional[GatewayPluginSamlOrderingArgs] = None,
                      protocols: Optional[Sequence[str]] = None,
                      route: Optional[GatewayPluginSamlRouteArgs] = None,
                      service: Optional[GatewayPluginSamlServiceArgs] = None,
                      tags: Optional[Sequence[str]] = None)func NewGatewayPluginSaml(ctx *Context, name string, args GatewayPluginSamlArgs, opts ...ResourceOption) (*GatewayPluginSaml, error)public GatewayPluginSaml(string name, GatewayPluginSamlArgs args, CustomResourceOptions? opts = null)
public GatewayPluginSaml(String name, GatewayPluginSamlArgs args)
public GatewayPluginSaml(String name, GatewayPluginSamlArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginSaml
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayPluginSamlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayPluginSamlArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayPluginSamlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginSamlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginSamlArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayPluginSamlResource = new Konnect.GatewayPluginSaml("gatewayPluginSamlResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginSamlConfigArgs
    {
        Anonymous = "string",
        AssertionConsumerPath = "string",
        IdpCertificate = "string",
        IdpSsoUrl = "string",
        Issuer = "string",
        NameidFormat = "string",
        Redis = new Konnect.Inputs.GatewayPluginSamlConfigRedisArgs
        {
            ClusterMaxRedirections = 0,
            ClusterNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginSamlConfigRedisClusterNodeArgs
                {
                    Ip = "string",
                    Port = 0,
                },
            },
            ConnectTimeout = 0,
            ConnectionIsProxied = false,
            Database = 0,
            Host = "string",
            KeepaliveBacklog = 0,
            KeepalivePoolSize = 0,
            Password = "string",
            Port = 0,
            Prefix = "string",
            ReadTimeout = 0,
            SendTimeout = 0,
            SentinelMaster = "string",
            SentinelNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginSamlConfigRedisSentinelNodeArgs
                {
                    Host = "string",
                    Port = 0,
                },
            },
            SentinelPassword = "string",
            SentinelRole = "string",
            SentinelUsername = "string",
            ServerName = "string",
            Socket = "string",
            Ssl = false,
            SslVerify = false,
            Username = "string",
        },
        RequestDigestAlgorithm = "string",
        RequestSignatureAlgorithm = "string",
        RequestSigningCertificate = "string",
        RequestSigningKey = "string",
        ResponseDigestAlgorithm = "string",
        ResponseEncryptionKey = "string",
        ResponseSignatureAlgorithm = "string",
        SessionAbsoluteTimeout = 0,
        SessionAudience = "string",
        SessionCookieDomain = "string",
        SessionCookieHttpOnly = false,
        SessionCookieName = "string",
        SessionCookiePath = "string",
        SessionCookieSameSite = "string",
        SessionCookieSecure = false,
        SessionEnforceSameSubject = false,
        SessionHashStorageKey = false,
        SessionHashSubject = false,
        SessionIdlingTimeout = 0,
        SessionMemcachedHost = "string",
        SessionMemcachedPort = 0,
        SessionMemcachedPrefix = "string",
        SessionMemcachedSocket = "string",
        SessionRemember = false,
        SessionRememberAbsoluteTimeout = 0,
        SessionRememberCookieName = "string",
        SessionRememberRollingTimeout = 0,
        SessionRequestHeaders = new[]
        {
            "string",
        },
        SessionResponseHeaders = new[]
        {
            "string",
        },
        SessionRollingTimeout = 0,
        SessionSecret = "string",
        SessionStorage = "string",
        SessionStoreMetadata = false,
        ValidateAssertionSignature = false,
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginSamlId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginSamlOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginSamlOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginSamlOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginSamlRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginSamlServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
example, err := konnect.NewGatewayPluginSaml(ctx, "gatewayPluginSamlResource", &konnect.GatewayPluginSamlArgs{
Config: &.GatewayPluginSamlConfigArgs{
Anonymous: pulumi.String("string"),
AssertionConsumerPath: pulumi.String("string"),
IdpCertificate: pulumi.String("string"),
IdpSsoUrl: pulumi.String("string"),
Issuer: pulumi.String("string"),
NameidFormat: pulumi.String("string"),
Redis: &.GatewayPluginSamlConfigRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: .GatewayPluginSamlConfigRedisClusterNodeArray{
&.GatewayPluginSamlConfigRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
Prefix: pulumi.String("string"),
ReadTimeout: pulumi.Float64(0),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: .GatewayPluginSamlConfigRedisSentinelNodeArray{
&.GatewayPluginSamlConfigRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Socket: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
RequestDigestAlgorithm: pulumi.String("string"),
RequestSignatureAlgorithm: pulumi.String("string"),
RequestSigningCertificate: pulumi.String("string"),
RequestSigningKey: pulumi.String("string"),
ResponseDigestAlgorithm: pulumi.String("string"),
ResponseEncryptionKey: pulumi.String("string"),
ResponseSignatureAlgorithm: pulumi.String("string"),
SessionAbsoluteTimeout: pulumi.Float64(0),
SessionAudience: pulumi.String("string"),
SessionCookieDomain: pulumi.String("string"),
SessionCookieHttpOnly: pulumi.Bool(false),
SessionCookieName: pulumi.String("string"),
SessionCookiePath: pulumi.String("string"),
SessionCookieSameSite: pulumi.String("string"),
SessionCookieSecure: pulumi.Bool(false),
SessionEnforceSameSubject: pulumi.Bool(false),
SessionHashStorageKey: pulumi.Bool(false),
SessionHashSubject: pulumi.Bool(false),
SessionIdlingTimeout: pulumi.Float64(0),
SessionMemcachedHost: pulumi.String("string"),
SessionMemcachedPort: pulumi.Float64(0),
SessionMemcachedPrefix: pulumi.String("string"),
SessionMemcachedSocket: pulumi.String("string"),
SessionRemember: pulumi.Bool(false),
SessionRememberAbsoluteTimeout: pulumi.Float64(0),
SessionRememberCookieName: pulumi.String("string"),
SessionRememberRollingTimeout: pulumi.Float64(0),
SessionRequestHeaders: pulumi.StringArray{
pulumi.String("string"),
},
SessionResponseHeaders: pulumi.StringArray{
pulumi.String("string"),
},
SessionRollingTimeout: pulumi.Float64(0),
SessionSecret: pulumi.String("string"),
SessionStorage: pulumi.String("string"),
SessionStoreMetadata: pulumi.Bool(false),
ValidateAssertionSignature: pulumi.Bool(false),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginSamlId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginSamlOrderingArgs{
After: &.GatewayPluginSamlOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginSamlOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginSamlRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginSamlServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var gatewayPluginSamlResource = new GatewayPluginSaml("gatewayPluginSamlResource", GatewayPluginSamlArgs.builder()
    .config(GatewayPluginSamlConfigArgs.builder()
        .anonymous("string")
        .assertionConsumerPath("string")
        .idpCertificate("string")
        .idpSsoUrl("string")
        .issuer("string")
        .nameidFormat("string")
        .redis(GatewayPluginSamlConfigRedisArgs.builder()
            .clusterMaxRedirections(0)
            .clusterNodes(GatewayPluginSamlConfigRedisClusterNodeArgs.builder()
                .ip("string")
                .port(0)
                .build())
            .connectTimeout(0)
            .connectionIsProxied(false)
            .database(0)
            .host("string")
            .keepaliveBacklog(0)
            .keepalivePoolSize(0)
            .password("string")
            .port(0)
            .prefix("string")
            .readTimeout(0)
            .sendTimeout(0)
            .sentinelMaster("string")
            .sentinelNodes(GatewayPluginSamlConfigRedisSentinelNodeArgs.builder()
                .host("string")
                .port(0)
                .build())
            .sentinelPassword("string")
            .sentinelRole("string")
            .sentinelUsername("string")
            .serverName("string")
            .socket("string")
            .ssl(false)
            .sslVerify(false)
            .username("string")
            .build())
        .requestDigestAlgorithm("string")
        .requestSignatureAlgorithm("string")
        .requestSigningCertificate("string")
        .requestSigningKey("string")
        .responseDigestAlgorithm("string")
        .responseEncryptionKey("string")
        .responseSignatureAlgorithm("string")
        .sessionAbsoluteTimeout(0)
        .sessionAudience("string")
        .sessionCookieDomain("string")
        .sessionCookieHttpOnly(false)
        .sessionCookieName("string")
        .sessionCookiePath("string")
        .sessionCookieSameSite("string")
        .sessionCookieSecure(false)
        .sessionEnforceSameSubject(false)
        .sessionHashStorageKey(false)
        .sessionHashSubject(false)
        .sessionIdlingTimeout(0)
        .sessionMemcachedHost("string")
        .sessionMemcachedPort(0)
        .sessionMemcachedPrefix("string")
        .sessionMemcachedSocket("string")
        .sessionRemember(false)
        .sessionRememberAbsoluteTimeout(0)
        .sessionRememberCookieName("string")
        .sessionRememberRollingTimeout(0)
        .sessionRequestHeaders("string")
        .sessionResponseHeaders("string")
        .sessionRollingTimeout(0)
        .sessionSecret("string")
        .sessionStorage("string")
        .sessionStoreMetadata(false)
        .validateAssertionSignature(false)
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginSamlId("string")
    .instanceName("string")
    .ordering(GatewayPluginSamlOrderingArgs.builder()
        .after(GatewayPluginSamlOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginSamlOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginSamlRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginSamlServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
gateway_plugin_saml_resource = konnect.GatewayPluginSaml("gatewayPluginSamlResource",
    config={
        "anonymous": "string",
        "assertion_consumer_path": "string",
        "idp_certificate": "string",
        "idp_sso_url": "string",
        "issuer": "string",
        "nameid_format": "string",
        "redis": {
            "cluster_max_redirections": 0,
            "cluster_nodes": [{
                "ip": "string",
                "port": 0,
            }],
            "connect_timeout": 0,
            "connection_is_proxied": False,
            "database": 0,
            "host": "string",
            "keepalive_backlog": 0,
            "keepalive_pool_size": 0,
            "password": "string",
            "port": 0,
            "prefix": "string",
            "read_timeout": 0,
            "send_timeout": 0,
            "sentinel_master": "string",
            "sentinel_nodes": [{
                "host": "string",
                "port": 0,
            }],
            "sentinel_password": "string",
            "sentinel_role": "string",
            "sentinel_username": "string",
            "server_name": "string",
            "socket": "string",
            "ssl": False,
            "ssl_verify": False,
            "username": "string",
        },
        "request_digest_algorithm": "string",
        "request_signature_algorithm": "string",
        "request_signing_certificate": "string",
        "request_signing_key": "string",
        "response_digest_algorithm": "string",
        "response_encryption_key": "string",
        "response_signature_algorithm": "string",
        "session_absolute_timeout": 0,
        "session_audience": "string",
        "session_cookie_domain": "string",
        "session_cookie_http_only": False,
        "session_cookie_name": "string",
        "session_cookie_path": "string",
        "session_cookie_same_site": "string",
        "session_cookie_secure": False,
        "session_enforce_same_subject": False,
        "session_hash_storage_key": False,
        "session_hash_subject": False,
        "session_idling_timeout": 0,
        "session_memcached_host": "string",
        "session_memcached_port": 0,
        "session_memcached_prefix": "string",
        "session_memcached_socket": "string",
        "session_remember": False,
        "session_remember_absolute_timeout": 0,
        "session_remember_cookie_name": "string",
        "session_remember_rolling_timeout": 0,
        "session_request_headers": ["string"],
        "session_response_headers": ["string"],
        "session_rolling_timeout": 0,
        "session_secret": "string",
        "session_storage": "string",
        "session_store_metadata": False,
        "validate_assertion_signature": False,
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_saml_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
const gatewayPluginSamlResource = new konnect.GatewayPluginSaml("gatewayPluginSamlResource", {
    config: {
        anonymous: "string",
        assertionConsumerPath: "string",
        idpCertificate: "string",
        idpSsoUrl: "string",
        issuer: "string",
        nameidFormat: "string",
        redis: {
            clusterMaxRedirections: 0,
            clusterNodes: [{
                ip: "string",
                port: 0,
            }],
            connectTimeout: 0,
            connectionIsProxied: false,
            database: 0,
            host: "string",
            keepaliveBacklog: 0,
            keepalivePoolSize: 0,
            password: "string",
            port: 0,
            prefix: "string",
            readTimeout: 0,
            sendTimeout: 0,
            sentinelMaster: "string",
            sentinelNodes: [{
                host: "string",
                port: 0,
            }],
            sentinelPassword: "string",
            sentinelRole: "string",
            sentinelUsername: "string",
            serverName: "string",
            socket: "string",
            ssl: false,
            sslVerify: false,
            username: "string",
        },
        requestDigestAlgorithm: "string",
        requestSignatureAlgorithm: "string",
        requestSigningCertificate: "string",
        requestSigningKey: "string",
        responseDigestAlgorithm: "string",
        responseEncryptionKey: "string",
        responseSignatureAlgorithm: "string",
        sessionAbsoluteTimeout: 0,
        sessionAudience: "string",
        sessionCookieDomain: "string",
        sessionCookieHttpOnly: false,
        sessionCookieName: "string",
        sessionCookiePath: "string",
        sessionCookieSameSite: "string",
        sessionCookieSecure: false,
        sessionEnforceSameSubject: false,
        sessionHashStorageKey: false,
        sessionHashSubject: false,
        sessionIdlingTimeout: 0,
        sessionMemcachedHost: "string",
        sessionMemcachedPort: 0,
        sessionMemcachedPrefix: "string",
        sessionMemcachedSocket: "string",
        sessionRemember: false,
        sessionRememberAbsoluteTimeout: 0,
        sessionRememberCookieName: "string",
        sessionRememberRollingTimeout: 0,
        sessionRequestHeaders: ["string"],
        sessionResponseHeaders: ["string"],
        sessionRollingTimeout: 0,
        sessionSecret: "string",
        sessionStorage: "string",
        sessionStoreMetadata: false,
        validateAssertionSignature: false,
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginSamlId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
type: konnect:GatewayPluginSaml
properties:
    config:
        anonymous: string
        assertionConsumerPath: string
        idpCertificate: string
        idpSsoUrl: string
        issuer: string
        nameidFormat: string
        redis:
            clusterMaxRedirections: 0
            clusterNodes:
                - ip: string
                  port: 0
            connectTimeout: 0
            connectionIsProxied: false
            database: 0
            host: string
            keepaliveBacklog: 0
            keepalivePoolSize: 0
            password: string
            port: 0
            prefix: string
            readTimeout: 0
            sendTimeout: 0
            sentinelMaster: string
            sentinelNodes:
                - host: string
                  port: 0
            sentinelPassword: string
            sentinelRole: string
            sentinelUsername: string
            serverName: string
            socket: string
            ssl: false
            sslVerify: false
            username: string
        requestDigestAlgorithm: string
        requestSignatureAlgorithm: string
        requestSigningCertificate: string
        requestSigningKey: string
        responseDigestAlgorithm: string
        responseEncryptionKey: string
        responseSignatureAlgorithm: string
        sessionAbsoluteTimeout: 0
        sessionAudience: string
        sessionCookieDomain: string
        sessionCookieHttpOnly: false
        sessionCookieName: string
        sessionCookiePath: string
        sessionCookieSameSite: string
        sessionCookieSecure: false
        sessionEnforceSameSubject: false
        sessionHashStorageKey: false
        sessionHashSubject: false
        sessionIdlingTimeout: 0
        sessionMemcachedHost: string
        sessionMemcachedPort: 0
        sessionMemcachedPrefix: string
        sessionMemcachedSocket: string
        sessionRemember: false
        sessionRememberAbsoluteTimeout: 0
        sessionRememberCookieName: string
        sessionRememberRollingTimeout: 0
        sessionRequestHeaders:
            - string
        sessionResponseHeaders:
            - string
        sessionRollingTimeout: 0
        sessionSecret: string
        sessionStorage: string
        sessionStoreMetadata: false
        validateAssertionSignature: false
    controlPlaneId: string
    enabled: false
    gatewayPluginSamlId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
GatewayPluginSaml Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayPluginSaml resource accepts the following input properties:
- Config
GatewayPlugin Saml Config 
- ControlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Enabled bool
- Whether the plugin is applied.
- GatewayPlugin stringSaml Id 
- The ID of this resource.
- InstanceName string
- Ordering
GatewayPlugin Saml Ordering 
- Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Config
GatewayPlugin Saml Config Args 
- ControlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Enabled bool
- Whether the plugin is applied.
- GatewayPlugin stringSaml Id 
- The ID of this resource.
- InstanceName string
- Ordering
GatewayPlugin Saml Ordering Args 
- Protocols []string
- A set of strings representing HTTP protocols.
- Route
GatewayPlugin Saml Route Args 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
GatewayPlugin Saml Service Args 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
GatewayPlugin Saml Config 
- controlPlane StringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- enabled Boolean
- Whether the plugin is applied.
- gatewayPlugin StringSaml Id 
- The ID of this resource.
- instanceName String
- ordering
GatewayPlugin Saml Ordering 
- protocols List<String>
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
GatewayPlugin Saml Config 
- controlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- enabled boolean
- Whether the plugin is applied.
- gatewayPlugin stringSaml Id 
- The ID of this resource.
- instanceName string
- ordering
GatewayPlugin Saml Ordering 
- protocols string[]
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
GatewayPlugin Saml Config Args 
- control_plane_ strid 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- enabled bool
- Whether the plugin is applied.
- gateway_plugin_ strsaml_ id 
- The ID of this resource.
- instance_name str
- ordering
GatewayPlugin Saml Ordering Args 
- protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route Args 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service Args 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config Property Map
- controlPlane StringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- enabled Boolean
- Whether the plugin is applied.
- gatewayPlugin StringSaml Id 
- The ID of this resource.
- instanceName String
- ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginSaml resource produces the following output properties:
- created_at float
- Unix epoch when the resource was created.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_at float
- Unix epoch when the resource was last updated.
Look up Existing GatewayPluginSaml Resource
Get an existing GatewayPluginSaml resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayPluginSamlState, opts?: CustomResourceOptions): GatewayPluginSaml@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginSamlConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_saml_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginSamlOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginSamlRouteArgs] = None,
        service: Optional[GatewayPluginSamlServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginSamlfunc GetGatewayPluginSaml(ctx *Context, name string, id IDInput, state *GatewayPluginSamlState, opts ...ResourceOption) (*GatewayPluginSaml, error)public static GatewayPluginSaml Get(string name, Input<string> id, GatewayPluginSamlState? state, CustomResourceOptions? opts = null)public static GatewayPluginSaml get(String name, Output<String> id, GatewayPluginSamlState state, CustomResourceOptions options)resources:  _:    type: konnect:GatewayPluginSaml    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
GatewayPlugin Saml Config 
- ControlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- CreatedAt double
- Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- GatewayPlugin stringSaml Id 
- The ID of this resource.
- InstanceName string
- Ordering
GatewayPlugin Saml Ordering 
- Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- UpdatedAt double
- Unix epoch when the resource was last updated.
- Config
GatewayPlugin Saml Config Args 
- ControlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- CreatedAt float64
- Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- GatewayPlugin stringSaml Id 
- The ID of this resource.
- InstanceName string
- Ordering
GatewayPlugin Saml Ordering Args 
- Protocols []string
- A set of strings representing HTTP protocols.
- Route
GatewayPlugin Saml Route Args 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
GatewayPlugin Saml Service Args 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- UpdatedAt float64
- Unix epoch when the resource was last updated.
- config
GatewayPlugin Saml Config 
- controlPlane StringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- createdAt Double
- Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gatewayPlugin StringSaml Id 
- The ID of this resource.
- instanceName String
- ordering
GatewayPlugin Saml Ordering 
- protocols List<String>
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updatedAt Double
- Unix epoch when the resource was last updated.
- config
GatewayPlugin Saml Config 
- controlPlane stringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- createdAt number
- Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gatewayPlugin stringSaml Id 
- The ID of this resource.
- instanceName string
- ordering
GatewayPlugin Saml Ordering 
- protocols string[]
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updatedAt number
- Unix epoch when the resource was last updated.
- config
GatewayPlugin Saml Config Args 
- control_plane_ strid 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created_at float
- Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_plugin_ strsaml_ id 
- The ID of this resource.
- instance_name str
- ordering
GatewayPlugin Saml Ordering Args 
- protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
GatewayPlugin Saml Route Args 
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
GatewayPlugin Saml Service Args 
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_at float
- Unix epoch when the resource was last updated.
- config Property Map
- controlPlane StringId 
- The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- createdAt Number
- Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gatewayPlugin StringSaml Id 
- The ID of this resource.
- instanceName String
- ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updatedAt Number
- Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginSamlConfig, GatewayPluginSamlConfigArgs        
- 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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- Redis
GatewayPlugin Saml Config Redis 
- RequestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- RequestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- Redis
GatewayPlugin Saml Config Redis 
- RequestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- RequestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- redis
GatewayPlugin Saml Config Redis 
- requestDigest StringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- requestSignature StringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- redis
GatewayPlugin Saml Config Redis 
- requestDigest stringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- requestSignature stringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- redis
GatewayPlugin Saml Config Redis 
- request_digest_ stralgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- request_signature_ stralgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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. must be one of ["EmailAddress", "Persistent", "Transient", "Unspecified"]
- redis Property Map
- requestDigest StringAlgorithm 
- The digest algorithm for Authn requests: - SHA256-SHA1. must be one of ["SHA1", "SHA256"]
- requestSignature StringAlgorithm 
- The signature algorithm for signing Authn requests. Options available are: - SHA256-SHA384-SHA512. must be one of ["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. must be one of ["SHA1", "SHA256"]
- 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. must be one of ["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. must be one of ["Default", "Lax", "None", "Strict"]
- 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. must be one of ["cookie", "memcache", "memcached", "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.
GatewayPluginSamlConfigRedis, GatewayPluginSamlConfigRedisArgs          
- ClusterMax doubleRedirections 
- Maximum retry attempts for redirection.
- ClusterNodes List<GatewayPlugin 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<GatewayPlugin 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. must be one of ["any", "master", "slave"]
- 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 []GatewayPlugin 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 []GatewayPlugin 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. must be one of ["any", "master", "slave"]
- 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<GatewayPlugin 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<GatewayPlugin 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. must be one of ["any", "master", "slave"]
- 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 GatewayPlugin 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 GatewayPlugin 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. must be one of ["any", "master", "slave"]
- 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[GatewayPlugin 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[GatewayPlugin 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. must be one of ["any", "master", "slave"]
- 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. must be one of ["any", "master", "slave"]
- 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.
GatewayPluginSamlConfigRedisClusterNode, GatewayPluginSamlConfigRedisClusterNodeArgs              
GatewayPluginSamlConfigRedisSentinelNode, GatewayPluginSamlConfigRedisSentinelNodeArgs              
GatewayPluginSamlOrdering, GatewayPluginSamlOrderingArgs        
GatewayPluginSamlOrderingAfter, GatewayPluginSamlOrderingAfterArgs          
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginSamlOrderingBefore, GatewayPluginSamlOrderingBeforeArgs          
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginSamlRoute, GatewayPluginSamlRouteArgs        
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginSamlService, GatewayPluginSamlServiceArgs        
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
$ pulumi import konnect:index/gatewayPluginSaml:GatewayPluginSaml my_konnect_gateway_plugin_saml "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the konnectTerraform Provider.