konnect 2.5.0, Apr 15 25

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginKeyAuth

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

Using getGatewayPluginKeyAuth

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.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginKeyAuth(args: GetGatewayPluginKeyAuthArgs, opts?: InvokeOptions): Promise<GetGatewayPluginKeyAuthResult>
function getGatewayPluginKeyAuthOutput(args: GetGatewayPluginKeyAuthOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginKeyAuthResult>

def get_gateway_plugin_key_auth(control_plane_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetGatewayPluginKeyAuthResult
def get_gateway_plugin_key_auth_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginKeyAuthResult]

func LookupGatewayPluginKeyAuth(ctx *Context, args *LookupGatewayPluginKeyAuthArgs, opts ...InvokeOption) (*LookupGatewayPluginKeyAuthResult, error)
func LookupGatewayPluginKeyAuthOutput(ctx *Context, args *LookupGatewayPluginKeyAuthOutputArgs, opts ...InvokeOption) LookupGatewayPluginKeyAuthResultOutput

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

public static class GetGatewayPluginKeyAuth 
{
    public static Task<GetGatewayPluginKeyAuthResult> InvokeAsync(GetGatewayPluginKeyAuthArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginKeyAuthResult> Invoke(GetGatewayPluginKeyAuthInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginKeyAuthResult> getGatewayPluginKeyAuth(GetGatewayPluginKeyAuthArgs args, InvokeOptions options)
public static Output<GetGatewayPluginKeyAuthResult> getGatewayPluginKeyAuth(GetGatewayPluginKeyAuthArgs args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginKeyAuth Result

The following output properties are available:

Config GetGatewayPluginKeyAuthConfig
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginKeyAuthOrdering
Protocols List<string>
Route GetGatewayPluginKeyAuthRoute
Service GetGatewayPluginKeyAuthService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginKeyAuthConfig
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginKeyAuthOrdering
Protocols []string
Route GetGatewayPluginKeyAuthRoute
Service GetGatewayPluginKeyAuthService
Tags []string
UpdatedAt float64

config GetGatewayPluginKeyAuthConfig
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginKeyAuthOrdering
protocols List<String>
route GetGatewayPluginKeyAuthRoute
service GetGatewayPluginKeyAuthService
tags List<String>
updatedAt Double

config GetGatewayPluginKeyAuthConfig
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginKeyAuthOrdering
protocols string[]
route GetGatewayPluginKeyAuthRoute
service GetGatewayPluginKeyAuthService
tags string[]
updatedAt number

config GetGatewayPluginKeyAuthConfig
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginKeyAuthOrdering
protocols Sequence[str]
route GetGatewayPluginKeyAuthRoute
service GetGatewayPluginKeyAuthService
tags Sequence[str]
updated_at float

config Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginKeyAuthConfig

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.
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.
KeyInBody bool: If enabled, the plugin reads the request body. 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 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.
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.
KeyInBody bool: If enabled, the plugin reads the request body. 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 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.
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.
keyInBody Boolean: If enabled, the plugin reads the request body. 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 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.
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.
keyInBody boolean: If enabled, the plugin reads the request body. 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 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.
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.
key_in_body bool: If enabled, the plugin reads the request body. 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 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.
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.
keyInBody Boolean: If enabled, the plugin reads the request body. 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 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.

GetGatewayPluginKeyAuthOrdering

After GetGatewayPluginKeyAuthOrderingAfter
Before GetGatewayPluginKeyAuthOrderingBefore

After GetGatewayPluginKeyAuthOrderingAfter
Before GetGatewayPluginKeyAuthOrderingBefore

after GetGatewayPluginKeyAuthOrderingAfter
before GetGatewayPluginKeyAuthOrderingBefore

after GetGatewayPluginKeyAuthOrderingAfter
before GetGatewayPluginKeyAuthOrderingBefore

after GetGatewayPluginKeyAuthOrderingAfter
before GetGatewayPluginKeyAuthOrderingBefore

after Property Map
before Property Map

GetGatewayPluginKeyAuthOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginKeyAuthOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginKeyAuthRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginKeyAuthService

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 2.5.0 published on Tuesday, Apr 15, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginKeyAuth

On this page

On this page

Using getGatewayPluginKeyAuth

getGatewayPluginKeyAuth Result

Supporting Types

GetGatewayPluginKeyAuthConfig

GetGatewayPluginKeyAuthOrdering

GetGatewayPluginKeyAuthOrderingAfter

GetGatewayPluginKeyAuthOrderingBefore

GetGatewayPluginKeyAuthRoute

GetGatewayPluginKeyAuthService

Package Details

On this page

On this page