Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. identity
  5. GroupMemberEntityIds
HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
pulumi/pulumi-vault

vault.identity.GroupMemberEntityIds

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
pulumi/pulumi-vault

    Manages member entities for an Identity Group for Vault. The Identity secrets engine is the identity management solution for Vault.

    Example Usage

    Exclusive Member Entities

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

const internal = new vault.identity.Group("internal", {
    type: "internal",
    externalMemberEntityIds: true,
    metadata: {
        version: "2",
    },
});
const user = new vault.identity.Entity("user", {});
const members = new vault.identity.GroupMemberEntityIds("members", {
    exclusive: true,
    memberEntityIds: [user.id],
    groupId: internal.id,
});

    import pulumi
import pulumi_vault as vault

internal = vault.identity.Group("internal",
    type="internal",
    external_member_entity_ids=True,
    metadata={
        "version": "2",
    })
user = vault.identity.Entity("user")
members = vault.identity.GroupMemberEntityIds("members",
    exclusive=True,
    member_entity_ids=[user.id],
    group_id=internal.id)

    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 {
		internal, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
			Type:                    pulumi.String("internal"),
			ExternalMemberEntityIds: pulumi.Bool(true),
			Metadata: pulumi.StringMap{
				"version": pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		user, err := identity.NewEntity(ctx, "user", nil)
		if err != nil {
			return err
		}
		_, err = identity.NewGroupMemberEntityIds(ctx, "members", &identity.GroupMemberEntityIdsArgs{
			Exclusive: pulumi.Bool(true),
			MemberEntityIds: pulumi.StringArray{
				user.ID(),
			},
			GroupId: internal.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Type = "internal",
        ExternalMemberEntityIds = true,
        Metadata = 
        {
            { "version", "2" },
        },
    });

    var user = new Vault.Identity.Entity("user");

    var members = new Vault.Identity.GroupMemberEntityIds("members", new()
    {
        Exclusive = true,
        MemberEntityIds = new[]
        {
            user.Id,
        },
        GroupId = @internal.Id,
    });

});

    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 com.pulumi.vault.identity.Entity;
import com.pulumi.vault.identity.GroupMemberEntityIds;
import com.pulumi.vault.identity.GroupMemberEntityIdsArgs;
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()        
            .type("internal")
            .externalMemberEntityIds(true)
            .metadata(Map.of("version", "2"))
            .build());

        var user = new Entity("user");

        var members = new GroupMemberEntityIds("members", GroupMemberEntityIdsArgs.builder()        
            .exclusive(true)
            .memberEntityIds(user.id())
            .groupId(internal.id())
            .build());

    }
}

    resources:
  internal:
    type: vault:identity:Group
    properties:
      type: internal
      externalMemberEntityIds: true
      metadata:
        version: '2'
  user:
    type: vault:identity:Entity
  members:
    type: vault:identity:GroupMemberEntityIds
    properties:
      exclusive: true
      memberEntityIds:
        - ${user.id}
      groupId: ${internal.id}

    Non-exclusive Member Entities

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

const internal = new vault.identity.Group("internal", {
    type: "internal",
    externalMemberEntityIds: true,
    metadata: {
        version: "2",
    },
});
const testUser = new vault.identity.Entity("testUser", {});
const secondTestUser = new vault.identity.Entity("secondTestUser", {});
const devUser = new vault.identity.Entity("devUser", {});
const test = new vault.identity.GroupMemberEntityIds("test", {
    memberEntityIds: [
        testUser.id,
        secondTestUser.id,
    ],
    exclusive: false,
    groupId: internal.id,
});
const others = new vault.identity.GroupMemberEntityIds("others", {
    memberEntityIds: [devUser.id],
    exclusive: false,
    groupId: internal.id,
});

    import pulumi
import pulumi_vault as vault

internal = vault.identity.Group("internal",
    type="internal",
    external_member_entity_ids=True,
    metadata={
        "version": "2",
    })
test_user = vault.identity.Entity("testUser")
second_test_user = vault.identity.Entity("secondTestUser")
dev_user = vault.identity.Entity("devUser")
test = vault.identity.GroupMemberEntityIds("test",
    member_entity_ids=[
        test_user.id,
        second_test_user.id,
    ],
    exclusive=False,
    group_id=internal.id)
