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

konnect.Portal

Explore with Pulumi AI

konnect logo
konnect 3.2.0 published on Tuesday, Sep 16, 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", {
    authenticationEnabled: false,
    autoApproveApplications: false,
    autoApproveDevelopers: false,
    defaultApiVisibility: "public",
    defaultApplicationAuthStrategyId: "e7d77a5f-c5f5-49db-9b2f-cabb4401add8",
    defaultPageVisibility: "private",
    description: "...my_description...",
    displayName: "...my_display_name...",
    forceDestroy: "false",
    labels: {
        key: "value",
    },
    rbacEnabled: true,
});

    import pulumi
import pulumi_konnect as konnect

my_portal = konnect.Portal("myPortal",
    authentication_enabled=False,
    auto_approve_applications=False,
    auto_approve_developers=False,
    default_api_visibility="public",
    default_application_auth_strategy_id="e7d77a5f-c5f5-49db-9b2f-cabb4401add8",
    default_page_visibility="private",
    description="...my_description...",
    display_name="...my_display_name...",
    force_destroy="false",
    labels={
        "key": "value",
    },
    rbac_enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/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{
			AuthenticationEnabled:            pulumi.Bool(false),
			AutoApproveApplications:          pulumi.Bool(false),
			AutoApproveDevelopers:            pulumi.Bool(false),
			DefaultApiVisibility:             pulumi.String("public"),
			DefaultApplicationAuthStrategyId: pulumi.String("e7d77a5f-c5f5-49db-9b2f-cabb4401add8"),
			DefaultPageVisibility:            pulumi.String("private"),
			Description:                      pulumi.String("...my_description..."),
			DisplayName:                      pulumi.String("...my_display_name..."),
			ForceDestroy:                     pulumi.String("false"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			RbacEnabled: pulumi.Bool(true),
		})
		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 myPortal = new Konnect.Portal("myPortal", new()
    {
        AuthenticationEnabled = false,
        AutoApproveApplications = false,
        AutoApproveDevelopers = false,
        DefaultApiVisibility = "public",
        DefaultApplicationAuthStrategyId = "e7d77a5f-c5f5-49db-9b2f-cabb4401add8",
        DefaultPageVisibility = "private",
        Description = "...my_description...",
        DisplayName = "...my_display_name...",
        ForceDestroy = "false",
        Labels = 
        {
            { "key", "value" },
        },
        RbacEnabled = true,
    });

});

    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()
            .authenticationEnabled(false)
            .autoApproveApplications(false)
            .autoApproveDevelopers(false)
            .defaultApiVisibility("public")
            .defaultApplicationAuthStrategyId("e7d77a5f-c5f5-49db-9b2f-cabb4401add8")
            .defaultPageVisibility("private")
            .description("...my_description...")
            .displayName("...my_display_name...")
            .forceDestroy("false")
            .labels(Map.of("key", "value"))
            .rbacEnabled(true)
            .build());

    }
}

    resources:
  myPortal:
    type: konnect:Portal
    properties:
      authenticationEnabled: false
      autoApproveApplications: false
      autoApproveDevelopers: false
      defaultApiVisibility: public
      defaultApplicationAuthStrategyId: e7d77a5f-c5f5-49db-9b2f-cabb4401add8
      defaultPageVisibility: private
      description: '...my_description...'
      displayName: '...my_display_name...'
      forceDestroy: 'false'
      labels:
        key: value
      rbacEnabled: true

    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,
           authentication_enabled: Optional[bool] = None,
           auto_approve_applications: Optional[bool] = None,
           auto_approve_developers: Optional[bool] = None,
           default_api_visibility: Optional[str] = None,
           default_application_auth_strategy_id: Optional[str] = None,
           default_page_visibility: Optional[str] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           force_destroy: Optional[str] = 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 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 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 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 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 String
    The unique name of the resource.
    args 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()
{
    AuthenticationEnabled = false,
    AutoApproveApplications = false,
    AutoApproveDevelopers = false,
    DefaultApiVisibility = "string",
    DefaultApplicationAuthStrategyId = "string",
    DefaultPageVisibility = "string",
    Description = "string",
    DisplayName = "string",
    ForceDestroy = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    RbacEnabled = false,
});

    example, err := konnect.NewPortal(ctx, "portalResource", &konnect.PortalArgs{
	AuthenticationEnabled:            pulumi.Bool(false),
	AutoApproveApplications:          pulumi.Bool(false),
	AutoApproveDevelopers:            pulumi.Bool(false),
	DefaultApiVisibility:             pulumi.String("string"),
	DefaultApplicationAuthStrategyId: pulumi.String("string"),
	DefaultPageVisibility:            pulumi.String("string"),
	Description:                      pulumi.String("string"),
	DisplayName:                      pulumi.String("string"),
	ForceDestroy:                     pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:        pulumi.String("string"),
	RbacEnabled: pulumi.Bool(false),
})

    var portalResource = new Portal("portalResource", PortalArgs.builder()
    .authenticationEnabled(false)
    .autoApproveApplications(false)
    .autoApproveDevelopers(false)
    .defaultApiVisibility("string")
    .defaultApplicationAuthStrategyId("string")
    .defaultPageVisibility("string")
    .description("string")
    .displayName("string")
    .forceDestroy("string")
    .labels(Map.of("string", "string"))
    .name("string")
    .rbacEnabled(false)
    .build());

    portal_resource = konnect.Portal("portalResource",
    authentication_enabled=False,
    auto_approve_applications=False,
    auto_approve_developers=False,
    default_api_visibility="string",
    default_application_auth_strategy_id="string",
    default_page_visibility="string",
    description="string",
    display_name="string",
    force_destroy="string",
    labels={
        "string": "string",
    },
    name="string",
    rbac_enabled=False)

    const portalResource = new konnect.Portal("portalResource", {
    authenticationEnabled: false,
    autoApproveApplications: false,
    autoApproveDevelopers: false,
    defaultApiVisibility: "string",
    defaultApplicationAuthStrategyId: "string",
    defaultPageVisibility: "string",
    description: "string",
    displayName: "string",
    forceDestroy: "string",
    labels: {
        string: "string",
    },
    name: "string",
    rbacEnabled: false,
});

    type: konnect:Portal
