konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getPortalList

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myPortallist = konnect.getPortalList({
    pageNumber: 1,
    pageSize: 10,
    sort: "...my_sort...",
});

import pulumi
import pulumi_konnect as konnect

my_portallist = konnect.get_portal_list(page_number=1,
    page_size=10,
    sort="...my_sort...")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.GetPortalList(ctx, &konnect.GetPortalListArgs{
			PageNumber: pulumi.Float64Ref(1),
			PageSize:   pulumi.Float64Ref(10),
			Sort:       pulumi.StringRef("...my_sort..."),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myPortallist = Konnect.GetPortalList.Invoke(new()
    {
        PageNumber = 1,
        PageSize = 10,
        Sort = "...my_sort...",
    });

});

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.GetPortalListArgs;
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 myPortallist = KonnectFunctions.getPortalList(GetPortalListArgs.builder()
            .pageNumber(1)
            .pageSize(10)
            .sort("...my_sort...")
            .build());

    }
}

variables:
  myPortallist:
    fn::invoke:
      function: konnect:getPortalList
      arguments:
        pageNumber: 1
        pageSize: 10
        sort: '...my_sort...'

Using getPortalList

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 getPortalList(args: GetPortalListArgs, opts?: InvokeOptions): Promise<GetPortalListResult>
function getPortalListOutput(args: GetPortalListOutputArgs, opts?: InvokeOptions): Output<GetPortalListResult>

