AuthBackendUser

Provides a resource to create a user in 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
        {
            Path = "user_okta",
            Organization = "dummy",
        });
        var foo = new Vault.Okta.AuthBackendUser("foo", new Vault.Okta.AuthBackendUserArgs
        {
            Path = example.Path,
            Username = "foo",
            Groups = 
            {
                "one",
                "two",
            },
        });
    }

}
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 {
		example, err := okta.NewAuthBackend(ctx, "example", &okta.AuthBackendArgs{
			Path:         pulumi.String("user_okta"),
			Organization: pulumi.String("dummy"),
		})
		if err != nil {
			return err
		}
		_, err = okta.NewAuthBackendUser(ctx, "foo", &okta.AuthBackendUserArgs{
			Path:     example.Path,
			Username: pulumi.String("foo"),
			Groups: pulumi.StringArray{
				pulumi.String("one"),
				pulumi.String("two"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_vault as vault

example = vault.okta.AuthBackend("example",
    path="user_okta",
    organization="dummy")
foo = vault.okta.AuthBackendUser("foo",
    path=example.path,
    username="foo",
    groups=[
        "one",
        "two",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = new vault.okta.AuthBackend("example", {
    path: "user_okta",
    organization: "dummy",
});
const foo = new vault.okta.AuthBackendUser("foo", {
    path: example.path,
    username: "foo",
    groups: [
        "one",
        "two",
    ],
});

Create a AuthBackendUser Resource

new AuthBackendUser(name: string, args: AuthBackendUserArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendUser(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    groups: Optional[Sequence[str]] = None,
                    path: Optional[str] = None,
                    policies: Optional[Sequence[str]] = None,
                    username: Optional[str] = None)
@overload
def AuthBackendUser(resource_name: str,
                    args: AuthBackendUserInitArgs,
                    opts: Optional[ResourceOptions] = None)
func NewAuthBackendUser(ctx *Context, name string, args AuthBackendUserArgs, opts ...ResourceOption) (*AuthBackendUser, error)
public AuthBackendUser(string name, AuthBackendUserArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AuthBackendUserArgs
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 AuthBackendUserInitArgs
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 AuthBackendUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AuthBackendUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AuthBackendUser 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 AuthBackendUser resource accepts the following input properties:

Path string
The path where the Okta auth backend is mounted
Username string
Name of the user within Okta
Groups List<string>
List of Okta groups to associate with this user
Policies List<string>
List of Vault policies to associate with this user
Path string
The path where the Okta auth backend is mounted
Username string
Name of the user within Okta
Groups []string
List of Okta groups to associate with this user
Policies []string
List of Vault policies to associate with this user
path string
The path where the Okta auth backend is mounted
username string
Name of the user within Okta
groups string[]
List of Okta groups to associate with this user
policies string[]
List of Vault policies to associate with this user
path str
The path where the Okta auth backend is mounted
username str
Name of the user within Okta
groups Sequence[str]
List of Okta groups to associate with this user
policies Sequence[str]
List of Vault policies to associate with this user

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing AuthBackendUser Resource

Get an existing AuthBackendUser 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?: AuthBackendUserState, opts?: CustomResourceOptions): AuthBackendUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        groups: Optional[Sequence[str]] = None,
        path: Optional[str] = None,
        policies: Optional[Sequence[str]] = None,
        username: Optional[str] = None) -> AuthBackendUser
func GetAuthBackendUser(ctx *Context, name string, id IDInput, state *AuthBackendUserState, opts ...ResourceOption) (*AuthBackendUser, error)
public static AuthBackendUser Get(string name, Input<string> id, AuthBackendUserState? 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:

Groups List<string>
List of Okta groups to associate with this user
Path string
The path where the Okta auth backend is mounted
Policies List<string>
List of Vault policies to associate with this user
Username string
Name of the user within Okta
Groups []string
List of Okta groups to associate with this user
Path string
The path where the Okta auth backend is mounted
Policies []string
List of Vault policies to associate with this user
Username string
Name of the user within Okta
groups string[]
List of Okta groups to associate with this user
path string
The path where the Okta auth backend is mounted
policies string[]
List of Vault policies to associate with this user
username string
Name of the user within Okta
groups Sequence[str]
List of Okta groups to associate with this user
path str
The path where the Okta auth backend is mounted
policies Sequence[str]
List of Vault policies to associate with this user
username str
Name of the user within 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.