properties:
    authenticationEnabled: false
    autoApproveApplications: false
    autoApproveDevelopers: false
    defaultApiVisibility: string
    defaultApplicationAuthStrategyId: string
    defaultPageVisibility: string
    description: string
    displayName: string
    forceDestroy: string
    labels:
        string: string
    name: string
    rbacEnabled: false

    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:

    AuthenticationEnabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    AutoApproveApplications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    AutoApproveDevelopers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    DefaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    DefaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    DefaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    Description string
    A description of the portal.
    DisplayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    ForceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    AuthenticationEnabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    AutoApproveApplications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    AutoApproveDevelopers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    DefaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    DefaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    DefaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    Description string
    A description of the portal.
    DisplayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    ForceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    authenticationEnabled Boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications Boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers Boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    defaultApiVisibility String
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId String
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    defaultPageVisibility String
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description String
    A description of the portal.
    displayName String
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy String
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    authenticationEnabled boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    defaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    defaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description string
    A description of the portal.
    displayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    authentication_enabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    auto_approve_applications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    auto_approve_developers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    default_api_visibility str
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    default_application_auth_strategy_id str
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    default_page_visibility str
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description str
    A 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_destroy str
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    authenticationEnabled Boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications Boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers Boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    defaultApiVisibility String
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId String
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    defaultPageVisibility String
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description String
    A description of the portal.
    displayName String
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy String
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false

    Outputs

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

    CanonicalDomain string
    The canonical domain of the developer 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``.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CanonicalDomain string
    The canonical domain of the developer 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``.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    canonicalDomain String
    The canonical domain of the developer 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``.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    canonicalDomain string
    The canonical domain of the developer 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``.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    canonical_domain str
    The canonical domain of the developer 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``.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    canonicalDomain String
    The canonical domain of the developer 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``.
    id String
    The provider-assigned unique ID for this managed resource.
    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,
        authentication_enabled: Optional[bool] = None,
        auto_approve_applications: Optional[bool] = None,
        auto_approve_developers: Optional[bool] = None,
        canonical_domain: Optional[str] = None,
        created_at: Optional[str] = None,
        default_api_visibility: Optional[str] = None,
        default_application_auth_strategy_id: Optional[str] = None,
        default_domain: Optional[str] = None,
        default_page_visibility: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        force_destroy: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = 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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AuthenticationEnabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    AutoApproveApplications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    AutoApproveDevelopers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    CanonicalDomain string
    The canonical domain of the developer portal
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    DefaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    DefaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    DefaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    Description string
    A description of the portal.
    DisplayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    ForceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    AuthenticationEnabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    AutoApproveApplications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    AutoApproveDevelopers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    CanonicalDomain string
    The canonical domain of the developer portal
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    DefaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    DefaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    DefaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    Description string
    A description of the portal.
    DisplayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    ForceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authenticationEnabled Boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications Boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers Boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    canonicalDomain String
    The canonical domain of the developer portal
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    defaultApiVisibility String
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId String
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    defaultPageVisibility String
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description String
    A description of the portal.
    displayName String
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy String
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authenticationEnabled boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    canonicalDomain string
    The canonical domain of the developer portal
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    defaultApiVisibility string
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId string
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    defaultPageVisibility string
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description string
    A description of the portal.
    displayName string
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy string
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authentication_enabled bool
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    auto_approve_applications bool
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    auto_approve_developers bool
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    canonical_domain str
    The canonical domain of the developer portal
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    default_api_visibility str
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    default_application_auth_strategy_id str
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    default_page_visibility str
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description str
    A 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_destroy str
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authenticationEnabled Boolean
    Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications. Default: true
    autoApproveApplications Boolean
    Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    autoApproveDevelopers Boolean
    Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. Default: false
    canonicalDomain String
    The canonical domain of the developer portal
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    defaultApiVisibility String
    The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers. must be one of ["public", "private"]
    defaultApplicationAuthStrategyId String
    The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
    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``.
    defaultPageVisibility String
    The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers. must be one of ["public", "private"]
    description String
    A description of the portal.
    displayName String
    The display name of the portal. This value will be the portal's name in Portal API.
    forceDestroy String
    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 APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC. Default: false
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Import

    $ pulumi import konnect:index/portal:Portal my_konnect_portal "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 3.2.0 published on Tuesday, Sep 16, 2025 by kong
    kong/terraform-provider-konnect