GetAuthBackendRolePlainArgs

data class GetAuthBackendRolePlainArgs(val audience: String? = null, val backend: String? = null, val namespace: String? = null, val roleName: String, val tokenBoundCidrs: List<String>? = null, val tokenExplicitMaxTtl: Int? = null, val tokenMaxTtl: Int? = null, val tokenNoDefaultPolicy: Boolean? = null, val tokenNumUses: Int? = null, val tokenPeriod: Int? = null, val tokenPolicies: List<String>? = null, val tokenTtl: Int? = null, val tokenType: String? = null) : ConvertibleToJava<GetAuthBackendRolePlainArgs>

A collection of arguments for invoking getAuthBackendRole.

Constructors

Link copied to clipboard
constructor(audience: String? = null, backend: String? = null, namespace: String? = null, roleName: String, tokenBoundCidrs: List<String>? = null, tokenExplicitMaxTtl: Int? = null, tokenMaxTtl: Int? = null, tokenNoDefaultPolicy: Boolean? = null, tokenNumUses: Int? = null, tokenPeriod: Int? = null, tokenPolicies: List<String>? = null, tokenTtl: Int? = null, tokenType: String? = null)

Properties

Link copied to clipboard
val audience: String? = null

Audience claim to verify in the JWT.

Link copied to clipboard
val backend: String? = null

The unique name for the Kubernetes backend the role to retrieve Role attributes for resides in. Defaults to "kubernetes".

Link copied to clipboard
val namespace: String? = null

The namespace of the target resource. 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.

Link copied to clipboard

The name of the role to retrieve the Role attributes for.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val tokenMaxTtl: Int? = null

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

Link copied to clipboard

If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.

Link copied to clipboard
val tokenNumUses: Int? = null

The period, if any, in number of seconds to set on the token.

Link copied to clipboard
val tokenPeriod: Int? = null

(Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token's TTL will be set to the value of this field. Specified in seconds.

Link copied to clipboard
val tokenPolicies: List<String>? = null

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

Link copied to clipboard
val tokenTtl: Int? = null

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

Link copied to clipboard
val tokenType: String? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): GetAuthBackendRolePlainArgs