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

konnect.getGatewayPluginKeyAuthEnc

Explore with Pulumi AI

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

    Using getGatewayPluginKeyAuthEnc

    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 getGatewayPluginKeyAuthEnc(args: GetGatewayPluginKeyAuthEncArgs, opts?: InvokeOptions): Promise<GetGatewayPluginKeyAuthEncResult>
function getGatewayPluginKeyAuthEncOutput(args: GetGatewayPluginKeyAuthEncOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginKeyAuthEncResult>
    def get_gateway_plugin_key_auth_enc(control_plane_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetGatewayPluginKeyAuthEncResult
def get_gateway_plugin_key_auth_enc_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginKeyAuthEncResult]
    func LookupGatewayPluginKeyAuthEnc(ctx *Context, args *LookupGatewayPluginKeyAuthEncArgs, opts ...InvokeOption) (*LookupGatewayPluginKeyAuthEncResult, error)
func LookupGatewayPluginKeyAuthEncOutput(ctx *Context, args *LookupGatewayPluginKeyAuthEncOutputArgs, opts ...InvokeOption) LookupGatewayPluginKeyAuthEncResultOutput

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

    public static class GetGatewayPluginKeyAuthEnc 
{
    public static Task<GetGatewayPluginKeyAuthEncResult> InvokeAsync(GetGatewayPluginKeyAuthEncArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginKeyAuthEncResult> Invoke(GetGatewayPluginKeyAuthEncInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginKeyAuthEncResult> getGatewayPluginKeyAuthEnc(GetGatewayPluginKeyAuthEncArgs args, InvokeOptions options)
public static Output<GetGatewayPluginKeyAuthEncResult> getGatewayPluginKeyAuthEnc(GetGatewayPluginKeyAuthEncArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getGatewayPluginKeyAuthEnc Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginKeyAuthEncConfig

    Anonymous string
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    HideCredentials bool
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    KeyInBody bool
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    KeyInHeader bool
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    KeyInQuery bool
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    KeyNames List<string>
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.
    Anonymous string
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    HideCredentials bool
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    KeyInBody bool
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    KeyInHeader bool
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    KeyInQuery bool
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    KeyNames []string
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.
    anonymous String
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    hideCredentials Boolean
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    keyInBody Boolean
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    keyInHeader Boolean
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    keyInQuery Boolean
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    keyNames List<String>
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.
    anonymous string
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    hideCredentials boolean
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    keyInBody boolean
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    keyInHeader boolean
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    keyInQuery boolean
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    keyNames string[]
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.
    anonymous str
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    hide_credentials bool
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    key_in_body bool
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    key_in_header bool
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    key_in_query bool
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    key_names Sequence[str]
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.
    anonymous String
    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
    hideCredentials Boolean
    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e., the header, query string, or request body containing the key) before proxying it.
    keyInBody Boolean
    If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
    keyInHeader Boolean
    If enabled (default), the plugin reads the request header and tries to find the key in it.
    keyInQuery Boolean
    If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
    keyNames List<String>
    Describes an array of parameter names where the plugin will look for a key. The client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. Key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
    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 are always allowed.

    GetGatewayPluginKeyAuthEncOrdering

    GetGatewayPluginKeyAuthEncOrderingAfter

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

    GetGatewayPluginKeyAuthEncOrderingBefore

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

    GetGatewayPluginKeyAuthEncRoute

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

    GetGatewayPluginKeyAuthEncService

    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