Class AuthBackend

Provides a resource for managing an LDAP auth backend within Vault.

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
public MyStack()
{
    var ldap = new Vault.Ldap.AuthBackend("ldap", new Vault.Ldap.AuthBackendArgs
    {
        Discoverdn = false,
        Groupdn = "OU=Groups,DC=example,DC=org",
        Groupfilter = "(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))",
        Path = "ldap",
        Upndomain = "EXAMPLE.ORG",
        Url = "ldaps://dc-01.example.org",
        Userattr = "sAMAccountName",
        Userdn = "OU=Users,OU=Accounts,DC=example,DC=org",
    });
}

}

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

Assembly: Pulumi.Vault.dll

Syntax

public class AuthBackend : CustomResource

Constructors

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

Accessor

The accessor for this auth mount.

Declaration

public Output<string> Accessor { get; }

Property Value

Type	Description
Output<System.String>

Binddn

DN of object to bind when performing user search

Declaration

public Output<string> Binddn { get; }

Property Value

Type	Description
Output<System.String>

Bindpass

Password to use with binddn when performing user search

Declaration

public Output<string> Bindpass { get; }

Property Value

Type	Description
Output<System.String>

Certificate

Trusted CA to validate TLS certificate

Declaration

public Output<string> Certificate { get; }

Property Value

Type	Description
Output<System.String>

DenyNullBind

Declaration

public Output<bool> DenyNullBind { get; }

Property Value

Type	Description
Output<System.Boolean>

Description

Description for the LDAP auth backend mount

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Discoverdn

Declaration

public Output<bool> Discoverdn { get; }

Property Value

Type	Description
Output<System.Boolean>

Groupattr

LDAP attribute to follow on objects returned by groupfilter

Declaration

public Output<string> Groupattr { get; }

Property Value

Type	Description
Output<System.String>

Groupdn

Base DN under which to perform group search

Declaration

public Output<string> Groupdn { get; }

Property Value

Type	Description
Output<System.String>

Groupfilter

Go template used to construct group membership query

Declaration

public Output<string> Groupfilter { get; }

Property Value

Type	Description
Output<System.String>

InsecureTls

Control whether or TLS certificates must be validated

Declaration

public Output<bool> InsecureTls { get; }

Property Value

Type	Description
Output<System.Boolean>

Path

Path to mount the LDAP auth backend under

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

Starttls

Control use of TLS when conecting to LDAP

Declaration

public Output<bool> Starttls { get; }

Property Value

Type	Description
Output<System.Boolean>

TlsMaxVersion

Maximum acceptable version of TLS

Declaration

public Output<string> TlsMaxVersion { get; }

Property Value

Type	Description
Output<System.String>

TlsMinVersion

Minimum acceptable version of TLS

Declaration

public Output<string> TlsMinVersion { get; }

Property Value

Type	Description
Output<System.String>

TokenBoundCidrs

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

TokenExplicitMaxTtl

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

TokenMaxTtl

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

TokenNoDefaultPolicy

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

TokenNumUses

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

TokenPeriod

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

TokenPolicies

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

TokenTtl

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

TokenType

The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

Declaration

public Output<string> TokenType { get; }

Property Value

Type	Description
Output<System.String>

Upndomain

The userPrincipalDomain used to construct UPN string

Declaration

public Output<string> Upndomain { get; }

Property Value

Type	Description
Output<System.String>

Url

The URL of the LDAP server

Declaration

public Output<string> Url { get; }

Property Value

Type	Description
Output<System.String>

Userattr

Attribute on user object matching username passed in

Declaration

public Output<string> Userattr { get; }

Property Value

Type	Description
Output<System.String>

Userdn

Base DN under which to perform user search

Declaration

public Output<string> Userdn { get; }

Property Value

Type	Description
Output<System.String>

UseTokenGroups

Use the Active Directory tokenGroups constructed attribute of the user to find the group memberships

Declaration

public Output<bool> UseTokenGroups { get; }

Property Value

Type	Description
Output<System.Boolean>

Methods

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