Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. PortalTeamRole
Viewing docs for konnect 3.20.0
published on Monday, Jul 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.PortalTeamRole

Viewing docs for konnect 3.20.0
published on Monday, Jul 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    PortalTeamRole Resource

    Example Usage

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

const myPortalteamrole = new konnect.PortalTeamRole("my_portalteamrole", {
    entityId: "e67490ce-44dc-4cbd-b65e-b52c746fc26a",
    entityRegion: "eu",
    entityTypeName: "Services",
    portalId: "f32d905a-ed33-46a3-a093-d8f536af9a8a",
    roleName: "API Viewer",
    teamId: "d32d905a-ed33-46a3-a093-d8f536af9a8a",
});

    import pulumi
import pulumi_konnect as konnect

my_portalteamrole = konnect.PortalTeamRole("my_portalteamrole",
    entity_id="e67490ce-44dc-4cbd-b65e-b52c746fc26a",
    entity_region="eu",
    entity_type_name="Services",
    portal_id="f32d905a-ed33-46a3-a093-d8f536af9a8a",
    role_name="API Viewer",
    team_id="d32d905a-ed33-46a3-a093-d8f536af9a8a")

    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.NewPortalTeamRole(ctx, "my_portalteamrole", &konnect.PortalTeamRoleArgs{
			EntityId:       pulumi.String("e67490ce-44dc-4cbd-b65e-b52c746fc26a"),
			EntityRegion:   pulumi.String("eu"),
			EntityTypeName: pulumi.String("Services"),
			PortalId:       pulumi.String("f32d905a-ed33-46a3-a093-d8f536af9a8a"),
			RoleName:       pulumi.String("API Viewer"),
			TeamId:         pulumi.String("d32d905a-ed33-46a3-a093-d8f536af9a8a"),
		})
		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 myPortalteamrole = new Konnect.PortalTeamRole("my_portalteamrole", new()
    {
        EntityId = "e67490ce-44dc-4cbd-b65e-b52c746fc26a",
        EntityRegion = "eu",
        EntityTypeName = "Services",
        PortalId = "f32d905a-ed33-46a3-a093-d8f536af9a8a",
        RoleName = "API Viewer",
        TeamId = "d32d905a-ed33-46a3-a093-d8f536af9a8a",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.PortalTeamRole;
import com.pulumi.konnect.PortalTeamRoleArgs;
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 myPortalteamrole = new PortalTeamRole("myPortalteamrole", PortalTeamRoleArgs.builder()
            .entityId("e67490ce-44dc-4cbd-b65e-b52c746fc26a")
            .entityRegion("eu")
            .entityTypeName("Services")
            .portalId("f32d905a-ed33-46a3-a093-d8f536af9a8a")
            .roleName("API Viewer")
            .teamId("d32d905a-ed33-46a3-a093-d8f536af9a8a")
            .build());

    }
}

    resources:
  myPortalteamrole:
    type: konnect:PortalTeamRole
    name: my_portalteamrole
    properties:
      entityId: e67490ce-44dc-4cbd-b65e-b52c746fc26a
      entityRegion: eu
      entityTypeName: Services
      portalId: f32d905a-ed33-46a3-a093-d8f536af9a8a
      roleName: API Viewer
      teamId: d32d905a-ed33-46a3-a093-d8f536af9a8a

    Example coming soon!

    Create PortalTeamRole Resource

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

    Constructor syntax

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

@overload
def PortalTeamRole(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   entity_id: Optional[str] = None,
                   entity_region: Optional[str] = None,
                   entity_type_name: Optional[str] = None,
                   portal_id: Optional[str] = None,
                   role_name: Optional[str] = None,
                   team_id: Optional[str] = None)
    func NewPortalTeamRole(ctx *Context, name string, args PortalTeamRoleArgs, opts ...ResourceOption) (*PortalTeamRole, error)
    public PortalTeamRole(string name, PortalTeamRoleArgs args, CustomResourceOptions? opts = null)
    public PortalTeamRole(String name, PortalTeamRoleArgs args)
public PortalTeamRole(String name, PortalTeamRoleArgs args, CustomResourceOptions options)

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


    resource "konnect_portal_team_role" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PortalTeamRoleArgs
    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 PortalTeamRoleArgs
    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 PortalTeamRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalTeamRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalTeamRoleArgs
    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 portalTeamRoleResource = new Konnect.PortalTeamRole("portalTeamRoleResource", new()
{
    EntityId = "string",
    EntityRegion = "string",
    EntityTypeName = "string",
    PortalId = "string",
    RoleName = "string",
    TeamId = "string",
});

    example, err := konnect.NewPortalTeamRole(ctx, "portalTeamRoleResource", &konnect.PortalTeamRoleArgs{
	EntityId:       pulumi.String("string"),
	EntityRegion:   pulumi.String("string"),
	EntityTypeName: pulumi.String("string"),
	PortalId:       pulumi.String("string"),
	RoleName:       pulumi.String("string"),
	TeamId:         pulumi.String("string"),
})

    resource "konnect_portal_team_role" "portalTeamRoleResource" {
  lifecycle {
    create_before_destroy = true
  }
  entity_id        = "string"
  entity_region    = "string"
  entity_type_name = "string"
  portal_id        = "string"
  role_name        = "string"
  team_id          = "string"
}

    var portalTeamRoleResource = new PortalTeamRole("portalTeamRoleResource", PortalTeamRoleArgs.builder()
    .entityId("string")
    .entityRegion("string")
    .entityTypeName("string")
    .portalId("string")
    .roleName("string")
    .teamId("string")
    .build());

    portal_team_role_resource = konnect.PortalTeamRole("portalTeamRoleResource",
    entity_id="string",
    entity_region="string",
    entity_type_name="string",
    portal_id="string",
    role_name="string",
    team_id="string")

    const portalTeamRoleResource = new konnect.PortalTeamRole("portalTeamRoleResource", {
    entityId: "string",
    entityRegion: "string",
    entityTypeName: "string",
    portalId: "string",
    roleName: "string",
    teamId: "string",
});

    type: konnect:PortalTeamRole
