konnect.IdentityGroupMembership

konnect 3.28.0, Nov 6 26

Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

Schema (JSON)

kong/terraform-provider-konnect

konnect

Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong

Schema (JSON)

kong/terraform-provider-konnect

Example Usage

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

const myIdentitygroupmembership = new konnect.IdentityGroupMembership("my_identitygroupmembership", {
    directoryId: "8a58fdbf-43c1-44f4-a374-04256712d369",
    groupId: "7f2a67a4-2de2-4271-86de-6be741d5ce51",
    member: {
        id: "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
        type: "principal",
    },
});

import pulumi
import pulumi_konnect as konnect

my_identitygroupmembership = konnect.IdentityGroupMembership("my_identitygroupmembership",
    directory_id="8a58fdbf-43c1-44f4-a374-04256712d369",
    group_id="7f2a67a4-2de2-4271-86de-6be741d5ce51",
    member={
        "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
        "type": "principal",
    })

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.NewIdentityGroupMembership(ctx, "my_identitygroupmembership", &konnect.IdentityGroupMembershipArgs{
			DirectoryId: pulumi.String("8a58fdbf-43c1-44f4-a374-04256712d369"),
			GroupId:     pulumi.String("7f2a67a4-2de2-4271-86de-6be741d5ce51"),
			Member: &konnect.IdentityGroupMembershipMemberArgs{
				Id:   pulumi.String("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"),
				Type: pulumi.String("principal"),
			},
		})
		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 myIdentitygroupmembership = new Konnect.IdentityGroupMembership("my_identitygroupmembership", new()
    {
        DirectoryId = "8a58fdbf-43c1-44f4-a374-04256712d369",
        GroupId = "7f2a67a4-2de2-4271-86de-6be741d5ce51",
        Member = new Konnect.Inputs.IdentityGroupMembershipMemberArgs
        {
            Id = "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
            Type = "principal",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.IdentityGroupMembership;
import com.pulumi.konnect.IdentityGroupMembershipArgs;
import com.pulumi.konnect.inputs.IdentityGroupMembershipMemberArgs;
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 myIdentitygroupmembership = new IdentityGroupMembership("myIdentitygroupmembership", IdentityGroupMembershipArgs.builder()
            .directoryId("8a58fdbf-43c1-44f4-a374-04256712d369")
            .groupId("7f2a67a4-2de2-4271-86de-6be741d5ce51")
            .member(IdentityGroupMembershipMemberArgs.builder()
                .id("5f9fd312-a987-4628-b4c5-bb4f4fddd5f7")
                .type("principal")
                .build())
            .build());

    }
}

resources:
  myIdentitygroupmembership:
    type: konnect:IdentityGroupMembership
    name: my_identitygroupmembership
    properties:
      directoryId: 8a58fdbf-43c1-44f4-a374-04256712d369
      groupId: 7f2a67a4-2de2-4271-86de-6be741d5ce51
      member:
        id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        type: principal

Example coming soon!

Create IdentityGroupMembership Resource

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

Constructor syntax

new IdentityGroupMembership(name: string, args: IdentityGroupMembershipArgs, opts?: CustomResourceOptions);

@overload
def IdentityGroupMembership(resource_name: str,
                            args: IdentityGroupMembershipArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def IdentityGroupMembership(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            directory_id: Optional[str] = None,
                            group_id: Optional[str] = None,
                            member: Optional[IdentityGroupMembershipMemberArgs] = None)

func NewIdentityGroupMembership(ctx *Context, name string, args IdentityGroupMembershipArgs, opts ...ResourceOption) (*IdentityGroupMembership, error)

public IdentityGroupMembership(string name, IdentityGroupMembershipArgs args, CustomResourceOptions? opts = null)

public IdentityGroupMembership(String name, IdentityGroupMembershipArgs args)
public IdentityGroupMembership(String name, IdentityGroupMembershipArgs args, CustomResourceOptions options)

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

resource "konnect_identity_group_membership" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args IdentityGroupMembershipArgs: 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 IdentityGroupMembershipArgs: 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 IdentityGroupMembershipArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IdentityGroupMembershipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IdentityGroupMembershipArgs: 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 identityGroupMembershipResource = new Konnect.IdentityGroupMembership("identityGroupMembershipResource", new()
{
    DirectoryId = "string",
    GroupId = "string",
    Member = new Konnect.Inputs.IdentityGroupMembershipMemberArgs
    {
        Id = "string",
        Type = "string",
        DisplayName = "string",
    },
});

example, err := konnect.NewIdentityGroupMembership(ctx, "identityGroupMembershipResource", &konnect.IdentityGroupMembershipArgs{
	DirectoryId: pulumi.String("string"),
	GroupId:     pulumi.String("string"),
	Member: &konnect.IdentityGroupMembershipMemberArgs{
		Id:          pulumi.String("string"),
		Type:        pulumi.String("string"),
		DisplayName: pulumi.String("string"),
	},
})

resource "konnect_identity_group_membership" "identityGroupMembershipResource" {
  lifecycle {
    create_before_destroy = true
  }
  directory_id = "string"
  group_id     = "string"
  member = {
    id           = "string"
    type         = "string"
    display_name = "string"
  }
}

var identityGroupMembershipResource = new IdentityGroupMembership("identityGroupMembershipResource", IdentityGroupMembershipArgs.builder()
    .directoryId("string")
    .groupId("string")
    .member(IdentityGroupMembershipMemberArgs.builder()
        .id("string")
        .type("string")
        .displayName("string")
        .build())
    .build());

identity_group_membership_resource = konnect.IdentityGroupMembership("identityGroupMembershipResource",
    directory_id="string",
    group_id="string",
    member={
        "id": "string",
        "type": "string",
        "display_name": "string",
    })

const identityGroupMembershipResource = new konnect.IdentityGroupMembership("identityGroupMembershipResource", {
    directoryId: "string",
    groupId: "string",
    member: {
        id: "string",
        type: "string",
        displayName: "string",
    },
});

type: konnect:IdentityGroupMembership
properties:
    directoryId: string
    groupId: string
    member:
        displayName: string
        id: string
        type: string

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

DirectoryId string: ID of the directory. Requires replacement if changed.
GroupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
Member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

DirectoryId string: ID of the directory. Requires replacement if changed.
GroupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
Member IdentityGroupMembershipMemberArgs: Identifies a single member (principal or group) of a group. Requires replacement if changed.

directory_id string: ID of the directory. Requires replacement if changed.
group_id string: Unique identifier of the group (UUID format). Requires replacement if changed.
member object: Identifies a single member (principal or group) of a group. Requires replacement if changed.

directoryId String: ID of the directory. Requires replacement if changed.
groupId String: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

directoryId string: ID of the directory. Requires replacement if changed.
groupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

directory_id str: ID of the directory. Requires replacement if changed.
group_id str: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMemberArgs: Identifies a single member (principal or group) of a group. Requires replacement if changed.

directoryId String: ID of the directory. Requires replacement if changed.
groupId String: Unique identifier of the group (UUID format). Requires replacement if changed.
member Property Map: Identifies a single member (principal or group) of a group. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityGroupMembership 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.

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
Id string: The provider-assigned unique ID for this managed resource.

created_at string: An ISO-8601 timestamp representation of entity creation date.
id string: The provider-assigned unique ID for this managed resource.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
id String: The provider-assigned unique ID for this managed resource.

createdAt string: An ISO-8601 timestamp representation of entity creation date.
id string: The provider-assigned unique ID for this managed resource.

created_at str: An ISO-8601 timestamp representation of entity creation date.
id str: The provider-assigned unique ID for this managed resource.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing IdentityGroupMembership Resource

Get an existing IdentityGroupMembership 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?: IdentityGroupMembershipState, opts?: CustomResourceOptions): IdentityGroupMembership

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        directory_id: Optional[str] = None,
        group_id: Optional[str] = None,
        member: Optional[IdentityGroupMembershipMemberArgs] = None) -> IdentityGroupMembership

