Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. ProviderScim
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.ProviderScim

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 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,
                 token: Optional[str] = None,
                 url: Optional[str] = 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)
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 This property is required. string
The unique name of the resource.
args This property is required. ProviderScimArgs
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 This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ProviderScimArgs
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 This property is required. ProviderScimArgs
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. 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()
{
    Token = "string",
    Url = "string",
    ExcludeUsersServiceAccount = false,
    FilterGroup = "string",
    Name = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    ProviderScimId = "string",
});
Copy
example, err := authentik.NewProviderScim(ctx, "providerScimResource", &authentik.ProviderScimArgs{
	Token:                      pulumi.String("string"),
	Url:                        pulumi.String("string"),
	ExcludeUsersServiceAccount: pulumi.Bool(false),
	FilterGroup:                pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProviderScimId: pulumi.String("string"),
})
Copy
var providerScimResource = new ProviderScim("providerScimResource", ProviderScimArgs.builder()
    .token("string")
    .url("string")
    .excludeUsersServiceAccount(false)
    .filterGroup("string")
    .name("string")
    .propertyMappings("string")
    .propertyMappingsGroups("string")
    .providerScimId("string")
    .build());
Copy
provider_scim_resource = authentik.ProviderScim("providerScimResource",
    token="string",
    url="string",
    exclude_users_service_account=False,
    filter_group="string",
    name="string",
    property_mappings=["string"],
    property_mappings_groups=["string"],
    provider_scim_id="string")
Copy
const providerScimResource = new authentik.ProviderScim("providerScimResource", {
    token: "string",
    url: "string",
    excludeUsersServiceAccount: false,
    filterGroup: "string",
    name: "string",
    propertyMappings: ["string"],
    propertyMappingsGroups: ["string"],
    providerScimId: "string",
});
Copy
type: authentik:ProviderScim
properties:
    excludeUsersServiceAccount: false
    filterGroup: string
    name: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    providerScimId: string
    token: string
    url: string
Copy

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:

Token This property is required. string
Url This property is required. string
ExcludeUsersServiceAccount bool
FilterGroup string
Name string
PropertyMappings List<string>
PropertyMappingsGroups List<string>
ProviderScimId string
The ID of this resource.
Token This property is required. string
Url This property is required. string
ExcludeUsersServiceAccount bool
FilterGroup string
Name string
PropertyMappings []string
PropertyMappingsGroups []string
ProviderScimId string
The ID of this resource.
token This property is required. String
url This property is required. String
excludeUsersServiceAccount Boolean
filterGroup String
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerScimId String
The ID of this resource.
token This property is required. string
url This property is required. string
excludeUsersServiceAccount boolean
filterGroup string
name string
propertyMappings string[]
propertyMappingsGroups string[]
providerScimId string
The ID of this resource.
token This property is required. str
url This property is required. str
exclude_users_service_account bool
filter_group str
name str
property_mappings Sequence[str]
property_mappings_groups Sequence[str]
provider_scim_id str
The ID of this resource.
token This property is required. String
url This property is required. String
excludeUsersServiceAccount Boolean
filterGroup String
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerScimId String
The ID of this resource.

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,
        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 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:
ExcludeUsersServiceAccount bool
FilterGroup string
Name string
PropertyMappings List<string>
PropertyMappingsGroups List<string>
ProviderScimId string
The ID of this resource.
Token string
Url string
ExcludeUsersServiceAccount bool
FilterGroup string
Name string
PropertyMappings []string
PropertyMappingsGroups []string
ProviderScimId string
The ID of this resource.
Token string
Url string
excludeUsersServiceAccount Boolean
filterGroup String
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerScimId String
The ID of this resource.
token String
url String
excludeUsersServiceAccount boolean
filterGroup string
name string
propertyMappings string[]
propertyMappingsGroups string[]
providerScimId string
The ID of this resource.
token string
url string
exclude_users_service_account bool
filter_group str
name str
property_mappings Sequence[str]
property_mappings_groups Sequence[str]
provider_scim_id str
The ID of this resource.
token str
url str
excludeUsersServiceAccount Boolean
filterGroup String
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerScimId String
The ID of this resource.
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 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik