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

konnect.getGatewayPluginOauth2Introspection

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 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>
    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]
    func LookupGatewayPluginOauth2Introspection(ctx *Context, args *LookupGatewayPluginOauth2IntrospectionArgs, opts ...InvokeOption) (*LookupGatewayPluginOauth2IntrospectionResult, error)
func LookupGatewayPluginOauth2IntrospectionOutput(ctx *Context, args *LookupGatewayPluginOauth2IntrospectionOutputArgs, opts ...InvokeOption) LookupGatewayPluginOauth2IntrospectionResultOutput

    > 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)
}
    public static CompletableFuture<GetGatewayPluginOauth2IntrospectionResult> getGatewayPluginOauth2Introspection(GetGatewayPluginOauth2IntrospectionArgs args, InvokeOptions options)
public static Output<GetGatewayPluginOauth2IntrospectionResult> getGatewayPluginOauth2Introspection(GetGatewayPluginOauth2IntrospectionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getGatewayPluginOauth2Introspection Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginOauth2IntrospectionConfig

    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 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 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 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 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 Dictionary<string, string>
    A list of custom headers to be added in the introspection request.
    HideCredentials 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 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 string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    Keepalive double
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    Timeout double
    An optional timeout in milliseconds when sending data to the upstream server.
    TokenTypeHint string
    The token_type_hint value to associate to introspection requests.
    Ttl double
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
    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 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 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 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 []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 map[string]string
    A list of custom headers to be added in the introspection request.
    HideCredentials 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 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 string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    Keepalive float64
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    Timeout float64
    An optional timeout in milliseconds when sending data to the upstream server.
    TokenTypeHint string
    The token_type_hint value to associate to introspection requests.
    Ttl float64
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
    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 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 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 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 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 Map<String,String>
    A list of custom headers to be added in the introspection request.
    hideCredentials 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 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 String
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    keepalive Double
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    timeout Double
    An optional timeout in milliseconds when sending data to the upstream server.
    tokenTypeHint String
    The token_type_hint value to associate to introspection requests.
    ttl Double
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
    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 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 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 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 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 {[key: string]: string}
    A list of custom headers to be added in the introspection request.
    hideCredentials 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 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 string
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    keepalive number
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    timeout number
    An optional timeout in milliseconds when sending data to the upstream server.
    tokenTypeHint string
    The token_type_hint value to associate to introspection requests.
    ttl number
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
    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 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 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 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 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 Mapping[str, str]
    A list of custom headers to be added in the introspection request.
    hide_credentials 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 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 str
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    keepalive float
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    timeout float
    An optional timeout in milliseconds when sending data to the upstream server.
    token_type_hint str
    The token_type_hint value to associate to introspection requests.
    ttl float
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.
    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 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 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 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 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 Map<String>
    A list of custom headers to be added in the introspection request.
    hideCredentials 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 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 String
    A string representing a URL, such as https://example.com/path/to/resource?q=search.
    keepalive Number
    An optional value in milliseconds that defines how long an idle connection lives before being closed.
    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 will always be allowed.
    timeout Number
    An optional timeout in milliseconds when sending data to the upstream server.
    tokenTypeHint String
    The token_type_hint value to associate to introspection requests.
    ttl Number
    The TTL in seconds for the introspection response. Set to 0 to disable the expiration.

    GetGatewayPluginOauth2IntrospectionOrdering

    GetGatewayPluginOauth2IntrospectionOrderingAfter

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

    GetGatewayPluginOauth2IntrospectionOrderingBefore

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

    GetGatewayPluginOauth2IntrospectionRoute

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

    GetGatewayPluginOauth2IntrospectionService

    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