Skip to content

Latest commit

 

History

History
2583 lines (1623 loc) · 107 KB

jwtAuthBackend.csharp.md

File metadata and controls

2583 lines (1623 loc) · 107 KB
Raw

jwtAuthBackend Submodule

Constructs

JwtAuthBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend vault_jwt_auth_backend}.

Initializers 

using HashiCorp.Cdktf.Providers.Vault;

new JwtAuthBackend(Construct Scope, string Id, JwtAuthBackendConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config JwtAuthBackendConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigOptional

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutTune No description.
ResetBoundIssuer No description.
ResetDefaultRole No description.
ResetDescription No description.
ResetDisableRemount No description.
ResetId No description.
ResetJwksCaPem No description.
ResetJwksUrl No description.
ResetJwtSupportedAlgs No description.
ResetJwtValidationPubkeys No description.
ResetLocal No description.
ResetNamespace No description.
ResetNamespaceInState No description.
ResetOidcClientId No description.
ResetOidcClientSecret No description.
ResetOidcDiscoveryCaPem No description.
ResetOidcDiscoveryUrl No description.
ResetOidcResponseMode No description.
ResetOidcResponseTypes No description.
ResetPath No description.
ResetProviderConfig No description.
ResetTune No description.
ResetType No description.
ToString 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget 
private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
HasResourceMove 
private object HasResourceMove()
ImportFrom 
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string
ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
MoveFromId 
private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

IdRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

IndexOptional
  • Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

IdRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

PutTune 
private void PutTune(object Value)
ValueRequired
  • Type: object
ResetBoundIssuer 
private void ResetBoundIssuer()
ResetDefaultRole 
private void ResetDefaultRole()
ResetDescription 
private void ResetDescription()
ResetDisableRemount 
private void ResetDisableRemount()
ResetId 
private void ResetId()
ResetJwksCaPem 
private void ResetJwksCaPem()
ResetJwksUrl 
private void ResetJwksUrl()
ResetJwtSupportedAlgs 
private void ResetJwtSupportedAlgs()
ResetJwtValidationPubkeys 
private void ResetJwtValidationPubkeys()
ResetLocal 
private void ResetLocal()
ResetNamespace 
private void ResetNamespace()
ResetNamespaceInState 
private void ResetNamespaceInState()
ResetOidcClientId 
private void ResetOidcClientId()
ResetOidcClientSecret 
private void ResetOidcClientSecret()
ResetOidcDiscoveryCaPem 
private void ResetOidcDiscoveryCaPem()
ResetOidcDiscoveryUrl 
private void ResetOidcDiscoveryUrl()
ResetOidcResponseMode 
private void ResetOidcResponseMode()
ResetOidcResponseTypes 
private void ResetOidcResponseTypes()
ResetPath 
private void ResetPath()
ResetProviderConfig 
private void ResetProviderConfig()
ResetTune 
private void ResetTune()
ResetType 
private void ResetType()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a JwtAuthBackend resource upon running "cdktf plan ".
IsConstruct 
using HashiCorp.Cdktf.Providers.Vault;

JwtAuthBackend.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Vault;

JwtAuthBackend.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformResource 
using HashiCorp.Cdktf.Providers.Vault;

JwtAuthBackend.IsTerraformResource(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Vault;

JwtAuthBackend.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a JwtAuthBackend resource upon running "cdktf plan ".

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

The construct id used in the generated config for the JwtAuthBackend to import.

ImportFromIdRequired
  • Type: string

The id of the existing JwtAuthBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#import import section} in the documentation of this resource for the id to use

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the JwtAuthBackend to import is found.

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Accessor string No description.
Tune JwtAuthBackendTuneList No description.
BoundIssuerInput string No description.
DefaultRoleInput string No description.
DescriptionInput string No description.
DisableRemountInput object No description.
IdInput string No description.
JwksCaPemInput string No description.
JwksUrlInput string No description.
JwtSupportedAlgsInput string[] No description.
JwtValidationPubkeysInput string[] No description.
LocalInput object No description.
NamespaceInput string No description.
NamespaceInStateInput object No description.
OidcClientIdInput string No description.
OidcClientSecretInput string No description.
OidcDiscoveryCaPemInput string No description.
OidcDiscoveryUrlInput string No description.
OidcResponseModeInput string No description.
OidcResponseTypesInput string[] No description.
PathInput string No description.
ProviderConfigInput System.Collections.Generic.IDictionary<string, string> No description.
TuneInput object No description.
TypeInput string No description.
BoundIssuer string No description.
DefaultRole string No description.
Description string No description.
DisableRemount object No description.
Id string No description.
JwksCaPem string No description.
JwksUrl string No description.
JwtSupportedAlgs string[] No description.
JwtValidationPubkeys string[] No description.
Local object No description.
Namespace string No description.
NamespaceInState object No description.
OidcClientId string No description.
OidcClientSecret string No description.
OidcDiscoveryCaPem string No description.
OidcDiscoveryUrl string No description.
OidcResponseMode string No description.
OidcResponseTypes string[] No description.
Path string No description.
ProviderConfig System.Collections.Generic.IDictionary<string, string> No description.
Type string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
TerraformMetaArgumentsRequired 
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
public object Connection { get; }
  • Type: object
CountOptional 
public object Count { get; }
  • Type: object
DependsOnOptional 
public string[] DependsOn { get; }
  • Type: string[]
ForEachOptional 
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; }
  • Type: object[]
AccessorRequired 
public string Accessor { get; }
  • Type: string
TuneRequired 
public JwtAuthBackendTuneList Tune { get; }
BoundIssuerInputOptional 
public string BoundIssuerInput { get; }
  • Type: string
DefaultRoleInputOptional 
public string DefaultRoleInput { get; }
  • Type: string
DescriptionInputOptional 
public string DescriptionInput { get; }
  • Type: string
DisableRemountInputOptional 
public object DisableRemountInput { get; }
  • Type: object
IdInputOptional 
public string IdInput { get; }
  • Type: string
JwksCaPemInputOptional 
public string JwksCaPemInput { get; }
  • Type: string
JwksUrlInputOptional 
public string JwksUrlInput { get; }
  • Type: string
JwtSupportedAlgsInputOptional 
public string[] JwtSupportedAlgsInput { get; }
  • Type: string[]
JwtValidationPubkeysInputOptional 
public string[] JwtValidationPubkeysInput { get; }
  • Type: string[]
LocalInputOptional 
public object LocalInput { get; }
  • Type: object
NamespaceInputOptional 
public string NamespaceInput { get; }
  • Type: string
NamespaceInStateInputOptional 
public object NamespaceInStateInput { get; }
  • Type: object
OidcClientIdInputOptional 
public string OidcClientIdInput { get; }
  • Type: string
OidcClientSecretInputOptional 
public string OidcClientSecretInput { get; }
  • Type: string
OidcDiscoveryCaPemInputOptional 
public string OidcDiscoveryCaPemInput { get; }
  • Type: string
OidcDiscoveryUrlInputOptional 
public string OidcDiscoveryUrlInput { get; }
  • Type: string
OidcResponseModeInputOptional 
public string OidcResponseModeInput { get; }
  • Type: string
OidcResponseTypesInputOptional 
public string[] OidcResponseTypesInput { get; }
  • Type: string[]
PathInputOptional 
public string PathInput { get; }
  • Type: string
ProviderConfigInputOptional 
public System.Collections.Generic.IDictionary<string, string> ProviderConfigInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
TuneInputOptional 
public object TuneInput { get; }
  • Type: object
TypeInputOptional 
public string TypeInput { get; }
  • Type: string
BoundIssuerRequired 
public string BoundIssuer { get; }
  • Type: string
DefaultRoleRequired 
public string DefaultRole { get; }
  • Type: string
DescriptionRequired 
public string Description { get; }
  • Type: string
DisableRemountRequired 
public object DisableRemount { get; }
  • Type: object
IdRequired 
public string Id { get; }
  • Type: string
JwksCaPemRequired 
public string JwksCaPem { get; }
  • Type: string
JwksUrlRequired 
public string JwksUrl { get; }
  • Type: string
JwtSupportedAlgsRequired 
public string[] JwtSupportedAlgs { get; }
  • Type: string[]
JwtValidationPubkeysRequired 
public string[] JwtValidationPubkeys { get; }
  • Type: string[]
LocalRequired 
public object Local { get; }
  • Type: object
NamespaceRequired 
public string Namespace { get; }
  • Type: string
NamespaceInStateRequired 
public object NamespaceInState { get; }
  • Type: object
OidcClientIdRequired 
public string OidcClientId { get; }
  • Type: string
OidcClientSecretRequired 
public string OidcClientSecret { get; }
  • Type: string
OidcDiscoveryCaPemRequired 
public string OidcDiscoveryCaPem { get; }
  • Type: string
OidcDiscoveryUrlRequired 
public string OidcDiscoveryUrl { get; }
  • Type: string
OidcResponseModeRequired 
public string OidcResponseMode { get; }
  • Type: string
OidcResponseTypesRequired 
public string[] OidcResponseTypes { get; }
  • Type: string[]
PathRequired 
public string Path { get; }
  • Type: string
ProviderConfigRequired 
public System.Collections.Generic.IDictionary<string, string> ProviderConfig { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>
TypeRequired 
public string Type { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

JwtAuthBackendConfig

Initializer 

using HashiCorp.Cdktf.Providers.Vault;

new JwtAuthBackendConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string BoundIssuer = null,
    string DefaultRole = null,
    string Description = null,
    object DisableRemount = null,
    string Id = null,
    string JwksCaPem = null,
    string JwksUrl = null,
    string[] JwtSupportedAlgs = null,
    string[] JwtValidationPubkeys = null,
    object Local = null,
    string Namespace = null,
    object NamespaceInState = null,
    string OidcClientId = null,
    string OidcClientSecret = null,
    string OidcDiscoveryCaPem = null,
    string OidcDiscoveryUrl = null,
    string OidcResponseMode = null,
    string[] OidcResponseTypes = null,
    string Path = null,
    System.Collections.Generic.IDictionary<string, string> ProviderConfig = null,
    object Tune = null,
    string Type = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
BoundIssuer string The value against which to match the iss claim in a JWT.
DefaultRole string The default role to use if none is provided during login.
Description string The description of the auth backend.
DisableRemount object If set, opts out of mount migration on path updates.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#id JwtAuthBackend#id}.
JwksCaPem string The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.
JwksUrl string JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.
JwtSupportedAlgs string[] A list of supported signing algorithms. Defaults to [RS256].
JwtValidationPubkeys string[] A list of PEM-encoded public keys to use to authenticate signatures locally.
Local object Specifies if the auth method is local only.
Namespace string Target namespace. (requires Enterprise).
NamespaceInState object Pass namespace in the OIDC state parameter instead of as a separate query parameter.
OidcClientId string Client ID used for OIDC.
OidcClientSecret string Client Secret used for OIDC.
OidcDiscoveryCaPem string The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.
OidcDiscoveryUrl string The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.
OidcResponseMode string The response mode to be used in the OAuth2 request.
OidcResponseTypes string[] The response types to request.
Path string path to mount the backend.
ProviderConfig System.Collections.Generic.IDictionary<string, string> Provider specific handling configuration.
Tune object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.
Type string Type of backend. Can be either 'jwt' or 'oidc'.
ConnectionOptional 
public object Connection { get; set; }
  • Type: object
CountOptional 
public object Count { get; set; }
  • Type: object
DependsOnOptional 
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]
ForEachOptional 
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator
LifecycleOptional 
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle
ProviderOptional 
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider
ProvisionersOptional 
public object[] Provisioners { get; set; }
  • Type: object[]
BoundIssuerOptional 
public string BoundIssuer { get; set; }
  • Type: string

The value against which to match the iss claim in a JWT.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#bound_issuer JwtAuthBackend#bound_issuer}

DefaultRoleOptional 
public string DefaultRole { get; set; }
  • Type: string

The default role to use if none is provided during login.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#default_role JwtAuthBackend#default_role}

DescriptionOptional 
public string Description { get; set; }
  • Type: string

The description of the auth backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#description JwtAuthBackend#description}

DisableRemountOptional 
public object DisableRemount { get; set; }
  • Type: object

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#disable_remount JwtAuthBackend#disable_remount}

IdOptional 
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#id JwtAuthBackend#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

JwksCaPemOptional 
public string JwksCaPem { get; set; }
  • Type: string

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the JWKS URL.

If not set, system certificates are used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#jwks_ca_pem JwtAuthBackend#jwks_ca_pem}

JwksUrlOptional 
public string JwksUrl { get; set; }
  • Type: string

JWKS URL to use to authenticate signatures. Cannot be used with 'oidc_discovery_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#jwks_url JwtAuthBackend#jwks_url}

JwtSupportedAlgsOptional 
public string[] JwtSupportedAlgs { get; set; }
  • Type: string[]

A list of supported signing algorithms. Defaults to [RS256].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#jwt_supported_algs JwtAuthBackend#jwt_supported_algs}

JwtValidationPubkeysOptional 
public string[] JwtValidationPubkeys { get; set; }
  • Type: string[]

A list of PEM-encoded public keys to use to authenticate signatures locally.

Cannot be used with 'jwks_url' or 'oidc_discovery_url'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#jwt_validation_pubkeys JwtAuthBackend#jwt_validation_pubkeys}

LocalOptional 
public object Local { get; set; }
  • Type: object

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#local JwtAuthBackend#local}

NamespaceOptional 
public string Namespace { get; set; }
  • Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#namespace JwtAuthBackend#namespace}

NamespaceInStateOptional 
public object NamespaceInState { get; set; }
  • Type: object

Pass namespace in the OIDC state parameter instead of as a separate query parameter.

With this setting, the allowed redirect URL(s) in Vault and on the provider side should not contain a namespace query parameter. This means only one redirect URL entry needs to be maintained on the OIDC provider side for all vault namespaces that will be authenticating against it. Defaults to true for new configs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#namespace_in_state JwtAuthBackend#namespace_in_state}

OidcClientIdOptional 
public string OidcClientId { get; set; }
  • Type: string

Client ID used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_client_id JwtAuthBackend#oidc_client_id}

OidcClientSecretOptional 
public string OidcClientSecret { get; set; }
  • Type: string

Client Secret used for OIDC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_client_secret JwtAuthBackend#oidc_client_secret}

OidcDiscoveryCaPemOptional 
public string OidcDiscoveryCaPem { get; set; }
  • Type: string

The CA certificate or chain of certificates, in PEM format, to use to validate connections to the OIDC Discovery URL.

If not set, system certificates are used

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_discovery_ca_pem JwtAuthBackend#oidc_discovery_ca_pem}

OidcDiscoveryUrlOptional 
public string OidcDiscoveryUrl { get; set; }
  • Type: string

The OIDC Discovery URL, without any .well-known component (base path). Cannot be used with 'jwks_url' or 'jwt_validation_pubkeys'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_discovery_url JwtAuthBackend#oidc_discovery_url}

OidcResponseModeOptional 
public string OidcResponseMode { get; set; }
  • Type: string

The response mode to be used in the OAuth2 request.

Allowed values are 'query' and 'form_post'. Defaults to 'query'. If using Vault namespaces, and oidc_response_mode is 'form_post', then 'namespace_in_state' should be set to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_response_mode JwtAuthBackend#oidc_response_mode}

OidcResponseTypesOptional 
public string[] OidcResponseTypes { get; set; }
  • Type: string[]

The response types to request.

Allowed values are 'code' and 'id_token'. Defaults to 'code'. Note: 'id_token' may only be used if 'oidc_response_mode' is set to 'form_post'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#oidc_response_types JwtAuthBackend#oidc_response_types}

PathOptional 
public string Path { get; set; }
  • Type: string

path to mount the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#path JwtAuthBackend#path}

ProviderConfigOptional 
public System.Collections.Generic.IDictionary<string, string> ProviderConfig { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Provider specific handling configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#provider_config JwtAuthBackend#provider_config}

TuneOptional 
public object Tune { get; set; }
  • Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#tune JwtAuthBackend#tune}.

TypeOptional 
public string Type { get; set; }
  • Type: string

Type of backend. Can be either 'jwt' or 'oidc'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#type JwtAuthBackend#type}

JwtAuthBackendTune

Initializer 

using HashiCorp.Cdktf.Providers.Vault;

new JwtAuthBackendTune {
    string[] AllowedResponseHeaders = null,
    string[] AuditNonHmacRequestKeys = null,
    string[] AuditNonHmacResponseKeys = null,
    string DefaultLeaseTtl = null,
    string ListingVisibility = null,
    string MaxLeaseTtl = null,
    string[] PassthroughRequestHeaders = null,
    string TokenType = null
};

Properties

Name Type Description
AllowedResponseHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#allowed_response_headers JwtAuthBackend#allowed_response_headers}.
AuditNonHmacRequestKeys string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#audit_non_hmac_request_keys JwtAuthBackend#audit_non_hmac_request_keys}.
AuditNonHmacResponseKeys string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#audit_non_hmac_response_keys JwtAuthBackend#audit_non_hmac_response_keys}.
DefaultLeaseTtl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#default_lease_ttl JwtAuthBackend#default_lease_ttl}.
ListingVisibility string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#listing_visibility JwtAuthBackend#listing_visibility}.
MaxLeaseTtl string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#max_lease_ttl JwtAuthBackend#max_lease_ttl}.
PassthroughRequestHeaders string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#passthrough_request_headers JwtAuthBackend#passthrough_request_headers}.
TokenType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#token_type JwtAuthBackend#token_type}.
AllowedResponseHeadersOptional 
public string[] AllowedResponseHeaders { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#allowed_response_headers JwtAuthBackend#allowed_response_headers}.

AuditNonHmacRequestKeysOptional 
public string[] AuditNonHmacRequestKeys { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#audit_non_hmac_request_keys JwtAuthBackend#audit_non_hmac_request_keys}.

AuditNonHmacResponseKeysOptional 
public string[] AuditNonHmacResponseKeys { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#audit_non_hmac_response_keys JwtAuthBackend#audit_non_hmac_response_keys}.

DefaultLeaseTtlOptional 
public string DefaultLeaseTtl { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#default_lease_ttl JwtAuthBackend#default_lease_ttl}.

ListingVisibilityOptional 
public string ListingVisibility { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#listing_visibility JwtAuthBackend#listing_visibility}.

MaxLeaseTtlOptional 
public string MaxLeaseTtl { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#max_lease_ttl JwtAuthBackend#max_lease_ttl}.

PassthroughRequestHeadersOptional 
public string[] PassthroughRequestHeaders { get; set; }
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#passthrough_request_headers JwtAuthBackend#passthrough_request_headers}.

TokenTypeOptional 
public string TokenType { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/jwt_auth_backend#token_type JwtAuthBackend#token_type}.

Classes

JwtAuthBackendTuneList

Initializers 

using HashiCorp.Cdktf.Providers.Vault;

new JwtAuthBackendTuneList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

WrapsSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.
AllWithMapKey 
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

MapKeyAttributeNameRequired
  • Type: string
ComputeFqn 
private string ComputeFqn()
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
private JwtAuthBackendTuneOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
public string Fqn { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object

JwtAuthBackendTuneOutputReference

Initializers 

using HashiCorp.Cdktf.Providers.Vault;

new JwtAuthBackendTuneOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.

TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.

ComplexObjectIsFromSetRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetAllowedResponseHeaders No description.
ResetAuditNonHmacRequestKeys No description.
ResetAuditNonHmacResponseKeys No description.
ResetDefaultLeaseTtl No description.
ResetListingVisibility No description.
ResetMaxLeaseTtl No description.
ResetPassthroughRequestHeaders No description.
ResetTokenType No description.
ComputeFqn 
private string ComputeFqn()
GetAnyMapAttribute 
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanAttribute 
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetBooleanMapAttribute 
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetListAttribute 
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberAttribute 
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberListAttribute 
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetNumberMapAttribute 
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringAttribute 
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
GetStringMapAttribute 
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string
InterpolationForAttribute 
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string
Resolve 
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext
ToString 
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetAllowedResponseHeaders 
private void ResetAllowedResponseHeaders()
ResetAuditNonHmacRequestKeys 
private void ResetAuditNonHmacRequestKeys()
ResetAuditNonHmacResponseKeys 
private void ResetAuditNonHmacResponseKeys()
ResetDefaultLeaseTtl 
private void ResetDefaultLeaseTtl()
ResetListingVisibility 
private void ResetListingVisibility()
ResetMaxLeaseTtl 
private void ResetMaxLeaseTtl()
ResetPassthroughRequestHeaders 
private void ResetPassthroughRequestHeaders()
ResetTokenType 
private void ResetTokenType()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
AllowedResponseHeadersInput string[] No description.
AuditNonHmacRequestKeysInput string[] No description.
AuditNonHmacResponseKeysInput string[] No description.
DefaultLeaseTtlInput string No description.
ListingVisibilityInput string No description.
MaxLeaseTtlInput string No description.
PassthroughRequestHeadersInput string[] No description.
TokenTypeInput string No description.
AllowedResponseHeaders string[] No description.
AuditNonHmacRequestKeys string[] No description.
AuditNonHmacResponseKeys string[] No description.
DefaultLeaseTtl string No description.
ListingVisibility string No description.
MaxLeaseTtl string No description.
PassthroughRequestHeaders string[] No description.
TokenType string No description.
InternalValue object No description.
CreationStackRequired 
public string[] CreationStack { get; }
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

FqnRequired 
public string Fqn { get; }
  • Type: string
AllowedResponseHeadersInputOptional 
public string[] AllowedResponseHeadersInput { get; }
  • Type: string[]
AuditNonHmacRequestKeysInputOptional 
public string[] AuditNonHmacRequestKeysInput { get; }
  • Type: string[]
AuditNonHmacResponseKeysInputOptional 
public string[] AuditNonHmacResponseKeysInput { get; }
  • Type: string[]
DefaultLeaseTtlInputOptional 
public string DefaultLeaseTtlInput { get; }
  • Type: string
ListingVisibilityInputOptional 
public string ListingVisibilityInput { get; }
  • Type: string
MaxLeaseTtlInputOptional 
public string MaxLeaseTtlInput { get; }
  • Type: string
PassthroughRequestHeadersInputOptional 
public string[] PassthroughRequestHeadersInput { get; }
  • Type: string[]
TokenTypeInputOptional 
public string TokenTypeInput { get; }
  • Type: string
AllowedResponseHeadersRequired 
public string[] AllowedResponseHeaders { get; }
  • Type: string[]
AuditNonHmacRequestKeysRequired 
public string[] AuditNonHmacRequestKeys { get; }
  • Type: string[]
AuditNonHmacResponseKeysRequired 
public string[] AuditNonHmacResponseKeys { get; }
  • Type: string[]
DefaultLeaseTtlRequired 
public string DefaultLeaseTtl { get; }
  • Type: string
ListingVisibilityRequired 
public string ListingVisibility { get; }
  • Type: string
MaxLeaseTtlRequired 
public string MaxLeaseTtl { get; }
  • Type: string
PassthroughRequestHeadersRequired 
public string[] PassthroughRequestHeaders { get; }
  • Type: string[]
TokenTypeRequired 
public string TokenType { get; }
  • Type: string
InternalValueOptional 
public object InternalValue { get; }
  • Type: object