Class Group

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

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var @internal = new Vault.Identity.Group("internal", new Vault.Identity.GroupArgs
    {
        Metadata = 
        {
            { "version", "2" },
        },
        Policies = 
        {
            "dev",
            "test",
        },
        Type = "internal",
    });
}

}

External Group

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var @group = new Vault.Identity.Group("group", new Vault.Identity.GroupArgs
    {
        Metadata = 
        {
            { "version", "1" },
        },
        Policies = 
        {
            "test",
        },
        Type = "external",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Group

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Vault.Identity

Assembly: Pulumi.Vault.dll

Syntax

public class Group : CustomResource

Constructors

Group(String, GroupArgs, CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

Declaration

public Group(string name, GroupArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GroupArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ExternalPolicies

false by default. If set to true, this resource will ignore any policies return from Vault or specified in the resource. You can use vault.identity.GroupPolicies to manage policies for this group in a decoupled manner.

Declaration

public Output<bool?> ExternalPolicies { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

MemberEntityIds

A list of Entity IDs to be assigned as group members. Not allowed on external groups.

Declaration

public Output<ImmutableArray<string>> MemberEntityIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

MemberGroupIds

A list of Group IDs to be assigned as group members. Not allowed on external groups.

Declaration

public Output<ImmutableArray<string>> MemberGroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Metadata

A Map of additional metadata to associate with the group.

Declaration

public Output<ImmutableDictionary<string, string>> Metadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Name

Name of the identity group to create.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Policies

A list of policies to apply to the group.

Declaration

public Output<ImmutableArray<string>> Policies { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Type

Type of the group, internal or external. Defaults to internal.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, GroupState, CustomResourceOptions)

Get an existing Group resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Group Get(string name, Input<string> id, GroupState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GroupState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Group