others = vault.identity.GroupMemberEntityIds("others",
    member_entity_ids=[dev_user.id],
    exclusive=False,
    group_id=internal.id)

    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 {
		internal, err := identity.NewGroup(ctx, "internal", &identity.GroupArgs{
			Type:                    pulumi.String("internal"),
			ExternalMemberEntityIds: pulumi.Bool(true),
			Metadata: pulumi.StringMap{
				"version": pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		testUser, err := identity.NewEntity(ctx, "testUser", nil)
		if err != nil {
			return err
		}
		secondTestUser, err := identity.NewEntity(ctx, "secondTestUser", nil)
		if err != nil {
			return err
		}
		devUser, err := identity.NewEntity(ctx, "devUser", nil)
		if err != nil {
			return err
		}
		_, err = identity.NewGroupMemberEntityIds(ctx, "test", &identity.GroupMemberEntityIdsArgs{
			MemberEntityIds: pulumi.StringArray{
				testUser.ID(),
				secondTestUser.ID(),
			},
			Exclusive: pulumi.Bool(false),
			GroupId:   internal.ID(),
		})
		if err != nil {
			return err
		}
		_, err = identity.NewGroupMemberEntityIds(ctx, "others", &identity.GroupMemberEntityIdsArgs{
			MemberEntityIds: pulumi.StringArray{
				devUser.ID(),
			},
			Exclusive: pulumi.Bool(false),
			GroupId:   internal.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Type = "internal",
        ExternalMemberEntityIds = true,
        Metadata = 
        {
            { "version", "2" },
        },
    });

    var testUser = new Vault.Identity.Entity("testUser");

    var secondTestUser = new Vault.Identity.Entity("secondTestUser");

    var devUser = new Vault.Identity.Entity("devUser");

    var test = new Vault.Identity.GroupMemberEntityIds("test", new()
    {
        MemberEntityIds = new[]
        {
            testUser.Id,
            secondTestUser.Id,
        },
        Exclusive = false,
        GroupId = @internal.Id,
    });

    var others = new Vault.Identity.GroupMemberEntityIds("others", new()
    {
        MemberEntityIds = new[]
        {
            devUser.Id,
        },
        Exclusive = false,
        GroupId = @internal.Id,
    });

});

    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 com.pulumi.vault.identity.Entity;
import com.pulumi.vault.identity.GroupMemberEntityIds;
import com.pulumi.vault.identity.GroupMemberEntityIdsArgs;
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()        
            .type("internal")
            .externalMemberEntityIds(true)
            .metadata(Map.of("version", "2"))
            .build());

        var testUser = new Entity("testUser");

        var secondTestUser = new Entity("secondTestUser");

        var devUser = new Entity("devUser");

        var test = new GroupMemberEntityIds("test", GroupMemberEntityIdsArgs.builder()        
            .memberEntityIds(            
                testUser.id(),
                secondTestUser.id())
            .exclusive(false)
            .groupId(internal.id())
            .build());

        var others = new GroupMemberEntityIds("others", GroupMemberEntityIdsArgs.builder()        
            .memberEntityIds(devUser.id())
            .exclusive(false)
            .groupId(internal.id())
            .build());

    }
}

    resources:
  internal:
    type: vault:identity:Group
    properties:
      type: internal
      externalMemberEntityIds: true
      metadata:
        version: '2'
  testUser:
    type: vault:identity:Entity
  secondTestUser:
    type: vault:identity:Entity
  devUser:
    type: vault:identity:Entity
  test:
    type: vault:identity:GroupMemberEntityIds
    properties:
      memberEntityIds:
        - ${testUser.id}
        - ${secondTestUser.id}
      exclusive: false
      groupId: ${internal.id}
  others:
    type: vault:identity:GroupMemberEntityIds
    properties:
      memberEntityIds:
        - ${devUser.id}
      exclusive: false
      groupId: ${internal.id}

    Create GroupMemberEntityIds Resource

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

    Constructor syntax

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

@overload
def GroupMemberEntityIds(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         group_id: Optional[str] = None,
                         exclusive: Optional[bool] = None,
                         member_entity_ids: Optional[Sequence[str]] = None,
                         namespace: Optional[str] = None)
    func NewGroupMemberEntityIds(ctx *Context, name string, args GroupMemberEntityIdsArgs, opts ...ResourceOption) (*GroupMemberEntityIds, error)
    public GroupMemberEntityIds(string name, GroupMemberEntityIdsArgs args, CustomResourceOptions? opts = null)
    public GroupMemberEntityIds(String name, GroupMemberEntityIdsArgs args)
