Class User

Manages policy mappings for Github Users authenticated via Github. See the Vault documentation for more information.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var example = new Vault.GitHub.AuthBackend("example", new Vault.GitHub.AuthBackendArgs
    {
        Organization = "myorg",
    });
    var tfUser = new Vault.GitHub.User("tfUser", new Vault.GitHub.UserArgs
    {
        Backend = example.Id,
        User = "john.doe",
        TokenPolicies = 
        {
            "developer",
            "read-only",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

User

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.GitHub

Assembly: Pulumi.Vault.dll

Syntax

public class User : CustomResource

Constructors

User(String, UserArgs, CustomResourceOptions)

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

Declaration

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

Parameters

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

Properties

Backend

Path where the github auth backend is mounted. Defaults to github if not specified.

Declaration

public Output<string> Backend { get; }

Property Value

Type	Description
Output<System.String>

Policies

An array of strings specifying the policies to be set on tokens issued using this role.

Declaration

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

Property Value

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

TokenBoundCidrs

Specifies the blocks of IP addresses which are allowed to use the generated token

Declaration

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

Property Value

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

TokenExplicitMaxTtl

Generated Token's Explicit Maximum TTL in seconds

Declaration

public Output<int?> TokenExplicitMaxTtl { get; }

Property Value

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

TokenMaxTtl

The maximum lifetime of the generated token

Declaration

public Output<int?> TokenMaxTtl { get; }

Property Value

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

TokenNoDefaultPolicy

If true, the 'default' policy will not automatically be added to generated tokens

Declaration

public Output<bool?> TokenNoDefaultPolicy { get; }

Property Value

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

TokenNumUses

The maximum number of times a token may be used, a value of zero means unlimited

Declaration

public Output<int?> TokenNumUses { get; }

Property Value

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

TokenPeriod

Generated Token's Period

Declaration

public Output<int?> TokenPeriod { get; }

Property Value

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

TokenPolicies

Generated Token's Policies

Declaration

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

Property Value

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

TokenTtl

The initial ttl of the token to generate in seconds

Declaration

public Output<int?> TokenTtl { get; }

Property Value

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

TokenType

The type of token to generate, service or batch

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

UserName

GitHub user name.

Declaration

public Output<string> UserName { get; }

Property Value

Type	Description
Output<System.String>

Methods

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

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

Declaration

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

Returns

Type	Description
User