Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. AuthBackend
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

vault.AuthBackend

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

Import

Auth methods can be imported using the path, e.g.

$ pulumi import vault:index/authBackend:AuthBackend example github
Copy

Create AuthBackend Resource

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

Constructor syntax

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
@overload
def AuthBackend(resource_name: str,
                args: AuthBackendArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                type: Optional[str] = None,
                description: Optional[str] = None,
                disable_remount: Optional[bool] = None,
                identity_token_key: Optional[str] = None,
                local: Optional[bool] = None,
                namespace: Optional[str] = None,
                path: Optional[str] = None,
                tune: Optional[AuthBackendTuneArgs] = None)
func NewAuthBackend(ctx *Context, name string, args AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)
public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions? opts = null)
public AuthBackend(String name, AuthBackendArgs args)
public AuthBackend(String name, AuthBackendArgs args, CustomResourceOptions options)

type: vault:AuthBackend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AuthBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AuthBackendArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AuthBackendArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AuthBackendArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AuthBackendArgs
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.

var exampleauthBackendResourceResourceFromIndexauthBackend = new Vault.AuthBackend("exampleauthBackendResourceResourceFromIndexauthBackend", new()
{
    Type = "string",
    Description = "string",
    DisableRemount = false,
    IdentityTokenKey = "string",
    Local = false,
    Namespace = "string",
    Path = "string",
    Tune = new Vault.Inputs.AuthBackendTuneArgs
    {
        AllowedResponseHeaders = new[]
        {
            "string",
        },
        AuditNonHmacRequestKeys = new[]
        {
            "string",
        },
        AuditNonHmacResponseKeys = new[]
        {
            "string",
        },
        DefaultLeaseTtl = "string",
        ListingVisibility = "string",
        MaxLeaseTtl = "string",
        PassthroughRequestHeaders = new[]
        {
            "string",
        },
        TokenType = "string",
    },
});
Copy
example, err := vault.NewAuthBackend(ctx, "exampleauthBackendResourceResourceFromIndexauthBackend", &vault.AuthBackendArgs{
	Type:             pulumi.String("string"),
	Description:      pulumi.String("string"),
	DisableRemount:   pulumi.Bool(false),
	IdentityTokenKey: pulumi.String("string"),
	Local:            pulumi.Bool(false),
	Namespace:        pulumi.String("string"),
	Path:             pulumi.String("string"),
	Tune: &vault.AuthBackendTuneArgs{
		AllowedResponseHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AuditNonHmacRequestKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
		AuditNonHmacResponseKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
		DefaultLeaseTtl:   pulumi.String("string"),
		ListingVisibility: pulumi.String("string"),
		MaxLeaseTtl:       pulumi.String("string"),
		PassthroughRequestHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		TokenType: pulumi.String("string"),
	},
})
Copy
var exampleauthBackendResourceResourceFromIndexauthBackend = new AuthBackend("exampleauthBackendResourceResourceFromIndexauthBackend", AuthBackendArgs.builder()
    .type("string")
    .description("string")
    .disableRemount(false)
    .identityTokenKey("string")
    .local(false)
    .namespace("string")
    .path("string")
    .tune(AuthBackendTuneArgs.builder()
        .allowedResponseHeaders("string")
        .auditNonHmacRequestKeys("string")
        .auditNonHmacResponseKeys("string")
        .defaultLeaseTtl("string")
        .listingVisibility("string")
        .maxLeaseTtl("string")
        .passthroughRequestHeaders("string")
        .tokenType("string")
        .build())
    .build());
Copy
exampleauth_backend_resource_resource_from_indexauth_backend = vault.AuthBackend("exampleauthBackendResourceResourceFromIndexauthBackend",
    type="string",
    description="string",
    disable_remount=False,
    identity_token_key="string",
    local=False,
    namespace="string",
    path="string",
    tune={
        "allowed_response_headers": ["string"],
        "audit_non_hmac_request_keys": ["string"],
        "audit_non_hmac_response_keys": ["string"],
        "default_lease_ttl": "string",
        "listing_visibility": "string",
        "max_lease_ttl": "string",
        "passthrough_request_headers": ["string"],
        "token_type": "string",
    })
