Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. IdentityGroup
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.IdentityGroup

konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    IdentityGroup Resource

    Example Usage

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

const myIdentitygroup = new konnect.IdentityGroup("my_identitygroup", {
    description: "...my_description...",
    directoryId: "307cd9e3-ea12-451b-8bb2-b6c398132110",
    labels: {
        key: "value",
    },
    managedBy: {
        key: "value",
    },
    metadata: "{ \"see\": \"documentation\" }",
    name: "...my_name...",
    type: "group",
});

    import pulumi
import pulumi_konnect as konnect

my_identitygroup = konnect.IdentityGroup("my_identitygroup",
    description="...my_description...",
    directory_id="307cd9e3-ea12-451b-8bb2-b6c398132110",
    labels={
        "key": "value",
    },
    managed_by={
        "key": "value",
    },
    metadata="{ \"see\": \"documentation\" }",
    name="...my_name...",
    type="group")

    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.NewIdentityGroup(ctx, "my_identitygroup", &konnect.IdentityGroupArgs{
			Description: pulumi.String("...my_description..."),
			DirectoryId: pulumi.String("307cd9e3-ea12-451b-8bb2-b6c398132110"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			ManagedBy: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Metadata: pulumi.String("{ \"see\": \"documentation\" }"),
			Name:     pulumi.String("...my_name..."),
			Type:     pulumi.String("group"),
		})
		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 myIdentitygroup = new Konnect.IdentityGroup("my_identitygroup", new()
    {
        Description = "...my_description...",
        DirectoryId = "307cd9e3-ea12-451b-8bb2-b6c398132110",
        Labels = 
        {
            { "key", "value" },
        },
        ManagedBy = 
        {
            { "key", "value" },
        },
        Metadata = "{ \"see\": \"documentation\" }",
        Name = "...my_name...",
        Type = "group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityGroup;
import com.pulumi.konnect.IdentityGroupArgs;
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 myIdentitygroup = new IdentityGroup("myIdentitygroup", IdentityGroupArgs.builder()
            .description("...my_description...")
            .directoryId("307cd9e3-ea12-451b-8bb2-b6c398132110")
            .labels(Map.of("key", "value"))
            .managedBy(Map.of("key", "value"))
            .metadata("{ \"see\": \"documentation\" }")
            .name("...my_name...")
            .type("group")
            .build());

    }
}

    resources:
  myIdentitygroup:
    type: konnect:IdentityGroup
    name: my_identitygroup
    properties:
      description: '...my_description...'
      directoryId: 307cd9e3-ea12-451b-8bb2-b6c398132110
      labels:
        key: value
      managedBy:
        key: value
      metadata: '{ "see": "documentation" }'
      name: '...my_name...'
      type: group

    Example coming soon!

    Create IdentityGroup Resource

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

    Constructor syntax

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

@overload
def IdentityGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  directory_id: Optional[str] = None,
                  description: Optional[str] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  managed_by: Optional[Mapping[str, str]] = None,
                  metadata: Optional[str] = None,
                  name: Optional[str] = None,
                  type: Optional[str] = None)
    func NewIdentityGroup(ctx *Context, name string, args IdentityGroupArgs, opts ...ResourceOption) (*IdentityGroup, error)
    public IdentityGroup(string name, IdentityGroupArgs args, CustomResourceOptions? opts = null)
    public IdentityGroup(String name, IdentityGroupArgs args)
public IdentityGroup(String name, IdentityGroupArgs args, CustomResourceOptions options)

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


    resource "konnect_identity_group" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IdentityGroupArgs
    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 IdentityGroupArgs
    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 IdentityGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityGroupArgs
    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 identityGroupResource = new Konnect.IdentityGroup("identityGroupResource", new()
{
    DirectoryId = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    ManagedBy = 
    {
        { "string", "string" },
    },
    Metadata = "string",
    Name = "string",
    Type = "string",
});

    example, err := konnect.NewIdentityGroup(ctx, "identityGroupResource", &konnect.IdentityGroupArgs{
	DirectoryId: pulumi.String("string"),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ManagedBy: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Metadata: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Type:     pulumi.String("string"),
})

    resource "konnect_identity_group" "identityGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = "string"
  description  = "string"
  labels = {
    "string" = "string"
  }
  managed_by = {
    "string" = "string"
  }
  metadata = "string"
  name     = "string"
  type     = "string"
}

    var identityGroupResource = new IdentityGroup("identityGroupResource", IdentityGroupArgs.builder()
    .directoryId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .managedBy(Map.of("string", "string"))
    .metadata("string")
    .name("string")
    .type("string")
    .build());

    identity_group_resource = konnect.IdentityGroup("identityGroupResource",
    directory_id="string",
    description="string",
    labels={
        "string": "string",
    },
    managed_by={
        "string": "string",
    },
    metadata="string",
    name="string",
    type="string")

    const identityGroupResource = new konnect.IdentityGroup("identityGroupResource", {
    directoryId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    managedBy: {
        string: "string",
    },
    metadata: "string",
    name: "string",
    type: "string",
});

    type: konnect:IdentityGroup
