Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pulumi Vault Provider
  3. API Docs
  4. okta
  5. AuthBackend
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

vault.okta.AuthBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-vault

    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"],
    }])

    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
	})
}

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

    Create AuthBackend Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
    @overload
def AuthBackend(resource_name: str,
                args: AuthBackendArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                organization: Optional[str] = None,
                token_bound_cidrs: Optional[Sequence[str]] = None,
                token_type: Optional[str] = None,
                disable_remount: Optional[bool] = None,
                groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
                max_ttl: Optional[str] = None,
                namespace: Optional[str] = None,
                bypass_okta_mfa: Optional[bool] = None,
                token_explicit_max_ttl: Optional[int] = None,
                users: Optional[Sequence[AuthBackendUserArgs]] = None,
                description: Optional[str] = None,
                path: Optional[str] = None,
                token_max_ttl: Optional[int] = None,
                token_no_default_policy: Optional[bool] = None,
                token_num_uses: Optional[int] = None,
                token_period: Optional[int] = None,
                token_policies: Optional[Sequence[str]] = None,
                token_ttl: Optional[int] = None,
                base_url: Optional[str] = None,
                ttl: Optional[str] = None,
                token: Optional[str] = None)
    func NewAuthBackend(ctx *Context, name string, args AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)
    public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions? opts = null)
    public AuthBackend(String name, AuthBackendArgs args)
public AuthBackend(String name, AuthBackendArgs args, CustomResourceOptions options)

    type: vault:okta:AuthBackend
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AuthBackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthBackendArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthBackendArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthBackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthBackendArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleauthBackendResourceResourceFromOktaauthBackend = new Vault.Okta.AuthBackend("exampleauthBackendResourceResourceFromOktaauthBackend", new()
{
    Organization = "string",
    TokenBoundCidrs = new[]
    {
        "string",
    },
    TokenType = "string",
    DisableRemount = false,
    Groups = new[]
    {
        new Vault.Okta.Inputs.AuthBackendGroupArgs
        {
            GroupName = "string",
            Policies = new[]
            {
                "string",
            },
        },
    },
    Namespace = "string",
    BypassOktaMfa = false,
    TokenExplicitMaxTtl = 0,
    Users = new[]
    {
        new Vault.Okta.Inputs.AuthBackendUserArgs
        {
            Username = "string",
            Groups = new[]
            {
                "string",
            },
            Policies = new[]
            {
                "string",
            },
        },
    },
    Description = "string",
    Path = "string",
    TokenMaxTtl = 0,
    TokenNoDefaultPolicy = false,
    TokenNumUses = 0,
    TokenPeriod = 0,
    TokenPolicies = new[]
    {
        "string",
    },
    TokenTtl = 0,
    BaseUrl = "string",
    Token = "string",
});

    example, err := okta.NewAuthBackend(ctx, "exampleauthBackendResourceResourceFromOktaauthBackend", &okta.AuthBackendArgs{
	Organization: pulumi.String("string"),
	TokenBoundCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenType:      pulumi.String("string"),
	DisableRemount: pulumi.Bool(false),
	Groups: okta.AuthBackendGroupTypeArray{
		&okta.AuthBackendGroupTypeArgs{
			GroupName: pulumi.String("string"),
			Policies: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Namespace:           pulumi.String("string"),
	BypassOktaMfa:       pulumi.Bool(false),
	TokenExplicitMaxTtl: pulumi.Int(0),
	Users: okta.AuthBackendUserTypeArray{
		&okta.AuthBackendUserTypeArgs{
			Username: pulumi.String("string"),
			Groups: pulumi.StringArray{
				pulumi.String("string"),
			},
			Policies: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Description:          pulumi.String("string"),
	Path:                 pulumi.String("string"),
	TokenMaxTtl:          pulumi.Int(0),
	TokenNoDefaultPolicy: pulumi.Bool(false),
	TokenNumUses:         pulumi.Int(0),
	TokenPeriod:          pulumi.Int(0),
	TokenPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	TokenTtl: pulumi.Int(0),
	BaseUrl:  pulumi.String("string"),
	Token:    pulumi.String("string"),
})

    var exampleauthBackendResourceResourceFromOktaauthBackend = new AuthBackend("exampleauthBackendResourceResourceFromOktaauthBackend", AuthBackendArgs.builder()
    .organization("string")
    .tokenBoundCidrs("string")
    .tokenType("string")
    .disableRemount(false)
    .groups(AuthBackendGroupArgs.builder()
        .groupName("string")
        .policies("string")
        .build())
    .namespace("string")
    .bypassOktaMfa(false)
    .tokenExplicitMaxTtl(0)
    .users(AuthBackendUserArgs.builder()
        .username("string")
        .groups("string")
        .policies("string")
        .build())
    .description("string")
    .path("string")
    .tokenMaxTtl(0)
    .tokenNoDefaultPolicy(false)
    .tokenNumUses(0)
    .tokenPeriod(0)
    .tokenPolicies("string")
    .tokenTtl(0)
    .baseUrl("string")
    .token("string")
    .build());

    exampleauth_backend_resource_resource_from_oktaauth_backend = vault.okta.AuthBackend("exampleauthBackendResourceResourceFromOktaauthBackend",
    organization="string",
    token_bound_cidrs=["string"],
    token_type="string",
    disable_remount=False,
    groups=[{
        "group_name": "string",
        "policies": ["string"],
    }],
    namespace="string",
    bypass_okta_mfa=False,
    token_explicit_max_ttl=0,
    users=[{
        "username": "string",
        "groups": ["string"],
        "policies": ["string"],
    }],
    description="string",
    path="string",
    token_max_ttl=0,
    token_no_default_policy=False,
    token_num_uses=0,
    token_period=0,
    token_policies=["string"],
    token_ttl=0,
    base_url="string",
    token="string")

    const exampleauthBackendResourceResourceFromOktaauthBackend = new vault.okta.AuthBackend("exampleauthBackendResourceResourceFromOktaauthBackend", {
    organization: "string",
    tokenBoundCidrs: ["string"],
    tokenType: "string",
    disableRemount: false,
    groups: [{
        groupName: "string",
        policies: ["string"],
    }],
    namespace: "string",
    bypassOktaMfa: false,
    tokenExplicitMaxTtl: 0,
    users: [{
        username: "string",
        groups: ["string"],
        policies: ["string"],
    }],
    description: "string",
    path: "string",
    tokenMaxTtl: 0,
    tokenNoDefaultPolicy: false,
    tokenNumUses: 0,
    tokenPeriod: 0,
    tokenPolicies: ["string"],
    tokenTtl: 0,
    baseUrl: "string",
    token: "string",
});

    type: vault:okta:AuthBackend
properties:
    baseUrl: string
    bypassOktaMfa: false
    description: string
    disableRemount: false
    groups:
        - groupName: string
          policies:
            - string
    namespace: string
    organization: string
    path: string
    token: string
    tokenBoundCidrs:
        - string
    tokenExplicitMaxTtl: 0
    tokenMaxTtl: 0
    tokenNoDefaultPolicy: false
    tokenNumUses: 0
    tokenPeriod: 0
    tokenPolicies:
        - string
    tokenTtl: 0
    tokenType: string
    users:
        - groups:
            - string
          policies:
            - string
          username: string

    AuthBackend Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AuthBackend resource accepts the following input properties:

    Organization string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    BaseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    BypassOktaMfa bool
    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.
    Description string
    The description of the auth backend
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    Groups List<AuthBackendGroup>
    Associate Okta groups with policies within Vault. See below for more details.
    MaxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    Namespace 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.
    Path string
    Path to mount the Okta auth backend. Default to path okta.
    Token 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.
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    Users List<AuthBackendUser>
    Associate Okta users with groups or policies within Vault. See below for more details.
    Organization string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    BaseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    BypassOktaMfa bool
    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.
    Description string
    The description of the auth backend
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    Groups []AuthBackendGroupTypeArgs
    Associate Okta groups with policies within Vault. See below for more details.
    MaxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    Namespace 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.
    Path string
    Path to mount the Okta auth backend. Default to path okta.
    Token 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.
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    Users []AuthBackendUserTypeArgs
    Associate Okta users with groups or policies within Vault. See below for more details.
    organization String
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    baseUrl String
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description String
    The description of the auth backend
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups List<AuthBackendGroup>
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl String
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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.
    path String
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    ttl String
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users List<AuthBackendUser>
    Associate Okta users with groups or policies within Vault. See below for more details.
    organization string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    baseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description string
    The description of the auth backend
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups AuthBackendGroup[]
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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.
    path string
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users AuthBackendUser[]
    Associate Okta users with groups or policies within Vault. See below for more details.
    organization str
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    base_url str
    The Okta url. Examples: oktapreview.com, okta.com
    bypass_okta_mfa bool
    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.
    description str
    The description of the auth backend
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups Sequence[AuthBackendGroupArgs]
    Associate Okta groups with policies within Vault. See below for more details.
    max_ttl str
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace str
    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.
    path str
    Path to mount the Okta auth backend. Default to path okta.
    token str
    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.
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    ttl str
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users Sequence[AuthBackendUserArgs]
    Associate Okta users with groups or policies within Vault. See below for more details.
    organization String
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    baseUrl String
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description String
    The description of the auth backend
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups List<Property Map>
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl String
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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.
    path String
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    ttl String
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users List<Property Map>
    Associate Okta users with groups or policies within Vault. See below for more details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthBackend resource produces the following output properties:

    Accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    Id string
    The provider-assigned unique ID for this managed resource.
    Accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    Id string
    The provider-assigned unique ID for this managed resource.
    accessor String
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    id String
    The provider-assigned unique ID for this managed resource.
    accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    id string
    The provider-assigned unique ID for this managed resource.
    accessor str
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    id str
    The provider-assigned unique ID for this managed resource.
    accessor String
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthBackend Resource

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

    public static get(name: string, id: Input<ID>, state?: AuthBackendState, opts?: CustomResourceOptions): AuthBackend
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessor: Optional[str] = None,
        base_url: Optional[str] = None,
        bypass_okta_mfa: Optional[bool] = None,
        description: Optional[str] = None,
        disable_remount: Optional[bool] = None,
        groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
        max_ttl: Optional[str] = None,
        namespace: Optional[str] = None,
        organization: Optional[str] = None,
        path: Optional[str] = None,
        token: Optional[str] = None,
        token_bound_cidrs: Optional[Sequence[str]] = None,
        token_explicit_max_ttl: Optional[int] = None,
        token_max_ttl: Optional[int] = None,
        token_no_default_policy: Optional[bool] = None,
        token_num_uses: Optional[int] = None,
        token_period: Optional[int] = None,
        token_policies: Optional[Sequence[str]] = None,
        token_ttl: Optional[int] = None,
        token_type: Optional[str] = None,
        ttl: Optional[str] = None,
        users: Optional[Sequence[AuthBackendUserArgs]] = None) -> AuthBackend
    func GetAuthBackend(ctx *Context, name string, id IDInput, state *AuthBackendState, opts ...ResourceOption) (*AuthBackend, error)
    public static AuthBackend Get(string name, Input<string> id, AuthBackendState? state, CustomResourceOptions? opts = null)
    public static AuthBackend get(String name, Output<String> id, AuthBackendState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    BaseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    BypassOktaMfa bool
    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.
    Description string
    The description of the auth backend
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    Groups List<AuthBackendGroup>
    Associate Okta groups with policies within Vault. See below for more details.
    MaxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    Namespace 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 string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    Path string
    Path to mount the Okta auth backend. Default to path okta.
    Token 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.
    TokenBoundCidrs List<string>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies List<string>
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    Users List<AuthBackendUser>
    Associate Okta users with groups or policies within Vault. See below for more details.
    Accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    BaseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    BypassOktaMfa bool
    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.
    Description string
    The description of the auth backend
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    Groups []AuthBackendGroupTypeArgs
    Associate Okta groups with policies within Vault. See below for more details.
    MaxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    Namespace 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 string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    Path string
    Path to mount the Okta auth backend. Default to path okta.
    Token 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.
    TokenBoundCidrs []string
    Specifies the blocks of IP addresses which are allowed to use the generated token
    TokenExplicitMaxTtl int
    Generated Token's Explicit Maximum TTL in seconds
    TokenMaxTtl int
    The maximum lifetime of the generated token
    TokenNoDefaultPolicy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    TokenNumUses int
    The maximum number of times a token may be used, a value of zero means unlimited
    TokenPeriod int
    Generated Token's Period
    TokenPolicies []string
    Generated Token's Policies
    TokenTtl int
    The initial ttl of the token to generate in seconds
    TokenType string
    The type of token to generate, service or batch
    Ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    Users []AuthBackendUserTypeArgs
    Associate Okta users with groups or policies within Vault. See below for more details.
    accessor String
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    baseUrl String
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description String
    The description of the auth backend
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups List<AuthBackendGroup>
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl String
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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 String
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    path String
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Integer
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Integer
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Integer
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Integer
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Integer
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    ttl String
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users List<AuthBackendUser>
    Associate Okta users with groups or policies within Vault. See below for more details.
    accessor string
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    baseUrl string
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description string
    The description of the auth backend
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups AuthBackendGroup[]
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl string
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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 string
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    path string
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs string[]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod number
    Generated Token's Period
    tokenPolicies string[]
    Generated Token's Policies
    tokenTtl number
    The initial ttl of the token to generate in seconds
    tokenType string
    The type of token to generate, service or batch
    ttl string
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users AuthBackendUser[]
    Associate Okta users with groups or policies within Vault. See below for more details.
    accessor str
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    base_url str
    The Okta url. Examples: oktapreview.com, okta.com
    bypass_okta_mfa bool
    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.
    description str
    The description of the auth backend
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups Sequence[AuthBackendGroupArgs]
    Associate Okta groups with policies within Vault. See below for more details.
    max_ttl str
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace str
    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 str
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    path str
    Path to mount the Okta auth backend. Default to path okta.
    token str
    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.
    token_bound_cidrs Sequence[str]
    Specifies the blocks of IP addresses which are allowed to use the generated token
    token_explicit_max_ttl int
    Generated Token's Explicit Maximum TTL in seconds
    token_max_ttl int
    The maximum lifetime of the generated token
    token_no_default_policy bool
    If true, the 'default' policy will not automatically be added to generated tokens
    token_num_uses int
    The maximum number of times a token may be used, a value of zero means unlimited
    token_period int
    Generated Token's Period
    token_policies Sequence[str]
    Generated Token's Policies
    token_ttl int
    The initial ttl of the token to generate in seconds
    token_type str
    The type of token to generate, service or batch
    ttl str
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users Sequence[AuthBackendUserArgs]
    Associate Okta users with groups or policies within Vault. See below for more details.
    accessor String
    The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
    baseUrl String
    The Okta url. Examples: oktapreview.com, okta.com
    bypassOktaMfa 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.
    description String
    The description of the auth backend
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    groups List<Property Map>
    Associate Okta groups with policies within Vault. See below for more details.
    maxTtl String
    Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_max_ttl instead.

    namespace 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 String
    The Okta organization. This will be the first part of the url https://XXX.okta.com
    path String
    Path to mount the Okta auth backend. Default to path okta.
    token 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.
    tokenBoundCidrs List<String>
    Specifies the blocks of IP addresses which are allowed to use the generated token
    tokenExplicitMaxTtl Number
    Generated Token's Explicit Maximum TTL in seconds
    tokenMaxTtl Number
    The maximum lifetime of the generated token
    tokenNoDefaultPolicy Boolean
    If true, the 'default' policy will not automatically be added to generated tokens
    tokenNumUses Number
    The maximum number of times a token may be used, a value of zero means unlimited
    tokenPeriod Number
    Generated Token's Period
    tokenPolicies List<String>
    Generated Token's Policies
    tokenTtl Number
    The initial ttl of the token to generate in seconds
    tokenType String
    The type of token to generate, service or batch
    ttl String
    Duration after which authentication will be expired. See the documentation for info on valid duration formats.

    Deprecated: Deprecated. Please use token_ttl instead.

    users List<Property Map>
    Associate Okta users with groups or policies within Vault. See below for more details.

    Supporting Types

    AuthBackendGroup, AuthBackendGroupArgs

    GroupName string
    Name of the Okta group
    Policies List<string>
    Policies to associate with this group
    GroupName string
    Name of the Okta group
    Policies []string
    Policies to associate with this group
    groupName String
    Name of the Okta group
    policies List<String>
    Policies to associate with this group
    groupName string
    Name of the Okta group
    policies string[]
    Policies to associate with this group
    group_name str
    Name of the Okta group
    policies Sequence[str]
    Policies to associate with this group
    groupName String
    Name of the Okta group
    policies List<String>
    Policies to associate with this group

    AuthBackendUser, AuthBackendUserArgs

    Username string
    Name of the user within Okta
    Groups List<string>
    Groups within the Okta auth backend to associate with this user
    Policies List<string>
    Policies to associate with this user
    Username string
    Name of the user within Okta
    Groups []string
    Groups within the Okta auth backend to associate with this user
    Policies []string
    Policies to associate with this user
    username String
    Name of the user within Okta
    groups List<String>
    Groups within the Okta auth backend to associate with this user
    policies List<String>
    Policies to associate with this user
    username string
    Name of the user within Okta
    groups string[]
    Groups within the Okta auth backend to associate with this user
    policies string[]
    Policies to associate with this user
    username str
    Name of the user within Okta
    groups Sequence[str]
    Groups within the Okta auth backend to associate with this user
    policies Sequence[str]
    Policies to associate with this user
    username String
    Name of the user within Okta
    groups List<String>
    Groups within the Okta auth backend to associate with this user
    policies List<String>
    Policies to associate with this user

    Import

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.4.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-vault