1. Packages
  2. Authentik Provider
  3. API Docs
  4. StageUserWrite
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

authentik.StageUserWrite

Explore with Pulumi AI

Example Usage

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

const name = new authentik.StageUserWrite("name", {createUsersAsInactive: false});
Copy
import pulumi
import pulumi_authentik as authentik

name = authentik.StageUserWrite("name", create_users_as_inactive=False)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewStageUserWrite(ctx, "name", &authentik.StageUserWriteArgs{
			CreateUsersAsInactive: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var name = new Authentik.StageUserWrite("name", new()
    {
        CreateUsersAsInactive = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.StageUserWrite;
import com.pulumi.authentik.StageUserWriteArgs;
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 name = new StageUserWrite("name", StageUserWriteArgs.builder()
            .createUsersAsInactive(false)
            .build());

    }
}
Copy
resources:
  name:
    type: authentik:StageUserWrite
    properties:
      createUsersAsInactive: false
Copy

Create StageUserWrite Resource

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

Constructor syntax

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

@overload
def StageUserWrite(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   create_users_as_inactive: Optional[bool] = None,
                   create_users_group: Optional[str] = None,
                   name: Optional[str] = None,
                   stage_user_write_id: Optional[str] = None,
                   user_creation_mode: Optional[str] = None,
                   user_path_template: Optional[str] = None,
                   user_type: Optional[str] = None)
func NewStageUserWrite(ctx *Context, name string, args *StageUserWriteArgs, opts ...ResourceOption) (*StageUserWrite, error)
public StageUserWrite(string name, StageUserWriteArgs? args = null, CustomResourceOptions? opts = null)
public StageUserWrite(String name, StageUserWriteArgs args)
public StageUserWrite(String name, StageUserWriteArgs args, CustomResourceOptions options)
type: authentik:StageUserWrite
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args StageUserWriteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args StageUserWriteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args StageUserWriteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args StageUserWriteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StageUserWriteArgs
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 stageUserWriteResource = new Authentik.StageUserWrite("stageUserWriteResource", new()
{
    CreateUsersAsInactive = false,
    CreateUsersGroup = "string",
    Name = "string",
    StageUserWriteId = "string",
    UserCreationMode = "string",
    UserPathTemplate = "string",
    UserType = "string",
});
Copy
example, err := authentik.NewStageUserWrite(ctx, "stageUserWriteResource", &authentik.StageUserWriteArgs{
	CreateUsersAsInactive: pulumi.Bool(false),
	CreateUsersGroup:      pulumi.String("string"),
	Name:                  pulumi.String("string"),
	StageUserWriteId:      pulumi.String("string"),
	UserCreationMode:      pulumi.String("string"),
	UserPathTemplate:      pulumi.String("string"),
	UserType:              pulumi.String("string"),
})
Copy
var stageUserWriteResource = new StageUserWrite("stageUserWriteResource", StageUserWriteArgs.builder()
    .createUsersAsInactive(false)
    .createUsersGroup("string")
    .name("string")
    .stageUserWriteId("string")
    .userCreationMode("string")
    .userPathTemplate("string")
    .userType("string")
    .build());
Copy
stage_user_write_resource = authentik.StageUserWrite("stageUserWriteResource",
    create_users_as_inactive=False,
    create_users_group="string",
    name="string",
    stage_user_write_id="string",
    user_creation_mode="string",
    user_path_template="string",
    user_type="string")
Copy
const stageUserWriteResource = new authentik.StageUserWrite("stageUserWriteResource", {
    createUsersAsInactive: false,
    createUsersGroup: "string",
    name: "string",
    stageUserWriteId: "string",
    userCreationMode: "string",
    userPathTemplate: "string",
    userType: "string",
});
Copy
type: authentik:StageUserWrite
properties:
    createUsersAsInactive: false
    createUsersGroup: string
    name: string
    stageUserWriteId: string
    userCreationMode: string
    userPathTemplate: string
    userType: string
Copy

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

CreateUsersAsInactive bool
Defaults to true.
CreateUsersGroup string
Name string
StageUserWriteId string
UserCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
UserPathTemplate string
Defaults to ``.
UserType string
Allowed values: - internal - external - service_account Defaults to external.
CreateUsersAsInactive bool
Defaults to true.
CreateUsersGroup string
Name string
StageUserWriteId string
UserCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
UserPathTemplate string
Defaults to ``.
UserType string
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive Boolean
Defaults to true.
createUsersGroup String
name String
stageUserWriteId String
userCreationMode String
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate String
Defaults to ``.
userType String
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive boolean
Defaults to true.
createUsersGroup string
name string
stageUserWriteId string
userCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate string
Defaults to ``.
userType string
Allowed values: - internal - external - service_account Defaults to external.
create_users_as_inactive bool
Defaults to true.
create_users_group str
name str
stage_user_write_id str
user_creation_mode str
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
user_path_template str
Defaults to ``.
user_type str
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive Boolean
Defaults to true.
createUsersGroup String
name String
stageUserWriteId String
userCreationMode String
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate String
Defaults to ``.
userType String
Allowed values: - internal - external - service_account Defaults to external.

Outputs

All input properties are implicitly available as output properties. Additionally, the StageUserWrite 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 StageUserWrite Resource

Get an existing StageUserWrite 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?: StageUserWriteState, opts?: CustomResourceOptions): StageUserWrite
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_users_as_inactive: Optional[bool] = None,
        create_users_group: Optional[str] = None,
        name: Optional[str] = None,
        stage_user_write_id: Optional[str] = None,
        user_creation_mode: Optional[str] = None,
        user_path_template: Optional[str] = None,
        user_type: Optional[str] = None) -> StageUserWrite
func GetStageUserWrite(ctx *Context, name string, id IDInput, state *StageUserWriteState, opts ...ResourceOption) (*StageUserWrite, error)
public static StageUserWrite Get(string name, Input<string> id, StageUserWriteState? state, CustomResourceOptions? opts = null)
public static StageUserWrite get(String name, Output<String> id, StageUserWriteState state, CustomResourceOptions options)
resources:  _:    type: authentik:StageUserWrite    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreateUsersAsInactive bool
Defaults to true.
CreateUsersGroup string
Name string
StageUserWriteId string
UserCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
UserPathTemplate string
Defaults to ``.
UserType string
Allowed values: - internal - external - service_account Defaults to external.
CreateUsersAsInactive bool
Defaults to true.
CreateUsersGroup string
Name string
StageUserWriteId string
UserCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
UserPathTemplate string
Defaults to ``.
UserType string
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive Boolean
Defaults to true.
createUsersGroup String
name String
stageUserWriteId String
userCreationMode String
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate String
Defaults to ``.
userType String
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive boolean
Defaults to true.
createUsersGroup string
name string
stageUserWriteId string
userCreationMode string
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate string
Defaults to ``.
userType string
Allowed values: - internal - external - service_account Defaults to external.
create_users_as_inactive bool
Defaults to true.
create_users_group str
name str
stage_user_write_id str
user_creation_mode str
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
user_path_template str
Defaults to ``.
user_type str
Allowed values: - internal - external - service_account Defaults to external.
createUsersAsInactive Boolean
Defaults to true.
createUsersGroup String
name String
stageUserWriteId String
userCreationMode String
Allowed values: - never_create - create_when_required - always_create Defaults to create_when_required.
userPathTemplate String
Defaults to ``.
userType String
Allowed values: - internal - external - service_account Defaults to external.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.