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

authentik.ProviderScim

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

    Example Usage

    Create ProviderScim Resource

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

    Constructor syntax

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

@overload
def ProviderScim(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 url: Optional[str] = None,
                 filter_group: Optional[str] = None,
                 auth_oauth_params: Optional[str] = None,
                 compatibility_mode: Optional[str] = None,
                 dry_run: Optional[bool] = None,
                 exclude_users_service_account: Optional[bool] = None,
                 auth_mode: Optional[str] = None,
                 name: Optional[str] = None,
                 property_mappings: Optional[Sequence[str]] = None,
                 property_mappings_groups: Optional[Sequence[str]] = None,
                 provider_scim_id: Optional[str] = None,
                 token: Optional[str] = None,
                 auth_oauth: Optional[str] = None)
    func NewProviderScim(ctx *Context, name string, args ProviderScimArgs, opts ...ResourceOption) (*ProviderScim, error)
    public ProviderScim(string name, ProviderScimArgs args, CustomResourceOptions? opts = null)
    public ProviderScim(String name, ProviderScimArgs args)
public ProviderScim(String name, ProviderScimArgs args, CustomResourceOptions options)

    type: authentik:ProviderScim
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 ProviderScimArgs
    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 ProviderScimArgs
    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 ProviderScimArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderScimArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderScimArgs
    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 providerScimResource = new Authentik.ProviderScim("providerScimResource", new()
{
    Url = "string",
    FilterGroup = "string",
    AuthOauthParams = "string",
    CompatibilityMode = "string",
    DryRun = false,
    ExcludeUsersServiceAccount = false,
    AuthMode = "string",
    Name = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    ProviderScimId = "string",
    Token = "string",
    AuthOauth = "string",
});

    example, err := authentik.NewProviderScim(ctx, "providerScimResource", &authentik.ProviderScimArgs{
	Url:                        pulumi.String("string"),
	FilterGroup:                pulumi.String("string"),
	AuthOauthParams:            pulumi.String("string"),
	CompatibilityMode:          pulumi.String("string"),
	DryRun:                     pulumi.Bool(false),
	ExcludeUsersServiceAccount: pulumi.Bool(false),
	AuthMode:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProviderScimId: pulumi.String("string"),
	Token:          pulumi.String("string"),
	AuthOauth:      pulumi.String("string"),
})

    var providerScimResource = new ProviderScim("providerScimResource", ProviderScimArgs.builder()
    .url("string")
    .filterGroup("string")
    .authOauthParams("string")
    .compatibilityMode("string")
    .dryRun(false)
    .excludeUsersServiceAccount(false)
    .authMode("string")
    .name("string")
    .propertyMappings("string")
    .propertyMappingsGroups("string")
    .providerScimId("string")
    .token("string")
    .authOauth("string")
    .build());

    provider_scim_resource = authentik.ProviderScim("providerScimResource",
    url="string",
    filter_group="string",
    auth_oauth_params="string",
    compatibility_mode="string",
    dry_run=False,
    exclude_users_service_account=False,
    auth_mode="string",
    name="string",
    property_mappings=["string"],
    property_mappings_groups=["string"],
    provider_scim_id="string",
    token="string",
    auth_oauth="string")

    const providerScimResource = new authentik.ProviderScim("providerScimResource", {
    url: "string",
    filterGroup: "string",
    authOauthParams: "string",
    compatibilityMode: "string",
    dryRun: false,
    excludeUsersServiceAccount: false,
    authMode: "string",
    name: "string",
    propertyMappings: ["string"],
    propertyMappingsGroups: ["string"],
    providerScimId: "string",
    token: "string",
    authOauth: "string",
});

    type: authentik:ProviderScim
