HashiCorp Vault v6.6.0, Mar 13 25

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

vault.github.User

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new vault.github.AuthBackend("example", {organization: "myorg"});
const tfUser = new vault.github.User("tf_user", {
    backend: example.id,
    user: "john.doe",
    policies: [
        "developer",
        "read-only",
    ],
});

import pulumi
import pulumi_vault as vault

example = vault.github.AuthBackend("example", organization="myorg")
tf_user = vault.github.User("tf_user",
    backend=example.id,
    user="john.doe",
    policies=[
        "developer",
        "read-only",
    ])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := github.NewAuthBackend(ctx, "example", &github.AuthBackendArgs{
			Organization: pulumi.String("myorg"),
		})
		if err != nil {
			return err
		}
		_, err = github.NewUser(ctx, "tf_user", &github.UserArgs{
			Backend: example.ID(),
			User:    pulumi.String("john.doe"),
			Policies: pulumi.StringArray{
				pulumi.String("developer"),
				pulumi.String("read-only"),
			},
		})
		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 example = new Vault.GitHub.AuthBackend("example", new()
    {
        Organization = "myorg",
    });

    var tfUser = new Vault.GitHub.User("tf_user", new()
    {
        Backend = example.Id,
        UserName = "john.doe",
        Policies = new[]
        {
            "developer",
            "read-only",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.github.AuthBackend;
import com.pulumi.vault.github.AuthBackendArgs;
import com.pulumi.vault.github.User;
import com.pulumi.vault.github.UserArgs;
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 example = new AuthBackend("example", AuthBackendArgs.builder()
            .organization("myorg")
            .build());

        var tfUser = new User("tfUser", UserArgs.builder()
            .backend(example.id())
            .user("john.doe")
            .policies(            
                "developer",
                "read-only")
            .build());

    }
}

resources:
  example:
    type: vault:github:AuthBackend
    properties:
      organization: myorg
  tfUser:
    type: vault:github:User
    name: tf_user
    properties:
      backend: ${example.id}
      user: john.doe
      policies:
        - developer
        - read-only

Create User Resource

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

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);

@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         user: Optional[str] = None,
         backend: Optional[str] = None,
         namespace: Optional[str] = None,
         policies: Optional[Sequence[str]] = None)

func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs args, CustomResourceOptions? opts = null)

public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: vault:github:User
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 UserArgs: 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 UserArgs: 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 UserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var userResource = new Vault.GitHub.User("userResource", new()
{
    UserName = "string",
    Backend = "string",
    Namespace = "string",
    Policies = new[]
    {
        "string",
    },
});

example, err := github.NewUser(ctx, "userResource", &github.UserArgs{
	User:      pulumi.String("string"),
	Backend:   pulumi.String("string"),
	Namespace: pulumi.String("string"),
	Policies: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var userResource = new User("userResource", UserArgs.builder()
    .user("string")
    .backend("string")
    .namespace("string")
    .policies("string")
    .build());

user_resource = vault.github.User("userResource",
    user="string",
    backend="string",
    namespace="string",
    policies=["string"])

const userResource = new vault.github.User("userResource", {
    user: "string",
    backend: "string",
    namespace: "string",
    policies: ["string"],
});

type: vault:github:User
properties:
    backend: string
    namespace: string
    policies:
        - string
    user: string

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

UserName string: GitHub user name.
Backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
Policies List<string>: An array of strings specifying the policies to be set on tokens issued using this role.

User string: GitHub user name.
Backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
Policies []string: An array of strings specifying the policies to be set on tokens issued using this role.

user String: GitHub user name.
backend String: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies List<String>: An array of strings specifying the policies to be set on tokens issued using this role.

user string: GitHub user name.
backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies string[]: An array of strings specifying the policies to be set on tokens issued using this role.

user str: GitHub user name.
backend str: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies Sequence[str]: An array of strings specifying the policies to be set on tokens issued using this role.

user String: GitHub user name.
backend String: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies List<String>: An array of strings specifying the policies to be set on tokens issued using this role.

Outputs

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

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend: Optional[str] = None,
        namespace: Optional[str] = None,
        policies: Optional[Sequence[str]] = None,
        user: Optional[str] = None) -> User

func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)

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

public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)

resources:  _:    type: vault:github:User    get:      id: ${id}

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:

Backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
Policies List<string>: An array of strings specifying the policies to be set on tokens issued using this role.
UserName string: GitHub user name.

Backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
Policies []string: An array of strings specifying the policies to be set on tokens issued using this role.
User string: GitHub user name.

backend String: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies List<String>: An array of strings specifying the policies to be set on tokens issued using this role.
user String: GitHub user name.

backend string: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies string[]: An array of strings specifying the policies to be set on tokens issued using this role.
user string: GitHub user name.

backend str: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies Sequence[str]: An array of strings specifying the policies to be set on tokens issued using this role.
user str: GitHub user name.

backend String: Path where the github auth backend is mounted. Defaults to github if not specified.
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.
policies List<String>: An array of strings specifying the policies to be set on tokens issued using this role.
user String: GitHub user name.

Import

Github user mappings can be imported using the path, e.g.

$ pulumi import vault:github/user:User tf_user auth/github/map/users/john.doe

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

vault.github.User

On this page

On this page

Example Usage

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Import

Package Details

On this page

On this page