properties:
    entityId: string
    entityRegion: string
    entityTypeName: string
    portalId: string
    roleName: string
    teamId: string

    PortalTeamRole 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 PortalTeamRole resource accepts the following input properties:

    EntityId string
    Requires replacement if changed.
    EntityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    EntityTypeName string
    Requires replacement if changed.
    PortalId string
    The Portal identifier. Requires replacement if changed.
    RoleName string
    Requires replacement if changed.
    TeamId string
    ID of the team. Requires replacement if changed.
    EntityId string
    Requires replacement if changed.
    EntityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    EntityTypeName string
    Requires replacement if changed.
    PortalId string
    The Portal identifier. Requires replacement if changed.
    RoleName string
    Requires replacement if changed.
    TeamId string
    ID of the team. Requires replacement if changed.
    entity_id string
    Requires replacement if changed.
    entity_region string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entity_type_name string
    Requires replacement if changed.
    portal_id string
    The Portal identifier. Requires replacement if changed.
    role_name string
    Requires replacement if changed.
    team_id string
    ID of the team. Requires replacement if changed.
    entityId String
    Requires replacement if changed.
    entityRegion String
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName String
    Requires replacement if changed.
    portalId String
    The Portal identifier. Requires replacement if changed.
    roleName String
    Requires replacement if changed.
    teamId String
    ID of the team. Requires replacement if changed.
    entityId string
    Requires replacement if changed.
    entityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName string
    Requires replacement if changed.
    portalId string
    The Portal identifier. Requires replacement if changed.
    roleName string
    Requires replacement if changed.
    teamId string
    ID of the team. Requires replacement if changed.
    entity_id str
    Requires replacement if changed.
    entity_region str
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entity_type_name str
    Requires replacement if changed.
    portal_id str
    The Portal identifier. Requires replacement if changed.
    role_name str
    Requires replacement if changed.
    team_id str
    ID of the team. Requires replacement if changed.
    entityId String
    Requires replacement if changed.
    entityRegion String
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName String
    Requires replacement if changed.
    portalId String
    The Portal identifier. Requires replacement if changed.
    roleName String
    Requires replacement if changed.
    teamId String
    ID of the team. Requires replacement if changed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PortalTeamRole Resource

    Get an existing PortalTeamRole 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?: PortalTeamRoleState, opts?: CustomResourceOptions): PortalTeamRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        entity_id: Optional[str] = None,
        entity_region: Optional[str] = None,
        entity_type_name: Optional[str] = None,
        portal_id: Optional[str] = None,
        role_name: Optional[str] = None,
        team_id: Optional[str] = None) -> PortalTeamRole
    func GetPortalTeamRole(ctx *Context, name string, id IDInput, state *PortalTeamRoleState, opts ...ResourceOption) (*PortalTeamRole, error)
    public static PortalTeamRole Get(string name, Input<string> id, PortalTeamRoleState? state, CustomResourceOptions? opts = null)
    public static PortalTeamRole get(String name, Output<String> id, PortalTeamRoleState state, CustomResourceOptions options)
    resources:  _:    type: konnect:PortalTeamRole    get:      id: ${id}
    import {
  to = konnect_portal_team_role.example
  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:
    EntityId string
    Requires replacement if changed.
    EntityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    EntityTypeName string
    Requires replacement if changed.
    PortalId string
    The Portal identifier. Requires replacement if changed.
    RoleName string
    Requires replacement if changed.
    TeamId string
    ID of the team. Requires replacement if changed.
    EntityId string
    Requires replacement if changed.
    EntityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    EntityTypeName string
    Requires replacement if changed.
    PortalId string
    The Portal identifier. Requires replacement if changed.
    RoleName string
    Requires replacement if changed.
    TeamId string
    ID of the team. Requires replacement if changed.
    entity_id string
    Requires replacement if changed.
    entity_region string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entity_type_name string
    Requires replacement if changed.
    portal_id string
    The Portal identifier. Requires replacement if changed.
    role_name string
    Requires replacement if changed.
    team_id string
    ID of the team. Requires replacement if changed.
    entityId String
    Requires replacement if changed.
    entityRegion String
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName String
    Requires replacement if changed.
    portalId String
    The Portal identifier. Requires replacement if changed.
    roleName String
    Requires replacement if changed.
    teamId String
    ID of the team. Requires replacement if changed.
    entityId string
    Requires replacement if changed.
    entityRegion string
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName string
    Requires replacement if changed.
    portalId string
    The Portal identifier. Requires replacement if changed.
    roleName string
    Requires replacement if changed.
    teamId string
    ID of the team. Requires replacement if changed.
    entity_id str
    Requires replacement if changed.
    entity_region str
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entity_type_name str
    Requires replacement if changed.
    portal_id str
    The Portal identifier. Requires replacement if changed.
    role_name str
    Requires replacement if changed.
    team_id str
    ID of the team. Requires replacement if changed.
    entityId String
    Requires replacement if changed.
    entityRegion String
    Region of the entity. possible known values include one of ["us", "eu", "au", "me", "in", "sg", "*"]; Requires replacement if changed.
    entityTypeName String
    Requires replacement if changed.
    portalId String
    The Portal identifier. Requires replacement if changed.
    roleName String
    Requires replacement if changed.
    teamId String
    ID of the team. Requires replacement if changed.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    Viewing docs for konnect 3.20.0
    published on Monday, Jul 6, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial