HashiCorp Vault v5.11.0, Apr 25 23

vault.AuthBackend

Explore with Pulumi AI

Import

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

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

Create AuthBackend Resource

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);

@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                disable_remount: Optional[bool] = None,
                local: Optional[bool] = None,
                namespace: Optional[str] = None,
                path: Optional[str] = None,
                tune: Optional[AuthBackendTuneArgs] = None,
                type: Optional[str] = None)
@overload
def AuthBackend(resource_name: str,
                args: AuthBackendArgs,
                opts: Optional[ResourceOptions] = 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.

name string: The unique name of the resource.
args AuthBackendArgs: 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 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 string: The unique name of the resource.
args AuthBackendArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuthBackendArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AuthBackendArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

The AuthBackend resource accepts the following input properties:

Type 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
Local bool: Specifies if the auth method is local only.
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.
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.

Type 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
Local bool: Specifies if the auth method is local only.
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.
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.

type 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
local Boolean: Specifies if the auth method is local only.
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.
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.

type 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
local boolean: Specifies if the auth method is local only.
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.
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.

type 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
local bool: Specifies if the auth method is local only.
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.
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.

type 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
local Boolean: Specifies if the auth method is local only.
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.
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.

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

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.

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
Local bool: Specifies if the auth method is local only.
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.
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.
Type 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
Local bool: Specifies if the auth method is local only.
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.
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.
Type 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
local Boolean: Specifies if the auth method is local only.
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.
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.
type 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
local boolean: Specifies if the auth method is local only.
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.
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.
type 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
local bool: Specifies if the auth method is local only.
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.
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.
type 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
local Boolean: Specifies if the auth method is local only.
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.
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.
type String: The name of the auth method type.

Supporting Types

AuthBackendTune

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.