1. Registry
  2. Packages
  3. Authentik Provider
  4. API Docs
  5. UserOffboarding
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as authentik from "@pulumi/authentik";
    
    const example = new authentik.User("example", {
        username: "leaving-user",
        name: "Leaving User",
    });
    const exampleUserOffboarding = new authentik.UserOffboarding("example", {
        user: example.userId,
        scheduledAt: "2026-12-31T00:00:00Z",
        action: "deactivate",
        revokeSessions: true,
        revokeTokens: true,
    });
    
    import pulumi
    import pulumi_authentik as authentik
    
    example = authentik.User("example",
        username="leaving-user",
        name="Leaving User")
    example_user_offboarding = authentik.UserOffboarding("example",
        user=example.user_id,
        scheduled_at="2026-12-31T00:00:00Z",
        action="deactivate",
        revoke_sessions=True,
        revoke_tokens=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2026/authentik"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := authentik.NewUser(ctx, "example", &authentik.UserArgs{
    			Username: pulumi.String("leaving-user"),
    			Name:     pulumi.String("Leaving User"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = authentik.NewUserOffboarding(ctx, "example", &authentik.UserOffboardingArgs{
    			User:           example.UserId,
    			ScheduledAt:    pulumi.String("2026-12-31T00:00:00Z"),
    			Action:         pulumi.String("deactivate"),
    			RevokeSessions: pulumi.Bool(true),
    			RevokeTokens:   pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Authentik = Pulumi.Authentik;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Authentik.User("example", new()
        {
            Username = "leaving-user",
            Name = "Leaving User",
        });
    
        var exampleUserOffboarding = new Authentik.UserOffboarding("example", new()
        {
            User = example.UserId,
            ScheduledAt = "2026-12-31T00:00:00Z",
            Action = "deactivate",
            RevokeSessions = true,
            RevokeTokens = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.authentik.User;
    import com.pulumi.authentik.UserArgs;
    import com.pulumi.authentik.UserOffboarding;
    import com.pulumi.authentik.UserOffboardingArgs;
    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 User("example", UserArgs.builder()
                .username("leaving-user")
                .name("Leaving User")
                .build());
    
            var exampleUserOffboarding = new UserOffboarding("exampleUserOffboarding", UserOffboardingArgs.builder()
                .user(example.userId())
                .scheduledAt("2026-12-31T00:00:00Z")
                .action("deactivate")
                .revokeSessions(true)
                .revokeTokens(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: authentik:User
        properties:
          username: leaving-user
          name: Leaving User
      exampleUserOffboarding:
        type: authentik:UserOffboarding
        name: example
        properties:
          user: ${example.userId}
          scheduledAt: 2026-12-31T00:00:00Z
          action: deactivate
          revokeSessions: true
          revokeTokens: true
    
    Example coming soon!
    

    Create UserOffboarding Resource

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

    Constructor syntax

    new UserOffboarding(name: string, args: UserOffboardingArgs, opts?: CustomResourceOptions);
    @overload
    def UserOffboarding(resource_name: str,
                        args: UserOffboardingArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserOffboarding(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        scheduled_at: Optional[str] = None,
                        user: Optional[float] = None,
                        action: Optional[str] = None,
                        revoke_sessions: Optional[bool] = None,
                        revoke_tokens: Optional[bool] = None,
                        user_offboarding_id: Optional[str] = None)
    func NewUserOffboarding(ctx *Context, name string, args UserOffboardingArgs, opts ...ResourceOption) (*UserOffboarding, error)
    public UserOffboarding(string name, UserOffboardingArgs args, CustomResourceOptions? opts = null)
    public UserOffboarding(String name, UserOffboardingArgs args)
    public UserOffboarding(String name, UserOffboardingArgs args, CustomResourceOptions options)
    
    type: authentik:UserOffboarding
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "authentik_user_offboarding" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args UserOffboardingArgs
    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 UserOffboardingArgs
    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 UserOffboardingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserOffboardingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserOffboardingArgs
    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 userOffboardingResource = new Authentik.UserOffboarding("userOffboardingResource", new()
    {
        ScheduledAt = "string",
        User = 0.0,
        Action = "string",
        RevokeSessions = false,
        RevokeTokens = false,
        UserOffboardingId = "string",
    });
    
    example, err := authentik.NewUserOffboarding(ctx, "userOffboardingResource", &authentik.UserOffboardingArgs{
    	ScheduledAt:       pulumi.String("string"),
    	User:              pulumi.Float64(0),
    	Action:            pulumi.String("string"),
    	RevokeSessions:    pulumi.Bool(false),
    	RevokeTokens:      pulumi.Bool(false),
    	UserOffboardingId: pulumi.String("string"),
    })
    
    resource "authentik_user_offboarding" "userOffboardingResource" {
      lifecycle {
        create_before_destroy = true
      }
      scheduled_at        = "string"
      user                = 0
      action              = "string"
      revoke_sessions     = false
      revoke_tokens       = false
      user_offboarding_id = "string"
    }
    
    var userOffboardingResource = new UserOffboarding("userOffboardingResource", UserOffboardingArgs.builder()
        .scheduledAt("string")
        .user(0.0)
        .action("string")
        .revokeSessions(false)
        .revokeTokens(false)
        .userOffboardingId("string")
        .build());
    
    user_offboarding_resource = authentik.UserOffboarding("userOffboardingResource",
        scheduled_at="string",
        user=float(0),
        action="string",
        revoke_sessions=False,
        revoke_tokens=False,
        user_offboarding_id="string")
    
    const userOffboardingResource = new authentik.UserOffboarding("userOffboardingResource", {
        scheduledAt: "string",
        user: 0,
        action: "string",
        revokeSessions: false,
        revokeTokens: false,
        userOffboardingId: "string",
    });
    
    type: authentik:UserOffboarding
    properties:
        action: string
        revokeSessions: false
        revokeTokens: false
        scheduledAt: string
        user: 0
        userOffboardingId: string
    

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

    ScheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    User double
    PK of the user to offboard.
    Action string
    Allowed values:

    • deactivate
    • delete Generated.
    RevokeSessions bool
    Generated.
    RevokeTokens bool
    Generated.
    UserOffboardingId string
    ScheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    User float64
    PK of the user to offboard.
    Action string
    Allowed values:

    • deactivate
    • delete Generated.
    RevokeSessions bool
    Generated.
    RevokeTokens bool
    Generated.
    UserOffboardingId string
    scheduled_at string
    Absolute RFC3339 time at which the offboarding action is executed.
    user number
    PK of the user to offboard.
    action string
    Allowed values:

    • deactivate
    • delete Generated.
    revoke_sessions bool
    Generated.
    revoke_tokens bool
    Generated.
    user_offboarding_id string
    scheduledAt String
    Absolute RFC3339 time at which the offboarding action is executed.
    user Double
    PK of the user to offboard.
    action String
    Allowed values:

    • deactivate
    • delete Generated.
    revokeSessions Boolean
    Generated.
    revokeTokens Boolean
    Generated.
    userOffboardingId String
    scheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    user number
    PK of the user to offboard.
    action string
    Allowed values:

    • deactivate
    • delete Generated.
    revokeSessions boolean
    Generated.
    revokeTokens boolean
    Generated.
    userOffboardingId string
    scheduled_at str
    Absolute RFC3339 time at which the offboarding action is executed.
    user float
    PK of the user to offboard.
    action str
    Allowed values:

    • deactivate
    • delete Generated.
    revoke_sessions bool
    Generated.
    revoke_tokens bool
    Generated.
    user_offboarding_id str
    scheduledAt String
    Absolute RFC3339 time at which the offboarding action is executed.
    user Number
    PK of the user to offboard.
    action String
    Allowed values:

    • deactivate
    • delete Generated.
    revokeSessions Boolean
    Generated.
    revokeTokens Boolean
    Generated.
    userOffboardingId String

    Outputs

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

    CreatedAt string
    Generated.
    ExecutedAt string
    Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Generated.
    CreatedAt string
    Generated.
    ExecutedAt string
    Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Generated.
    created_at string
    Generated.
    executed_at string
    Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Generated.
    createdAt String
    Generated.
    executedAt String
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Generated.
    createdAt string
    Generated.
    executedAt string
    Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Generated.
    created_at str
    Generated.
    executed_at str
    Generated.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Generated.
    createdAt String
    Generated.
    executedAt String
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Generated.

    Look up Existing UserOffboarding Resource

    Get an existing UserOffboarding 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?: UserOffboardingState, opts?: CustomResourceOptions): UserOffboarding
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action: Optional[str] = None,
            created_at: Optional[str] = None,
            executed_at: Optional[str] = None,
            revoke_sessions: Optional[bool] = None,
            revoke_tokens: Optional[bool] = None,
            scheduled_at: Optional[str] = None,
            status: Optional[str] = None,
            user: Optional[float] = None,
            user_offboarding_id: Optional[str] = None) -> UserOffboarding
    func GetUserOffboarding(ctx *Context, name string, id IDInput, state *UserOffboardingState, opts ...ResourceOption) (*UserOffboarding, error)
    public static UserOffboarding Get(string name, Input<string> id, UserOffboardingState? state, CustomResourceOptions? opts = null)
    public static UserOffboarding get(String name, Output<String> id, UserOffboardingState state, CustomResourceOptions options)
    resources:  _:    type: authentik:UserOffboarding    get:      id: ${id}
    import {
      to = authentik_user_offboarding.example
      id = "${id}"
    }
    
    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:
    Action string
    Allowed values:

    • deactivate
    • delete Generated.
    CreatedAt string
    Generated.
    ExecutedAt string
    Generated.
    RevokeSessions bool
    Generated.
    RevokeTokens bool
    Generated.
    ScheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    Status string
    Generated.
    User double
    PK of the user to offboard.
    UserOffboardingId string
    Action string
    Allowed values:

    • deactivate
    • delete Generated.
    CreatedAt string
    Generated.
    ExecutedAt string
    Generated.
    RevokeSessions bool
    Generated.
    RevokeTokens bool
    Generated.
    ScheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    Status string
    Generated.
    User float64
    PK of the user to offboard.
    UserOffboardingId string
    action string
    Allowed values:

    • deactivate
    • delete Generated.
    created_at string
    Generated.
    executed_at string
    Generated.
    revoke_sessions bool
    Generated.
    revoke_tokens bool
    Generated.
    scheduled_at string
    Absolute RFC3339 time at which the offboarding action is executed.
    status string
    Generated.
    user number
    PK of the user to offboard.
    user_offboarding_id string
    action String
    Allowed values:

    • deactivate
    • delete Generated.
    createdAt String
    Generated.
    executedAt String
    Generated.
    revokeSessions Boolean
    Generated.
    revokeTokens Boolean
    Generated.
    scheduledAt String
    Absolute RFC3339 time at which the offboarding action is executed.
    status String
    Generated.
    user Double
    PK of the user to offboard.
    userOffboardingId String
    action string
    Allowed values:

    • deactivate
    • delete Generated.
    createdAt string
    Generated.
    executedAt string
    Generated.
    revokeSessions boolean
    Generated.
    revokeTokens boolean
    Generated.
    scheduledAt string
    Absolute RFC3339 time at which the offboarding action is executed.
    status string
    Generated.
    user number
    PK of the user to offboard.
    userOffboardingId string
    action str
    Allowed values:

    • deactivate
    • delete Generated.
    created_at str
    Generated.
    executed_at str
    Generated.
    revoke_sessions bool
    Generated.
    revoke_tokens bool
    Generated.
    scheduled_at str
    Absolute RFC3339 time at which the offboarding action is executed.
    status str
    Generated.
    user float
    PK of the user to offboard.
    user_offboarding_id str
    action String
    Allowed values:

    • deactivate
    • delete Generated.
    createdAt String
    Generated.
    executedAt String
    Generated.
    revokeSessions Boolean
    Generated.
    revokeTokens Boolean
    Generated.
    scheduledAt String
    Absolute RFC3339 time at which the offboarding action is executed.
    status String
    Generated.
    user Number
    PK of the user to offboard.
    userOffboardingId String

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    Viewing docs for authentik 2026.8.0
    published on Wednesday, Sep 9, 2026 by goauthentik

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial