konnect.GatewayPluginOauth2Introspection

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args GatewayPluginOauth2IntrospectionArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args GatewayPluginOauth2IntrospectionArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args GatewayPluginOauth2IntrospectionArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginOauth2IntrospectionArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginOauth2IntrospectionArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config GatewayPluginOauth2IntrospectionConfig

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Enabled bool

Whether the plugin is applied.

GatewayPluginOauth2IntrospectionId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginOauth2IntrospectionOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Route GatewayPluginOauth2IntrospectionRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

Service GatewayPluginOauth2IntrospectionService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags List<string>

An optional set of strings associated with the Plugin for grouping and filtering.

Config GatewayPluginOauth2IntrospectionConfigArgs

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Enabled bool

Whether the plugin is applied.

GatewayPluginOauth2IntrospectionId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginOauth2IntrospectionOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Route GatewayPluginOauth2IntrospectionRouteArgs

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

Service GatewayPluginOauth2IntrospectionServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags []string

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginOauth2IntrospectionConfig

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled Boolean

Whether the plugin is applied.

gatewayPluginOauth2IntrospectionId String

The ID of this resource.

instanceName String

ordering GatewayPluginOauth2IntrospectionOrdering

protocols List<String>

A set of strings representing HTTP protocols.

route GatewayPluginOauth2IntrospectionRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginOauth2IntrospectionService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginOauth2IntrospectionConfig

controlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled boolean

Whether the plugin is applied.

gatewayPluginOauth2IntrospectionId string

The ID of this resource.

instanceName string

ordering GatewayPluginOauth2IntrospectionOrdering

protocols string[]

A set of strings representing HTTP protocols.

route GatewayPluginOauth2IntrospectionRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginOauth2IntrospectionService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags string[]

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginOauth2IntrospectionConfigArgs

control_plane_id str

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled bool

Whether the plugin is applied.

gateway_plugin_oauth2_introspection_id str

The ID of this resource.

instance_name str

ordering GatewayPluginOauth2IntrospectionOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

route GatewayPluginOauth2IntrospectionRouteArgs

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginOauth2IntrospectionServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags Sequence[str]

An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled Boolean

Whether the plugin is applied.

gatewayPluginOauth2IntrospectionId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A set of strings representing HTTP protocols.

route Property Map

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service Property Map

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

CreatedAt double

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt double

Unix epoch when the resource was last updated.

CreatedAt float64

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt float64

Unix epoch when the resource was last updated.

createdAt Double

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Double

Unix epoch when the resource was last updated.

createdAt number

Unix epoch when the resource was created.

id string

The provider-assigned unique ID for this managed resource.

updatedAt number

Unix epoch when the resource was last updated.

created_at float

Unix epoch when the resource was created.

id str

The provider-assigned unique ID for this managed resource.

updated_at float

Unix epoch when the resource was last updated.

createdAt Number

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Number

Unix epoch when the resource was last updated.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

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. must be one of ["client_id", "username"]

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. must be one of ["client_id", "username"]

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. must be one of ["client_id", "username"]

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. must be one of ["client_id", "username"]

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. must be one of ["client_id", "username"]

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. must be one of ["client_id", "username"]

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.

After GatewayPluginOauth2IntrospectionOrderingAfter

Before GatewayPluginOauth2IntrospectionOrderingBefore

After GatewayPluginOauth2IntrospectionOrderingAfter

Before GatewayPluginOauth2IntrospectionOrderingBefore

after GatewayPluginOauth2IntrospectionOrderingAfter

before GatewayPluginOauth2IntrospectionOrderingBefore

after GatewayPluginOauth2IntrospectionOrderingAfter

before GatewayPluginOauth2IntrospectionOrderingBefore

after GatewayPluginOauth2IntrospectionOrderingAfter

before GatewayPluginOauth2IntrospectionOrderingBefore

after Property Map

before Property Map

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Id string

Id string

id String

id string

id str

id String

Id string

Id string

id String

id string

id str

id String