konnect 3.1.0, Sep 2 25

konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong

konnect.getPortal

Explore with Pulumi AI

konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong

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(true)
                .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(10)
            .sort("...my_sort...")
            .build());

    }
}

variables:
  myPortal:
    fn::invoke:
      function: konnect:getPortal
      arguments:
        filter:
          authentication_enabled: true
          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: 10
        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 dictionary

The following arguments are supported:

Filter GetPortalFilter
PageNumber double
PageSize double
Sort string

Filter GetPortalFilter
PageNumber float64
PageSize float64
Sort string

filter GetPortalFilter
pageNumber Double
pageSize Double
sort String

filter GetPortalFilter
pageNumber number
pageSize number
sort string

filter GetPortalFilter
page_number float
page_size float
sort str

filter Property Map
pageNumber Number
pageSize Number
sort String

getPortal Result

The following output properties are available:

AuthenticationEnabled bool
AutoApproveApplications bool
AutoApproveDevelopers bool
CanonicalDomain string
CreatedAt string
DefaultApiVisibility string
DefaultApplicationAuthStrategyId string
DefaultDomain string
DefaultPageVisibility string
Description string
DisplayName string
Id string
Labels Dictionary<string, string>
Name string
Number double
RbacEnabled bool
Size double
Total double
UpdatedAt string
Filter GetPortalFilter
PageNumber double
PageSize double
Sort string

AuthenticationEnabled bool
AutoApproveApplications bool
AutoApproveDevelopers bool
CanonicalDomain string
CreatedAt string
DefaultApiVisibility string
DefaultApplicationAuthStrategyId string
DefaultDomain string
DefaultPageVisibility string
Description string
DisplayName string
Id string
Labels map[string]string
Name string
Number float64
RbacEnabled bool
Size float64
Total float64
UpdatedAt string
Filter GetPortalFilter
PageNumber float64
PageSize float64
Sort string

authenticationEnabled Boolean
autoApproveApplications Boolean
autoApproveDevelopers Boolean
canonicalDomain String
createdAt String
defaultApiVisibility String
defaultApplicationAuthStrategyId String
defaultDomain String
defaultPageVisibility String
description String
displayName String
id String
labels Map<String,String>
name String
number Double
rbacEnabled Boolean
size Double
total Double
updatedAt String
filter GetPortalFilter
pageNumber Double
pageSize Double
sort String

authenticationEnabled boolean
autoApproveApplications boolean
autoApproveDevelopers boolean
canonicalDomain string
createdAt string
defaultApiVisibility string
defaultApplicationAuthStrategyId string
defaultDomain string
defaultPageVisibility string
description string
displayName string
id string
labels {[key: string]: string}
name string
number number
rbacEnabled boolean
size number
total number
updatedAt string
filter GetPortalFilter
pageNumber number
pageSize number
sort string

authentication_enabled bool
auto_approve_applications bool
auto_approve_developers bool
canonical_domain str
created_at str
default_api_visibility str
default_application_auth_strategy_id str
default_domain str
default_page_visibility str
description str
display_name str
id str
labels Mapping[str, str]
name str
number float
rbac_enabled bool
size float
total float
updated_at str
filter GetPortalFilter
page_number float
page_size float
sort str

authenticationEnabled Boolean
autoApproveApplications Boolean
autoApproveDevelopers Boolean
canonicalDomain String
createdAt String
defaultApiVisibility String
defaultApplicationAuthStrategyId String
defaultDomain String
defaultPageVisibility String
description String
displayName String
id String
labels Map<String>
name String
number Number
rbacEnabled Boolean
size Number
total Number
updatedAt String
filter Property Map
pageNumber Number
pageSize Number
sort String

Supporting Types

GetPortalFilter

AuthenticationEnabled bool: Filter by a boolean value (true/false).
AutoApproveApplications bool: Filter by a boolean value (true/false).
AutoApproveDevelopers bool: Filter by a boolean value (true/false).
CanonicalDomain GetPortalFilterCanonicalDomain: Filters on the given string field value by exact match inequality.
DefaultApiVisibility GetPortalFilterDefaultApiVisibility: Filters on the given string field value by exact match inequality.
DefaultApplicationAuthStrategyId GetPortalFilterDefaultApplicationAuthStrategyId: Filters on the given string field value by exact match inequality.
DefaultDomain GetPortalFilterDefaultDomain: Filters on the given string field value by exact match inequality.
DefaultPageVisibility GetPortalFilterDefaultPageVisibility: Filters on the given string field value by exact match inequality.
Description GetPortalFilterDescription: Filters on the given string field value by exact match inequality.
Id GetPortalFilterId: Filters on the given string field value by exact match inequality.
Name GetPortalFilterName: Filters on the given string field value by exact match inequality.
RbacEnabled bool: Filter by a boolean value (true/false).

AuthenticationEnabled bool: Filter by a boolean value (true/false).
AutoApproveApplications bool: Filter by a boolean value (true/false).
AutoApproveDevelopers bool: Filter by a boolean value (true/false).
CanonicalDomain GetPortalFilterCanonicalDomain: Filters on the given string field value by exact match inequality.
DefaultApiVisibility GetPortalFilterDefaultApiVisibility: Filters on the given string field value by exact match inequality.
DefaultApplicationAuthStrategyId GetPortalFilterDefaultApplicationAuthStrategyId: Filters on the given string field value by exact match inequality.
DefaultDomain GetPortalFilterDefaultDomain: Filters on the given string field value by exact match inequality.
DefaultPageVisibility GetPortalFilterDefaultPageVisibility: Filters on the given string field value by exact match inequality.
Description GetPortalFilterDescription: Filters on the given string field value by exact match inequality.
Id GetPortalFilterId: Filters on the given string field value by exact match inequality.
Name GetPortalFilterName: Filters on the given string field value by exact match inequality.
RbacEnabled bool: Filter by a boolean value (true/false).

