Class AuthBackend

Manages a Github Auth mount in a Vault server. 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(&quot;example&quot;, new Vault.GitHub.AuthBackendArgs
    {
        Organization = &quot;myorg&quot;,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthBackend

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

Constructors

View Source

AuthBackend(String, AuthBackendArgs, CustomResourceOptions)

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

Declaration

public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions options = null)

Parameters

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

Properties

View Source

Accessor

The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.

Declaration

public Output<string> Accessor { get; }

Property Value

Type	Description
Output<System.String>

View Source

BaseUrl

The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.

Declaration

public Output<string> BaseUrl { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

Specifies the description of the mount. This overrides the current stored value, if any.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

MaxTtl

(Optional; Deprecated, use token_max_ttl instead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.

Declaration

public Output<string> MaxTtl { get; }

Property Value

Type	Description
Output<System.String>

View Source

Organization

The organization configured users must be part of.

Declaration

public Output<string> Organization { get; }

Property Value

Type	Description
Output<System.String>

View Source

Path

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

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

View Source

TokenBoundCidrs

(Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.

Declaration

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

Property Value

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

View Source

TokenExplicitMaxTtl

(Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

Declaration

public Output<int?> TokenExplicitMaxTtl { get; }

Property Value

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

View Source

TokenMaxTtl

(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenMaxTtl { get; }

Property Value

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

View Source

TokenNoDefaultPolicy

(Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

Declaration

public Output<bool?> TokenNoDefaultPolicy { get; }

Property Value

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

View Source

TokenNumUses

(Optional) The period, if any, in number of seconds to set on the token.

Declaration

public Output<int?> TokenNumUses { get; }

Property Value

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

View Source

TokenPeriod

(Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Declaration

public Output<int?> TokenPeriod { get; }

Property Value

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

View Source

TokenPolicies

(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

Declaration

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

Property Value

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

View Source

TokenTtl

(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

Declaration

public Output<int?> TokenTtl { get; }

Property Value

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

View Source

TokenType

Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

View Source

Ttl

(Optional; Deprecated, use token_ttl instead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.

Declaration

public Output<string> Ttl { get; }

Property Value

Type	Description
Output<System.String>

View Source

Tune

Declaration

public Output<AuthBackendTune> Tune { get; }

Property Value

Type	Description
Output<AuthBackendTune>

Methods

View Source

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

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

Declaration

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

Returns

Type	Description
AuthBackend