def get_portal_list(page_number: Optional[float] = None,
                    page_size: Optional[float] = None,
                    sort: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPortalListResult
def get_portal_list_output(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[GetPortalListResult]

func GetPortalList(ctx *Context, args *GetPortalListArgs, opts ...InvokeOption) (*GetPortalListResult, error)
func GetPortalListOutput(ctx *Context, args *GetPortalListOutputArgs, opts ...InvokeOption) GetPortalListResultOutput

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

public static class GetPortalList 
{
    public static Task<GetPortalListResult> InvokeAsync(GetPortalListArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalListResult> Invoke(GetPortalListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPortalListResult> getPortalList(GetPortalListArgs args, InvokeOptions options)
public static Output<GetPortalListResult> getPortalList(GetPortalListArgs args, InvokeOptions options)

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

The following arguments are supported:

PageNumber double
PageSize double
Sort string

PageNumber float64
PageSize float64
Sort string

pageNumber Double
pageSize Double
sort String

pageNumber number
pageSize number
sort string

page_number float
page_size float
sort str

pageNumber Number
pageSize Number
sort String

getPortalList Result

The following output properties are available:

Datas List<GetPortalListData>
Id string: The provider-assigned unique ID for this managed resource.
Meta GetPortalListMeta
PageNumber double
PageSize double
Sort string

Datas []GetPortalListData
Id string: The provider-assigned unique ID for this managed resource.
Meta GetPortalListMeta
PageNumber float64
PageSize float64
Sort string

datas List<GetPortalListData>
id String: The provider-assigned unique ID for this managed resource.
meta GetPortalListMeta
pageNumber Double
pageSize Double
sort String

datas GetPortalListData[]
id string: The provider-assigned unique ID for this managed resource.
meta GetPortalListMeta
pageNumber number
pageSize number
sort string

datas Sequence[GetPortalListData]
id str: The provider-assigned unique ID for this managed resource.
meta GetPortalListMeta
page_number float
page_size float
sort str

datas List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
meta Property Map
pageNumber Number
pageSize Number
sort String

Supporting Types

GetPortalListData

ApplicationCount double

Number of applications created in the portal.

AutoApproveApplications bool

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

AutoApproveDevelopers bool

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

CustomClientDomain string

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

CustomDomain string

The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.

DefaultApplicationAuthStrategyId string

Default strategy ID applied on applications for the portal

DefaultDomain string

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

Description string

The description of the portal.

DeveloperCount double

Number of developers using the portal.

DisplayName string

The display name of the portal. This value will be the portal's name in Portal API.

Id string

Contains a unique identifier used by the API for this resource.

IsPublic bool

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

Labels Dictionary<string, string>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Name string

The name of the portal, used to distinguish it from other portals. Name must be unique.

PublishedProductCount double

Number of api products published to the portal

RbacEnabled bool

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

ApplicationCount float64

Number of applications created in the portal.

AutoApproveApplications bool

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

AutoApproveDevelopers bool

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

CreatedAt string

An ISO-8601 timestamp representation of entity creation date.

CustomClientDomain string

CustomDomain string

DefaultApplicationAuthStrategyId string

Default strategy ID applied on applications for the portal

DefaultDomain string

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

Description string

The description of the portal.

DeveloperCount float64

Number of developers using the portal.

DisplayName string

The display name of the portal. This value will be the portal's name in Portal API.

Id string

Contains a unique identifier used by the API for this resource.

IsPublic bool

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

Labels map[string]string

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Name string

The name of the portal, used to distinguish it from other portals. Name must be unique.

PublishedProductCount float64

Number of api products published to the portal

RbacEnabled bool

UpdatedAt string

An ISO-8601 timestamp representation of entity update date.

applicationCount Double

Number of applications created in the portal.

autoApproveApplications Boolean

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

autoApproveDevelopers Boolean

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

customClientDomain String

customDomain String

defaultApplicationAuthStrategyId String

Default strategy ID applied on applications for the portal

defaultDomain String

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

description String

The description of the portal.

developerCount Double

Number of developers using the portal.

displayName String

The display name of the portal. This value will be the portal's name in Portal API.

id String

Contains a unique identifier used by the API for this resource.

isPublic Boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

labels Map<String,String>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name String

The name of the portal, used to distinguish it from other portals. Name must be unique.

publishedProductCount Double

Number of api products published to the portal

rbacEnabled Boolean

updatedAt String

An ISO-8601 timestamp representation of entity update date.

applicationCount number

Number of applications created in the portal.

autoApproveApplications boolean

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

autoApproveDevelopers boolean

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

createdAt string

An ISO-8601 timestamp representation of entity creation date.

customClientDomain string

customDomain string

defaultApplicationAuthStrategyId string

Default strategy ID applied on applications for the portal

defaultDomain string

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

description string

The description of the portal.

developerCount number

Number of developers using the portal.

displayName string

The display name of the portal. This value will be the portal's name in Portal API.

id string

Contains a unique identifier used by the API for this resource.

isPublic boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

labels {[key: string]: string}

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name string

The name of the portal, used to distinguish it from other portals. Name must be unique.

publishedProductCount number

Number of api products published to the portal

rbacEnabled boolean

updatedAt string

An ISO-8601 timestamp representation of entity update date.

application_count float

Number of applications created in the portal.

auto_approve_applications bool

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developers bool

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

created_at str

An ISO-8601 timestamp representation of entity creation date.

custom_client_domain str

custom_domain str

default_application_auth_strategy_id str

Default strategy ID applied on applications for the portal

default_domain str

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

description str

The description of the portal.

developer_count float

Number of developers using the portal.

display_name str

The display name of the portal. This value will be the portal's name in Portal API.

id str

Contains a unique identifier used by the API for this resource.

is_public bool

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

labels Mapping[str, str]

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name str

The name of the portal, used to distinguish it from other portals. Name must be unique.

published_product_count float

Number of api products published to the portal

rbac_enabled bool

updated_at str

An ISO-8601 timestamp representation of entity update date.

applicationCount Number

Number of applications created in the portal.

autoApproveApplications Boolean

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

autoApproveDevelopers Boolean

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

createdAt String

An ISO-8601 timestamp representation of entity creation date.

customClientDomain String

customDomain String

defaultApplicationAuthStrategyId String

Default strategy ID applied on applications for the portal

defaultDomain String

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

description String

The description of the portal.

developerCount Number

Number of developers using the portal.

displayName String

The display name of the portal. This value will be the portal's name in Portal API.

id String

Contains a unique identifier used by the API for this resource.

isPublic Boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

labels Map<String>

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

name String

The name of the portal, used to distinguish it from other portals. Name must be unique.

publishedProductCount Number

Number of api products published to the portal

rbacEnabled Boolean

updatedAt String

An ISO-8601 timestamp representation of entity update date.

GetPortalListMeta

Page GetPortalListMetaPage: Contains pagination query parameters and the total number of objects returned.

Page GetPortalListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetPortalListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetPortalListMetaPage: Contains pagination query parameters and the total number of objects returned.

page GetPortalListMetaPage: Contains pagination query parameters and the total number of objects returned.

page Property Map: Contains pagination query parameters and the total number of objects returned.

GetPortalListMetaPage

Number double
Size double
Total double

Number float64
Size float64
Total float64

number Double
size Double
total Double

number number
size number
total number

number float
size float
total float

number Number
size Number
total Number

Package Details

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

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.getPortalList

On this page

On this page

Example Usage

Using getPortalList

getPortalList Result

Supporting Types

GetPortalListData

GetPortalListMeta

GetPortalListMetaPage

Package Details

On this page

On this page