authenticationEnabled Boolean: Filter by a boolean value (true/false).
autoApproveApplications Boolean: Filter by a boolean value (true/false).
autoApproveDevelopers Boolean: Filter by a boolean value (true/false).
canonicalDomain GetPortalFilterCanonicalDomain: Filters on the given string field value by exact match inequality.
defaultApiVisibility GetPortalFilterDefaultApiVisibility: Filters on the given string field value by exact match inequality.
defaultApplicationAuthStrategyId GetPortalFilterDefaultApplicationAuthStrategyId: Filters on the given string field value by exact match inequality.
defaultDomain GetPortalFilterDefaultDomain: Filters on the given string field value by exact match inequality.
defaultPageVisibility GetPortalFilterDefaultPageVisibility: Filters on the given string field value by exact match inequality.
description GetPortalFilterDescription: Filters on the given string field value by exact match inequality.
id GetPortalFilterId: Filters on the given string field value by exact match inequality.
name GetPortalFilterName: Filters on the given string field value by exact match inequality.
rbacEnabled Boolean: Filter by a boolean value (true/false).

authenticationEnabled boolean: Filter by a boolean value (true/false).
autoApproveApplications boolean: Filter by a boolean value (true/false).
autoApproveDevelopers boolean: Filter by a boolean value (true/false).
canonicalDomain GetPortalFilterCanonicalDomain: Filters on the given string field value by exact match inequality.
defaultApiVisibility GetPortalFilterDefaultApiVisibility: Filters on the given string field value by exact match inequality.
defaultApplicationAuthStrategyId GetPortalFilterDefaultApplicationAuthStrategyId: Filters on the given string field value by exact match inequality.
defaultDomain GetPortalFilterDefaultDomain: Filters on the given string field value by exact match inequality.
defaultPageVisibility GetPortalFilterDefaultPageVisibility: Filters on the given string field value by exact match inequality.
description GetPortalFilterDescription: Filters on the given string field value by exact match inequality.
id GetPortalFilterId: Filters on the given string field value by exact match inequality.
name GetPortalFilterName: Filters on the given string field value by exact match inequality.
rbacEnabled boolean: Filter by a boolean value (true/false).

authentication_enabled bool: Filter by a boolean value (true/false).
auto_approve_applications bool: Filter by a boolean value (true/false).
auto_approve_developers bool: Filter by a boolean value (true/false).
canonical_domain GetPortalFilterCanonicalDomain: Filters on the given string field value by exact match inequality.
default_api_visibility GetPortalFilterDefaultApiVisibility: Filters on the given string field value by exact match inequality.
default_application_auth_strategy_id GetPortalFilterDefaultApplicationAuthStrategyId: Filters on the given string field value by exact match inequality.
default_domain GetPortalFilterDefaultDomain: Filters on the given string field value by exact match inequality.
default_page_visibility GetPortalFilterDefaultPageVisibility: Filters on the given string field value by exact match inequality.
description GetPortalFilterDescription: Filters on the given string field value by exact match inequality.
id GetPortalFilterId: Filters on the given string field value by exact match inequality.
name GetPortalFilterName: Filters on the given string field value by exact match inequality.
rbac_enabled bool: Filter by a boolean value (true/false).

authenticationEnabled Boolean: Filter by a boolean value (true/false).
autoApproveApplications Boolean: Filter by a boolean value (true/false).
autoApproveDevelopers Boolean: Filter by a boolean value (true/false).
canonicalDomain Property Map: Filters on the given string field value by exact match inequality.
defaultApiVisibility Property Map: Filters on the given string field value by exact match inequality.
defaultApplicationAuthStrategyId Property Map: Filters on the given string field value by exact match inequality.
defaultDomain Property Map: Filters on the given string field value by exact match inequality.
defaultPageVisibility Property Map: 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.
rbacEnabled Boolean: Filter by a boolean value (true/false).

GetPortalFilterCanonicalDomain

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

GetPortalFilterDefaultApiVisibility

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

GetPortalFilterDefaultApplicationAuthStrategyId

Eq string
Neq string
Oeq string

Eq string
Neq string
Oeq string

eq String
neq String
oeq String

eq string
neq string
oeq string

eq str
neq str
oeq str

eq String
neq String
oeq String

GetPortalFilterDefaultDomain

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

GetPortalFilterDefaultPageVisibility

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

GetPortalFilterDescription

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

GetPortalFilterId

Eq string
Neq string
Oeq string

Eq string
Neq string
Oeq string

eq String
neq String
oeq String

eq string
neq string
oeq string

eq str
neq str
oeq str

eq String
neq String
oeq String

GetPortalFilterName

Contains string
Eq string
Neq string
Ocontains string
Oeq string

Contains string
Eq string
Neq string
Ocontains string
Oeq string

contains String
eq String
neq String
ocontains String
oeq String

contains string
eq string
neq string
ocontains string
oeq string

contains str
eq str
neq str
ocontains str
oeq str

contains String
eq String
neq String
ocontains String
oeq String

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong

kong/terraform-provider-konnect

konnect.getPortal

On this page

On this page

Example Usage

Using getPortal

getPortal Result

Supporting Types

GetPortalFilter

GetPortalFilterCanonicalDomain

GetPortalFilterDefaultApiVisibility

GetPortalFilterDefaultApplicationAuthStrategyId

GetPortalFilterDefaultDomain

GetPortalFilterDefaultPageVisibility

GetPortalFilterDescription

GetPortalFilterId

GetPortalFilterName

Package Details

On this page

On this page