HashiCorp Vault

v5.7.0 published on Thursday, Oct 13, 2022 by Pulumi

AuthBackendGroup

Provides a resource to create a group in an Okta auth backend within Vault.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var example = new Vault.Okta.AuthBackend("example", new()
    {
        Path = "group_okta",
        Organization = "dummy",
    });

    var foo = new Vault.Okta.AuthBackendGroup("foo", new()
    {
        Path = example.Path,
        GroupName = "foo",
        Policies = new[]
        {
            "one",
            "two",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/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("group_okta"),
			Organization: pulumi.String("dummy"),
		})
		if err != nil {
			return err
		}
		_, err = okta.NewAuthBackendGroup(ctx, "foo", &okta.AuthBackendGroupArgs{
			Path:      example.Path,
			GroupName: pulumi.String("foo"),
			Policies: pulumi.StringArray{
				pulumi.String("one"),
				pulumi.String("two"),
			},
		})
		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.AuthBackendGroup;
import com.pulumi.vault.okta.AuthBackendGroupArgs;
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()        
            .path("group_okta")
            .organization("dummy")
            .build());

        var foo = new AuthBackendGroup("foo", AuthBackendGroupArgs.builder()        
            .path(example.path())
            .groupName("foo")
            .policies(            
                "one",
                "two")
            .build());

    }
}

import pulumi
import pulumi_vault as vault

example = vault.okta.AuthBackend("example",
    path="group_okta",
    organization="dummy")
foo = vault.okta.AuthBackendGroup("foo",
    path=example.path,
    group_name="foo",
    policies=[
        "one",
        "two",
    ])

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const example = new vault.okta.AuthBackend("example", {
    path: "group_okta",
    organization: "dummy",
});
const foo = new vault.okta.AuthBackendGroup("foo", {
    path: example.path,
    groupName: "foo",
    policies: [
        "one",
        "two",
    ],
});

resources:
  example:
    type: vault:okta:AuthBackend
    properties:
      path: group_okta
      organization: dummy
  foo:
    type: vault:okta:AuthBackendGroup
    properties:
      path: ${example.path}
      groupName: foo
      policies:
        - one
        - two

Create AuthBackendGroup Resource

new AuthBackendGroup(name: string, args: AuthBackendGroupArgs, opts?: CustomResourceOptions);

@overload
def AuthBackendGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     group_name: Optional[str] = None,
                     namespace: Optional[str] = None,
                     path: Optional[str] = None,
                     policies: Optional[Sequence[str]] = None)
@overload
def AuthBackendGroup(resource_name: str,
                     args: AuthBackendGroupInitArgs,
                     opts: Optional[ResourceOptions] = None)

func NewAuthBackendGroup(ctx *Context, name string, args AuthBackendGroupArgs, opts ...ResourceOption) (*AuthBackendGroup, error)

public AuthBackendGroup(string name, AuthBackendGroupArgs args, CustomResourceOptions? opts = null)

public AuthBackendGroup(String name, AuthBackendGroupArgs args)
public AuthBackendGroup(String name, AuthBackendGroupArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args AuthBackendGroupArgs: 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 AuthBackendGroupInitArgs: 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 AuthBackendGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AuthBackendGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AuthBackendGroupArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

GroupName string: Name of the group within the Okta
Path string: The path where the Okta auth backend is mounted
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.
Policies List<string>: Vault policies to associate with this group

GroupName string: Name of the group within the Okta
Path string: The path where the Okta auth backend is mounted
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.
Policies []string: Vault policies to associate with this group

groupName String: Name of the group within the Okta
path String: The path where the Okta auth backend is mounted
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.
policies List<String>: Vault policies to associate with this group

groupName string: Name of the group within the Okta
path string: The path where the Okta auth backend is mounted
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.
policies string[]: Vault policies to associate with this group

group_name str: Name of the group within the Okta
path str: The path where the Okta auth backend is mounted
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.
policies Sequence[str]: Vault policies to associate with this group

groupName String: Name of the group within the Okta
path String: The path where the Okta auth backend is mounted
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.
policies List<String>: Vault policies to associate with this group

Outputs

All input properties are implicitly available as output properties. Additionally, the AuthBackendGroup 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 string: The provider-assigned unique ID for this managed resource.

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

id String: The provider-assigned unique ID for this managed resource.

Look up Existing AuthBackendGroup Resource

Get an existing AuthBackendGroup 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?: AuthBackendGroupState, opts?: CustomResourceOptions): AuthBackendGroup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_name: Optional[str] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None,
        policies: Optional[Sequence[str]] = None) -> AuthBackendGroup

func GetAuthBackendGroup(ctx *Context, name string, id IDInput, state *AuthBackendGroupState, opts ...ResourceOption) (*AuthBackendGroup, error)

public static AuthBackendGroup Get(string name, Input<string> id, AuthBackendGroupState? state, CustomResourceOptions? opts = null)

public static AuthBackendGroup get(String name, Output<String> id, AuthBackendGroupState 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:

GroupName string: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
Policies List<string>: Vault policies to associate with this group

GroupName string: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
Policies []string: Vault policies to associate with this group

groupName String: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
policies List<String>: Vault policies to associate with this group

groupName string: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
policies string[]: Vault policies to associate with this group

group_name str: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
policies Sequence[str]: Vault policies to associate with this group

groupName String: Name of the group within the Okta
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: The path where the Okta auth backend is mounted
policies List<String>: Vault policies to associate with this group

Import

Okta authentication backend groups can be imported using the format backend/groupName e.g.

 $ pulumi import vault:okta/authBackendGroup:AuthBackendGroup foo okta/foo

Package Details

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