properties:
    description: string
    directoryId: string
    labels:
        string: string
    managedBy:
        string: string
    metadata: string
    name: string
    type: string

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

    DirectoryId string
    ID of the directory
    Description string
    Optional description providing additional context about the group's purpose.
    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.
    ManagedBy Dictionary<string, string>
    Metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    Name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    Type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    DirectoryId string
    ID of the directory
    Description string
    Optional description providing additional context about the group's purpose.
    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.
    ManagedBy map[string]string
    Metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    Name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    Type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    directory_id string
    ID of the directory
    description string
    Optional description providing additional context about the group's purpose.
    labels map(string)
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    managed_by map(string)
    metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    directoryId String
    ID of the directory
    description String
    Optional description providing additional context about the group's purpose.
    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.
    managedBy Map<String,String>
    metadata String
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name String
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    type String
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    directoryId string
    ID of the directory
    description string
    Optional description providing additional context about the group's purpose.
    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.
    managedBy {[key: string]: string}
    metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    directory_id str
    ID of the directory
    description str
    Optional description providing additional context about the group's purpose.
    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.
    managed_by Mapping[str, str]
    metadata str
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name str
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    type str
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    directoryId String
    ID of the directory
    description String
    Optional description providing additional context about the group's purpose.
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    managedBy Map<String>
    metadata String
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name String
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    type String
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.

    Outputs

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

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    TeamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProvisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    TeamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    provisioned_by string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    team_manager object
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    provisionedBy String
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    provisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    provisioned_by str
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    team_manager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    provisionedBy String
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager Property Map
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing IdentityGroup Resource

    Get an existing IdentityGroup 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?: IdentityGroupState, opts?: CustomResourceOptions): IdentityGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        directory_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        managed_by: Optional[Mapping[str, str]] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        provisioned_by: Optional[str] = None,
        team_manager: Optional[IdentityGroupTeamManagerArgs] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> IdentityGroup
    func GetIdentityGroup(ctx *Context, name string, id IDInput, state *IdentityGroupState, opts ...ResourceOption) (*IdentityGroup, error)
    public static IdentityGroup Get(string name, Input<string> id, IdentityGroupState? state, CustomResourceOptions? opts = null)
    public static IdentityGroup get(String name, Output<String> id, IdentityGroupState state, CustomResourceOptions options)
    resources:  _:    type: konnect:IdentityGroup    get:      id: ${id}
    import {
  to = konnect_identity_group.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:
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    Optional description providing additional context about the group's purpose.
    DirectoryId string
    ID of the directory
    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.
    ManagedBy Dictionary<string, string>
    Metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    Name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    ProvisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    TeamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    Type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    Optional description providing additional context about the group's purpose.
    DirectoryId string
    ID of the directory
    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.
    ManagedBy map[string]string
    Metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    Name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    ProvisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    TeamManager IdentityGroupTeamManagerArgs
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    Type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    Optional description providing additional context about the group's purpose.
    directory_id string
    ID of the directory
    labels map(string)
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    managed_by map(string)
    metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    provisioned_by string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    team_manager object
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    updated_at string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    Optional description providing additional context about the group's purpose.
    directoryId String
    ID of the directory
    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.
    managedBy Map<String,String>
    metadata String
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name String
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    provisionedBy String
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    type String
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    Optional description providing additional context about the group's purpose.
    directoryId string
    ID of the directory
    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.
    managedBy {[key: string]: string}
    metadata string
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name string
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    provisionedBy string
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager IdentityGroupTeamManager
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    type string
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    description str
    Optional description providing additional context about the group's purpose.
    directory_id str
    ID of the directory
    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.
    managed_by Mapping[str, str]
    metadata str
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name str
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    provisioned_by str
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    team_manager IdentityGroupTeamManagerArgs
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    type str
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    Optional description providing additional context about the group's purpose.
    directoryId String
    ID of the directory
    labels Map<String>
    Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
    managedBy Map<String>
    metadata String
    A map of metadata key-value pairs associated with this entity. This metadata is passed to the data plane to enrich the execution context. During authentication, metadata is inherited and overridden in a hierarchical manner: Directory metadata is inherited by Principals, which is then inherited and overridden by Credentials. Parsed as JSON.
    name String
    Human-readable name of the group. Must start and end with a letter or a digit. Letters, digits, and hyphens are allowed in between.
    provisionedBy String
    Identifies the actor that provisioned this principal. Defaults to konnect_user for principals created directly by a user; other values identify a service that provisioned the principal on a user's behalf (for example, developer_portal or trusted_idp). Default: "konnect_user"
    teamManager Property Map
    The manager of a team, set through the team's team_manager custom identity. Always null for plain groups, and for teams without a manager.
    type String
    Type of the group. Immutable after creation. possible known values include one of ["group", "team"]; Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    IdentityGroupTeamManager, IdentityGroupTeamManagerArgs

    DisplayName string
    Display name of the manager.
    Email string
    Value of the manager's email custom identity, or null when the manager has none.
    Id string
    Contains a unique identifier used for this resource.
    DisplayName string
    Display name of the manager.
    Email string
    Value of the manager's email custom identity, or null when the manager has none.
    Id string
    Contains a unique identifier used for this resource.
    display_name string
    Display name of the manager.
    email string
    Value of the manager's email custom identity, or null when the manager has none.
    id string
    Contains a unique identifier used for this resource.
    displayName String
    Display name of the manager.
    email String
    Value of the manager's email custom identity, or null when the manager has none.
    id String
    Contains a unique identifier used for this resource.
    displayName string
    Display name of the manager.
    email string
    Value of the manager's email custom identity, or null when the manager has none.
    id string
    Contains a unique identifier used for this resource.
    display_name str
    Display name of the manager.
    email str
    Value of the manager's email custom identity, or null when the manager has none.
    id str
    Contains a unique identifier used for this resource.
    displayName String
    Display name of the manager.
    email String
    Value of the manager's email custom identity, or null when the manager has none.
    id String
    Contains a unique identifier used for this resource.

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_identity_group.my_konnect_identity_group

    id = jsonencode({

    directory_id = "..."

id           = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/identityGroup:IdentityGroup my_konnect_identity_group '{"directory_id": "...", "id": "..."}'

    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
    Viewing docs for konnect 3.28.0
    published on Friday, Nov 6, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial