» vault_token_auth_backend_role

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

» Example Usage

resource "vault_token_auth_backend_role" "example" {
  role_name           = "my-role"
  allowed_policies    = ["dev", "test"]
  disallowed_policies = ["default"]
  orphan              = true
  period              = "86400"
  renewable           = true
  explicit_max_ttl    = "115200"
  path_suffix         = "path-suffix"
}

» Argument Reference

The following arguments are supported:

  • role_name - (Required) The name of the role.

  • allowed_policies (Optional) List of allowed policies for given role.

  • disallowed_policies (Optional) List of disallowed policies for given role.

  • orphan (Optional) If true, tokens created against this policy will be orphan tokens.

  • renewable (Optional) Wether to disable the ability of the token to be renewed past its initial TTL.

  • path_suffix (Optional) Tokens created against this role will have the given suffix as part of their path in addition to the role name.

» Common Token Arguments

These arguments are common across several Authentication Token resources since Vault 1.2.

  • token_ttl - (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_max_ttl - (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.

  • token_policies - (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.

  • token_bound_cidrs - (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.

  • token_explicit_max_ttl - (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if token_ttl and token_max_ttl would otherwise allow a renewal.

  • token_no_default_policy - (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

  • token_num_uses - (Optional) The period, if any, in number of seconds to set on the token.

  • token_type - (Optional) 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.

» Deprecated Arguments

These arguments are deprecated since Vault 1.2 in favour of the common token arguments documented above.

  • explicit_max_ttl (Optional; Deprecated, use token_explicit_max_ttl instead) If set, the token will have an explicit max TTL set upon it.

  • period - (Optional; Deprecated, use token_period instead) 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. The maximum allowed lifetime of token issued using this role. Specified as a number of seconds.

  • bound_cidrs - (Optional; Deprecated, use token_bound_cidrs instead) If set, a list of CIDRs valid as the source address for login requests. This value is also encoded into any resulting token.

» Attributes Reference

No additional attributes are exported by this resource.

» Import

Token auth backend roles can be imported with auth/token/roles/ followed by the role_name, e.g.

$ terraform import vault_token_auth_backend_role.example auth/token/roles/my-role