Class AuthBackend

Inheritance

System.Object

Resource

CustomResource

AuthBackend

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Vault.Jwt

Assembly: Pulumi.Vault.dll

Syntax

public class AuthBackend : CustomResource

Constructors

AuthBackend(String, AuthBackendArgs, CustomResourceOptions)

Create a AuthBackend resource with the given unique name, arguments, and options.

Declaration

public AuthBackend(string name, AuthBackendArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthBackendArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Accessor

The accessor of the JWT auth backend

Declaration

public Output<string> Accessor { get; }

Property Value

Type	Description
Output<System.String>

BoundIssuer

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

Declaration

public Output<string> BoundIssuer { get; }

Property Value

Type	Description
Output<System.String>

DefaultRole

The default role to use if none is provided during login

Declaration

public Output<string> DefaultRole { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the auth backend

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

JwksCaPem

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.

Declaration

public Output<string> JwksCaPem { get; }

Property Value

Type	Description
Output<System.String>

JwksUrl

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

Declaration

public Output<string> JwksUrl { get; }

Property Value

Type	Description
Output<System.String>

JwtSupportedAlgs

A list of supported signing algorithms. Vault 1.1.0 defaults to [RS256] but future or past versions of Vault may differ

Declaration

public Output<ImmutableArray<string>> JwtSupportedAlgs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

JwtValidationPubkeys

A list of PEM-encoded public keys to use to authenticate signatures locally. Cannot be used in combination with oidc_discovery_url

Declaration

public Output<ImmutableArray<string>> JwtValidationPubkeys { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

OidcClientId

Client ID used for OIDC backends

Declaration

public Output<string> OidcClientId { get; }

Property Value

Type	Description
Output<System.String>

OidcClientSecret

Client Secret used for OIDC backends

Declaration

public Output<string> OidcClientSecret { get; }

Property Value

Type	Description
Output<System.String>

OidcDiscoveryCaPem

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

Declaration

public Output<string> OidcDiscoveryCaPem { get; }

Property Value

Type	Description
Output<System.String>

OidcDiscoveryUrl

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

Declaration

public Output<string> OidcDiscoveryUrl { get; }

Property Value

Type	Description
Output<System.String>

Path

Path to mount the JWT/OIDC auth backend

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

Tune

Declaration

public Output<AuthBackendTune> Tune { get; }

Property Value

Type	Description
Output<AuthBackendTune>

Type

Type of auth backend. Should be one of jwt or oidc. Default - jwt

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthBackendState, CustomResourceOptions)

Get an existing AuthBackend resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AuthBackend Get(string name, Input<string> id, AuthBackendState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthBackendState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthBackend