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

konnect.getGatewayPluginOauth2Introspection

Explore with Pulumi AI

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

Using getGatewayPluginOauth2Introspection

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 getGatewayPluginOauth2Introspection(args: GetGatewayPluginOauth2IntrospectionArgs, opts?: InvokeOptions): Promise<GetGatewayPluginOauth2IntrospectionResult>
function getGatewayPluginOauth2IntrospectionOutput(args: GetGatewayPluginOauth2IntrospectionOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginOauth2IntrospectionResult>
Copy
def get_gateway_plugin_oauth2_introspection(control_plane_id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetGatewayPluginOauth2IntrospectionResult
def get_gateway_plugin_oauth2_introspection_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginOauth2IntrospectionResult]
Copy
func LookupGatewayPluginOauth2Introspection(ctx *Context, args *LookupGatewayPluginOauth2IntrospectionArgs, opts ...InvokeOption) (*LookupGatewayPluginOauth2IntrospectionResult, error)
func LookupGatewayPluginOauth2IntrospectionOutput(ctx *Context, args *LookupGatewayPluginOauth2IntrospectionOutputArgs, opts ...InvokeOption) LookupGatewayPluginOauth2IntrospectionResultOutput
Copy

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

public static class GetGatewayPluginOauth2Introspection 
{
    public static Task<GetGatewayPluginOauth2IntrospectionResult> InvokeAsync(GetGatewayPluginOauth2IntrospectionArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginOauth2IntrospectionResult> Invoke(GetGatewayPluginOauth2IntrospectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginOauth2IntrospectionResult> getGatewayPluginOauth2Introspection(GetGatewayPluginOauth2IntrospectionArgs args, InvokeOptions options)
public static Output<GetGatewayPluginOauth2IntrospectionResult> getGatewayPluginOauth2Introspection(GetGatewayPluginOauth2IntrospectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginOauth2Introspection:getGatewayPluginOauth2Introspection
  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

getGatewayPluginOauth2Introspection Result

The following output properties are available:

Supporting Types

GetGatewayPluginOauth2IntrospectionConfig

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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
AuthorizationValue This property is required. string
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
ConsumerBy This property is required. string
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
CustomClaimsForwards This property is required. List<string>
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
CustomIntrospectionHeaders This property is required. Dictionary<string, string>
A list of custom headers to be added in the introspection request.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
IntrospectRequest This property is required. bool
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
IntrospectionUrl This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
Keepalive This property is required. double
An optional value in milliseconds that defines how long an idle connection lives before being closed.
RunOnPreflight This property is required. 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.
Timeout This property is required. double
An optional timeout in milliseconds when sending data to the upstream server.
TokenTypeHint This property is required. string
The token_type_hint value to associate to introspection requests.
Ttl This property is required. double
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
AuthorizationValue This property is required. string
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
ConsumerBy This property is required. string
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
CustomClaimsForwards This property is required. []string
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
CustomIntrospectionHeaders This property is required. map[string]string
A list of custom headers to be added in the introspection request.
HideCredentials This property is required. bool
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
IntrospectRequest This property is required. bool
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
IntrospectionUrl This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
Keepalive This property is required. float64
An optional value in milliseconds that defines how long an idle connection lives before being closed.
RunOnPreflight This property is required. 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.
Timeout This property is required. float64
An optional timeout in milliseconds when sending data to the upstream server.
TokenTypeHint This property is required. string
The token_type_hint value to associate to introspection requests.
Ttl This property is required. float64
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
authorizationValue This property is required. String
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
consumerBy This property is required. String
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
customClaimsForwards This property is required. List<String>
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
customIntrospectionHeaders This property is required. Map<String,String>
A list of custom headers to be added in the introspection request.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
introspectRequest This property is required. Boolean
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
introspectionUrl This property is required. String
A string representing a URL, such as https://example.com/path/to/resource?q=search.
keepalive This property is required. Double
An optional value in milliseconds that defines how long an idle connection lives before being closed.
runOnPreflight This property is required. 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.
timeout This property is required. Double
An optional timeout in milliseconds when sending data to the upstream server.
tokenTypeHint This property is required. String
The token_type_hint value to associate to introspection requests.
ttl This property is required. Double
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
authorizationValue This property is required. string
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
consumerBy This property is required. string
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
customClaimsForwards This property is required. string[]
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
customIntrospectionHeaders This property is required. {[key: string]: string}
A list of custom headers to be added in the introspection request.
hideCredentials This property is required. boolean
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
introspectRequest This property is required. boolean
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
introspectionUrl This property is required. string
A string representing a URL, such as https://example.com/path/to/resource?q=search.
keepalive This property is required. number
An optional value in milliseconds that defines how long an idle connection lives before being closed.
runOnPreflight This property is required. 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.
timeout This property is required. number
An optional timeout in milliseconds when sending data to the upstream server.
tokenTypeHint This property is required. string
The token_type_hint value to associate to introspection requests.
ttl This property is required. number
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
authorization_value This property is required. str
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
consumer_by This property is required. str
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
custom_claims_forwards This property is required. Sequence[str]
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
custom_introspection_headers This property is required. Mapping[str, str]
A list of custom headers to be added in the introspection request.
hide_credentials This property is required. bool
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
introspect_request This property is required. bool
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
introspection_url This property is required. str
A string representing a URL, such as https://example.com/path/to/resource?q=search.
keepalive This property is required. float
An optional value in milliseconds that defines how long an idle connection lives before being closed.
run_on_preflight This property is required. 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.
timeout This property is required. float
An optional timeout in milliseconds when sending data to the upstream server.
token_type_hint This property is required. str
The token_type_hint value to associate to introspection requests.
ttl This property is required. float
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
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 fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
authorizationValue This property is required. String
The value to set as the Authorization header when querying the introspection endpoint. This depends on the OAuth 2.0 server, but usually is the client_id and client_secret as a Base64-encoded Basic Auth string (Basic MG9hNWl...).
consumerBy This property is required. String
A string indicating whether to associate OAuth2 username or client_id with the consumer's username. OAuth2 username is mapped to a consumer's username field, while an OAuth2 client_id maps to a consumer's custom_id.
customClaimsForwards This property is required. List<String>
A list of custom claims to be forwarded from the introspection response to the upstream request. Claims are forwarded in headers with prefix X-Credential-{claim-name}.
customIntrospectionHeaders This property is required. Map<String>
A list of custom headers to be added in the introspection request.
hideCredentials This property is required. Boolean
An optional boolean value telling the plugin to hide the credential to the upstream API server. It will be removed by Kong before proxying the request.
introspectRequest This property is required. Boolean
A boolean indicating whether to forward information about the current downstream request to the introspect endpoint. If true, headers X-Request-Path and X-Request-Http-Method will be inserted into the introspect request.
introspectionUrl This property is required. String
A string representing a URL, such as https://example.com/path/to/resource?q=search.
keepalive This property is required. Number
An optional value in milliseconds that defines how long an idle connection lives before being closed.
runOnPreflight This property is required. 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.
timeout This property is required. Number
An optional timeout in milliseconds when sending data to the upstream server.
tokenTypeHint This property is required. String
The token_type_hint value to associate to introspection requests.
ttl This property is required. Number
The TTL in seconds for the introspection response. Set to 0 to disable the expiration.

GetGatewayPluginOauth2IntrospectionOrdering

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

GetGatewayPluginOauth2IntrospectionOrderingAfter

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>

GetGatewayPluginOauth2IntrospectionOrderingBefore

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>

GetGatewayPluginOauth2IntrospectionRoute

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

GetGatewayPluginOauth2IntrospectionService

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