Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. identity
  5. Group
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

vault.identity.Group

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

Creates an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

A group can contain multiple entities as its members. A group can also have subgroups. Policies set on the group is granted to all members of the group. During request time, when the token’s entity ID is being evaluated for the policies that it has access to; along with the policies on the entity itself, policies that are inherited due to group memberships are also granted.

Example Usage

Internal Group

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

const internal = new vault.identity.Group("internal", {
    name: "internal",
    type: "internal",
    policies: [
        "dev",
        "test",
    ],
    metadata: {
        version: "2",
    },
});
Copy
import pulumi
import pulumi_vault as vault

internal = vault.identity.Group("internal",
    name="internal",
    type="internal",
    policies=[
        "dev",
        "test",
    ],
    metadata={
        "version": "2",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
			Name: pulumi.String("internal"),
			Type: pulumi.String("internal"),
			Policies: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("test"),
			},
			Metadata: pulumi.StringMap{
				"version": pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var @internal = new Vault.Identity.Group("internal", new()
    {
        Name = "internal",
        Type = "internal",
        Policies = new[]
        {
            "dev",
            "test",
        },
        Metadata = 
        {
            { "version", "2" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.Group;
import com.pulumi.vault.identity.GroupArgs;
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 internal = new Group("internal", GroupArgs.builder()
            .name("internal")
            .type("internal")
            .policies(            
                "dev",
                "test")
            .metadata(Map.of("version", "2"))
            .build());

    }
}
Copy
resources:
  internal:
    type: vault:identity:Group
    properties:
      name: internal
      type: internal
      policies:
        - dev
        - test
      metadata:
        version: '2'
Copy

External Group

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

const group = new vault.identity.Group("group", {
    name: "external",
    type: "external",
    policies: ["test"],
    metadata: {
        version: "1",
    },
});
Copy
import pulumi
import pulumi_vault as vault

group = vault.identity.Group("group",
    name="external",
    type="external",
    policies=["test"],
    metadata={
        "version": "1",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.NewGroup(ctx, "group", &identity.GroupArgs{
			Name: pulumi.String("external"),
			Type: pulumi.String("external"),
			Policies: pulumi.StringArray{
				pulumi.String("test"),
			},
			Metadata: pulumi.StringMap{
				"version": pulumi.String("1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var @group = new Vault.Identity.Group("group", new()
    {
        Name = "external",
        Type = "external",
        Policies = new[]
        {
            "test",
        },
        Metadata = 
        {
            { "version", "1" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.Group;
import com.pulumi.vault.identity.GroupArgs;
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 group = new Group("group", GroupArgs.builder()
            .name("external")
            .type("external")
            .policies("test")
            .metadata(Map.of("version", "1"))
            .build());

    }
}
Copy
resources:
  group:
    type: vault:identity:Group
    properties:
      name: external
      type: external
      policies:
        - test
      metadata:
        version: '1'
Copy

Caveats

It’s important to note that Vault identity groups names are case-insensitive. For example the following resources would be equivalent. Applying this configuration would result in the provider failing to create one of the identity groups, since the resources share the same name.

This sort of pattern should be avoided:

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

const internal = new vault.identity.Group("internal", {
    name: "internal",
    type: "internal",
    policies: [
        "dev",
        "test",
    ],
    metadata: {
        version: "2",
    },
});
const internalGroup = new vault.identity.Group("Internal", {
    name: "Internal",
    type: "internal",
    policies: [
        "dev",
        "test",
    ],
    metadata: {
        version: "2",
    },
});
Copy
import pulumi
import pulumi_vault as vault

internal = vault.identity.Group("internal",
    name="internal",
    type="internal",
    policies=[
        "dev",
        "test",
    ],
    metadata={
        "version": "2",
    })
internal_group = vault.identity.Group("Internal",
    name="Internal",
    type="internal",
    policies=[
        "dev",
        "test",
    ],
    metadata={
        "version": "2",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
			Name: pulumi.String("internal"),
			Type: pulumi.String("internal"),
			Policies: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("test"),
			},
			Metadata: pulumi.StringMap{
				"version": pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = identity.NewGroup(ctx, "Internal", &identity.GroupArgs{
			Name: pulumi.String("Internal"),
			Type: pulumi.String("internal"),
			Policies: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("test"),
			},
			Metadata: pulumi.StringMap{
				"version": pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var @internal = new Vault.Identity.Group("internal", new()
    {
        Name = "internal",
        Type = "internal",
        Policies = new[]
        {
            "dev",
            "test",
        },
        Metadata = 
        {
            { "version", "2" },
        },
    });

    var internalGroup = new Vault.Identity.Group("Internal", new()
    {
        Name = "Internal",
        Type = "internal",
        Policies = new[]
        {
            "dev",
            "test",
        },
        Metadata = 
        {
            { "version", "2" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.Group;
import com.pulumi.vault.identity.GroupArgs;
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 internal = new Group("internal", GroupArgs.builder()
            .name("internal")
            .type("internal")
            .policies(            
                "dev",
                "test")
            .metadata(Map.of("version", "2"))
            .build());

        var internalGroup = new Group("internalGroup", GroupArgs.builder()
            .name("Internal")
            .type("internal")
            .policies(            
                "dev",
                "test")
            .metadata(Map.of("version", "2"))
            .build());

    }
}
Copy
resources:
  internal:
    type: vault:identity:Group
    properties:
      name: internal
      type: internal
      policies:
        - dev
        - test
      metadata:
        version: '2'
  internalGroup:
    type: vault:identity:Group
    name: Internal
    properties:
      name: Internal
      type: internal
      policies:
        - dev
        - test
      metadata:
        version: '2'
Copy

Create Group Resource

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

Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          external_member_entity_ids: Optional[bool] = None,
          external_member_group_ids: Optional[bool] = None,
          external_policies: Optional[bool] = None,
          member_entity_ids: Optional[Sequence[str]] = None,
          member_group_ids: Optional[Sequence[str]] = None,
          metadata: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None,
          namespace: Optional[str] = None,
          policies: Optional[Sequence[str]] = None,
          type: Optional[str] = None)
func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: vault:identity:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
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 groupResource = new Vault.Identity.Group("groupResource", new()
{
    ExternalMemberEntityIds = false,
    ExternalMemberGroupIds = false,
    ExternalPolicies = false,
    MemberEntityIds = new[]
    {
        "string",
    },
    MemberGroupIds = new[]
    {
        "string",
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Namespace = "string",
    Policies = new[]
    {
        "string",
    },
    Type = "string",
});
Copy
example, err := identity.NewGroup(ctx, "groupResource", &identity.GroupArgs{
	ExternalMemberEntityIds: pulumi.Bool(false),
	ExternalMemberGroupIds:  pulumi.Bool(false),
	ExternalPolicies:        pulumi.Bool(false),
	MemberEntityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	MemberGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	Namespace: pulumi.String("string"),
	Policies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .externalMemberEntityIds(false)
    .externalMemberGroupIds(false)
    .externalPolicies(false)
    .memberEntityIds("string")
    .memberGroupIds("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .namespace("string")
    .policies("string")
    .type("string")
    .build());
Copy
group_resource = vault.identity.Group("groupResource",
    external_member_entity_ids=False,
    external_member_group_ids=False,
    external_policies=False,
    member_entity_ids=["string"],
    member_group_ids=["string"],
    metadata={
        "string": "string",
    },
    name="string",
    namespace="string",
    policies=["string"],
    type="string")
Copy
const groupResource = new vault.identity.Group("groupResource", {
    externalMemberEntityIds: false,
    externalMemberGroupIds: false,
    externalPolicies: false,
    memberEntityIds: ["string"],
    memberGroupIds: ["string"],
    metadata: {
        string: "string",
    },
    name: "string",
    namespace: "string",
    policies: ["string"],
    type: "string",
});
Copy
type: vault:identity:Group
properties:
    externalMemberEntityIds: false
    externalMemberGroupIds: false
    externalPolicies: false
    memberEntityIds:
        - string
    memberGroupIds:
        - string
    metadata:
        string: string
    name: string
    namespace: string
    policies:
        - string
    type: string
Copy

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

ExternalMemberEntityIds bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
ExternalMemberGroupIds bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
ExternalPolicies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
MemberEntityIds List<string>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
MemberGroupIds List<string>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
Metadata Dictionary<string, string>
A Map of additional metadata to associate with the group.
Name string
Name of the identity group to create.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
Policies List<string>
A list of policies to apply to the group.
Type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
ExternalMemberEntityIds bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
ExternalMemberGroupIds bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
ExternalPolicies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
MemberEntityIds []string
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
MemberGroupIds []string
A list of Group IDs to be assigned as group members. Not allowed on external groups.
Metadata map[string]string
A Map of additional metadata to associate with the group.
Name string
Name of the identity group to create.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
Policies []string
A list of policies to apply to the group.
Type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds Boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds Boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies Boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds List<String>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds List<String>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Map<String,String>
A Map of additional metadata to associate with the group.
name String
Name of the identity group to create.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies List<String>
A list of policies to apply to the group.
type Changes to this property will trigger replacement. String
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds string[]
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds string[]
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata {[key: string]: string}
A Map of additional metadata to associate with the group.
name string
Name of the identity group to create.
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies string[]
A list of policies to apply to the group.
type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
external_member_entity_ids bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
external_member_group_ids bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
external_policies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
member_entity_ids Sequence[str]
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
member_group_ids Sequence[str]
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Mapping[str, str]
A Map of additional metadata to associate with the group.
name str
Name of the identity group to create.
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies Sequence[str]
A list of policies to apply to the group.
type Changes to this property will trigger replacement. str
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds Boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds Boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies Boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds List<String>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds List<String>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Map<String>
A Map of additional metadata to associate with the group.
name String
Name of the identity group to create.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies List<String>
A list of policies to apply to the group.
type Changes to this property will trigger replacement. String
Type of the group, internal or external. Defaults to internal.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Group Resource

Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_member_entity_ids: Optional[bool] = None,
        external_member_group_ids: Optional[bool] = None,
        external_policies: Optional[bool] = None,
        member_entity_ids: Optional[Sequence[str]] = None,
        member_group_ids: Optional[Sequence[str]] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        policies: Optional[Sequence[str]] = None,
        type: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: vault:identity:Group    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ExternalMemberEntityIds bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
ExternalMemberGroupIds bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
ExternalPolicies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
MemberEntityIds List<string>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
MemberGroupIds List<string>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
Metadata Dictionary<string, string>
A Map of additional metadata to associate with the group.
Name string
Name of the identity group to create.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
Policies List<string>
A list of policies to apply to the group.
Type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
ExternalMemberEntityIds bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
ExternalMemberGroupIds bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
ExternalPolicies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
MemberEntityIds []string
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
MemberGroupIds []string
A list of Group IDs to be assigned as group members. Not allowed on external groups.
Metadata map[string]string
A Map of additional metadata to associate with the group.
Name string
Name of the identity group to create.
Namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
Policies []string
A list of policies to apply to the group.
Type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds Boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds Boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies Boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds List<String>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds List<String>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Map<String,String>
A Map of additional metadata to associate with the group.
name String
Name of the identity group to create.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies List<String>
A list of policies to apply to the group.
type Changes to this property will trigger replacement. String
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds string[]
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds string[]
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata {[key: string]: string}
A Map of additional metadata to associate with the group.
name string
Name of the identity group to create.
namespace Changes to this property will trigger replacement. string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies string[]
A list of policies to apply to the group.
type Changes to this property will trigger replacement. string
Type of the group, internal or external. Defaults to internal.
external_member_entity_ids bool
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
external_member_group_ids bool
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
external_policies bool
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
member_entity_ids Sequence[str]
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
member_group_ids Sequence[str]
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Mapping[str, str]
A Map of additional metadata to associate with the group.
name str
Name of the identity group to create.
namespace Changes to this property will trigger replacement. str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies Sequence[str]
A list of policies to apply to the group.
type Changes to this property will trigger replacement. str
Type of the group, internal or external. Defaults to internal.
externalMemberEntityIds Boolean
false by default. If set to true, this resource will ignore any Entity IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberEntityIds to manage Entity IDs for this group in a decoupled manner.
externalMemberGroupIds Boolean
false by default. If set to true, this resource will ignore any Group IDs returned from Vault or specified in the resource. You can use vault.identity.GroupMemberGroupIds to manage Group IDs for this group in a decoupled manner.
externalPolicies Boolean
false by default. If set to true, this resource will ignore any policies returned from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.
memberEntityIds List<String>
A list of Entity IDs to be assigned as group members. Not allowed on external groups.
memberGroupIds List<String>
A list of Group IDs to be assigned as group members. Not allowed on external groups.
metadata Map<String>
A Map of additional metadata to associate with the group.
name String
Name of the identity group to create.
namespace Changes to this property will trigger replacement. String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
policies List<String>
A list of policies to apply to the group.
type Changes to this property will trigger replacement. String
Type of the group, internal or external. Defaults to internal.

Import

Identity group can be imported using the id, e.g.

$ pulumi import vault:identity/group:Group test 'fcbf1efb-2b69-4209-bed8-811e3475dad3'
Copy

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

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault