vault.ldap.AuthBackendUser
Explore with Pulumi AI
Provides a resource to create a user in an LDAP auth backend within Vault.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var ldap = new Vault.Ldap.AuthBackend("ldap", new()
{
Path = "ldap",
Url = "ldaps://dc-01.example.org",
Userdn = "OU=Users,OU=Accounts,DC=example,DC=org",
Userattr = "sAMAccountName",
Upndomain = "EXAMPLE.ORG",
Discoverdn = false,
Groupdn = "OU=Groups,DC=example,DC=org",
Groupfilter = "(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))",
});
var user = new Vault.Ldap.AuthBackendUser("user", new()
{
Username = "test-user",
Policies = new[]
{
"dba",
"sysops",
},
Backend = ldap.Path,
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/ldap"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
ldap, err := ldap.NewAuthBackend(ctx, "ldap", &ldap.AuthBackendArgs{
Path: pulumi.String("ldap"),
Url: pulumi.String("ldaps://dc-01.example.org"),
Userdn: pulumi.String("OU=Users,OU=Accounts,DC=example,DC=org"),
Userattr: pulumi.String("sAMAccountName"),
Upndomain: pulumi.String("EXAMPLE.ORG"),
Discoverdn: pulumi.Bool(false),
Groupdn: pulumi.String("OU=Groups,DC=example,DC=org"),
Groupfilter: pulumi.String("(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))"),
})
if err != nil {
return err
}
_, err = ldap.NewAuthBackendUser(ctx, "user", &ldap.AuthBackendUserArgs{
Username: pulumi.String("test-user"),
Policies: pulumi.StringArray{
pulumi.String("dba"),
pulumi.String("sysops"),
},
Backend: ldap.Path,
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.ldap.AuthBackend;
import com.pulumi.vault.ldap.AuthBackendArgs;
import com.pulumi.vault.ldap.AuthBackendUser;
import com.pulumi.vault.ldap.AuthBackendUserArgs;
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 ldap = new AuthBackend("ldap", AuthBackendArgs.builder()
.path("ldap")
.url("ldaps://dc-01.example.org")
.userdn("OU=Users,OU=Accounts,DC=example,DC=org")
.userattr("sAMAccountName")
.upndomain("EXAMPLE.ORG")
.discoverdn(false)
.groupdn("OU=Groups,DC=example,DC=org")
.groupfilter("(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))")
.build());
var user = new AuthBackendUser("user", AuthBackendUserArgs.builder()
.username("test-user")
.policies(
"dba",
"sysops")
.backend(ldap.path())
.build());
}
}
import pulumi
import pulumi_vault as vault
ldap = vault.ldap.AuthBackend("ldap",
path="ldap",
url="ldaps://dc-01.example.org",
userdn="OU=Users,OU=Accounts,DC=example,DC=org",
userattr="sAMAccountName",
upndomain="EXAMPLE.ORG",
discoverdn=False,
groupdn="OU=Groups,DC=example,DC=org",
groupfilter="(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))")
user = vault.ldap.AuthBackendUser("user",
username="test-user",
policies=[
"dba",
"sysops",
],
backend=ldap.path)
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const ldap = new vault.ldap.AuthBackend("ldap", {
path: "ldap",
url: "ldaps://dc-01.example.org",
userdn: "OU=Users,OU=Accounts,DC=example,DC=org",
userattr: "sAMAccountName",
upndomain: "EXAMPLE.ORG",
discoverdn: false,
groupdn: "OU=Groups,DC=example,DC=org",
groupfilter: "(&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))",
});
const user = new vault.ldap.AuthBackendUser("user", {
username: "test-user",
policies: [
"dba",
"sysops",
],
backend: ldap.path,
});
resources:
ldap:
type: vault:ldap:AuthBackend
properties:
path: ldap
url: ldaps://dc-01.example.org
userdn: OU=Users,OU=Accounts,DC=example,DC=org
userattr: sAMAccountName
upndomain: EXAMPLE.ORG
discoverdn: false
groupdn: OU=Groups,DC=example,DC=org
groupfilter: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}}))
user:
type: vault:ldap:AuthBackendUser
properties:
username: test-user
policies:
- dba
- sysops
backend: ${ldap.path}
Create AuthBackendUser Resource
new AuthBackendUser(name: string, args: AuthBackendUserArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendUser(resource_name: str,
opts: Optional[ResourceOptions] = None,
backend: Optional[str] = None,
groups: Optional[Sequence[str]] = None,
namespace: Optional[str] = None,
policies: Optional[Sequence[str]] = None,
username: Optional[str] = None)
@overload
def AuthBackendUser(resource_name: str,
args: AuthBackendUserArgs,
opts: Optional[ResourceOptions] = None)
func NewAuthBackendUser(ctx *Context, name string, args AuthBackendUserArgs, opts ...ResourceOption) (*AuthBackendUser, error)
public AuthBackendUser(string name, AuthBackendUserArgs args, CustomResourceOptions? opts = null)
public AuthBackendUser(String name, AuthBackendUserArgs args)
public AuthBackendUser(String name, AuthBackendUserArgs args, CustomResourceOptions options)
type: vault:ldap:AuthBackendUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthBackendUserArgs
- 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 AuthBackendUserArgs
- 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 AuthBackendUserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthBackendUserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthBackendUserArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AuthBackendUser Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AuthBackendUser resource accepts the following input properties:
- Username string
The LDAP username
- Backend string
Path to the authentication backend
- Groups List<string>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
- Username string
The LDAP username
- Backend string
Path to the authentication backend
- Groups []string
Override LDAP groups which should be granted to user
- 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
Policies which should be granted to user
- username String
The LDAP username
- backend String
Path to the authentication backend
- groups List<String>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
- username string
The LDAP username
- backend string
Path to the authentication backend
- groups string[]
Override LDAP groups which should be granted to user
- 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[]
Policies which should be granted to user
- username str
The LDAP username
- backend str
Path to the authentication backend
- groups Sequence[str]
Override LDAP groups which should be granted to user
- 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]
Policies which should be granted to user
- username String
The LDAP username
- backend String
Path to the authentication backend
- groups List<String>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthBackendUser 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 AuthBackendUser Resource
Get an existing AuthBackendUser 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?: AuthBackendUserState, opts?: CustomResourceOptions): AuthBackendUser
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backend: Optional[str] = None,
groups: Optional[Sequence[str]] = None,
namespace: Optional[str] = None,
policies: Optional[Sequence[str]] = None,
username: Optional[str] = None) -> AuthBackendUser
func GetAuthBackendUser(ctx *Context, name string, id IDInput, state *AuthBackendUserState, opts ...ResourceOption) (*AuthBackendUser, error)
public static AuthBackendUser Get(string name, Input<string> id, AuthBackendUserState? state, CustomResourceOptions? opts = null)
public static AuthBackendUser get(String name, Output<String> id, AuthBackendUserState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Backend string
Path to the authentication backend
- Groups List<string>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
- Username string
The LDAP username
- Backend string
Path to the authentication backend
- Groups []string
Override LDAP groups which should be granted to user
- 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
Policies which should be granted to user
- Username string
The LDAP username
- backend String
Path to the authentication backend
- groups List<String>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
- username String
The LDAP username
- backend string
Path to the authentication backend
- groups string[]
Override LDAP groups which should be granted to user
- 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[]
Policies which should be granted to user
- username string
The LDAP username
- backend str
Path to the authentication backend
- groups Sequence[str]
Override LDAP groups which should be granted to user
- 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]
Policies which should be granted to user
- username str
The LDAP username
- backend String
Path to the authentication backend
- groups List<String>
Override LDAP groups which should be granted to user
- 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>
Policies which should be granted to user
- username String
The LDAP username
Import
LDAP authentication backend users can be imported using the path
, e.g.
$ pulumi import vault:ldap/authBackendUser:AuthBackendUser foo auth/ldap/users/foo
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.