public GroupMemberEntityIds(String name, GroupMemberEntityIdsArgs args, CustomResourceOptions options)

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

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var groupMemberEntityIdsResource = new Vault.Identity.GroupMemberEntityIds("groupMemberEntityIdsResource", new()
{
    GroupId = "string",
    Exclusive = false,
    MemberEntityIds = new[]
    {
        "string",
    },
    Namespace = "string",
});

    example, err := identity.NewGroupMemberEntityIds(ctx, "groupMemberEntityIdsResource", &identity.GroupMemberEntityIdsArgs{
	GroupId:   pulumi.String("string"),
	Exclusive: pulumi.Bool(false),
	MemberEntityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Namespace: pulumi.String("string"),
})

    var groupMemberEntityIdsResource = new GroupMemberEntityIds("groupMemberEntityIdsResource", GroupMemberEntityIdsArgs.builder()        
    .groupId("string")
    .exclusive(false)
    .memberEntityIds("string")
    .namespace("string")
    .build());

    group_member_entity_ids_resource = vault.identity.GroupMemberEntityIds("groupMemberEntityIdsResource",
    group_id="string",
    exclusive=False,
    member_entity_ids=["string"],
    namespace="string")

    const groupMemberEntityIdsResource = new vault.identity.GroupMemberEntityIds("groupMemberEntityIdsResource", {
    groupId: "string",
    exclusive: false,
    memberEntityIds: ["string"],
    namespace: "string",
});

    type: vault:identity:GroupMemberEntityIds
properties:
    exclusive: false
    groupId: string
    memberEntityIds:
        - string
    namespace: string

    GroupMemberEntityIds Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The GroupMemberEntityIds resource accepts the following input properties:

    GroupId string
    Group ID to assign member entities to.
    Exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    MemberEntityIds List<string>
    List of member entities that belong to the group
    Namespace 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.
    GroupId string
    Group ID to assign member entities to.
    Exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    MemberEntityIds []string
    List of member entities that belong to the group
    Namespace 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.
    groupId String
    Group ID to assign member entities to.
    exclusive Boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    memberEntityIds List<String>
    List of member entities that belong to the group
    namespace 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.
    groupId string
    Group ID to assign member entities to.
    exclusive boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    memberEntityIds string[]
    List of member entities that belong to the group
    namespace 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.
    group_id str
    Group ID to assign member entities to.
    exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    member_entity_ids Sequence[str]
    List of member entities that belong to the group
    namespace 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.
    groupId String
    Group ID to assign member entities to.
    exclusive Boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    memberEntityIds List<String>
    List of member entities that belong to the group
    namespace 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.

    Outputs

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

    Get an existing GroupMemberEntityIds 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?: GroupMemberEntityIdsState, opts?: CustomResourceOptions): GroupMemberEntityIds
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        exclusive: Optional[bool] = None,
        group_id: Optional[str] = None,
        member_entity_ids: Optional[Sequence[str]] = None,
        namespace: Optional[str] = None) -> GroupMemberEntityIds
    func GetGroupMemberEntityIds(ctx *Context, name string, id IDInput, state *GroupMemberEntityIdsState, opts ...ResourceOption) (*GroupMemberEntityIds, error)
    public static GroupMemberEntityIds Get(string name, Input<string> id, GroupMemberEntityIdsState? state, CustomResourceOptions? opts = null)
    public static GroupMemberEntityIds get(String name, Output<String> id, GroupMemberEntityIdsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    GroupId string
    Group ID to assign member entities to.
    MemberEntityIds List<string>
    List of member entities that belong to the group
    Namespace 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.
    Exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    GroupId string
    Group ID to assign member entities to.
    MemberEntityIds []string
    List of member entities that belong to the group
    Namespace 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.
    exclusive Boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    groupId String
    Group ID to assign member entities to.
    memberEntityIds List<String>
    List of member entities that belong to the group
    namespace 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.
    exclusive boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    groupId string
    Group ID to assign member entities to.
    memberEntityIds string[]
    List of member entities that belong to the group
    namespace 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.
    exclusive bool

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    group_id str
    Group ID to assign member entities to.
    member_entity_ids Sequence[str]
    List of member entities that belong to the group
    namespace 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.
    exclusive Boolean

    Defaults to true.

    If true, this resource will take exclusive control of the member entities that belong to the group and will set it equal to what is specified in the resource.

    If set to false, this resource will simply ensure that the member entities specified in the resource are present in the group. When destroying the resource, the resource will ensure that the member entities specified in the resource are removed.

    groupId String
    Group ID to assign member entities to.
    memberEntityIds List<String>
    List of member entities that belong to the group
    namespace 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.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
    pulumi/pulumi-vault