func GetIdentityGroupMembership(ctx *Context, name string, id IDInput, state *IdentityGroupMembershipState, opts ...ResourceOption) (*IdentityGroupMembership, error)

public static IdentityGroupMembership Get(string name, Input<string> id, IdentityGroupMembershipState? state, CustomResourceOptions? opts = null)

public static IdentityGroupMembership get(String name, Output<String> id, IdentityGroupMembershipState state, CustomResourceOptions options)

resources:  _:    type: konnect:IdentityGroupMembership    get:      id: ${id}

import {
  to = konnect_identity_group_membership.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.
DirectoryId string: ID of the directory. Requires replacement if changed.
GroupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
Member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

CreatedAt string: An ISO-8601 timestamp representation of entity creation date.
DirectoryId string: ID of the directory. Requires replacement if changed.
GroupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
Member IdentityGroupMembershipMemberArgs: Identifies a single member (principal or group) of a group. Requires replacement if changed.

created_at string: An ISO-8601 timestamp representation of entity creation date.
directory_id string: ID of the directory. Requires replacement if changed.
group_id string: Unique identifier of the group (UUID format). Requires replacement if changed.
member object: Identifies a single member (principal or group) of a group. Requires replacement if changed.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
directoryId String: ID of the directory. Requires replacement if changed.
groupId String: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

createdAt string: An ISO-8601 timestamp representation of entity creation date.
directoryId string: ID of the directory. Requires replacement if changed.
groupId string: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMember: Identifies a single member (principal or group) of a group. Requires replacement if changed.

created_at str: An ISO-8601 timestamp representation of entity creation date.
directory_id str: ID of the directory. Requires replacement if changed.
group_id str: Unique identifier of the group (UUID format). Requires replacement if changed.
member IdentityGroupMembershipMemberArgs: Identifies a single member (principal or group) of a group. Requires replacement if changed.

createdAt String: An ISO-8601 timestamp representation of entity creation date.
directoryId String: ID of the directory. Requires replacement if changed.
groupId String: Unique identifier of the group (UUID format). Requires replacement if changed.
member Property Map: Identifies a single member (principal or group) of a group. Requires replacement if changed.

Supporting Types

IdentityGroupMembershipMember, IdentityGroupMembershipMemberArgs

Id string: Contains a unique identifier used for this resource. Requires replacement if changed.
Type string: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
DisplayName string: Human-readable name of the member. For a principal, its display_name; for a group, its name.

Id string: Contains a unique identifier used for this resource. Requires replacement if changed.
Type string: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
DisplayName string: Human-readable name of the member. For a principal, its display_name; for a group, its name.

id string: Contains a unique identifier used for this resource. Requires replacement if changed.
type string: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
display_name string: Human-readable name of the member. For a principal, its display_name; for a group, its name.

id String: Contains a unique identifier used for this resource. Requires replacement if changed.
type String: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
displayName String: Human-readable name of the member. For a principal, its display_name; for a group, its name.

id string: Contains a unique identifier used for this resource. Requires replacement if changed.
type string: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
displayName string: Human-readable name of the member. For a principal, its display_name; for a group, its name.

id str: Contains a unique identifier used for this resource. Requires replacement if changed.
type str: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
display_name str: Human-readable name of the member. For a principal, its display_name; for a group, its name.

id String: Contains a unique identifier used for this resource. Requires replacement if changed.
type String: Classifies the kind of member referenced by a group membership entry. possible known values include one of ["principal", "group"]; Requires replacement if changed.
displayName String: Human-readable name of the member. For a principal, its display_name; for a group, its name.

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_membership.my_konnect_identity_group_membership

id = jsonencode({

directory_id = "..."

group_id     = "..."

id           = "..."

})

}

The pulumi import command can be used, for example:

$ pulumi import konnect:index/identityGroupMembership:IdentityGroupMembership my_konnect_identity_group_membership '{"directory_id": "...", "group_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

konnect.IdentityGroupMembership

On this page

On this page

Example Usage

Create IdentityGroupMembership Resource

Constructor syntax

Parameters

Constructor example

IdentityGroupMembership Resource Properties

Inputs

Outputs

Look up Existing IdentityGroupMembership Resource

Supporting Types

IdentityGroupMembershipMember, IdentityGroupMembershipMemberArgs

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

konnect.IdentityGroupMembership

On this page

On this page

Example Usage

Create IdentityGroupMembership Resource

Constructor syntax

Parameters

Constructor example

IdentityGroupMembership Resource Properties

Inputs

Outputs

Look up Existing IdentityGroupMembership Resource

Supporting Types

IdentityGroupMembershipMember, IdentityGroupMembershipMemberArgs

Import

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.