1. Docs
2. Reference
3. API
4. Vault
5. identity
6. GroupAlias

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.

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",
        });
    }

}

import pulumi
import pulumi_vault as vault

group = vault.identity.Group("group",
    policies=["test"],
    type="external")
github = vault.AuthBackend("github",
    path="github",
    type="github")
group_alias = vault.identity.GroupAlias("group-alias",
    canonical_id=group.id,
    mount_accessor=github.accessor,
    name="Github_Team_Slug")

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

const group = new vault.identity.Group("group", {
    policies: ["test"],
    type: "external",
});
const github = new vault.AuthBackend("github", {
    path: "github",
    type: "github",
});
const group_alias = new vault.identity.GroupAlias("group-alias", {
    canonicalId: group.id,
    mountAccessor: github.accessor,
    name: "Github_Team_Slug",
});

Create a GroupAlias Resource

new GroupAlias(name: string, args: GroupAliasArgs, opts?: CustomResourceOptions);

def GroupAlias(resource_name, opts=None, canonical_id=None, mount_accessor=None, name=None, __props__=None);

func NewGroupAlias(ctx *Context, name string, args GroupAliasArgs, opts ...ResourceOption) (*GroupAlias, error)

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

GroupAlias Resource Properties

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

Inputs

The GroupAlias resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the GroupAlias resource produces the following output properties:

Look up an Existing GroupAlias Resource

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

static get(resource_name, id, opts=None, canonical_id=None, mount_accessor=None, name=None, __props__=None);

func GetGroupAlias(ctx *Context, name string, id IDInput, state *GroupAliasState, opts ...ResourceOption) (*GroupAlias, error)

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

The following state arguments are supported:

Package Details

Repository

https://github.com/pulumi/pulumi-vault

License

Apache-2.0

Notes

This Pulumi package is based on the vault Terraform Provider.