konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
konnect.getPortal
Portal DataSource
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.KonnectFunctions;
import com.pulumi.konnect.inputs.GetPortalArgs;
import com.pulumi.konnect.inputs.GetPortalFilterArgs;
import com.pulumi.konnect.inputs.GetPortalFilterDescriptionArgs;
import com.pulumi.konnect.inputs.GetPortalFilterIdArgs;
import com.pulumi.konnect.inputs.GetPortalFilterNameArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var myPortal = KonnectFunctions.getPortal(GetPortalArgs.builder()
.filter(GetPortalFilterArgs.builder()
.authentication_enabled(false)
.auto_approve_applications(true)
.auto_approve_developers(true)
.canonical_domain(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.default_api_visibility(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.default_application_auth_strategy_id(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.default_domain(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.default_page_visibility(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.description(GetPortalFilterDescriptionArgs.builder()
.contains("...my_contains...")
.eq("...my_eq...")
.neq("...my_neq...")
.ocontains("...my_ocontains...")
.oeq("...my_oeq...")
.build())
.id(GetPortalFilterIdArgs.builder()
.eq("...my_eq...")
.neq("...my_neq...")
.oeq("...my_oeq...")
.build())
.name(GetPortalFilterNameArgs.builder()
.contains("...my_contains...")
.eq("...my_eq...")
.neq("...my_neq...")
.ocontains("...my_ocontains...")
.oeq("...my_oeq...")
.build())
.rbac_enabled(true)
.build())
.pageNumber(1)
.pageSize(100)
.sort("...my_sort...")
.build());
}
}
variables:
myPortal:
fn::invoke:
function: konnect:getPortal
arguments:
filter:
authentication_enabled: false
auto_approve_applications: true
auto_approve_developers: true
canonical_domain:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
default_api_visibility:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
default_application_auth_strategy_id:
eq: '...my_eq...'
neq: '...my_neq...'
oeq: '...my_oeq...'
default_domain:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
default_page_visibility:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
description:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
id:
eq: '...my_eq...'
neq: '...my_neq...'
oeq: '...my_oeq...'
name:
contains: '...my_contains...'
eq: '...my_eq...'
neq: '...my_neq...'
ocontains: '...my_ocontains...'
oeq: '...my_oeq...'
rbac_enabled: true
pageNumber: 1
pageSize: 100
sort: '...my_sort...'
Using getPortal
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 getPortal(args: GetPortalArgs, opts?: InvokeOptions): Promise<GetPortalResult>
function getPortalOutput(args: GetPortalOutputArgs, opts?: InvokeOptions): Output<GetPortalResult>def get_portal(filter: Optional[GetPortalFilter] = None,
page_number: Optional[float] = None,
page_size: Optional[float] = None,
sort: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPortalResult
def get_portal_output(filter: Optional[pulumi.Input[GetPortalFilterArgs]] = None,
page_number: Optional[pulumi.Input[float]] = None,
page_size: Optional[pulumi.Input[float]] = None,
sort: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPortalResult]func LookupPortal(ctx *Context, args *LookupPortalArgs, opts ...InvokeOption) (*LookupPortalResult, error)
func LookupPortalOutput(ctx *Context, args *LookupPortalOutputArgs, opts ...InvokeOption) LookupPortalResultOutput> Note: This function is named LookupPortal in the Go SDK.
public static class GetPortal
{
public static Task<GetPortalResult> InvokeAsync(GetPortalArgs args, InvokeOptions? opts = null)
public static Output<GetPortalResult> Invoke(GetPortalInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
public static Output<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
fn::invoke:
function: konnect:index/getPortal:getPortal
arguments:
# arguments dictionaryThe following arguments are supported:
- Filter
Get
Portal Filter - Page
Number double - Page
Size double - Sort string
- Filter
Get
Portal Filter - Page
Number float64 - Page
Size float64 - Sort string
- filter
Get
Portal Filter - page
Number Double - page
Size Double - sort String
- filter
Get
Portal Filter - page
Number number - page
Size number - sort string
- filter
Get
Portal Filter - page_
number float - page_
size float - sort str
- filter Property Map
- page
Number Number - page
Size Number - sort String
getPortal Result
The following output properties are available:
- Authentication
Enabled bool - Auto
Approve boolApplications - Auto
Approve boolDevelopers - Canonical
Domain string - Created
At string - Default
Api stringVisibility - Default
Application stringAuth Strategy Id - Default
Domain string - Default
Page stringVisibility - Description string
- Display
Name string - Id string
- Labels Dictionary<string, string>
- Name string
- Rbac
Enabled bool - Updated
At string - Filter
Get
Portal Filter - Page
Number double - Page
Size double - Sort string
- Authentication
Enabled bool - Auto
Approve boolApplications - Auto
Approve boolDevelopers - Canonical
Domain string - Created
At string - Default
Api stringVisibility - Default
Application stringAuth Strategy Id - Default
Domain string - Default
Page stringVisibility - Description string
- Display
Name string - Id string
- Labels map[string]string
- Name string
- Rbac
Enabled bool - Updated
At string - Filter
Get
Portal Filter - Page
Number float64 - Page
Size float64 - Sort string
- authentication
Enabled Boolean - auto
Approve BooleanApplications - auto
Approve BooleanDevelopers - canonical
Domain String - created
At String - default
Api StringVisibility - default
Application StringAuth Strategy Id - default
Domain String - default
Page StringVisibility - description String
- display
Name String - id String
- labels Map<String,String>
- name String
- rbac
Enabled Boolean - updated
At String - filter
Get
Portal Filter - page
Number Double - page
Size Double - sort String
- authentication
Enabled boolean - auto
Approve booleanApplications - auto
Approve booleanDevelopers - canonical
Domain string - created
At string - default
Api stringVisibility - default
Application stringAuth Strategy Id - default
Domain string - default
Page stringVisibility - description string
- display
Name string - id string
- labels {[key: string]: string}
- name string
- rbac
Enabled boolean - updated
At string - filter
Get
Portal Filter - page
Number number - page
Size number - sort string
- authentication_
enabled bool - auto_
approve_ boolapplications - auto_
approve_ booldevelopers - canonical_
domain str - created_
at str - default_
api_ strvisibility - default_
application_ strauth_ strategy_ id - default_
domain str - default_
page_ strvisibility - description str
- display_
name str - id str
- labels Mapping[str, str]
- name str
- rbac_
enabled bool - updated_
at str - filter
Get
Portal Filter - page_
number float - page_
size float - sort str
- authentication
Enabled Boolean - auto
Approve BooleanApplications - auto
Approve BooleanDevelopers - canonical
Domain String - created
At String - default
Api StringVisibility - default
Application StringAuth Strategy Id - default
Domain String - default
Page StringVisibility - description String
- display
Name String - id String
- labels Map<String>
- name String
- rbac
Enabled Boolean - updated
At String - filter Property Map
- page
Number Number - page
Size Number - sort String
Supporting Types
GetPortalFilter
- Authentication
Enabled bool - Filter by a boolean value (true/false).
- Auto
Approve boolApplications - Filter by a boolean value (true/false).
- Auto
Approve boolDevelopers - Filter by a boolean value (true/false).
- Canonical
Domain GetPortal Filter Canonical Domain - Filters on the given string field value by exact match inequality.
- Default
Api GetVisibility Portal Filter Default Api Visibility - Filters on the given string field value by exact match inequality.
- Default
Application GetAuth Strategy Id Portal Filter Default Application Auth Strategy Id - Filters on the given string field value by exact match inequality.
- Default
Domain GetPortal Filter Default Domain - Filters on the given string field value by exact match inequality.
- Default
Page GetVisibility Portal Filter Default Page Visibility - Filters on the given string field value by exact match inequality.
- Description
Get
Portal Filter Description - Filters on the given string field value by exact match inequality.
- Id
Get
Portal Filter Id - Filters on the given string field value by exact match inequality.
- Name
Get
Portal Filter Name - Filters on the given string field value by exact match inequality.
- Rbac
Enabled bool - Filter by a boolean value (true/false).
- Authentication
Enabled bool - Filter by a boolean value (true/false).
- Auto
Approve boolApplications - Filter by a boolean value (true/false).
- Auto
Approve boolDevelopers - Filter by a boolean value (true/false).
- Canonical
Domain GetPortal Filter Canonical Domain - Filters on the given string field value by exact match inequality.
- Default
Api GetVisibility Portal Filter Default Api Visibility - Filters on the given string field value by exact match inequality.
- Default
Application GetAuth Strategy Id Portal Filter Default Application Auth Strategy Id - Filters on the given string field value by exact match inequality.
- Default
Domain GetPortal Filter Default Domain - Filters on the given string field value by exact match inequality.
- Default
Page GetVisibility Portal Filter Default Page Visibility - Filters on the given string field value by exact match inequality.
- Description
Get
Portal Filter Description - Filters on the given string field value by exact match inequality.
- Id
Get
Portal Filter Id - Filters on the given string field value by exact match inequality.
- Name
Get
Portal Filter Name - Filters on the given string field value by exact match inequality.
- Rbac
Enabled bool - Filter by a boolean value (true/false).
- authentication
Enabled Boolean - Filter by a boolean value (true/false).
- auto
Approve BooleanApplications - Filter by a boolean value (true/false).
- auto
Approve BooleanDevelopers - Filter by a boolean value (true/false).
- canonical
Domain GetPortal Filter Canonical Domain - Filters on the given string field value by exact match inequality.
- default
Api GetVisibility Portal Filter Default Api Visibility - Filters on the given string field value by exact match inequality.
- default
Application GetAuth Strategy Id Portal Filter Default Application Auth Strategy Id - Filters on the given string field value by exact match inequality.
- default
Domain GetPortal Filter Default Domain - Filters on the given string field value by exact match inequality.
- default
Page GetVisibility Portal Filter Default Page Visibility - Filters on the given string field value by exact match inequality.
- description
Get
Portal Filter Description - Filters on the given string field value by exact match inequality.
- id
Get
Portal Filter Id - Filters on the given string field value by exact match inequality.
- name
Get
Portal Filter Name - Filters on the given string field value by exact match inequality.
- rbac
Enabled Boolean - Filter by a boolean value (true/false).
- authentication
Enabled boolean - Filter by a boolean value (true/false).
- auto
Approve booleanApplications - Filter by a boolean value (true/false).
- auto
Approve booleanDevelopers - Filter by a boolean value (true/false).
- canonical
Domain GetPortal Filter Canonical Domain - Filters on the given string field value by exact match inequality.
- default
Api GetVisibility Portal Filter Default Api Visibility - Filters on the given string field value by exact match inequality.
- default
Application GetAuth Strategy Id Portal Filter Default Application Auth Strategy Id - Filters on the given string field value by exact match inequality.
- default
Domain GetPortal Filter Default Domain - Filters on the given string field value by exact match inequality.
- default
Page GetVisibility Portal Filter Default Page Visibility - Filters on the given string field value by exact match inequality.
- description
Get
Portal Filter Description - Filters on the given string field value by exact match inequality.
- id
Get
Portal Filter Id - Filters on the given string field value by exact match inequality.
- name
Get
Portal Filter Name - Filters on the given string field value by exact match inequality.
- rbac
Enabled boolean - Filter by a boolean value (true/false).
- authentication_
enabled bool - Filter by a boolean value (true/false).
- auto_
approve_ boolapplications - Filter by a boolean value (true/false).
- auto_
approve_ booldevelopers - Filter by a boolean value (true/false).
- canonical_
domain GetPortal Filter Canonical Domain - Filters on the given string field value by exact match inequality.
- default_
api_ Getvisibility Portal Filter Default Api Visibility - Filters on the given string field value by exact match inequality.
- default_
application_ Getauth_ strategy_ id Portal Filter Default Application Auth Strategy Id - Filters on the given string field value by exact match inequality.
- default_
domain GetPortal Filter Default Domain - Filters on the given string field value by exact match inequality.
- default_
page_ Getvisibility Portal Filter Default Page Visibility - Filters on the given string field value by exact match inequality.
- description
Get
Portal Filter Description - Filters on the given string field value by exact match inequality.
- id
Get
Portal Filter Id - Filters on the given string field value by exact match inequality.
- name
Get
Portal Filter Name - Filters on the given string field value by exact match inequality.
- rbac_
enabled bool - Filter by a boolean value (true/false).
- authentication
Enabled Boolean - Filter by a boolean value (true/false).
- auto
Approve BooleanApplications - Filter by a boolean value (true/false).
- auto
Approve BooleanDevelopers - Filter by a boolean value (true/false).
- canonical
Domain Property Map - Filters on the given string field value by exact match inequality.
- default
Api Property MapVisibility - Filters on the given string field value by exact match inequality.
- default
Application Property MapAuth Strategy Id - Filters on the given string field value by exact match inequality.
- default
Domain Property Map - Filters on the given string field value by exact match inequality.
- default
Page Property MapVisibility - Filters on the given string field value by exact match inequality.
- description Property Map
- Filters on the given string field value by exact match inequality.
- id Property Map
- Filters on the given string field value by exact match inequality.
- name Property Map
- Filters on the given string field value by exact match inequality.
- rbac
Enabled Boolean - Filter by a boolean value (true/false).
GetPortalFilterCanonicalDomain
GetPortalFilterDefaultApiVisibility
GetPortalFilterDefaultApplicationAuthStrategyId
GetPortalFilterDefaultDomain
GetPortalFilterDefaultPageVisibility
GetPortalFilterDescription
GetPortalFilterId
GetPortalFilterName
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.
