pulumi-vault-kotlin/com.pulumi.vault.github.kotlin/AuthBackend

AuthBackend

class AuthBackend : KotlinCustomResource

Manages a GitHub Auth mount in a Vault server. See the [Vault

documentation](https://www.vaultproject.io/docs/auth/github/) for more information.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.github.AuthBackend("example", {organization: "myorg"});

import pulumi
import pulumi_vault as vault
example = vault.github.AuthBackend("example", organization="myorg")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
    var example = new Vault.GitHub.AuthBackend("example", new()
    {
        Organization = "myorg",
    });
});

package main
import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.NewAuthBackend(ctx, "example", &github.AuthBackendArgs{
			Organization: pulumi.String("myorg"),
		})
		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.github.AuthBackend;
import com.pulumi.vault.github.AuthBackendArgs;
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 example = new AuthBackend("example", AuthBackendArgs.builder()
            .organization("myorg")
            .build());
    }
}

resources:
  example:
    type: vault:github:AuthBackend
    properties:
      organization: myorg

Import

GitHub authentication mounts can be imported using the path, e.g.

$ pulumi import vault:github/authBackend:AuthBackend example github

Properties

accessor

val accessor: Output<String>

The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.

baseUrl

val baseUrl: Output<String>?

The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.

description

val description: Output<String>?

Specifies the description of the mount. This overrides the current stored value, if any.

disableRemount

val disableRemount: Output<Boolean>?

If set, opts out of mount migration on path updates. See here for more info on Mount Migration

val id: Output<String>

namespace

val namespace: Output<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.

organization

val organization: Output<String>

The organization configured users must be part of.

organizationId

val organizationId: Output<Int>

The ID of the organization users must be part of. Vault will attempt to fetch and set this value if it is not provided. (Vault 1.10+)

path

val path: Output<String>?

Path where the auth backend is mounted. Defaults to auth/github if not specified.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

tokenBoundCidrs

val tokenBoundCidrs: Output<List<String>>?

(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.

tokenExplicitMaxTtl

val tokenExplicitMaxTtl: Output<Int>?

(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.

tokenMaxTtl

val tokenMaxTtl: Output<Int>?

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

tokenNoDefaultPolicy

val tokenNoDefaultPolicy: Output<Boolean>?

(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.

tokenNumUses

val tokenNumUses: Output<Int>?

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

tokenPeriod

val tokenPeriod: Output<Int>?

(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.

tokenPolicies

val tokenPolicies: Output<List<String>>?

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

tokenTtl

val tokenTtl: Output<Int>?

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

tokenType

val tokenType: Output<String>?

Specifies the type of tokens that should be returned by the mount. Valid values are "default-service", "default-batch", "service", "batch".

tune

val tune: Output<AuthBackendTune>

Extra configuration block. Structure is documented below. The tune block is used to tune the auth backend:

urn

val urn: Output<String>