Copy
const exampleauthBackendResourceResourceFromIndexauthBackend = new vault.AuthBackend("exampleauthBackendResourceResourceFromIndexauthBackend", {
    type: "string",
    description: "string",
    disableRemount: false,
    identityTokenKey: "string",
    local: false,
    namespace: "string",
    path: "string",
    tune: {
        allowedResponseHeaders: ["string"],
        auditNonHmacRequestKeys: ["string"],
        auditNonHmacResponseKeys: ["string"],
        defaultLeaseTtl: "string",
        listingVisibility: "string",
        maxLeaseTtl: "string",
        passthroughRequestHeaders: ["string"],
        tokenType: "string",
    },
});
Copy
type: vault:AuthBackend
properties:
    description: string
    disableRemount: false
    identityTokenKey: string
    local: false
    namespace: string
    path: string
    tune:
        allowedResponseHeaders:
            - string
        auditNonHmacRequestKeys:
            - string
        auditNonHmacResponseKeys:
            - string
        defaultLeaseTtl: string
        listingVisibility: string
        maxLeaseTtl: string
        passthroughRequestHeaders:
            - string
        tokenType: string
    type: string
Copy

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

Type
This property is required.
Changes to this property will trigger replacement.
string
The name of the auth method type.
Description string
A description of the auth method.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
IdentityTokenKey string
The key to use for signing identity tokens.
Local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
Namespace Changes to this property will trigger replacement. 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.
Path string
The path to mount the auth method — this defaults to the name of the type.
Tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

Type
This property is required.
Changes to this property will trigger replacement.
string
The name of the auth method type.
Description string
A description of the auth method.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
IdentityTokenKey string
The key to use for signing identity tokens.
Local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
Namespace Changes to this property will trigger replacement. 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.
Path string
The path to mount the auth method — this defaults to the name of the type.
Tune AuthBackendTuneArgs

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type
This property is required.
Changes to this property will trigger replacement.
String
The name of the auth method type.
description String
A description of the auth method.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey String
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. Boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path String
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type
This property is required.
Changes to this property will trigger replacement.
string
The name of the auth method type.
description string
A description of the auth method.
disableRemount boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey string
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path string
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type
This property is required.
Changes to this property will trigger replacement.
str
The name of the auth method type.
description str
A description of the auth method.
disable_remount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identity_token_key str
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path str
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTuneArgs

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type
This property is required.
Changes to this property will trigger replacement.
String
The name of the auth method type.
description String
A description of the auth method.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey String
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. Boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path String
The path to mount the auth method — this defaults to the name of the type.
tune Property Map

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackend resource produces the following output properties:

Accessor string
The accessor for this auth method
Id string
The provider-assigned unique ID for this managed resource.
Accessor string
The accessor for this auth method
Id string
The provider-assigned unique ID for this managed resource.
accessor String
The accessor for this auth method
id String
The provider-assigned unique ID for this managed resource.
accessor string
The accessor for this auth method
id string
The provider-assigned unique ID for this managed resource.
accessor str
The accessor for this auth method
id str
The provider-assigned unique ID for this managed resource.
accessor String
The accessor for this auth method
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AuthBackend Resource

Get an existing AuthBackend 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?: AuthBackendState, opts?: CustomResourceOptions): AuthBackend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessor: Optional[str] = None,
        description: Optional[str] = None,
        disable_remount: Optional[bool] = None,
        identity_token_key: Optional[str] = None,
        local: Optional[bool] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None,
        tune: Optional[AuthBackendTuneArgs] = None,
        type: Optional[str] = None) -> AuthBackend
func GetAuthBackend(ctx *Context, name string, id IDInput, state *AuthBackendState, opts ...ResourceOption) (*AuthBackend, error)
public static AuthBackend Get(string name, Input<string> id, AuthBackendState? state, CustomResourceOptions? opts = null)
public static AuthBackend get(String name, Output<String> id, AuthBackendState state, CustomResourceOptions options)
resources:  _:    type: vault:AuthBackend    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Accessor string
The accessor for this auth method
Description string
A description of the auth method.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
IdentityTokenKey string
The key to use for signing identity tokens.
Local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
Namespace Changes to this property will trigger replacement. 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.
Path string
The path to mount the auth method — this defaults to the name of the type.
Tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

