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 logo
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>
    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]
    func LookupGatewayPluginJwt(ctx *Context, args *LookupGatewayPluginJwtArgs, opts ...InvokeOption) (*LookupGatewayPluginJwtResult, error)
func LookupGatewayPluginJwtOutput(ctx *Context, args *LookupGatewayPluginJwtOutputArgs, opts ...InvokeOption) LookupGatewayPluginJwtResultOutput

    > 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)
}
    public static CompletableFuture<GetGatewayPluginJwtResult> getGatewayPluginJwt(GetGatewayPluginJwtArgs args, InvokeOptions options)
public static Output<GetGatewayPluginJwtResult> getGatewayPluginJwt(GetGatewayPluginJwtArgs args, InvokeOptions options)

    fn::invoke:
  function: konnect:index/getGatewayPluginJwt:getGatewayPluginJwt
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getGatewayPluginJwt Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginJwtConfig

    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.

    GetGatewayPluginJwtOrdering

    GetGatewayPluginJwtOrderingAfter

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

    GetGatewayPluginJwtOrderingBefore

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

    GetGatewayPluginJwtRoute

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

    GetGatewayPluginJwtService

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

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect