AuthBackend

class AuthBackend : KotlinCustomResource

Provides a resource for managing an Okta auth backend within Vault.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.okta.AuthBackend("example", {
description: "Demonstration of the Terraform Okta auth backend",
organization: "example",
token: "something that should be kept secret",
groups: [{
groupName: "foo",
policies: [
"one",
"two",
],
}],
users: [{
username: "bar",
groups: ["foo"],
}],
});
import pulumi
import pulumi_vault as vault
example = vault.okta.AuthBackend("example",
description="Demonstration of the Terraform Okta auth backend",
organization="example",
token="something that should be kept secret",
groups=[{
"group_name": "foo",
"policies": [
"one",
"two",
],
}],
users=[{
"username": "bar",
"groups": ["foo"],
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var example = new Vault.Okta.AuthBackend("example", new()
{
Description = "Demonstration of the Terraform Okta auth backend",
Organization = "example",
Token = "something that should be kept secret",
Groups = new[]
{
new Vault.Okta.Inputs.AuthBackendGroupArgs
{
GroupName = "foo",
Policies = new[]
{
"one",
"two",
},
},
},
Users = new[]
{
new Vault.Okta.Inputs.AuthBackendUserArgs
{
Username = "bar",
Groups = new[]
{
"foo",
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.NewAuthBackend(ctx, "example", &okta.AuthBackendArgs{
Description: pulumi.String("Demonstration of the Terraform Okta auth backend"),
Organization: pulumi.String("example"),
Token: pulumi.String("something that should be kept secret"),
Groups: okta.AuthBackendGroupTypeArray{
&okta.AuthBackendGroupTypeArgs{
GroupName: pulumi.String("foo"),
Policies: pulumi.StringArray{
pulumi.String("one"),
pulumi.String("two"),
},
},
},
Users: okta.AuthBackendUserTypeArray{
&okta.AuthBackendUserTypeArgs{
Username: pulumi.String("bar"),
Groups: pulumi.StringArray{
pulumi.String("foo"),
},
},
},
})
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.okta.AuthBackend;
import com.pulumi.vault.okta.AuthBackendArgs;
import com.pulumi.vault.okta.inputs.AuthBackendGroupArgs;
import com.pulumi.vault.okta.inputs.AuthBackendUserArgs;
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()
.description("Demonstration of the Terraform Okta auth backend")
.organization("example")
.token("something that should be kept secret")
.groups(AuthBackendGroupArgs.builder()
.groupName("foo")
.policies(
"one",
"two")
.build())
.users(AuthBackendUserArgs.builder()
.username("bar")
.groups("foo")
.build())
.build());
}
}
resources:
example:
type: vault:okta:AuthBackend
properties:
description: Demonstration of the Terraform Okta auth backend
organization: example
token: something that should be kept secret
groups:
- groupName: foo
policies:
- one
- two
users:
- username: bar
groups:
- foo

Import

Okta authentication backends can be imported using its path, e.g.

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

Properties

Link copied to clipboard
val accessor: Output<String>

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

Link copied to clipboard
val baseUrl: Output<String>?

The Okta url. Examples: oktapreview.com, okta.com

Link copied to clipboard
val bypassOktaMfa: Output<Boolean>?

When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.

Link copied to clipboard
val description: Output<String>?

The description of the auth backend

Link copied to clipboard
val disableRemount: Output<Boolean>?

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

Link copied to clipboard

Associate Okta groups with policies within Vault. See below for more details.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val maxTtl: Output<String>?

Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

Link copied to clipboard
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.

Link copied to clipboard
val organization: Output<String>

The Okta organization. This will be the first part of the url https://XXX.okta.com

Link copied to clipboard
val path: Output<String>?

Path to mount the Okta auth backend. Default to path okta.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val token: Output<String>?

The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.

Link copied to clipboard
val tokenBoundCidrs: Output<List<String>>?

Specifies the blocks of IP addresses which are allowed to use the generated token

Link copied to clipboard
val tokenExplicitMaxTtl: Output<Int>?

Generated Token's Explicit Maximum TTL in seconds

Link copied to clipboard
val tokenMaxTtl: Output<Int>?

The maximum lifetime of the generated token

Link copied to clipboard

If true, the 'default' policy will not automatically be added to generated tokens

Link copied to clipboard
val tokenNumUses: Output<Int>?

The maximum number of times a token may be used, a value of zero means unlimited

Link copied to clipboard
val tokenPeriod: Output<Int>?

Generated Token's Period

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

Generated Token's Policies

Link copied to clipboard
val tokenTtl: Output<Int>?

The initial ttl of the token to generate in seconds

Link copied to clipboard
val tokenType: Output<String>?

The type of token to generate, service or batch

Link copied to clipboard
val ttl: Output<String>?

Duration after which authentication will be expired. See the documentation for info on valid duration formats.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val users: Output<List<AuthBackendUser>>

Associate Okta users with groups or policies within Vault. See below for more details.