Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Authentik Provider
  4. API Docs
  5. ObjectAttribute
Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

authentik.ObjectAttribute

Viewing docs for authentik 2026.8.0
published on Wednesday, Sep 9, 2026 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

    Example Usage

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

const example = new authentik.ObjectAttribute("example", {
    objectType: "authentik_core.user",
    key: "employee_id",
    label: "Employee ID",
    type: "text",
    isUnique: true,
    isRequired: false,
});

    import pulumi
import pulumi_authentik as authentik

example = authentik.ObjectAttribute("example",
    object_type="authentik_core.user",
    key="employee_id",
    label="Employee ID",
    type="text",
    is_unique=True,
    is_required=False)

    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 {
		_, err := authentik.NewObjectAttribute(ctx, "example", &authentik.ObjectAttributeArgs{
			ObjectType: pulumi.String("authentik_core.user"),
			Key:        pulumi.String("employee_id"),
			Label:      pulumi.String("Employee ID"),
			Type:       pulumi.String("text"),
			IsUnique:   pulumi.Bool(true),
			IsRequired: pulumi.Bool(false),
		})
		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.ObjectAttribute("example", new()
    {
        ObjectType = "authentik_core.user",
        Key = "employee_id",
        Label = "Employee ID",
        Type = "text",
        IsUnique = true,
        IsRequired = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.ObjectAttribute;
import com.pulumi.authentik.ObjectAttributeArgs;
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 ObjectAttribute("example", ObjectAttributeArgs.builder()
            .objectType("authentik_core.user")
            .key("employee_id")
            .label("Employee ID")
            .type("text")
            .isUnique(true)
            .isRequired(false)
            .build());

    }
}

    resources:
  example:
    type: authentik:ObjectAttribute
    properties:
      objectType: authentik_core.user
      key: employee_id
      label: Employee ID
      type: text
      isUnique: true
      isRequired: false

    Example coming soon!

    Create ObjectAttribute Resource

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

    Constructor syntax

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

@overload
def ObjectAttribute(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    key: Optional[str] = None,
                    label: Optional[str] = None,
                    object_type: Optional[str] = None,
                    type: Optional[str] = None,
                    enabled: Optional[bool] = None,
                    group: Optional[str] = None,
                    is_required: Optional[bool] = None,
                    is_unique: Optional[bool] = None,
                    managed: Optional[str] = None,
                    object_attribute_id: Optional[str] = None,
                    regex: Optional[str] = None)
    func NewObjectAttribute(ctx *Context, name string, args ObjectAttributeArgs, opts ...ResourceOption) (*ObjectAttribute, error)
    public ObjectAttribute(string name, ObjectAttributeArgs args, CustomResourceOptions? opts = null)
    public ObjectAttribute(String name, ObjectAttributeArgs args)
public ObjectAttribute(String name, ObjectAttributeArgs args, CustomResourceOptions options)

    type: authentik:ObjectAttribute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "authentik_object_attribute" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ObjectAttributeArgs
    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 ObjectAttributeArgs
    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 ObjectAttributeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectAttributeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectAttributeArgs
    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 objectAttributeResource = new Authentik.ObjectAttribute("objectAttributeResource", new()
{
    Key = "string",
    Label = "string",
    ObjectType = "string",
    Type = "string",
    Enabled = false,
    Group = "string",
    IsRequired = false,
    IsUnique = false,
    Managed = "string",
    ObjectAttributeId = "string",
    Regex = "string",
});

    example, err := authentik.NewObjectAttribute(ctx, "objectAttributeResource", &authentik.ObjectAttributeArgs{
	Key:               pulumi.String("string"),
	Label:             pulumi.String("string"),
	ObjectType:        pulumi.String("string"),
	Type:              pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	Group:             pulumi.String("string"),
	IsRequired:        pulumi.Bool(false),
	IsUnique:          pulumi.Bool(false),
	Managed:           pulumi.String("string"),
	ObjectAttributeId: pulumi.String("string"),
	Regex:             pulumi.String("string"),
})

    resource "authentik_object_attribute" "objectAttributeResource" {
  lifecycle {
    create_before_destroy = true
  }
  key                 = "string"
  label               = "string"
  object_type         = "string"
  type                = "string"
  enabled             = false
  group               = "string"
  is_required         = false
  is_unique           = false
  managed             = "string"
  object_attribute_id = "string"
  regex               = "string"
}

    var objectAttributeResource = new ObjectAttribute("objectAttributeResource", ObjectAttributeArgs.builder()
    .key("string")
    .label("string")
    .objectType("string")
    .type("string")
    .enabled(false)
    .group("string")
    .isRequired(false)
    .isUnique(false)
    .managed("string")
    .objectAttributeId("string")
    .regex("string")
    .build());

    object_attribute_resource = authentik.ObjectAttribute("objectAttributeResource",
    key="string",
    label="string",
    object_type="string",
    type="string",
    enabled=False,
    group="string",
    is_required=False,
    is_unique=False,
    managed="string",
    object_attribute_id="string",
    regex="string")

    const objectAttributeResource = new authentik.ObjectAttribute("objectAttributeResource", {
    key: "string",
    label: "string",
    objectType: "string",
    type: "string",
    enabled: false,
    group: "string",
    isRequired: false,
    isUnique: false,
    managed: "string",
    objectAttributeId: "string",
    regex: "string",
});

    type: authentik:ObjectAttribute
properties:
    enabled: false
    group: string
    isRequired: false
    isUnique: false
    key: string
    label: string
    managed: string
    objectAttributeId: string
    objectType: string
    regex: string
    type: string

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

    Key string
    Label string
    ObjectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    Type string
    Allowed values:

    • text
    • number
    • boolean
    Enabled bool
    Defaults to true.
    Group string
    IsRequired bool
    IsUnique bool
    Managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    ObjectAttributeId string
    Regex string
    Key string
    Label string
    ObjectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    Type string
    Allowed values:

    • text
    • number
    • boolean
    Enabled bool
    Defaults to true.
    Group string
    IsRequired bool
    IsUnique bool
    Managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    ObjectAttributeId string
    Regex string
    key string
    label string
    object_type string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    type string
    Allowed values:

    • text
    • number
    • boolean
    enabled bool
    Defaults to true.
    group string
    is_required bool
    is_unique bool
    managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    object_attribute_id string
    regex string
    key String
    label String
    objectType String
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    type String
    Allowed values:

    • text
    • number
    • boolean
    enabled Boolean
    Defaults to true.
    group String
    isRequired Boolean
    isUnique Boolean
    managed String
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId String
    regex String
    key string
    label string
    objectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    type string
    Allowed values:

    • text
    • number
    • boolean
    enabled boolean
    Defaults to true.
    group string
    isRequired boolean
    isUnique boolean
    managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId string
    regex string
    key str
    label str
    object_type str
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    type str
    Allowed values:

    • text
    • number
    • boolean
    enabled bool
    Defaults to true.
    group str
    is_required bool
    is_unique bool
    managed str
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    object_attribute_id str
    regex str
    key String
    label String
    objectType String
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    type String
    Allowed values:

    • text
    • number
    • boolean
    enabled Boolean
    Defaults to true.
    group String
    isRequired Boolean
    isUnique Boolean
    managed String
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId String
    regex String

    Outputs

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

    Created string
    Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Generated.
    Created string
    Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Generated.
    created string
    Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    last_updated string
    Generated.
    created String
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Generated.
    created string
    Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    Generated.
    created str
    Generated.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    Generated.
    created String
    Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Generated.

    Look up Existing ObjectAttribute Resource

    Get an existing ObjectAttribute 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?: ObjectAttributeState, opts?: CustomResourceOptions): ObjectAttribute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        enabled: Optional[bool] = None,
        group: Optional[str] = None,
        is_required: Optional[bool] = None,
        is_unique: Optional[bool] = None,
        key: Optional[str] = None,
        label: Optional[str] = None,
        last_updated: Optional[str] = None,
        managed: Optional[str] = None,
        object_attribute_id: Optional[str] = None,
        object_type: Optional[str] = None,
        regex: Optional[str] = None,
        type: Optional[str] = None) -> ObjectAttribute
    func GetObjectAttribute(ctx *Context, name string, id IDInput, state *ObjectAttributeState, opts ...ResourceOption) (*ObjectAttribute, error)
    public static ObjectAttribute Get(string name, Input<string> id, ObjectAttributeState? state, CustomResourceOptions? opts = null)
    public static ObjectAttribute get(String name, Output<String> id, ObjectAttributeState state, CustomResourceOptions options)
    resources:  _:    type: authentik:ObjectAttribute    get:      id: ${id}
    import {
  to = authentik_object_attribute.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:
    Created string
    Generated.
    Enabled bool
    Defaults to true.
    Group string
    IsRequired bool
    IsUnique bool
    Key string
    Label string
    LastUpdated string
    Generated.
    Managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    ObjectAttributeId string
    ObjectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    Regex string
    Type string
    Allowed values:

    • text
    • number
    • boolean
    Created string
    Generated.
    Enabled bool
    Defaults to true.
    Group string
    IsRequired bool
    IsUnique bool
    Key string
    Label string
    LastUpdated string
    Generated.
    Managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    ObjectAttributeId string
    ObjectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    Regex string
    Type string
    Allowed values:

    • text
    • number
    • boolean
    created string
    Generated.
    enabled bool
    Defaults to true.
    group string
    is_required bool
    is_unique bool
    key string
    label string
    last_updated string
    Generated.
    managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    object_attribute_id string
    object_type string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    regex string
    type string
    Allowed values:

    • text
    • number
    • boolean
    created String
    Generated.
    enabled Boolean
    Defaults to true.
    group String
    isRequired Boolean
    isUnique Boolean
    key String
    label String
    lastUpdated String
    Generated.
    managed String
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId String
    objectType String
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    regex String
    type String
    Allowed values:

    • text
    • number
    • boolean
    created string
    Generated.
    enabled boolean
    Defaults to true.
    group string
    isRequired boolean
    isUnique boolean
    key string
    label string
    lastUpdated string
    Generated.
    managed string
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId string
    objectType string
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    regex string
    type string
    Allowed values:

    • text
    • number
    • boolean
    created str
    Generated.
    enabled bool
    Defaults to true.
    group str
    is_required bool
    is_unique bool
    key str
    label str
    last_updated str
    Generated.
    managed str
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    object_attribute_id str
    object_type str
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    regex str
    type str
    Allowed values:

    • text
    • number
    • boolean
    created String
    Generated.
    enabled Boolean
    Defaults to true.
    group String
    isRequired Boolean
    isUnique Boolean
    key String
    label String
    lastUpdated String
    Generated.
    managed String
    Objects that are managed by authentik are created/updated automatically and may be overwritten by later migrations.
    objectAttributeId String
    objectType String
    Content-type of the objects this attribute definition applies to, e.g. authentik_core.user.
    regex String
    type String
    Allowed values:

    • text
    • number
    • boolean

    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
    Schema (JSON)
    goauthentik/terraform-provider-authentik

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial