Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. github
  5. AuthBackend
HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
pulumi/pulumi-vault

vault.github.AuthBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
pulumi/pulumi-vault

    Manages a GitHub Auth mount in a Vault server. See the Vault documentation for more information.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

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

    import pulumi
import pulumi_vault as vault

example = vault.github.AuthBackend("example", organization="myorg")

    package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/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
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var example = new Vault.GitHub.AuthBackend("example", new()
    {
        Organization = "myorg",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.github.AuthBackend;
import com.pulumi.vault.github.AuthBackendArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AuthBackend("example", AuthBackendArgs.builder()        
            .organization("myorg")
            .build());

    }
}

    resources:
  example:
    type: vault:github:AuthBackend
    properties:
      organization: myorg

    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,
                organization: Optional[str] = None,
                token_explicit_max_ttl: Optional[int] = None,
                token_bound_cidrs: Optional[Sequence[str]] = None,
                namespace: Optional[str] = None,
                description: Optional[str] = None,
                token_max_ttl: Optional[int] = None,
                path: Optional[str] = None,
                disable_remount: Optional[bool] = None,
                base_url: Optional[str] = None,
                organization_id: 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,
                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:github:AuthBackend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var vaultAuthBackendResource = new Vault.GitHub.AuthBackend("vaultAuthBackendResource", new()
{
    Organization = "string",
    TokenExplicitMaxTtl = 0,
    TokenBoundCidrs = new[]
    {
        "string",
    },
    Namespace = "string",
    Description = "string",
    TokenMaxTtl = 0,
    Path = "string",
    DisableRemount = false,
    BaseUrl = "string",
    OrganizationId = 0,
    TokenNoDefaultPolicy = false,
    TokenNumUses = 0,
    TokenPeriod = 0,
    TokenPolicies = new[]
    {
        "string",
    },
    TokenTtl = 0,
    TokenType = "string",
    Tune = new Vault.GitHub.Inputs.AuthBackendTuneArgs
    {
        AllowedResponseHeaders = new[]
        {
            "string",
        },
        AuditNonHmacRequestKeys = new[]
        {
            "string",
        },
        AuditNonHmacResponseKeys = new[]
        {
            "string",
        },
        DefaultLeaseTtl = "string",
        ListingVisibility = "string",
        MaxLeaseTtl = "string",
        PassthroughRequestHeaders = new[]
        {
            "string",
        },
        TokenType = "string",
    },
});

    example, err := github.NewAuthBackend(ctx, "vaultAuthBackendResource", &github.AuthBackendArgs{
	Organization:        pulumi.String("string"),
	TokenExplicitMaxTtl: pulumi.Int(0),
	TokenBoundCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Namespace:            pulumi.String("string"),
	Description:          pulumi.String("string"),
	TokenMaxTtl:          pulumi.Int(0),
	Path:                 pulumi.String("string"),
	DisableRemount:       pulumi.Bool(false),
	BaseUrl:              pulumi.String("string"),
	OrganizationId:       pulumi.Int(0),
	TokenNoDefaultPolicy: pulumi.Bool(false),
	TokenNumUses:         pulumi.Int(0),
	TokenPeriod:          pulumi.Int(0),
	TokenPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenTtl:  pulumi.Int(0),
	TokenType: pulumi.String("string"),
	Tune: &github.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"),
	},
})

    var vaultAuthBackendResource = new AuthBackend("vaultAuthBackendResource", AuthBackendArgs.builder()        
    .organization("string")
    .tokenExplicitMaxTtl(0)
    .tokenBoundCidrs("string")
    .namespace("string")
    .description("string")
    .tokenMaxTtl(0)
    .path("string")
    .disableRemount(false)
    .baseUrl("string")
    .organizationId(0)
    .tokenNoDefaultPolicy(false)
    .tokenNumUses(0)
    .tokenPeriod(0)
    .tokenPolicies("string")
    .tokenTtl(0)
    .tokenType("string")
    .tune(AuthBackendTuneArgs.builder()
        .allowedResponseHeaders("string")
        .auditNonHmacRequestKeys("string")
        .auditNonHmacResponseKeys("string")
        .defaultLeaseTtl("string")
        .listingVisibility("string")
        .maxLeaseTtl("string")
        .passthroughRequestHeaders("string")
        .tokenType("string")
        .build())
    .build());

    vault_auth_backend_resource = vault.github.AuthBackend("vaultAuthBackendResource",
    organization="string",
    token_explicit_max_ttl=0,
    token_bound_cidrs=["string"],
    namespace="string",
    description="string",
    token_max_ttl=0,
    path="string",
    disable_remount=False,
    base_url="string",
    organization_id=0,
    token_no_default_policy=False,
    token_num_uses=0,
    token_period=0,
    token_policies=["string"],
    token_ttl=0,
    token_type="string",
    tune=vault.github.AuthBackendTuneArgs(
        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",
    ))

    const vaultAuthBackendResource = new vault.github.AuthBackend("vaultAuthBackendResource", {
    organization: "string",
    tokenExplicitMaxTtl: 0,
    tokenBoundCidrs: ["string"],
    namespace: "string",
    description: "string",
    tokenMaxTtl: 0,
    path: "string",
    disableRemount: false,
    baseUrl: "string",
    organizationId: 0,
    tokenNoDefaultPolicy: false,
    tokenNumUses: 0,
    tokenPeriod: 0,
    tokenPolicies: ["string"],
    tokenTtl: 0,
    tokenType: "string",
    tune: {
        allowedResponseHeaders: ["string"],
        auditNonHmacRequestKeys: ["string"],
        auditNonHmacResponseKeys: ["string"],
        defaultLeaseTtl: "string",
        listingVisibility: "string",
        maxLeaseTtl: "string",
        passthroughRequestHeaders: ["string"],
        tokenType: "string",
    },
});

    type: vault:github:AuthBackend
