Docs Packages
  1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. appRole
  5. AuthBackendRole
HashiCorp Vault v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
pulumi/pulumi-vault

vault.appRole.AuthBackendRole

Explore with Pulumi AI

vault logo
HashiCorp Vault v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
pulumi/pulumi-vault

    Manages an AppRole auth backend role in a Vault server. See the Vault documentation for more information.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var approle = new Vault.AuthBackend("approle", new()
    {
        Type = "approle",
    });

    var example = new Vault.AppRole.AuthBackendRole("example", new()
    {
        Backend = approle.Path,
        RoleName = "test-role",
        TokenPolicies = new[]
        {
            "default",
            "dev",
            "prod",
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		approle, err := vault.NewAuthBackend(ctx, "approle", &vault.AuthBackendArgs{
			Type: pulumi.String("approle"),
		})
		if err != nil {
			return err
		}
		_, err = appRole.NewAuthBackendRole(ctx, "example", &appRole.AuthBackendRoleArgs{
			Backend:  approle.Path,
			RoleName: pulumi.String("test-role"),
			TokenPolicies: pulumi.StringArray{
				pulumi.String("default"),
				pulumi.String("dev"),
				pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.appRole.AuthBackendRole;
import com.pulumi.vault.appRole.AuthBackendRoleArgs;
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 approle = new AuthBackend("approle", AuthBackendArgs.builder()        
            .type("approle")
            .build());

        var example = new AuthBackendRole("example", AuthBackendRoleArgs.builder()        
            .backend(approle.path())
            .roleName("test-role")
            .tokenPolicies(            
                "default",
                "dev",
                "prod")
            .build());

    }
}

    import pulumi
import pulumi_vault as vault

approle = vault.AuthBackend("approle", type="approle")
example = vault.app_role.AuthBackendRole("example",
    backend=approle.path,
    role_name="test-role",
    token_policies=[
        "default",
        "dev",
        "prod",
    ])

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

const approle = new vault.AuthBackend("approle", {type: "approle"});
const example = new vault.approle.AuthBackendRole("example", {
    backend: approle.path,
    roleName: "test-role",
    tokenPolicies: [
        "default",
        "dev",
        "prod",
    ],
});

    resources:
  approle:
    type: vault:AuthBackend
    properties:
      type: approle
  example:
    type: vault:appRole:AuthBackendRole
    properties:
      backend: ${approle.path}
      roleName: test-role
      tokenPolicies:
        - default
        - dev
        - prod

    Create AuthBackendRole Resource

    new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
    @overload
def AuthBackendRole(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    backend: Optional[str] = None,
                    bind_secret_id: Optional[bool] = None,
                    namespace: Optional[str] = None,
                    role_id: Optional[str] = None,
                    role_name: Optional[str] = None,
                    secret_id_bound_cidrs: Optional[Sequence[str]] = None,
                    secret_id_num_uses: Optional[int] = None,
                    secret_id_ttl: Optional[int] = 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)
@overload
def AuthBackendRole(resource_name: str,
                    args: AuthBackendRoleArgs,
                    opts: Optional[ResourceOptions] = 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:appRole:AuthBackendRole
properties: # The arguments to resource properties.
options: # 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.
    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.

    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

    The AuthBackendRole resource accepts the following input properties:

    RoleName string

    The name of the role.

    Backend string

    The unique name of the auth backend to configure. Defaults to approle.

    BindSecretId bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    RoleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    SecretIdBoundCidrs List<string>

    If set, specifies blocks of IP addresses which can perform the login operation.

    SecretIdNumUses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    SecretIdTtl int

    The number of seconds after which any SecretID expires.

    TokenBoundCidrs List<string>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenNoDefaultPolicy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    TokenPeriod int

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    RoleName string

    The name of the role.

    Backend string

    The unique name of the auth backend to configure. Defaults to approle.

    BindSecretId bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    RoleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    SecretIdBoundCidrs []string

    If set, specifies blocks of IP addresses which can perform the login operation.

    SecretIdNumUses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    SecretIdTtl int

    The number of seconds after which any SecretID expires.

    TokenBoundCidrs []string

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenNoDefaultPolicy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    TokenPeriod int

    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

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    roleName String

    The name of the role.

    backend String

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId Boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId String

    The RoleID of this role. If not specified, one will be auto-generated.

    secretIdBoundCidrs List<String>

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses Integer

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl Integer

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs List<String>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy Boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod Integer

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType String

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    roleName string

    The name of the role.

    backend string

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    secretIdBoundCidrs string[]

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses number

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl number

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs string[]

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod number

    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[]

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    role_name str

    The name of the role.

    backend str

    The unique name of the auth backend to configure. Defaults to approle.

    bind_secret_id bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    role_id str

    The RoleID of this role. If not specified, one will be auto-generated.

    secret_id_bound_cidrs Sequence[str]

    If set, specifies blocks of IP addresses which can perform the login operation.

    secret_id_num_uses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secret_id_ttl int

    The number of seconds after which any SecretID expires.

    token_bound_cidrs Sequence[str]

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    token_no_default_policy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    token_period int

    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]

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    token_type str

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    roleName String

    The name of the role.

    backend String

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId Boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId String

    The RoleID of this role. If not specified, one will be auto-generated.

    secretIdBoundCidrs List<String>

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses Number

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl Number

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs List<String>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy Boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod Number

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType String

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    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 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,
        backend: Optional[str] = None,
        bind_secret_id: Optional[bool] = None,
        namespace: Optional[str] = None,
        role_id: Optional[str] = None,
        role_name: Optional[str] = None,
        secret_id_bound_cidrs: Optional[Sequence[str]] = None,
        secret_id_num_uses: Optional[int] = None,
        secret_id_ttl: Optional[int] = 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)
    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:
    Backend string

    The unique name of the auth backend to configure. Defaults to approle.

    BindSecretId bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    RoleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    RoleName string

    The name of the role.

    SecretIdBoundCidrs List<string>

    If set, specifies blocks of IP addresses which can perform the login operation.

    SecretIdNumUses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    SecretIdTtl int

    The number of seconds after which any SecretID expires.

    TokenBoundCidrs List<string>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenNoDefaultPolicy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    TokenPeriod int

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    Backend string

    The unique name of the auth backend to configure. Defaults to approle.

    BindSecretId bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    RoleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    RoleName string

    The name of the role.

    SecretIdBoundCidrs []string

    If set, specifies blocks of IP addresses which can perform the login operation.

    SecretIdNumUses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    SecretIdTtl int

    The number of seconds after which any SecretID expires.

    TokenBoundCidrs []string

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenNoDefaultPolicy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    TokenPeriod int

    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

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    TokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    backend String

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId Boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId String

    The RoleID of this role. If not specified, one will be auto-generated.

    roleName String

    The name of the role.

    secretIdBoundCidrs List<String>

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses Integer

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl Integer

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs List<String>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy Boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod Integer

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType String

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    backend string

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId string

    The RoleID of this role. If not specified, one will be auto-generated.

    roleName string

    The name of the role.

    secretIdBoundCidrs string[]

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses number

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl number

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs string[]

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod number

    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[]

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType string

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    backend str

    The unique name of the auth backend to configure. Defaults to approle.

    bind_secret_id bool

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    role_id str

    The RoleID of this role. If not specified, one will be auto-generated.

    role_name str

    The name of the role.

    secret_id_bound_cidrs Sequence[str]

    If set, specifies blocks of IP addresses which can perform the login operation.

    secret_id_num_uses int

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secret_id_ttl int

    The number of seconds after which any SecretID expires.

    token_bound_cidrs Sequence[str]

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    token_no_default_policy bool

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    token_period int

    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]

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    token_type str

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    backend String

    The unique name of the auth backend to configure. Defaults to approle.

    bindSecretId Boolean

    Whether or not to require secret_id to be presented when logging in using this AppRole. Defaults to true.

    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.

    roleId String

    The RoleID of this role. If not specified, one will be auto-generated.

    roleName String

    The name of the role.

    secretIdBoundCidrs List<String>

    If set, specifies blocks of IP addresses which can perform the login operation.

    secretIdNumUses Number

    The number of times any particular SecretID can be used to fetch a token from this AppRole, after which the SecretID will expire. A value of zero will allow unlimited uses.

    secretIdTtl Number

    The number of seconds after which any SecretID expires.

    tokenBoundCidrs List<String>

    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

    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

    The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenNoDefaultPolicy Boolean

    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

    The maximum number of times a generated token may be used (within its lifetime); 0 means unlimited.

    tokenPeriod Number

    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>

    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

    The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

    tokenType String

    The type of token that should be generated. Can be service, batch, or default to use the mount's tuned default (which unless changed will be service tokens). For token store roles, there are two additional possibilities: default-service and default-batch which specify the type to return unless the client requests a different type at generation time.

    Import

    AppRole authentication backend roles can be imported using the path, e.g.

     $ pulumi import vault:appRole/authBackendRole:AuthBackendRole example auth/approle/role/test-role

    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 v5.17.0 published on Thursday, Nov 9, 2023 by Pulumi
    pulumi/pulumi-vault