Type Changes to this property will trigger replacement. string
The name of the auth method type.
Accessor string
The accessor for this auth method
Description string
A description of the auth method.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
IdentityTokenKey string
The key to use for signing identity tokens.
Local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
Namespace Changes to this property will trigger replacement. 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.
Path string
The path to mount the auth method — this defaults to the name of the type.
Tune AuthBackendTuneArgs

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

Type Changes to this property will trigger replacement. string
The name of the auth method type.
accessor String
The accessor for this auth method
description String
A description of the auth method.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey String
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. Boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path String
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type Changes to this property will trigger replacement. String
The name of the auth method type.
accessor string
The accessor for this auth method
description string
A description of the auth method.
disableRemount boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey string
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path string
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTune

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type Changes to this property will trigger replacement. string
The name of the auth method type.
accessor str
The accessor for this auth method
description str
A description of the auth method.
disable_remount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identity_token_key str
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. bool
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path str
The path to mount the auth method — this defaults to the name of the type.
tune AuthBackendTuneArgs

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type Changes to this property will trigger replacement. str
The name of the auth method type.
accessor String
The accessor for this auth method
description String
A description of the auth method.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
identityTokenKey String
The key to use for signing identity tokens.
local Changes to this property will trigger replacement. Boolean
Specifies if the auth method is local only.
namespace Changes to this property will trigger replacement. 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.
path String
The path to mount the auth method — this defaults to the name of the type.
tune Property Map

Extra configuration block. Structure is documented below.

The tune block is used to tune the auth backend:

type Changes to this property will trigger replacement. String
The name of the auth method type.

Supporting Types

AuthBackendTune
, AuthBackendTuneArgs

AllowedResponseHeaders List<string>
List of headers to whitelist and allowing a plugin to include them in the response.
AuditNonHmacRequestKeys List<string>
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
AuditNonHmacResponseKeys List<string>
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
DefaultLeaseTtl string
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
ListingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
MaxLeaseTtl string
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
PassthroughRequestHeaders List<string>
List of headers to whitelist and pass from the request to the backend.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".
AllowedResponseHeaders []string
List of headers to whitelist and allowing a plugin to include them in the response.
AuditNonHmacRequestKeys []string
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
AuditNonHmacResponseKeys []string
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
DefaultLeaseTtl string
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
ListingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
MaxLeaseTtl string
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
PassthroughRequestHeaders []string
List of headers to whitelist and pass from the request to the backend.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".
allowedResponseHeaders List<String>
List of headers to whitelist and allowing a plugin to include them in the response.
auditNonHmacRequestKeys List<String>
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
auditNonHmacResponseKeys List<String>
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
defaultLeaseTtl String
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
listingVisibility String
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
maxLeaseTtl String
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
passthroughRequestHeaders List<String>
List of headers to whitelist and pass from the request to the backend.
tokenType String
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".
allowedResponseHeaders string[]
List of headers to whitelist and allowing a plugin to include them in the response.
auditNonHmacRequestKeys string[]
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
auditNonHmacResponseKeys string[]
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
defaultLeaseTtl string
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
listingVisibility string
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
maxLeaseTtl string
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
passthroughRequestHeaders string[]
List of headers to whitelist and pass from the request to the backend.
tokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".
allowed_response_headers Sequence[str]
List of headers to whitelist and allowing a plugin to include them in the response.
audit_non_hmac_request_keys Sequence[str]
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
audit_non_hmac_response_keys Sequence[str]
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
default_lease_ttl str
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
listing_visibility str
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
max_lease_ttl str
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
passthrough_request_headers Sequence[str]
List of headers to whitelist and pass from the request to the backend.
token_type str
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".
allowedResponseHeaders List<String>
List of headers to whitelist and allowing a plugin to include them in the response.
auditNonHmacRequestKeys List<String>
Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
auditNonHmacResponseKeys List<String>
Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
defaultLeaseTtl String
Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
listingVisibility String
Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are "unauth" or "hidden".
maxLeaseTtl String
Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
passthroughRequestHeaders List<String>
List of headers to whitelist and pass from the request to the backend.
tokenType String
Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".

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