konnect 2.5.0, Apr 15 25

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginOauth2

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

Using getGatewayPluginOauth2

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.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginOauth2(args: GetGatewayPluginOauth2Args, opts?: InvokeOptions): Promise<GetGatewayPluginOauth2Result>
function getGatewayPluginOauth2Output(args: GetGatewayPluginOauth2OutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginOauth2Result>

def get_gateway_plugin_oauth2(control_plane_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGatewayPluginOauth2Result
def get_gateway_plugin_oauth2_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginOauth2Result]

func LookupGatewayPluginOauth2(ctx *Context, args *LookupGatewayPluginOauth2Args, opts ...InvokeOption) (*LookupGatewayPluginOauth2Result, error)
func LookupGatewayPluginOauth2Output(ctx *Context, args *LookupGatewayPluginOauth2OutputArgs, opts ...InvokeOption) LookupGatewayPluginOauth2ResultOutput

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

public static class GetGatewayPluginOauth2 
{
    public static Task<GetGatewayPluginOauth2Result> InvokeAsync(GetGatewayPluginOauth2Args args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginOauth2Result> Invoke(GetGatewayPluginOauth2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginOauth2Result> getGatewayPluginOauth2(GetGatewayPluginOauth2Args args, InvokeOptions options)
public static Output<GetGatewayPluginOauth2Result> getGatewayPluginOauth2(GetGatewayPluginOauth2Args args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginOauth2 Result

The following output properties are available:

Config GetGatewayPluginOauth2Config
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginOauth2Ordering
Protocols List<string>
Route GetGatewayPluginOauth2Route
Service GetGatewayPluginOauth2Service
Tags List<string>
UpdatedAt double

Config GetGatewayPluginOauth2Config
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginOauth2Ordering
Protocols []string
Route GetGatewayPluginOauth2Route
Service GetGatewayPluginOauth2Service
Tags []string
UpdatedAt float64

config GetGatewayPluginOauth2Config
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginOauth2Ordering
protocols List<String>
route GetGatewayPluginOauth2Route
service GetGatewayPluginOauth2Service
tags List<String>
updatedAt Double

config GetGatewayPluginOauth2Config
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginOauth2Ordering
protocols string[]
route GetGatewayPluginOauth2Route
service GetGatewayPluginOauth2Service
tags string[]
updatedAt number

config GetGatewayPluginOauth2Config
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginOauth2Ordering
protocols Sequence[str]
route GetGatewayPluginOauth2Route
service GetGatewayPluginOauth2Service
tags Sequence[str]
updated_at float

config Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginOauth2Config

AcceptHttpIfAlreadyTerminated bool: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
Anonymous string: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
AuthHeaderName string: The name of the header that is supposed to carry the access token.
EnableAuthorizationCode bool: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
EnableClientCredentials bool: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
EnableImplicitGrant bool: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
EnablePasswordGrant bool: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
GlobalCredentials bool: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
HideCredentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
MandatoryScope bool: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
PersistentRefreshToken bool
Pkce string: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
ProvisionKey string: The unique key the plugin has generated when it has been added to the Service.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RefreshTokenTtl double: Time-to-live value for data
ReuseRefreshToken bool: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
Scopes List<string>: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
TokenExpiration double: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

AcceptHttpIfAlreadyTerminated bool: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
Anonymous string: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
AuthHeaderName string: The name of the header that is supposed to carry the access token.
EnableAuthorizationCode bool: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
EnableClientCredentials bool: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
EnableImplicitGrant bool: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
EnablePasswordGrant bool: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
GlobalCredentials bool: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
HideCredentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
MandatoryScope bool: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
PersistentRefreshToken bool
Pkce string: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
ProvisionKey string: The unique key the plugin has generated when it has been added to the Service.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RefreshTokenTtl float64: Time-to-live value for data
ReuseRefreshToken bool: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
Scopes []string: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
TokenExpiration float64: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

acceptHttpIfAlreadyTerminated Boolean: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
anonymous String: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
authHeaderName String: The name of the header that is supposed to carry the access token.
enableAuthorizationCode Boolean: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
enableClientCredentials Boolean: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
enableImplicitGrant Boolean: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
enablePasswordGrant Boolean: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
globalCredentials Boolean: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
hideCredentials Boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
mandatoryScope Boolean: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
persistentRefreshToken Boolean
pkce String: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
provisionKey String: The unique key the plugin has generated when it has been added to the Service.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
refreshTokenTtl Double: Time-to-live value for data
reuseRefreshToken Boolean: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
scopes List<String>: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
tokenExpiration Double: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

acceptHttpIfAlreadyTerminated boolean: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
anonymous string: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
authHeaderName string: The name of the header that is supposed to carry the access token.
enableAuthorizationCode boolean: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
enableClientCredentials boolean: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
enableImplicitGrant boolean: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
enablePasswordGrant boolean: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
globalCredentials boolean: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
hideCredentials boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
mandatoryScope boolean: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
persistentRefreshToken boolean
pkce string: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
provisionKey string: The unique key the plugin has generated when it has been added to the Service.
realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
refreshTokenTtl number: Time-to-live value for data
reuseRefreshToken boolean: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
scopes string[]: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
tokenExpiration number: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

accept_http_if_already_terminated bool: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
anonymous str: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
auth_header_name str: The name of the header that is supposed to carry the access token.
enable_authorization_code bool: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
enable_client_credentials bool: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
enable_implicit_grant bool: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
enable_password_grant bool: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
global_credentials bool: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
hide_credentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
mandatory_scope bool: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
persistent_refresh_token bool
pkce str: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
provision_key str: The unique key the plugin has generated when it has been added to the Service.
realm str: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
refresh_token_ttl float: Time-to-live value for data
reuse_refresh_token bool: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
scopes Sequence[str]: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
token_expiration float: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

acceptHttpIfAlreadyTerminated Boolean: Accepts HTTPs requests that have already been terminated by a proxy or load balancer.
anonymous String: An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
authHeaderName String: The name of the header that is supposed to carry the access token.
enableAuthorizationCode Boolean: An optional boolean value to enable the three-legged Authorization Code flow (RFC 6742 Section 4.1).
enableClientCredentials Boolean: An optional boolean value to enable the Client Credentials Grant flow (RFC 6742 Section 4.4).
enableImplicitGrant Boolean: An optional boolean value to enable the Implicit Grant flow which allows to provision a token as a result of the authorization process (RFC 6742 Section 4.2).
enablePasswordGrant Boolean: An optional boolean value to enable the Resource Owner Password Credentials Grant flow (RFC 6742 Section 4.3).
globalCredentials Boolean: An optional boolean value that allows using the same OAuth credentials generated by the plugin with any other service whose OAuth 2.0 plugin configuration also has config.global_credentials=true.
hideCredentials Boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
mandatoryScope Boolean: An optional boolean value telling the plugin to require at least one scope to be authorized by the end user.
persistentRefreshToken Boolean
pkce String: Specifies a mode of how the Proof Key for Code Exchange (PKCE) should be handled by the plugin.
provisionKey String: The unique key the plugin has generated when it has been added to the Service.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
refreshTokenTtl Number: Time-to-live value for data
reuseRefreshToken Boolean: An optional boolean value that indicates whether an OAuth refresh token is reused when refreshing an access token.
scopes List<String>: Describes an array of scope names that will be available to the end user. If mandatory_scope is set to true, then scopes are required.
tokenExpiration Number: An optional integer value telling the plugin how many seconds a token should last, after which the client will need to refresh the token. Set to 0 to disable the expiration.

GetGatewayPluginOauth2Ordering

After GetGatewayPluginOauth2OrderingAfter
Before GetGatewayPluginOauth2OrderingBefore

After GetGatewayPluginOauth2OrderingAfter
Before GetGatewayPluginOauth2OrderingBefore

after GetGatewayPluginOauth2OrderingAfter
before GetGatewayPluginOauth2OrderingBefore

after GetGatewayPluginOauth2OrderingAfter
before GetGatewayPluginOauth2OrderingBefore

after GetGatewayPluginOauth2OrderingAfter
before GetGatewayPluginOauth2OrderingBefore

after Property Map
before Property Map

GetGatewayPluginOauth2OrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginOauth2OrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginOauth2Route

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginOauth2Service

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 2.5.0 published on Tuesday, Apr 15, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginOauth2

On this page

On this page

Using getGatewayPluginOauth2

getGatewayPluginOauth2 Result

Supporting Types

GetGatewayPluginOauth2Config

GetGatewayPluginOauth2Ordering

GetGatewayPluginOauth2OrderingAfter

GetGatewayPluginOauth2OrderingBefore

GetGatewayPluginOauth2Route

GetGatewayPluginOauth2Service

Package Details

On this page

On this page