AuthBackend

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

Example Usage

using Pulumi;
using Vault = Pulumi.Vault;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Vault.Okta.AuthBackend("example", new Vault.Okta.AuthBackendArgs
        {
            Description = "Demonstration of the Terraform Okta auth backend",
            Groups = 
            {
                new Vault.Okta.Inputs.AuthBackendGroupArgs
                {
                    GroupName = "foo",
                    Policies = 
                    {
                        "one",
                        "two",
                    },
                },
            },
            Organization = "example",
            Token = "something that should be kept secret",
            Users = 
            {
                new Vault.Okta.Inputs.AuthBackendUserArgs
                {
                    Groups = 
                    {
                        "foo",
                    },
                    Username = "bar",
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v4/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"),
			Groups: okta.AuthBackendGroupArray{
				&okta.AuthBackendGroupArgs{
					GroupName: pulumi.String("foo"),
					Policies: pulumi.StringArray{
						pulumi.String("one"),
						pulumi.String("two"),
					},
				},
			},
			Organization: pulumi.String("example"),
			Token:        pulumi.String("something that should be kept secret"),
			Users: okta.AuthBackendUserArray{
				&okta.AuthBackendUserArgs{
					Groups: pulumi.StringArray{
						pulumi.String("foo"),
					},
					Username: pulumi.String("bar"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

example = vault.okta.AuthBackend("example",
    description="Demonstration of the Terraform Okta auth backend",
    groups=[vault.okta.AuthBackendGroupArgs(
        group_name="foo",
        policies=[
            "one",
            "two",
        ],
    )],
    organization="example",
    token="something that should be kept secret",
    users=[vault.okta.AuthBackendUserArgs(
        groups=["foo"],
        username="bar",
    )])
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",
    groups: [{
        groupName: "foo",
        policies: [
            "one",
            "two",
        ],
    }],
    organization: "example",
    token: "something that should be kept secret",
    users: [{
        groups: ["foo"],
        username: "bar",
    }],
});

Create a AuthBackend Resource

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
@overload
def AuthBackend(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                base_url: Optional[str] = None,
                bypass_okta_mfa: Optional[bool] = None,
                description: Optional[str] = None,
                groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
                max_ttl: Optional[str] = None,
                organization: Optional[str] = None,
                path: Optional[str] = None,
                token: Optional[str] = None,
                ttl: Optional[str] = None,
                users: Optional[Sequence[AuthBackendUserArgs]] = None)
@overload
def AuthBackend(resource_name: str,
                args: AuthBackendArgs,
                opts: Optional[ResourceOptions] = None)
func NewAuthBackend(ctx *Context, name string, args AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)
public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions? opts = null)
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.

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

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
Groups List<AuthBackendGroupArgs>
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.
Path string
Path to mount the Okta auth backend
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.
Ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users List<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 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
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.
Path string
Path to mount the Okta auth backend
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.
Ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
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
groups AuthBackendGroupArgs[]
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.
path string
Path to mount the Okta auth backend
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.
ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users AuthBackendUserArgs[]
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
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.
path str
Path to mount the Okta auth backend
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.
ttl str
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users Sequence[AuthBackendUserArgs]
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 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.

Look up an 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,
        groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
        max_ttl: Optional[str] = None,
        organization: Optional[str] = None,
        path: Optional[str] = None,
        token: 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)
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.

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
Groups List<AuthBackendGroupArgs>
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.
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
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.
Ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users List<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 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
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.
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
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.
Ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
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
groups AuthBackendGroupArgs[]
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.
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
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.
ttl string
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users AuthBackendUserArgs[]
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
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.
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
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.
ttl str
Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users Sequence[AuthBackendUserArgs]
Associate Okta users with groups or policies within Vault. See below for more details.

Supporting Types

AuthBackendGroup

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

AuthBackendUser

Groups List<string>
List of Okta groups to associate with this user
Username string
Name of the user within Okta
Policies List<string>
List of Vault policies to associate with this user
Groups []string
List of Okta groups to associate with this user
Username string
Name of the user within Okta
Policies []string
List of Vault policies to associate with this user
groups string[]
List of Okta groups to associate with this user
username string
Name of the user within Okta
policies string[]
List of Vault policies to associate with this user
groups Sequence[str]
List of Okta groups to associate with this user
username str
Name of the user within Okta
policies Sequence[str]
List of Vault 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

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.