properties:
    baseUrl: string
    description: string
    disableRemount: false
    namespace: string
    organization: string
    organizationId: 0
    path: string
    tokenBoundCidrs:
        - string
    tokenExplicitMaxTtl: 0
    tokenMaxTtl: 0
    tokenNoDefaultPolicy: false
    tokenNumUses: 0
    tokenPeriod: 0
    tokenPolicies:
        - string
    tokenTtl: 0
    tokenType: string
    tune:
        allowedResponseHeaders:
            - string
        auditNonHmacRequestKeys:
            - string
        auditNonHmacResponseKeys:
            - string
        defaultLeaseTtl: string
        listingVisibility: string
        maxLeaseTtl: string
        passthroughRequestHeaders:
            - string
        tokenType: string

    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.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    OrganizationId int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    Tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    OrganizationId int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    Tune AuthBackendTuneArgs

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organizationId Integer
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 Integer
    (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 Integer
    (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 Integer
    (Optional) The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    tokenPeriod Integer
    (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 Integer
    (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".
    tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organizationId number
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organization_id int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    tune AuthBackendTuneArgs

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organizationId Number
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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 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 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".
    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 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 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.
    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.

    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,
        base_url: Optional[str] = None,
        description: Optional[str] = None,
        disable_remount: Optional[bool] = None,
        namespace: Optional[str] = None,
        organization: Optional[str] = None,
        organization_id: Optional[int] = 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,
        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)
    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 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.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    Organization string
    The organization configured users must be part of.
    OrganizationId int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    Tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    Organization string
    The organization configured users must be part of.
    OrganizationId int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    Tune AuthBackendTuneArgs

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organization String
    The organization configured users must be part of.
    organizationId Integer
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 Integer
    (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 Integer
    (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 Integer
    (Optional) The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    tokenPeriod Integer
    (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 Integer
    (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".
    tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organization string
    The organization configured users must be part of.
    organizationId number
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    tune AuthBackendTune

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organization str
    The organization configured users must be part of.
    organization_id int
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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".
    tune AuthBackendTuneArgs

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

    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.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    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.
    organization String
    The organization configured users must be part of.
    organizationId Number
    The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)
    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 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 maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.
    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 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 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".
    tune Property Map

    Extra configuration block. Structure is documented below.

    The tune block is used to tune the auth backend:

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

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.1.0 published on Thursday, Apr 4, 2024 by Pulumi
    pulumi/pulumi-vault