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("example", new Vault.GitHub.AuthBackendArgs
        {
            Organization = "myorg",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v4/go/vault/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.NewAuthBackend(ctx, "example", &github.AuthBackendArgs{
			Organization: pulumi.String("myorg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

example = vault.github.AuthBackend("example", organization="myorg")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = new vault.github.AuthBackend("example", {
    organization: "myorg",
});

Create a AuthBackend Resource

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                base_url: Optional[str] = None,
                description: Optional[str] = None,
                max_ttl: Optional[str] = None,
                organization: Optional[str] = None,
                path: Optional[str] = None,
                token_bound_cidrs: Optional[Sequence[str]] = None,
                token_explicit_max_ttl: Optional[int] = None,
                token_max_ttl: Optional[int] = None,
                token_no_default_policy: Optional[bool] = None,
                token_num_uses: Optional[int] = None,
                token_period: Optional[int] = None,
                token_policies: Optional[Sequence[str]] = None,
                token_ttl: Optional[int] = None,
                token_type: Optional[str] = None,
                ttl: Optional[str] = None,
                tune: Optional[AuthBackendTuneArgs] = 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)
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.

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:

Organization string
The organization configured users must be part of.
BaseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
Description string
Specifies the description of the mount. This overrides the current stored value, if any.
MaxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

Path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
TokenBoundCidrs List<string>
(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.
TokenExplicitMaxTtl int
(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.
TokenMaxTtl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
(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.
TokenNumUses int
(Optional) The period, if any, in number of seconds to set on the token.
TokenPeriod int
(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.
TokenPolicies List<string>
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
Ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

Tune AuthBackendTuneArgs
Organization string
The organization configured users must be part of.
BaseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
Description string
Specifies the description of the mount. This overrides the current stored value, if any.
MaxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

Path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
TokenBoundCidrs []string
(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.
TokenExplicitMaxTtl int
(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.
TokenMaxTtl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
(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.
TokenNumUses int
(Optional) The period, if any, in number of seconds to set on the token.
TokenPeriod int
(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.
TokenPolicies []string
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
Ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

Tune AuthBackendTuneArgs
organization string
The organization configured users must be part of.
baseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description string
Specifies the description of the mount. This overrides the current stored value, if any.
maxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
tokenBoundCidrs string[]
(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.
tokenExplicitMaxTtl number
(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.
tokenMaxTtl number
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenNoDefaultPolicy boolean
(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.
tokenNumUses number
(Optional) The period, if any, in number of seconds to set on the token.
tokenPeriod number
(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.
tokenPolicies string[]
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
tokenTtl number
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

tune AuthBackendTuneArgs
organization str
The organization configured users must be part of.
base_url str
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description str
Specifies the description of the mount. This overrides the current stored value, if any.
max_ttl str
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

path str
Path where the auth backend is mounted. Defaults to auth/github if not specified.
token_bound_cidrs Sequence[str]
(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.
token_explicit_max_ttl int
(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.
token_max_ttl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_no_default_policy bool
(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.
token_num_uses int
(Optional) The period, if any, in number of seconds to set on the token.
token_period int
(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.
token_policies Sequence[str]
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
token_ttl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
ttl str
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

tune AuthBackendTuneArgs

Outputs

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

Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
Id string
The provider-assigned unique ID for this managed resource.
Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
Id string
The provider-assigned unique ID for this managed resource.
accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
id string
The provider-assigned unique ID for this managed resource.
accessor str
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
id str
The provider-assigned unique ID for this managed resource.

Look up an 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,
        base_url: Optional[str] = None,
        description: Optional[str] = None,
        max_ttl: Optional[str] = None,
        organization: Optional[str] = None,
        path: Optional[str] = None,
        token_bound_cidrs: Optional[Sequence[str]] = None,
        token_explicit_max_ttl: Optional[int] = None,
        token_max_ttl: Optional[int] = None,
        token_no_default_policy: Optional[bool] = None,
        token_num_uses: Optional[int] = None,
        token_period: Optional[int] = None,
        token_policies: Optional[Sequence[str]] = None,
        token_ttl: Optional[int] = None,
        token_type: Optional[str] = None,
        ttl: Optional[str] = None,
        tune: Optional[AuthBackendTuneArgs] = 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)
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.

The following state arguments are supported:

Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
BaseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
Description string
Specifies the description of the mount. This overrides the current stored value, if any.
MaxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

Organization string
The organization configured users must be part of.
Path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
TokenBoundCidrs List<string>
(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.
TokenExplicitMaxTtl int
(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.
TokenMaxTtl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
(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.
TokenNumUses int
(Optional) The period, if any, in number of seconds to set on the token.
TokenPeriod int
(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.
TokenPolicies List<string>
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
Ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

Tune AuthBackendTuneArgs
Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
BaseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
Description string
Specifies the description of the mount. This overrides the current stored value, if any.
MaxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

Organization string
The organization configured users must be part of.
Path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
TokenBoundCidrs []string
(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.
TokenExplicitMaxTtl int
(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.
TokenMaxTtl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenNoDefaultPolicy bool
(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.
TokenNumUses int
(Optional) The period, if any, in number of seconds to set on the token.
TokenPeriod int
(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.
TokenPolicies []string
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
TokenTtl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
TokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
Ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

Tune AuthBackendTuneArgs
accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
baseUrl string
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description string
Specifies the description of the mount. This overrides the current stored value, if any.
maxTtl string
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

organization string
The organization configured users must be part of.
path string
Path where the auth backend is mounted. Defaults to auth/github if not specified.
tokenBoundCidrs string[]
(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.
tokenExplicitMaxTtl number
(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.
tokenMaxTtl number
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenNoDefaultPolicy boolean
(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.
tokenNumUses number
(Optional) The period, if any, in number of seconds to set on the token.
tokenPeriod number
(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.
tokenPolicies string[]
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
tokenTtl number
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
tokenType string
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
ttl string
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

tune AuthBackendTuneArgs
accessor str
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
base_url str
The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
description str
Specifies the description of the mount. This overrides the current stored value, if any.
max_ttl str
(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.

Deprecated: use token_max_ttl instead if you are running Vault >= 1.2

organization str
The organization configured users must be part of.
path str
Path where the auth backend is mounted. Defaults to auth/github if not specified.
token_bound_cidrs Sequence[str]
(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.
token_explicit_max_ttl int
(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.
token_max_ttl int
(Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_no_default_policy bool
(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.
token_num_uses int
(Optional) The period, if any, in number of seconds to set on the token.
token_period int
(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.
token_policies Sequence[str]
(Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
token_ttl int
(Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
token_type str
Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
ttl str
(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.

Deprecated: use token_ttl instead if you are running Vault >= 1.2

tune AuthBackendTuneArgs

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

Import

Github authentication mounts can be imported using the path, e.g.

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

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.