Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

AuthBackend

Import

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

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

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Vault.AuthBackend("example", new Vault.AuthBackendArgs
        {
            Tune = new Vault.Inputs.AuthBackendTuneArgs
            {
                ListingVisibility = "unauth",
                MaxLeaseTtl = "90000s",
            },
            Type = "github",
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := vault.NewAuthBackend(ctx, "example", &vault.AuthBackendArgs{
            Tune: &vault.AuthBackendTuneArgs{
                ListingVisibility: pulumi.String("unauth"),
                MaxLeaseTtl:       pulumi.String("90000s"),
            },
            Type: pulumi.String("github"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_vault as vault

example = vault.AuthBackend("example",
    tune=vault.AuthBackendTuneArgs(
        listing_visibility="unauth",
        max_lease_ttl="90000s",
    ),
    type="github")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = new vault.AuthBackend("example", {
    tune: {
        listingVisibility: "unauth",
        maxLeaseTtl: "90000s",
    },
    type: "github",
});

Create a AuthBackend Resource

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
def AuthBackend(resource_name: str, opts: Optional[ResourceOptions] = None, default_lease_ttl_seconds: Optional[int] = None, description: Optional[str] = None, listing_visibility: Optional[str] = None, local: Optional[bool] = None, max_lease_ttl_seconds: Optional[int] = None, path: Optional[str] = None, tune: Optional[AuthBackendTuneArgs] = None, type: Optional[str] = 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.
opts ResourceOptions
A bag of options that control this 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 Programming Model docs.

Inputs

The AuthBackend resource accepts the following input properties:

Type string

The name of the auth method type

DefaultLeaseTtlSeconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Description string

A description of the auth method

ListingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Local bool

Specifies if the auth method is local only.

MaxLeaseTtlSeconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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

DefaultLeaseTtlSeconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Description string

A description of the auth method

ListingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Local bool

Specifies if the auth method is local only.

MaxLeaseTtlSeconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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.

type string

The name of the auth method type

defaultLeaseTtlSeconds number

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

description string

A description of the auth method

listingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

local boolean

Specifies if the auth method is local only.

maxLeaseTtlSeconds number

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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.

type str

The name of the auth method type

default_lease_ttl_seconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

description str

A description of the auth method

listing_visibility str

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

local bool

Specifies if the auth method is local only.

max_lease_ttl_seconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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.

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 str

The accessor for this auth method

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, default_lease_ttl_seconds: Optional[int] = None, description: Optional[str] = None, listing_visibility: Optional[str] = None, local: Optional[bool] = None, max_lease_ttl_seconds: Optional[int] = 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)
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 accessor for this auth method

DefaultLeaseTtlSeconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Description string

A description of the auth method

ListingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Local bool

Specifies if the auth method is local only.

MaxLeaseTtlSeconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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

DefaultLeaseTtlSeconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Description string

A description of the auth method

ListingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

Local bool

Specifies if the auth method is local only.

MaxLeaseTtlSeconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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.

Type string

The name of the auth method type

accessor string

The accessor for this auth method

defaultLeaseTtlSeconds number

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

description string

A description of the auth method

listingVisibility string

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

local boolean

Specifies if the auth method is local only.

maxLeaseTtlSeconds number

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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.

type string

The name of the auth method type

accessor str

The accessor for this auth method

default_lease_ttl_seconds int

(Optional; Deprecated, use tune.default_lease_ttl if you are using Vault provider version >= 1.8) The default lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

description str

A description of the auth method

listing_visibility str

Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

local bool

Specifies if the auth method is local only.

max_lease_ttl_seconds int

(Optional; Deprecated, use tune.max_lease_ttl if you are using Vault provider version >= 1.8) The maximum lease duration in seconds.

Deprecated: Use the tune configuration block to avoid forcing creation of new resource on an update

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

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

Package Details

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