Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. Portal
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.Portal

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

Portal Resource

Example Usage

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

const myPortal = new konnect.Portal("myPortal", {
    autoApproveApplications: false,
    autoApproveDevelopers: false,
    customClientDomain: "key-self-confidence.name",
    customDomain: "measly-conservation.info",
    defaultApplicationAuthStrategyId: "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    description: "...my_description...",
    displayName: "...my_display_name...",
    force: "true",
    isPublic: false,
    labels: {
        key: "value",
    },
    rbacEnabled: true,
});
Copy
import pulumi
import pulumi_konnect as konnect

my_portal = konnect.Portal("myPortal",
    auto_approve_applications=False,
    auto_approve_developers=False,
    custom_client_domain="key-self-confidence.name",
    custom_domain="measly-conservation.info",
    default_application_auth_strategy_id="5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
    description="...my_description...",
    display_name="...my_display_name...",
    force="true",
    is_public=False,
    labels={
        "key": "value",
    },
    rbac_enabled=True)
Copy
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.NewPortal(ctx, "myPortal", &konnect.PortalArgs{
			AutoApproveApplications:          pulumi.Bool(false),
			AutoApproveDevelopers:            pulumi.Bool(false),
			CustomClientDomain:               pulumi.String("key-self-confidence.name"),
			CustomDomain:                     pulumi.String("measly-conservation.info"),
			DefaultApplicationAuthStrategyId: pulumi.String("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"),
			Description:                      pulumi.String("...my_description..."),
			DisplayName:                      pulumi.String("...my_display_name..."),
			Force:                            pulumi.String("true"),
			IsPublic:                         pulumi.Bool(false),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			RbacEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myPortal = new Konnect.Portal("myPortal", new()
    {
        AutoApproveApplications = false,
        AutoApproveDevelopers = false,
        CustomClientDomain = "key-self-confidence.name",
        CustomDomain = "measly-conservation.info",
        DefaultApplicationAuthStrategyId = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
        Description = "...my_description...",
        DisplayName = "...my_display_name...",
        Force = "true",
        IsPublic = false,
        Labels = 
        {
            { "key", "value" },
        },
        RbacEnabled = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.Portal;
import com.pulumi.konnect.PortalArgs;
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) {
        var myPortal = new Portal("myPortal", PortalArgs.builder()
            .autoApproveApplications(false)
            .autoApproveDevelopers(false)
            .customClientDomain("key-self-confidence.name")
            .customDomain("measly-conservation.info")
            .defaultApplicationAuthStrategyId("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7")
            .description("...my_description...")
            .displayName("...my_display_name...")
            .force("true")
            .isPublic(false)
            .labels(Map.of("key", "value"))
            .rbacEnabled(true)
            .build());

    }
}
Copy
resources:
  myPortal:
    type: konnect:Portal
    properties:
      autoApproveApplications: false
      autoApproveDevelopers: false
      customClientDomain: key-self-confidence.name
      customDomain: measly-conservation.info
      defaultApplicationAuthStrategyId: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      description: '...my_description...'
      displayName: '...my_display_name...'
      force: 'true'
      isPublic: false
      labels:
        key: value
      rbacEnabled: true
Copy

Create Portal Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Portal(name: string, args?: PortalArgs, opts?: CustomResourceOptions);
@overload
def Portal(resource_name: str,
           args: Optional[PortalArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Portal(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           auto_approve_applications: Optional[bool] = None,
           auto_approve_developers: Optional[bool] = None,
           custom_client_domain: Optional[str] = None,
           custom_domain: Optional[str] = None,
           default_application_auth_strategy_id: Optional[str] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           force: Optional[str] = None,
           is_public: Optional[bool] = None,
           labels: Optional[Mapping[str, str]] = None,
           name: Optional[str] = None,
           rbac_enabled: Optional[bool] = None)
func NewPortal(ctx *Context, name string, args *PortalArgs, opts ...ResourceOption) (*Portal, error)
public Portal(string name, PortalArgs? args = null, CustomResourceOptions? opts = null)
public Portal(String name, PortalArgs args)
public Portal(String name, PortalArgs args, CustomResourceOptions options)

type: konnect:Portal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args PortalArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args PortalArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args PortalArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args PortalArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PortalArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var portalResource = new Konnect.Portal("portalResource", new()
{
    AutoApproveApplications = false,
    AutoApproveDevelopers = false,
    CustomClientDomain = "string",
    CustomDomain = "string",
    DefaultApplicationAuthStrategyId = "string",
    Description = "string",
    DisplayName = "string",
    Force = "string",
    IsPublic = false,
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    RbacEnabled = false,
});
Copy
example, err := konnect.NewPortal(ctx, "portalResource", &konnect.PortalArgs{
AutoApproveApplications: pulumi.Bool(false),
AutoApproveDevelopers: pulumi.Bool(false),
CustomClientDomain: pulumi.String("string"),
CustomDomain: pulumi.String("string"),
DefaultApplicationAuthStrategyId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Force: pulumi.String("string"),
IsPublic: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
RbacEnabled: pulumi.Bool(false),
})
Copy
var portalResource = new Portal("portalResource", PortalArgs.builder()
    .autoApproveApplications(false)
    .autoApproveDevelopers(false)
    .customClientDomain("string")
    .customDomain("string")
    .defaultApplicationAuthStrategyId("string")
    .description("string")
    .displayName("string")
    .force("string")
    .isPublic(false)
    .labels(Map.of("string", "string"))
    .name("string")
    .rbacEnabled(false)
    .build());
Copy
portal_resource = konnect.Portal("portalResource",
    auto_approve_applications=False,
    auto_approve_developers=False,
    custom_client_domain="string",
    custom_domain="string",
    default_application_auth_strategy_id="string",
    description="string",
    display_name="string",
    force="string",
    is_public=False,
    labels={
        "string": "string",
    },
    name="string",
    rbac_enabled=False)
Copy
const portalResource = new konnect.Portal("portalResource", {
    autoApproveApplications: false,
    autoApproveDevelopers: false,
    customClientDomain: "string",
    customDomain: "string",
    defaultApplicationAuthStrategyId: "string",
    description: "string",
    displayName: "string",
    force: "string",
    isPublic: false,
    labels: {
        string: "string",
    },
    name: "string",
    rbacEnabled: false,
});
Copy
type: konnect:Portal
properties:
    autoApproveApplications: false
    autoApproveDevelopers: false
    customClientDomain: string
    customDomain: string
    defaultApplicationAuthStrategyId: string
    description: string
    displayName: string
    force: string
    isPublic: false
    labels:
        string: string
    name: string
    rbacEnabled: false
Copy

Portal Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Portal resource accepts the following input properties:

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.
CustomClientDomain string
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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
Description string
The description of the portal.
DisplayName string
The display name of the portal. This value will be the portal's name in Portal API.
Force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
Name string
The name of the portal, used to distinguish it from other portals. Name must be unique.
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.
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.
CustomClientDomain string
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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
Description string
The description of the portal.
DisplayName string
The display name of the portal. This value will be the portal's name in Portal API.
Force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
Name string
The name of the portal, used to distinguish it from other portals. Name must be unique.
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.
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.
customClientDomain String
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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
description String
The description of the portal.
displayName String
The display name of the portal. This value will be the portal's name in Portal API.
force String
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
name String
The name of the portal, used to distinguish it from other portals. Name must be unique.
rbacEnabled Boolean
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.
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.
customClientDomain string
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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
description string
The description of the portal.
displayName string
The display name of the portal. This value will be the portal's name in Portal API.
force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
name string
The name of the portal, used to distinguish it from other portals. Name must be unique.
rbacEnabled boolean
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.
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.
custom_client_domain str
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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.
custom_domain str
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.
default_application_auth_strategy_id str
Default strategy ID applied on applications for the portal
description str
The description of the portal.
display_name str
The display name of the portal. This value will be the portal's name in Portal API.
force str
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
name str
The name of the portal, used to distinguish it from other portals. Name must be unique.
rbac_enabled 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.
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.
customClientDomain String
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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
description String
The description of the portal.
displayName String
The display name of the portal. This value will be the portal's name in Portal API.
force String
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
name String
The name of the portal, used to distinguish it from other portals. Name must be unique.
rbacEnabled Boolean
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:

ApplicationCount double
Number of applications created in the portal.
CreatedAt string
An ISO-8601 timestamp representation of entity creation date.
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``.
DeveloperCount double
Number of developers using the portal.
Id string
The provider-assigned unique ID for this managed resource.
PublishedProductCount double
Number of api products published to the portal
UpdatedAt string
An ISO-8601 timestamp representation of entity update date.
ApplicationCount float64
Number of applications created in the portal.
CreatedAt string
An ISO-8601 timestamp representation of entity creation date.
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``.
DeveloperCount float64
Number of developers using the portal.
Id string
The provider-assigned unique ID for this managed resource.
PublishedProductCount float64
Number of api products published to the portal
UpdatedAt string
An ISO-8601 timestamp representation of entity update date.
applicationCount Double
Number of applications created in the portal.
createdAt String
An ISO-8601 timestamp representation of entity creation date.
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``.
developerCount Double
Number of developers using the portal.
id String
The provider-assigned unique ID for this managed resource.
publishedProductCount Double
Number of api products published to the portal
updatedAt String
An ISO-8601 timestamp representation of entity update date.
applicationCount number
Number of applications created in the portal.
createdAt string
An ISO-8601 timestamp representation of entity creation date.
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``.
developerCount number
Number of developers using the portal.
id string
The provider-assigned unique ID for this managed resource.
publishedProductCount number
Number of api products published to the portal
updatedAt string
An ISO-8601 timestamp representation of entity update date.
application_count float
Number of applications created in the portal.
created_at str
An ISO-8601 timestamp representation of entity creation date.
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``.
developer_count float
Number of developers using the portal.
id str
The provider-assigned unique ID for this managed resource.
published_product_count float
Number of api products published to the portal
updated_at str
An ISO-8601 timestamp representation of entity update date.
applicationCount Number
Number of applications created in the portal.
createdAt String
An ISO-8601 timestamp representation of entity creation date.
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``.
developerCount Number
Number of developers using the portal.
id String
The provider-assigned unique ID for this managed resource.
publishedProductCount Number
Number of api products published to the portal
updatedAt String
An ISO-8601 timestamp representation of entity update date.

Look up Existing Portal Resource

Get an existing Portal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PortalState, opts?: CustomResourceOptions): Portal
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_count: Optional[float] = None,
        auto_approve_applications: Optional[bool] = None,
        auto_approve_developers: Optional[bool] = None,
        created_at: Optional[str] = None,
        custom_client_domain: Optional[str] = None,
        custom_domain: Optional[str] = None,
        default_application_auth_strategy_id: Optional[str] = None,
        default_domain: Optional[str] = None,
        description: Optional[str] = None,
        developer_count: Optional[float] = None,
        display_name: Optional[str] = None,
        force: Optional[str] = None,
        is_public: Optional[bool] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        published_product_count: Optional[float] = None,
        rbac_enabled: Optional[bool] = None,
        updated_at: Optional[str] = None) -> Portal
func GetPortal(ctx *Context, name string, id IDInput, state *PortalState, opts ...ResourceOption) (*Portal, error)
public static Portal Get(string name, Input<string> id, PortalState? state, CustomResourceOptions? opts = null)
public static Portal get(String name, Output<String> id, PortalState state, CustomResourceOptions options)
resources:  _:    type: konnect:Portal    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
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 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.
Force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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 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.
Force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
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 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
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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.
force String
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
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 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
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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 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.
force string
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
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.
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
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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.
custom_domain str
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.
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.
force str
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
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.
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
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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 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.
force String
If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled. Default: "false"; must be one of ["true", "false"]
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.
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
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.

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