properties:
    authMode: string
    authOauth: string
    authOauthParams: string
    compatibilityMode: string
    dryRun: false
    excludeUsersServiceAccount: false
    filterGroup: string
    name: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    providerScimId: string
    token: string
    url: string

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

    Url string
    AuthMode string
    Allowed values: - token - oauth Defaults to token.
    AuthOauth string
    Slug of an OAuth source used for authentication
    AuthOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    CompatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    DryRun bool
    Defaults to false.
    ExcludeUsersServiceAccount bool
    FilterGroup string
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    ProviderScimId string
    Token string
    Url string
    AuthMode string
    Allowed values: - token - oauth Defaults to token.
    AuthOauth string
    Slug of an OAuth source used for authentication
    AuthOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    CompatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    DryRun bool
    Defaults to false.
    ExcludeUsersServiceAccount bool
    FilterGroup string
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    ProviderScimId string
    Token string
    url String
    authMode String
    Allowed values: - token - oauth Defaults to token.
    authOauth String
    Slug of an OAuth source used for authentication
    authOauthParams String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode String
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun Boolean
    Defaults to false.
    excludeUsersServiceAccount Boolean
    filterGroup String
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerScimId String
    token String
    url string
    authMode string
    Allowed values: - token - oauth Defaults to token.
    authOauth string
    Slug of an OAuth source used for authentication
    authOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun boolean
    Defaults to false.
    excludeUsersServiceAccount boolean
    filterGroup string
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    providerScimId string
    token string
    url str
    auth_mode str
    Allowed values: - token - oauth Defaults to token.
    auth_oauth str
    Slug of an OAuth source used for authentication
    auth_oauth_params str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibility_mode str
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dry_run bool
    Defaults to false.
    exclude_users_service_account bool
    filter_group str
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    provider_scim_id str
    token str
    url String
    authMode String
    Allowed values: - token - oauth Defaults to token.
    authOauth String
    Slug of an OAuth source used for authentication
    authOauthParams String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode String
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun Boolean
    Defaults to false.
    excludeUsersServiceAccount Boolean
    filterGroup String
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerScimId String
    token String

    Outputs

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

    Get an existing ProviderScim 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?: ProviderScimState, opts?: CustomResourceOptions): ProviderScim
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_mode: Optional[str] = None,
        auth_oauth: Optional[str] = None,
        auth_oauth_params: Optional[str] = None,
        compatibility_mode: Optional[str] = None,
        dry_run: Optional[bool] = None,
        exclude_users_service_account: Optional[bool] = None,
        filter_group: Optional[str] = None,
        name: Optional[str] = None,
        property_mappings: Optional[Sequence[str]] = None,
        property_mappings_groups: Optional[Sequence[str]] = None,
        provider_scim_id: Optional[str] = None,
        token: Optional[str] = None,
        url: Optional[str] = None) -> ProviderScim
    func GetProviderScim(ctx *Context, name string, id IDInput, state *ProviderScimState, opts ...ResourceOption) (*ProviderScim, error)
    public static ProviderScim Get(string name, Input<string> id, ProviderScimState? state, CustomResourceOptions? opts = null)
    public static ProviderScim get(String name, Output<String> id, ProviderScimState state, CustomResourceOptions options)
    resources:  _:    type: authentik:ProviderScim    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:
    AuthMode string
    Allowed values: - token - oauth Defaults to token.
    AuthOauth string
    Slug of an OAuth source used for authentication
    AuthOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    CompatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    DryRun bool
    Defaults to false.
    ExcludeUsersServiceAccount bool
    FilterGroup string
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    ProviderScimId string
    Token string
    Url string
    AuthMode string
    Allowed values: - token - oauth Defaults to token.
    AuthOauth string
    Slug of an OAuth source used for authentication
    AuthOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    CompatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    DryRun bool
    Defaults to false.
    ExcludeUsersServiceAccount bool
    FilterGroup string
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    ProviderScimId string
    Token string
    Url string
    authMode String
    Allowed values: - token - oauth Defaults to token.
    authOauth String
    Slug of an OAuth source used for authentication
    authOauthParams String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode String
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun Boolean
    Defaults to false.
    excludeUsersServiceAccount Boolean
    filterGroup String
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerScimId String
    token String
    url String
    authMode string
    Allowed values: - token - oauth Defaults to token.
    authOauth string
    Slug of an OAuth source used for authentication
    authOauthParams string
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode string
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun boolean
    Defaults to false.
    excludeUsersServiceAccount boolean
    filterGroup string
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    providerScimId string
    token string
    url string
    auth_mode str
    Allowed values: - token - oauth Defaults to token.
    auth_oauth str
    Slug of an OAuth source used for authentication
    auth_oauth_params str
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibility_mode str
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dry_run bool
    Defaults to false.
    exclude_users_service_account bool
    filter_group str
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    provider_scim_id str
    token str
    url str
    authMode String
    Allowed values: - token - oauth Defaults to token.
    authOauth String
    Slug of an OAuth source used for authentication
    authOauthParams String
    JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
    compatibilityMode String
    Allowed values: - default - aws - slack - sfdc Defaults to default.
    dryRun Boolean
    Defaults to false.
    excludeUsersServiceAccount Boolean
    filterGroup String
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerScimId String
    token String
    url String

    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
    goauthentik/terraform-provider-authentik
      Meet Neo: Your AI Platform Teammate