1. Packages
  2. Authentik Provider
  3. API Docs
  4. SourceScim
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

authentik.SourceScim

Get Started
authentik logo
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
Schema (JSON)
goauthentik/terraform-provider-authentik

    Example Usage

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

const name = new authentik.SourceScim("name", {slug: "test-source"});

    import pulumi
import pulumi_authentik as authentik

name = authentik.SourceScim("name", slug="test-source")

    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.NewSourceScim(ctx, "name", &authentik.SourceScimArgs{
			Slug: pulumi.String("test-source"),
		})
		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 name = new Authentik.SourceScim("name", new()
    {
        Slug = "test-source",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.SourceScim;
import com.pulumi.authentik.SourceScimArgs;
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 SourceScim("name", SourceScimArgs.builder()
            .slug("test-source")
            .build());

    }
}

    resources:
  name:
    type: authentik:SourceScim
    properties:
      slug: test-source

    Create SourceScim Resource

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

    Constructor syntax

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

@overload
def SourceScim(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               slug: Optional[str] = None,
               enabled: Optional[bool] = None,
               name: Optional[str] = None,
               property_mappings: Optional[Sequence[str]] = None,
               property_mappings_groups: Optional[Sequence[str]] = None,
               source_scim_id: Optional[str] = None,
               user_path_template: Optional[str] = None,
               uuid: Optional[str] = None)
    func NewSourceScim(ctx *Context, name string, args SourceScimArgs, opts ...ResourceOption) (*SourceScim, error)
    public SourceScim(string name, SourceScimArgs args, CustomResourceOptions? opts = null)
    public SourceScim(String name, SourceScimArgs args)
public SourceScim(String name, SourceScimArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SourceScimArgs
    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 SourceScimArgs
    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 SourceScimArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceScimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceScimArgs
    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 sourceScimResource = new Authentik.SourceScim("sourceScimResource", new()
{
    Slug = "string",
    Enabled = false,
    Name = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    SourceScimId = "string",
    UserPathTemplate = "string",
    Uuid = "string",
});

    example, err := authentik.NewSourceScim(ctx, "sourceScimResource", &authentik.SourceScimArgs{
	Slug:    pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	Name:    pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	SourceScimId:     pulumi.String("string"),
	UserPathTemplate: pulumi.String("string"),
	Uuid:             pulumi.String("string"),
})

    var sourceScimResource = new SourceScim("sourceScimResource", SourceScimArgs.builder()
    .slug("string")
    .enabled(false)
    .name("string")
    .propertyMappings("string")
    .propertyMappingsGroups("string")
    .sourceScimId("string")
    .userPathTemplate("string")
    .uuid("string")
    .build());

    source_scim_resource = authentik.SourceScim("sourceScimResource",
    slug="string",
    enabled=False,
    name="string",
    property_mappings=["string"],
    property_mappings_groups=["string"],
    source_scim_id="string",
    user_path_template="string",
    uuid="string")

    const sourceScimResource = new authentik.SourceScim("sourceScimResource", {
    slug: "string",
    enabled: false,
    name: "string",
    propertyMappings: ["string"],
    propertyMappingsGroups: ["string"],
    sourceScimId: "string",
    userPathTemplate: "string",
    uuid: "string",
});

    type: authentik:SourceScim
properties:
    enabled: false
    name: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    slug: string
    sourceScimId: string
    userPathTemplate: string
    uuid: string

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

    Slug string
    Enabled bool
    Defaults to true.
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    SourceScimId string
    The ID of this resource.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    Slug string
    Enabled bool
    Defaults to true.
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    SourceScimId string
    The ID of this resource.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    slug String
    enabled Boolean
    Defaults to true.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    sourceScimId String
    The ID of this resource.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.
    slug string
    enabled boolean
    Defaults to true.
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    sourceScimId string
    The ID of this resource.
    userPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid string
    Generated.
    slug str
    enabled bool
    Defaults to true.
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    source_scim_id str
    The ID of this resource.
    user_path_template str
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid str
    Generated.
    slug String
    enabled Boolean
    Defaults to true.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    sourceScimId String
    The ID of this resource.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ScimUrl string
    SCIM URL Generated.
    Token string
    SCIM URL Generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ScimUrl string
    SCIM URL Generated.
    Token string
    SCIM URL Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    scimUrl String
    SCIM URL Generated.
    token String
    SCIM URL Generated.
    id string
    The provider-assigned unique ID for this managed resource.
    scimUrl string
    SCIM URL Generated.
    token string
    SCIM URL Generated.
    id str
    The provider-assigned unique ID for this managed resource.
    scim_url str
    SCIM URL Generated.
    token str
    SCIM URL Generated.
    id String
    The provider-assigned unique ID for this managed resource.
    scimUrl String
    SCIM URL Generated.
    token String
    SCIM URL Generated.

    Look up Existing SourceScim Resource

    Get an existing SourceScim 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?: SourceScimState, opts?: CustomResourceOptions): SourceScim
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        property_mappings: Optional[Sequence[str]] = None,
        property_mappings_groups: Optional[Sequence[str]] = None,
        scim_url: Optional[str] = None,
        slug: Optional[str] = None,
        source_scim_id: Optional[str] = None,
        token: Optional[str] = None,
        user_path_template: Optional[str] = None,
        uuid: Optional[str] = None) -> SourceScim
    func GetSourceScim(ctx *Context, name string, id IDInput, state *SourceScimState, opts ...ResourceOption) (*SourceScim, error)
    public static SourceScim Get(string name, Input<string> id, SourceScimState? state, CustomResourceOptions? opts = null)
    public static SourceScim get(String name, Output<String> id, SourceScimState state, CustomResourceOptions options)
    resources:  _:    type: authentik:SourceScim    get:      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:
    Enabled bool
    Defaults to true.
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    ScimUrl string
    SCIM URL Generated.
    Slug string
    SourceScimId string
    The ID of this resource.
    Token string
    SCIM URL Generated.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    Enabled bool
    Defaults to true.
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    ScimUrl string
    SCIM URL Generated.
    Slug string
    SourceScimId string
    The ID of this resource.
    Token string
    SCIM URL Generated.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    enabled Boolean
    Defaults to true.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    scimUrl String
    SCIM URL Generated.
    slug String
    sourceScimId String
    The ID of this resource.
    token String
    SCIM URL Generated.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.
    enabled boolean
    Defaults to true.
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    scimUrl string
    SCIM URL Generated.
    slug string
    sourceScimId string
    The ID of this resource.
    token string
    SCIM URL Generated.
    userPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid string
    Generated.
    enabled bool
    Defaults to true.
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    scim_url str
    SCIM URL Generated.
    slug str
    source_scim_id str
    The ID of this resource.
    token str
    SCIM URL Generated.
    user_path_template str
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid str
    Generated.
    enabled Boolean
    Defaults to true.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    scimUrl String
    SCIM URL Generated.
    slug String
    sourceScimId String
    The ID of this resource.
    token String
    SCIM URL Generated.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
    Schema (JSON)
    goauthentik/terraform-provider-authentik
      Meet Neo: Your AI Platform Teammate