Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginBasicAuth
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginBasicAuth

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

Using getGatewayPluginBasicAuth

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 getGatewayPluginBasicAuth(args: GetGatewayPluginBasicAuthArgs, opts?: InvokeOptions): Promise<GetGatewayPluginBasicAuthResult>
function getGatewayPluginBasicAuthOutput(args: GetGatewayPluginBasicAuthOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginBasicAuthResult>
Copy
def get_gateway_plugin_basic_auth(control_plane_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetGatewayPluginBasicAuthResult
def get_gateway_plugin_basic_auth_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginBasicAuthResult]
Copy
func LookupGatewayPluginBasicAuth(ctx *Context, args *LookupGatewayPluginBasicAuthArgs, opts ...InvokeOption) (*LookupGatewayPluginBasicAuthResult, error)
func LookupGatewayPluginBasicAuthOutput(ctx *Context, args *LookupGatewayPluginBasicAuthOutputArgs, opts ...InvokeOption) LookupGatewayPluginBasicAuthResultOutput
Copy

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

public static class GetGatewayPluginBasicAuth 
{
    public static Task<GetGatewayPluginBasicAuthResult> InvokeAsync(GetGatewayPluginBasicAuthArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginBasicAuthResult> Invoke(GetGatewayPluginBasicAuthInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginBasicAuthResult> getGatewayPluginBasicAuth(GetGatewayPluginBasicAuthArgs args, InvokeOptions options)
public static Output<GetGatewayPluginBasicAuthResult> getGatewayPluginBasicAuth(GetGatewayPluginBasicAuthArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginBasicAuth:getGatewayPluginBasicAuth
  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

getGatewayPluginBasicAuth Result

The following output properties are available:

Supporting Types

GetGatewayPluginBasicAuthConfig

Anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
Anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
Realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
hideCredentials This property is required. boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm This property is required. string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
hide_credentials This property is required. bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm This property is required. str
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
anonymous This property is required. 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. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm This property is required. String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

GetGatewayPluginBasicAuthOrdering

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

GetGatewayPluginBasicAuthOrderingAfter

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>

GetGatewayPluginBasicAuthOrderingBefore

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>

GetGatewayPluginBasicAuthRoute

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

GetGatewayPluginBasicAuthService

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.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect