Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. HashiCorp Vault Provider
  4. API Docs
  5. cf
  6. AuthBackendRole
Viewing docs for HashiCorp Vault v7.12.0
published on Saturday, Aug 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vault

vault.cf.AuthBackendRole

vault logo vault logo
Viewing docs for HashiCorp Vault v7.12.0
published on Saturday, Aug 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vault

    Manages a role for the CloudFoundry (CF) auth method in Vault. Roles define the constraints that must be satisfied by a CF instance certificate at login time, and the token parameters issued on a successful login.

    Note Roles can be created independently of the backend configuration, but a vault.cf.AuthBackendConfig must be in place before any login attempt will succeed.

    Example Usage

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

const cf = new vault.AuthBackend("cf", {
    type: "cf",
    path: "cf",
});
const cfPolicy = new vault.Policy("cf_policy", {
    name: "cf-policy",
    policy: `path \\"secret/*\\" {
  capabilities = [\\"read\\"]
}
`,
});
const role = new vault.cf.AuthBackendRole("role", {
    mount: cf.path,
    name: "my-role",
    boundSpaceIds: ["space-uuid-1"],
    boundOrganizationIds: ["org-uuid-1"],
    disableIpMatching: true,
    tokenTtl: 3600,
    tokenPolicies: [cfPolicy.name],
});

    import pulumi
import pulumi_vault as vault

cf = vault.AuthBackend("cf",
    type="cf",
    path="cf")
cf_policy = vault.Policy("cf_policy",
    name="cf-policy",
    policy="""path \"secret/*\" {
  capabilities = [\"read\"]
}
""")
role = vault.cf.AuthBackendRole("role",
    mount=cf.path,
    name="my-role",
    bound_space_ids=["space-uuid-1"],
    bound_organization_ids=["org-uuid-1"],
    disable_ip_matching=True,
    token_ttl=3600,
    token_policies=[cf_policy.name])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cf2, err := vault.NewAuthBackend(ctx, "cf", &vault.AuthBackendArgs{
			Type: pulumi.String("cf"),
			Path: pulumi.String("cf"),
		})
		if err != nil {
			return err
		}
		cfPolicy, err := vault.NewPolicy(ctx, "cf_policy", &vault.PolicyArgs{
			Name:   pulumi.String("cf-policy"),
			Policy: pulumi.String("path \\\"secret/*\\\" {\n  capabilities = [\\\"read\\\"]\n}\n"),
		})
		if err != nil {
			return err
		}
		_, err = cf.NewAuthBackendRole(ctx, "role", &cf.AuthBackendRoleArgs{
			Mount: cf2.Path,
			Name:  pulumi.String("my-role"),
			BoundSpaceIds: pulumi.StringArray{
				pulumi.String("space-uuid-1"),
			},
			BoundOrganizationIds: pulumi.StringArray{
				pulumi.String("org-uuid-1"),
			},
			DisableIpMatching: pulumi.Bool(true),
			TokenTtl:          pulumi.Int(3600),
			TokenPolicies: pulumi.StringArray{
				cfPolicy.Name,
			},
		})
		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 cf = new Vault.AuthBackend("cf", new()
    {
        Type = "cf",
        Path = "cf",
    });

    var cfPolicy = new Vault.Policy("cf_policy", new()
    {
        Name = "cf-policy",
        PolicyContents = @"path \""secret/*\"" {
  capabilities = [\""read\""]
}
",
    });

    var role = new Vault.Cf.AuthBackendRole("role", new()
    {
        Mount = cf.Path,
        Name = "my-role",
        BoundSpaceIds = new[]
        {
            "space-uuid-1",
        },
        BoundOrganizationIds = new[]
        {
            "org-uuid-1",
        },
        DisableIpMatching = true,
        TokenTtl = 3600,
        TokenPolicies = new[]
        {
            cfPolicy.Name,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import com.pulumi.vault.Policy;
import com.pulumi.vault.PolicyArgs;
import com.pulumi.vault.cf.AuthBackendRole;
import com.pulumi.vault.cf.AuthBackendRoleArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 cf = new AuthBackend("cf", AuthBackendArgs.builder()
            .type("cf")
            .path("cf")
            .build());

        var cfPolicy = new Policy("cfPolicy", PolicyArgs.builder()
            .name("cf-policy")
            .policy("""
path \"secret/*\" {
  capabilities = [\"read\"]
}
            """)
            .build());

        var role = new AuthBackendRole("role", AuthBackendRoleArgs.builder()
            .mount(cf.path())
            .name("my-role")
            .boundSpaceIds("space-uuid-1")
            .boundOrganizationIds("org-uuid-1")
            .disableIpMatching(true)
            .tokenTtl(3600)
            .tokenPolicies(cfPolicy.name())
            .build());

    }
}

    resources:
  cf:
    type: vault:AuthBackend
    properties:
      type: cf
      path: cf
  cfPolicy:
    type: vault:Policy
    name: cf_policy
    properties:
      name: cf-policy
      policy: |
        path \"secret/*\" {
          capabilities = [\"read\"]
        }
  role:
    type: vault:cf:AuthBackendRole
    properties:
      mount: ${cf.path}
      name: my-role
      boundSpaceIds:
        - space-uuid-1
      boundOrganizationIds:
        - org-uuid-1
      disableIpMatching: true
      tokenTtl: 3600
      tokenPolicies:
        - ${cfPolicy.name}

    pulumi {
  required_providers {
    vault = {
      source = "pulumi/vault"
    }
  }
}

resource "vault_authbackend" "cf" {
  type = "cf"
  path = "cf"
}
resource "vault_policy" "cf_policy" {
  name   = "cf-policy"
  policy = "path \\\"secret/*\\\" {\n  capabilities = [\\\"read\\\"]\n}\n"
}
resource "vault_cf_authbackendrole" "role" {
  mount                  = vault_authbackend.cf.path
  name                   = "my-role"
  bound_space_ids        = ["space-uuid-1"]
  bound_organization_ids = ["org-uuid-1"]
  disable_ip_matching    = true
  token_ttl              = 3600
  token_policies         = [vault_policy.cf_policy.name]
}

    Create AuthBackendRole Resource

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

    Constructor syntax

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

@overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    mount: Optional[str] = None,
                    namespace: Optional[str] = None,
                    token_explicit_max_ttl: Optional[int] = None,
                    bound_organization_ids: Optional[Sequence[str]] = None,
                    bound_space_ids: Optional[Sequence[str]] = None,
                    disable_ip_matching: Optional[bool] = None,
                    bound_application_ids: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    alias_metadata: Optional[Mapping[str, str]] = None,
                    bound_instance_ids: Optional[Sequence[str]] = None,
                    token_max_ttl: Optional[int] = None,
                    token_bound_cidrs: Optional[Sequence[str]] = 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)
    func NewAuthBackendRole(ctx *Context, name string, args AuthBackendRoleArgs, opts ...ResourceOption) (*AuthBackendRole, error)
    public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions? opts = null)
    public AuthBackendRole(String name, AuthBackendRoleArgs args)
public AuthBackendRole(String name, AuthBackendRoleArgs args, CustomResourceOptions options)

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


    resource "vault_cf_auth_backend_role" "name" {
    # resource properties
}

    Parameters

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

    Constructor example

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

    var exampleauthBackendRoleResourceResourceFromCfauthBackendRole = new Vault.Cf.AuthBackendRole("exampleauthBackendRoleResourceResourceFromCfauthBackendRole", new()
{
    Mount = "string",
    Namespace = "string",
    TokenExplicitMaxTtl = 0,
    BoundOrganizationIds = new[]
    {
        "string",
    },
    BoundSpaceIds = new[]
    {
        "string",
    },
    DisableIpMatching = false,
    BoundApplicationIds = new[]
    {
        "string",
    },
    Name = "string",
    AliasMetadata = 
    {
        { "string", "string" },
    },
    BoundInstanceIds = new[]
    {
        "string",
    },
    TokenMaxTtl = 0,
    TokenBoundCidrs = new[]
    {
        "string",
    },
    TokenNoDefaultPolicy = false,
    TokenNumUses = 0,
    TokenPeriod = 0,
    TokenPolicies = new[]
    {
        "string",
    },
    TokenTtl = 0,
    TokenType = "string",
});

    example, err := cf.NewAuthBackendRole(ctx, "exampleauthBackendRoleResourceResourceFromCfauthBackendRole", &cf.AuthBackendRoleArgs{
	Mount:               pulumi.String("string"),
	Namespace:           pulumi.String("string"),
	TokenExplicitMaxTtl: pulumi.Int(0),
	BoundOrganizationIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	BoundSpaceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisableIpMatching: pulumi.Bool(false),
	BoundApplicationIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	AliasMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BoundInstanceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenMaxTtl: pulumi.Int(0),
	TokenBoundCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	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"),
})

    resource "vault_cf_auth_backend_role" "exampleauthBackendRoleResourceResourceFromCfauthBackendRole" {
  lifecycle {
    create_before_destroy = true
  }
  mount                  = "string"
  namespace              = "string"
  token_explicit_max_ttl = 0
  bound_organization_ids = ["string"]
  bound_space_ids        = ["string"]
  disable_ip_matching    = false
  bound_application_ids  = ["string"]
  name                   = "string"
  alias_metadata = {
    "string" = "string"
  }
  bound_instance_ids      = ["string"]
  token_max_ttl           = 0
  token_bound_cidrs       = ["string"]
  token_no_default_policy = false
  token_num_uses          = 0
  token_period            = 0
  token_policies          = ["string"]
  token_ttl               = 0
  token_type              = "string"
}

    var exampleauthBackendRoleResourceResourceFromCfauthBackendRole = new com.pulumi.vault.cf.AuthBackendRole("exampleauthBackendRoleResourceResourceFromCfauthBackendRole", com.pulumi.vault.cf.AuthBackendRoleArgs.builder()
    .mount("string")
    .namespace("string")
    .tokenExplicitMaxTtl(0)
    .boundOrganizationIds("string")
    .boundSpaceIds("string")
    .disableIpMatching(false)
    .boundApplicationIds("string")
    .name("string")
    .aliasMetadata(Map.of("string", "string"))
    .boundInstanceIds("string")
    .tokenMaxTtl(0)
    .tokenBoundCidrs("string")
    .tokenNoDefaultPolicy(false)
    .tokenNumUses(0)
    .tokenPeriod(0)
    .tokenPolicies("string")
    .tokenTtl(0)
    .tokenType("string")
    .build());

    exampleauth_backend_role_resource_resource_from_cfauth_backend_role = vault.cf.AuthBackendRole("exampleauthBackendRoleResourceResourceFromCfauthBackendRole",
    mount="string",
    namespace="string",
    token_explicit_max_ttl=0,
    bound_organization_ids=["string"],
    bound_space_ids=["string"],
    disable_ip_matching=False,
    bound_application_ids=["string"],
    name="string",
    alias_metadata={
        "string": "string",
    },
    bound_instance_ids=["string"],
    token_max_ttl=0,
    token_bound_cidrs=["string"],
    token_no_default_policy=False,
    token_num_uses=0,
    token_period=0,
    token_policies=["string"],
    token_ttl=0,
    token_type="string")

    const exampleauthBackendRoleResourceResourceFromCfauthBackendRole = new vault.cf.AuthBackendRole("exampleauthBackendRoleResourceResourceFromCfauthBackendRole", {
    mount: "string",
    namespace: "string",
    tokenExplicitMaxTtl: 0,
    boundOrganizationIds: ["string"],
    boundSpaceIds: ["string"],
    disableIpMatching: false,
    boundApplicationIds: ["string"],
    name: "string",
    aliasMetadata: {
        string: "string",
    },
    boundInstanceIds: ["string"],
    tokenMaxTtl: 0,
    tokenBoundCidrs: ["string"],
    tokenNoDefaultPolicy: false,
    tokenNumUses: 0,
    tokenPeriod: 0,
    tokenPolicies: ["string"],
    tokenTtl: 0,
    tokenType: "string",
});

    type: vault:cf:AuthBackendRole
properties:
    aliasMetadata:
        string: string
    boundApplicationIds:
        - string
    boundInstanceIds:
        - string
    boundOrganizationIds:
        - string
    boundSpaceIds:
        - string
    disableIpMatching: false
    mount: string
    name: string
    namespace: string
    tokenBoundCidrs:
        - string
    tokenExplicitMaxTtl: 0
    tokenMaxTtl: 0
    tokenNoDefaultPolicy: false
    tokenNumUses: 0
    tokenPeriod: 0
    tokenPolicies:
        - string
    tokenTtl: 0
    tokenType: string

    AuthBackendRole Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthBackendRole resource accepts the following input properties:

    Mount string
    The mount path for the CF auth engine in Vault.
    AliasMetadata Dictionary<string, string>
    A map of string to string that will be set as metadata on the identity alias
    BoundApplicationIds List<string>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    BoundInstanceIds List<string>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    BoundOrganizationIds List<string>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    BoundSpaceIds List<string>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    DisableIpMatching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    Name string
    The name of the CF auth role.
    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.
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Mount string
    The mount path for the CF auth engine in Vault.
    AliasMetadata map[string]string
    A map of string to string that will be set as metadata on the identity alias
    BoundApplicationIds []string
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    BoundInstanceIds []string
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    BoundOrganizationIds []string
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    BoundSpaceIds []string
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    DisableIpMatching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    Name string
    The name of the CF auth role.
    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.
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    mount string
    The mount path for the CF auth engine in Vault.
    alias_metadata map(string)
    A map of string to string that will be set as metadata on the identity alias
    bound_application_ids list(string)
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    bound_instance_ids list(string)
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    bound_organization_ids list(string)
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    bound_space_ids list(string)
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disable_ip_matching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    name string
    The name of the CF auth role.
    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.
    token_bound_cidrs list(string)
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl number
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl number
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses number
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period number
    Generated Token's Period
    token_policies list(string)
    Generated Token's Policies
    token_ttl number
    The initial ttl of the token to generate in seconds
    token_type string
    The type of token to generate, service or batch
    mount String
    The mount path for the CF auth engine in Vault.
    aliasMetadata Map<String,String>
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds List<String>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds List<String>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds List<String>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds List<String>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching Boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    name String
    The name of the CF auth role.
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    mount string
    The mount path for the CF auth engine in Vault.
    aliasMetadata {[key: string]: string}
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds string[]
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds string[]
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds string[]
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds string[]
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    name string
    The name of the CF auth role.
    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.
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    mount str
    The mount path for the CF auth engine in Vault.
    alias_metadata Mapping[str, str]
    A map of string to string that will be set as metadata on the identity alias
    bound_application_ids Sequence[str]
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    bound_instance_ids Sequence[str]
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    bound_organization_ids Sequence[str]
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    bound_space_ids Sequence[str]
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disable_ip_matching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    name str
    The name of the CF auth role.
    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.
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    mount String
    The mount path for the CF auth engine in Vault.
    aliasMetadata Map<String>
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds List<String>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds List<String>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds List<String>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds List<String>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching Boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    name String
    The name of the CF auth role.
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch

    Outputs

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

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

    Look up Existing AuthBackendRole Resource

    Get an existing AuthBackendRole 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?: AuthBackendRoleState, opts?: CustomResourceOptions): AuthBackendRole
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias_metadata: Optional[Mapping[str, str]] = None,
        bound_application_ids: Optional[Sequence[str]] = None,
        bound_instance_ids: Optional[Sequence[str]] = None,
        bound_organization_ids: Optional[Sequence[str]] = None,
        bound_space_ids: Optional[Sequence[str]] = None,
        disable_ip_matching: Optional[bool] = None,
        mount: Optional[str] = None,
        name: Optional[str] = None,
        namespace: 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) -> AuthBackendRole
    func GetAuthBackendRole(ctx *Context, name string, id IDInput, state *AuthBackendRoleState, opts ...ResourceOption) (*AuthBackendRole, error)
    public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState? state, CustomResourceOptions? opts = null)
    public static AuthBackendRole get(String name, Output<String> id, AuthBackendRoleState state, CustomResourceOptions options)
    resources:  _:    type: vault:cf:AuthBackendRole    get:      id: ${id}
    import {
  to = vault_cf_auth_backend_role.example
  id = "${id}"
}
    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:
    AliasMetadata Dictionary<string, string>
    A map of string to string that will be set as metadata on the identity alias
    BoundApplicationIds List<string>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    BoundInstanceIds List<string>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    BoundOrganizationIds List<string>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    BoundSpaceIds List<string>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    DisableIpMatching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    Mount string
    The mount path for the CF auth engine in Vault.
    Name string
    The name of the CF auth role.
    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.
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    AliasMetadata map[string]string
    A map of string to string that will be set as metadata on the identity alias
    BoundApplicationIds []string
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    BoundInstanceIds []string
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    BoundOrganizationIds []string
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    BoundSpaceIds []string
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    DisableIpMatching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    Mount string
    The mount path for the CF auth engine in Vault.
    Name string
    The name of the CF auth role.
    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.
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    alias_metadata map(string)
    A map of string to string that will be set as metadata on the identity alias
    bound_application_ids list(string)
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    bound_instance_ids list(string)
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    bound_organization_ids list(string)
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    bound_space_ids list(string)
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disable_ip_matching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    mount string
    The mount path for the CF auth engine in Vault.
    name string
    The name of the CF auth role.
    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.
    token_bound_cidrs list(string)
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl number
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl number
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses number
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period number
    Generated Token's Period
    token_policies list(string)
    Generated Token's Policies
    token_ttl number
    The initial ttl of the token to generate in seconds
    token_type string
    The type of token to generate, service or batch
    aliasMetadata Map<String,String>
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds List<String>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds List<String>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds List<String>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds List<String>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching Boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    mount String
    The mount path for the CF auth engine in Vault.
    name String
    The name of the CF auth role.
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    aliasMetadata {[key: string]: string}
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds string[]
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds string[]
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds string[]
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds string[]
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    mount string
    The mount path for the CF auth engine in Vault.
    name string
    The name of the CF auth role.
    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.
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    alias_metadata Mapping[str, str]
    A map of string to string that will be set as metadata on the identity alias
    bound_application_ids Sequence[str]
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    bound_instance_ids Sequence[str]
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    bound_organization_ids Sequence[str]
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    bound_space_ids Sequence[str]
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disable_ip_matching bool
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    mount str
    The mount path for the CF auth engine in Vault.
    name str
    The name of the CF auth role.
    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.
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    aliasMetadata Map<String>
    A map of string to string that will be set as metadata on the identity alias
    boundApplicationIds List<String>
    An optional set of CF application IDs. If set, a logging-in instance must belong to one of these applications.
    boundInstanceIds List<String>
    An optional set of CF instance IDs. If set, the logging-in instance's ID must appear in this list.
    boundOrganizationIds List<String>
    An optional set of CF organization IDs. If set, a logging-in instance must belong to one of these organizations.
    boundSpaceIds List<String>
    An optional set of CF space IDs. If set, a logging-in instance must belong to one of these spaces.
    disableIpMatching Boolean
    If true, disables the default behavior that requires login requests to originate from an IP address listed in the instance certificate. Useful when CF instances sit behind a load balancer or NAT. Defaults to false. Removing this field from your configuration resets the value to false in Vault.
    mount String
    The mount path for the CF auth engine in Vault.
    name String
    The name of the CF auth role.
    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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch

    Import

    CF auth backend roles can be imported using auth/, the mount path, /roles/, and the role name, e.g.

    $ pulumi import vault:cf/authBackendRole:AuthBackendRole role auth/cf/roles/my-role

    The namespace can be set using the environment variable TERRAFORM_VAULT_NAMESPACE.

    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 vault logo
    Viewing docs for HashiCorp Vault v7.12.0
    published on Saturday, Aug 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-vault

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial