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

konnect.getGatewayPluginJwt

Explore with Pulumi AI

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

Using getGatewayPluginJwt

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayPluginJwt(args: GetGatewayPluginJwtArgs, opts?: InvokeOptions): Promise<GetGatewayPluginJwtResult>
function getGatewayPluginJwtOutput(args: GetGatewayPluginJwtOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginJwtResult>
Copy
def get_gateway_plugin_jwt(control_plane_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetGatewayPluginJwtResult
def get_gateway_plugin_jwt_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginJwtResult]
Copy
func LookupGatewayPluginJwt(ctx *Context, args *LookupGatewayPluginJwtArgs, opts ...InvokeOption) (*LookupGatewayPluginJwtResult, error)
func LookupGatewayPluginJwtOutput(ctx *Context, args *LookupGatewayPluginJwtOutputArgs, opts ...InvokeOption) LookupGatewayPluginJwtResultOutput
Copy

> Note: This function is named LookupGatewayPluginJwt in the Go SDK.

public static class GetGatewayPluginJwt 
{
    public static Task<GetGatewayPluginJwtResult> InvokeAsync(GetGatewayPluginJwtArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginJwtResult> Invoke(GetGatewayPluginJwtInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginJwtResult> getGatewayPluginJwt(GetGatewayPluginJwtArgs args, InvokeOptions options)
public static Output<GetGatewayPluginJwtResult> getGatewayPluginJwt(GetGatewayPluginJwtArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginJwt:getGatewayPluginJwt
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginJwt Result

The following output properties are available:

Supporting Types

GetGatewayPluginJwtConfig

Anonymous This property is required. string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClaimsToVerifies This property is required. 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 This property is required. List<string>
A list of cookie names that Kong will inspect to retrieve JWTs.
HeaderNames This property is required. List<string>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
KeyClaimName This property is required. 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 This property is required. double
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight This property is required. 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 This property is required. 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 This property is required. List<string>
A list of querystring parameters that Kong will inspect to retrieve JWTs.
Anonymous This property is required. string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClaimsToVerifies This property is required. []string
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
CookieNames This property is required. []string
A list of cookie names that Kong will inspect to retrieve JWTs.
HeaderNames This property is required. []string
A list of HTTP header names that Kong will inspect to retrieve JWTs.
KeyClaimName This property is required. 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 This property is required. float64
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight This property is required. 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 This property is required. 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 This property is required. []string
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous This property is required. String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies This property is required. 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 This property is required. List<String>
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames This property is required. List<String>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName This property is required. 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 This property is required. Double
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight This property is required. 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 This property is required. 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 This property is required. List<String>
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous This property is required. string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies This property is required. string[]
A list of registered claims (according to RFC 7519) that Kong can verify as well. Accepted values: one of exp or nbf.
cookieNames This property is required. string[]
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames This property is required. string[]
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName This property is required. 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 This property is required. number
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight This property is required. 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 This property is required. 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 This property is required. string[]
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous This property is required. str
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claims_to_verifies This property is required. 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 This property is required. Sequence[str]
A list of cookie names that Kong will inspect to retrieve JWTs.
header_names This property is required. Sequence[str]
A list of HTTP header names that Kong will inspect to retrieve JWTs.
key_claim_name This property is required. 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 This property is required. float
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm This property is required. str
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
run_on_preflight This property is required. 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 This property is required. 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 This property is required. Sequence[str]
A list of querystring parameters that Kong will inspect to retrieve JWTs.
anonymous This property is required. String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
claimsToVerifies This property is required. 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 This property is required. List<String>
A list of cookie names that Kong will inspect to retrieve JWTs.
headerNames This property is required. List<String>
A list of HTTP header names that Kong will inspect to retrieve JWTs.
keyClaimName This property is required. 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 This property is required. Number
A value between 0 and 31536000 (365 days) limiting the lifetime of the JWT to maximum_expiration seconds in the future.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight This property is required. 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 This property is required. 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 This property is required. List<String>
A list of querystring parameters that Kong will inspect to retrieve JWTs.

GetGatewayPluginJwtOrdering

After This property is required. GetGatewayPluginJwtOrderingAfter
Before This property is required. GetGatewayPluginJwtOrderingBefore
After This property is required. GetGatewayPluginJwtOrderingAfter
Before This property is required. GetGatewayPluginJwtOrderingBefore
after This property is required. GetGatewayPluginJwtOrderingAfter
before This property is required. GetGatewayPluginJwtOrderingBefore
after This property is required. GetGatewayPluginJwtOrderingAfter
before This property is required. GetGatewayPluginJwtOrderingBefore
after This property is required. GetGatewayPluginJwtOrderingAfter
before This property is required. GetGatewayPluginJwtOrderingBefore
after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginJwtOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginJwtOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginJwtRoute

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginJwtService

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

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