1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginHmacAuth
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginHmacAuth

Explore with Pulumi AI

Using getGatewayPluginHmacAuth

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 getGatewayPluginHmacAuth(args: GetGatewayPluginHmacAuthArgs, opts?: InvokeOptions): Promise<GetGatewayPluginHmacAuthResult>
function getGatewayPluginHmacAuthOutput(args: GetGatewayPluginHmacAuthOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginHmacAuthResult>
Copy
def get_gateway_plugin_hmac_auth(control_plane_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetGatewayPluginHmacAuthResult
def get_gateway_plugin_hmac_auth_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginHmacAuthResult]
Copy
func LookupGatewayPluginHmacAuth(ctx *Context, args *LookupGatewayPluginHmacAuthArgs, opts ...InvokeOption) (*LookupGatewayPluginHmacAuthResult, error)
func LookupGatewayPluginHmacAuthOutput(ctx *Context, args *LookupGatewayPluginHmacAuthOutputArgs, opts ...InvokeOption) LookupGatewayPluginHmacAuthResultOutput
Copy

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

public static class GetGatewayPluginHmacAuth 
{
    public static Task<GetGatewayPluginHmacAuthResult> InvokeAsync(GetGatewayPluginHmacAuthArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginHmacAuthResult> Invoke(GetGatewayPluginHmacAuthInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginHmacAuthResult> getGatewayPluginHmacAuth(GetGatewayPluginHmacAuthArgs args, InvokeOptions options)
public static Output<GetGatewayPluginHmacAuthResult> getGatewayPluginHmacAuth(GetGatewayPluginHmacAuthArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginHmacAuth:getGatewayPluginHmacAuth
  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

getGatewayPluginHmacAuth Result

The following output properties are available:

Supporting Types

GetGatewayPluginHmacAuthConfig

Algorithms This property is required. List<string>
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
Anonymous This property is required. string
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClockSkew This property is required. double
Clock skew in seconds to prevent replay attacks.
EnforceHeaders This property is required. List<string>
A list of headers that the client should at least use for HTTP signature creation.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
ValidateRequestBody This property is required. bool
A boolean value telling the plugin to enable body validation.
Algorithms This property is required. []string
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
Anonymous This property is required. string
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClockSkew This property is required. float64
Clock skew in seconds to prevent replay attacks.
EnforceHeaders This property is required. []string
A list of headers that the client should at least use for HTTP signature creation.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
ValidateRequestBody This property is required. bool
A boolean value telling the plugin to enable body validation.
algorithms This property is required. List<String>
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous This property is required. String
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew This property is required. Double
Clock skew in seconds to prevent replay attacks.
enforceHeaders This property is required. List<String>
A list of headers that the client should at least use for HTTP signature creation.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody This property is required. Boolean
A boolean value telling the plugin to enable body validation.
algorithms This property is required. string[]
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous This property is required. string
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew This property is required. number
Clock skew in seconds to prevent replay attacks.
enforceHeaders This property is required. string[]
A list of headers that the client should at least use for HTTP signature creation.
hideCredentials This property is required. boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody This property is required. boolean
A boolean value telling the plugin to enable body validation.
algorithms This property is required. Sequence[str]
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous This property is required. str
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clock_skew This property is required. float
Clock skew in seconds to prevent replay attacks.
enforce_headers This property is required. Sequence[str]
A list of headers that the client should at least use for HTTP signature creation.
hide_credentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm This property is required. str
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validate_request_body This property is required. bool
A boolean value telling the plugin to enable body validation.
algorithms This property is required. List<String>
A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous This property is required. String
An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew This property is required. Number
Clock skew in seconds to prevent replay attacks.
enforceHeaders This property is required. List<String>
A list of headers that the client should at least use for HTTP signature creation.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody This property is required. Boolean
A boolean value telling the plugin to enable body validation.

GetGatewayPluginHmacAuthOrdering

after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginHmacAuthOrderingAfter

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>

GetGatewayPluginHmacAuthOrderingBefore

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>

GetGatewayPluginHmacAuthRoute

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

GetGatewayPluginHmacAuthService

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.