Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginJwt
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginJwt

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

GatewayPluginJwt 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.GatewayPluginJwt;
import com.pulumi.konnect.GatewayPluginJwtArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginJwtServiceArgs;
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 myGatewaypluginjwt = new GatewayPluginJwt("myGatewaypluginjwt", GatewayPluginJwtArgs.builder()
            .config(GatewayPluginJwtConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .claims_to_verify("exp")
                .cookie_names("...")
                .header_names("...")
                .key_claim_name("...my_key_claim_name...")
                .maximum_expiration(2.49057258e+07)
                .realm("...my_realm...")
                .run_on_preflight(true)
                .secret_is_base64(false)
                .uri_param_names("...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginJwtId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginJwtOrderingArgs.builder()
                .after(GatewayPluginJwtOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginJwtOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginJwtRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginJwtServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewaypluginjwt:
    type: konnect:GatewayPluginJwt
    properties:
      config:
        anonymous: '...my_anonymous...'
        claims_to_verify:
          - exp
        cookie_names:
          - '...'
        header_names:
          - '...'
        key_claim_name: '...my_key_claim_name...'
        maximum_expiration: 2.49057258e+07
        realm: '...my_realm...'
        run_on_preflight: true
        secret_is_base64: false
        uri_param_names:
          - '...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginJwtId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
Copy

Create GatewayPluginJwt Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayPluginJwt(name: string, args: GatewayPluginJwtArgs, opts?: CustomResourceOptions);
@overload
def GatewayPluginJwt(resource_name: str,
                     args: GatewayPluginJwtArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginJwt(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     config: Optional[GatewayPluginJwtConfigArgs] = None,
                     control_plane_id: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     gateway_plugin_jwt_id: Optional[str] = None,
                     instance_name: Optional[str] = None,
                     ordering: Optional[GatewayPluginJwtOrderingArgs] = None,
                     protocols: Optional[Sequence[str]] = None,
                     route: Optional[GatewayPluginJwtRouteArgs] = None,
                     service: Optional[GatewayPluginJwtServiceArgs] = None,
                     tags: Optional[Sequence[str]] = None)
func NewGatewayPluginJwt(ctx *Context, name string, args GatewayPluginJwtArgs, opts ...ResourceOption) (*GatewayPluginJwt, error)
public GatewayPluginJwt(string name, GatewayPluginJwtArgs args, CustomResourceOptions? opts = null)
public GatewayPluginJwt(String name, GatewayPluginJwtArgs args)
public GatewayPluginJwt(String name, GatewayPluginJwtArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginJwt
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginJwtArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginJwtArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginJwtArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginJwtArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayPluginJwtArgs
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 gatewayPluginJwtResource = new Konnect.GatewayPluginJwt("gatewayPluginJwtResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginJwtConfigArgs
    {
        Anonymous = "string",
        ClaimsToVerifies = new[]
        {
            "string",
        },
        CookieNames = new[]
        {
            "string",
        },
        HeaderNames = new[]
        {
            "string",
        },
        KeyClaimName = "string",
        MaximumExpiration = 0,
        Realm = "string",
        RunOnPreflight = false,
        SecretIsBase64 = false,
        UriParamNames = new[]
        {
            "string",
        },
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginJwtId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginJwtOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginJwtOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginJwtOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginJwtRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginJwtServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayPluginJwt(ctx, "gatewayPluginJwtResource", &konnect.GatewayPluginJwtArgs{
Config: &.GatewayPluginJwtConfigArgs{
Anonymous: pulumi.String("string"),
ClaimsToVerifies: pulumi.StringArray{
pulumi.String("string"),
},
CookieNames: pulumi.StringArray{
pulumi.String("string"),
},
HeaderNames: pulumi.StringArray{
pulumi.String("string"),
},
KeyClaimName: pulumi.String("string"),
MaximumExpiration: pulumi.Float64(0),
Realm: pulumi.String("string"),
RunOnPreflight: pulumi.Bool(false),
SecretIsBase64: pulumi.Bool(false),
UriParamNames: pulumi.StringArray{
pulumi.String("string"),
},
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginJwtId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginJwtOrderingArgs{
After: &.GatewayPluginJwtOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginJwtOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginJwtRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginJwtServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayPluginJwtResource = new GatewayPluginJwt("gatewayPluginJwtResource", GatewayPluginJwtArgs.builder()
    .config(GatewayPluginJwtConfigArgs.builder()
        .anonymous("string")
        .claimsToVerifies("string")
        .cookieNames("string")
        .headerNames("string")
        .keyClaimName("string")
        .maximumExpiration(0)
        .realm("string")
        .runOnPreflight(false)
        .secretIsBase64(false)
        .uriParamNames("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginJwtId("string")
    .instanceName("string")
    .ordering(GatewayPluginJwtOrderingArgs.builder()
        .after(GatewayPluginJwtOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginJwtOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginJwtRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginJwtServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_plugin_jwt_resource = konnect.GatewayPluginJwt("gatewayPluginJwtResource",
    config={
        "anonymous": "string",
        "claims_to_verifies": ["string"],
        "cookie_names": ["string"],
        "header_names": ["string"],
        "key_claim_name": "string",
        "maximum_expiration": 0,
        "realm": "string",
        "run_on_preflight": False,
        "secret_is_base64": False,
        "uri_param_names": ["string"],
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_jwt_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayPluginJwtResource = new konnect.GatewayPluginJwt("gatewayPluginJwtResource", {
    config: {
        anonymous: "string",
        claimsToVerifies: ["string"],
        cookieNames: ["string"],
        headerNames: ["string"],
        keyClaimName: "string",
        maximumExpiration: 0,
        realm: "string",
        runOnPreflight: false,
        secretIsBase64: false,
        uriParamNames: ["string"],
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginJwtId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayPluginJwt
properties:
    config:
        anonymous: string
        claimsToVerifies:
            - string
        cookieNames:
            - string
        headerNames:
            - string
        keyClaimName: string
        maximumExpiration: 0
        realm: string
        runOnPreflight: false
        secretIsBase64: false
        uriParamNames:
            - string
    controlPlaneId: string
    enabled: false
    gatewayPluginJwtId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
Copy

GatewayPluginJwt 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 GatewayPluginJwt resource accepts the following input properties:

Config This property is required. GatewayPluginJwtConfig
ControlPlaneId This property is required. string
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.
GatewayPluginJwtId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginJwtOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
Tags List<string>
An optional set of strings associated with the Plugin for grouping and filtering.
Config This property is required. GatewayPluginJwtConfigArgs
ControlPlaneId This property is required. string
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.
GatewayPluginJwtId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginJwtOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginJwtRouteArgs
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 GatewayPluginJwtServiceArgs
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.
Tags []string
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginJwtConfig
controlPlaneId This property is required. String
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.
gatewayPluginJwtId String
The ID of this resource.
instanceName String
ordering GatewayPluginJwtOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
tags List<String>
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginJwtConfig
controlPlaneId This property is required. string
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.
gatewayPluginJwtId string
The ID of this resource.
instanceName string
ordering GatewayPluginJwtOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
tags string[]
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. GatewayPluginJwtConfigArgs
control_plane_id This property is required. str
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_jwt_id str
The ID of this resource.
instance_name str
ordering GatewayPluginJwtOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginJwtRouteArgs
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 GatewayPluginJwtServiceArgs
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.
tags Sequence[str]
An optional set of strings associated with the Plugin for grouping and filtering.
config This property is required. Property Map
controlPlaneId This property is required. String
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.
gatewayPluginJwtId String
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.
tags 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 GatewayPluginJwt resource produces the following output properties:

CreatedAt double
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt double
Unix epoch when the resource was last updated.
CreatedAt float64
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt float64
Unix epoch when the resource was last updated.
createdAt Double
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Double
Unix epoch when the resource was last updated.
createdAt number
Unix epoch when the resource was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt number
Unix epoch when the resource was last updated.
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.
createdAt Number
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Number
Unix epoch when the resource was last updated.

Look up Existing GatewayPluginJwt Resource

Get an existing GatewayPluginJwt 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?: GatewayPluginJwtState, opts?: CustomResourceOptions): GatewayPluginJwt
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginJwtConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_jwt_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginJwtOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginJwtRouteArgs] = None,
        service: Optional[GatewayPluginJwtServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginJwt
func GetGatewayPluginJwt(ctx *Context, name string, id IDInput, state *GatewayPluginJwtState, opts ...ResourceOption) (*GatewayPluginJwt, error)
public static GatewayPluginJwt Get(string name, Input<string> id, GatewayPluginJwtState? state, CustomResourceOptions? opts = null)
public static GatewayPluginJwt get(String name, Output<String> id, GatewayPluginJwtState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginJwt    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Config GatewayPluginJwtConfig
ControlPlaneId string
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.
GatewayPluginJwtId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginJwtOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
Tags 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 GatewayPluginJwtConfigArgs
ControlPlaneId string
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.
GatewayPluginJwtId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginJwtOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginJwtRouteArgs
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 GatewayPluginJwtServiceArgs
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.
Tags []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 GatewayPluginJwtConfig
controlPlaneId String
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.
gatewayPluginJwtId String
The ID of this resource.
instanceName String
ordering GatewayPluginJwtOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
tags 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 GatewayPluginJwtConfig
controlPlaneId string
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.
gatewayPluginJwtId string
The ID of this resource.
instanceName string
ordering GatewayPluginJwtOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginJwtRoute
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 GatewayPluginJwtService
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.
tags 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 GatewayPluginJwtConfigArgs
control_plane_id str
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_jwt_id str
The ID of this resource.
instance_name str
ordering GatewayPluginJwtOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginJwtRouteArgs
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 GatewayPluginJwtServiceArgs
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.
tags 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
controlPlaneId String
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.
gatewayPluginJwtId String
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.
tags 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

GatewayPluginJwtConfig
, GatewayPluginJwtConfigArgs

Anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClaimsToVerifies List<string>
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
CookieNames List<string>
A list of cookie names that Kong will inspect to retrieve JWTs.
HeaderNames List<string>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
KeyClaimName string
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
MaximumExpiration double
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
Realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
SecretIsBase64 bool
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
UriParamNames List<string>
A list of querystring parameters that Kong will inspect to retrieve JWTs.
Anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClaimsToVerifies []string
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
CookieNames []string
A list of cookie names that Kong will inspect to retrieve JWTs.
HeaderNames []string
A list of HTTP header names that Kong will inspect to retrieve JWTs.
KeyClaimName string
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
MaximumExpiration float64
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
Realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
SecretIsBase64 bool
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
UriParamNames []string
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies List<String>
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
cookieNames List<String>
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames List<String>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName String
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
maximumExpiration Double
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight Boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
secretIsBase64 Boolean
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
uriParamNames List<String>
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies string[]
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
cookieNames string[]
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames string[]
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName string
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
maximumExpiration number
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
secretIsBase64 boolean
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
uriParamNames string[]
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous str
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claims_to_verifies Sequence[str]
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
cookie_names Sequence[str]
A list of cookie names that Kong will inspect to retrieve JWTs.
header_names Sequence[str]
A list of HTTP header names that Kong will inspect to retrieve JWTs.
key_claim_name str
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
maximum_expiration float
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm str
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
run_on_preflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
secret_is_base64 bool
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
uri_param_names Sequence[str]
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies List<String>
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
cookieNames List<String>
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames List<String>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName String
The name of the claim in which the key identifying the secret must be passed. The plugin will attempt to read this claim from the JWT payload and the header, in that order.
maximumExpiration Number
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight Boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests will always be allowed.
secretIsBase64 Boolean
If true, the plugin assumes the credential’s secret to be base64 encoded. You will need to create a base64-encoded secret for your Consumer, and sign your JWT with the original secret.
uriParamNames List<String>
A list of querystring parameters that Kong will inspect to retrieve JWTs.

GatewayPluginJwtOrdering
, GatewayPluginJwtOrderingArgs

GatewayPluginJwtOrderingAfter
, GatewayPluginJwtOrderingAfterArgs

Accesses List<string>
Accesses []string
accesses List<String>
accesses string[]
accesses Sequence[str]
accesses List<String>

GatewayPluginJwtOrderingBefore
, GatewayPluginJwtOrderingBeforeArgs

Accesses List<string>
Accesses []string
accesses List<String>
accesses string[]
accesses Sequence[str]
accesses List<String>

GatewayPluginJwtRoute
, GatewayPluginJwtRouteArgs

Id string
Id string
id String
id string
id str
id String

GatewayPluginJwtService
, GatewayPluginJwtServiceArgs

Id string
Id string
id String
id string
id str
id String

Import

$ pulumi import konnect:index/gatewayPluginJwt:GatewayPluginJwt my_konnect_gateway_plugin_jwt "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
Copy

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 konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect