Class GroupAlias

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

Group aliases allows entity membership in external groups to be managed semi-automatically. External group serves as a mapping to a group that is outside of the identity store. External groups can have one (and only one) alias. This alias should map to a notion of group that is outside of the identity store. For example, groups in LDAP, and teams in GitHub. A username in LDAP, belonging to a group in LDAP, can get its entity ID added as a member of a group in Vault automatically during logins and token renewals. This works only if the group in Vault is an external group and has an alias that maps to the group in LDAP. If the user is removed from the group in LDAP, that change gets reflected in Vault only upon the subsequent login or renewal operation.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var @group = new Vault.Identity.Group("group", new Vault.Identity.GroupArgs
    {
        Policies = 
        {
            "test",
        },
        Type = "external",
    });
    var github = new Vault.AuthBackend("github", new Vault.AuthBackendArgs
    {
        Path = "github",
        Type = "github",
    });
    var group_alias = new Vault.Identity.GroupAlias("group-alias", new Vault.Identity.GroupAliasArgs
    {
        CanonicalId = @group.Id,
        MountAccessor = github.Accessor,
        Name = "Github_Team_Slug",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

GroupAlias

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 GroupAlias : CustomResource

Constructors

GroupAlias(String, GroupAliasArgs, CustomResourceOptions)

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

Declaration

public GroupAlias(string name, GroupAliasArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

CanonicalId

ID of the group to which this is an alias.

Declaration

public Output<string> CanonicalId { get; }

Property Value

Type	Description
Output<System.String>

MountAccessor

Mount accessor of the authentication backend to which this alias belongs to.

Declaration

public Output<string> MountAccessor { get; }

Property Value

Type	Description
Output<System.String>

Name

Name of the group alias to create.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

public static GroupAlias Get(string name, Input<string> id, GroupAliasState 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.
GroupAliasState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
GroupAlias