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

authentik.ProviderMicrosoftEntra

Explore with Pulumi AI

authentik logo
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

    Create ProviderMicrosoftEntra Resource

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

    Constructor syntax

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

@overload
def ProviderMicrosoftEntra(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           client_id: Optional[str] = None,
                           client_secret: Optional[str] = None,
                           tenant_id: Optional[str] = None,
                           exclude_users_service_account: Optional[bool] = None,
                           filter_group: Optional[str] = None,
                           group_delete_action: Optional[str] = None,
                           name: Optional[str] = None,
                           property_mappings: Optional[Sequence[str]] = None,
                           property_mappings_groups: Optional[Sequence[str]] = None,
                           provider_microsoft_entra_id: Optional[str] = None,
                           user_delete_action: Optional[str] = None)
    func NewProviderMicrosoftEntra(ctx *Context, name string, args ProviderMicrosoftEntraArgs, opts ...ResourceOption) (*ProviderMicrosoftEntra, error)
    public ProviderMicrosoftEntra(string name, ProviderMicrosoftEntraArgs args, CustomResourceOptions? opts = null)
    public ProviderMicrosoftEntra(String name, ProviderMicrosoftEntraArgs args)
public ProviderMicrosoftEntra(String name, ProviderMicrosoftEntraArgs args, CustomResourceOptions options)

    type: authentik:ProviderMicrosoftEntra
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 ProviderMicrosoftEntraArgs
    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 ProviderMicrosoftEntraArgs
    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 ProviderMicrosoftEntraArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderMicrosoftEntraArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderMicrosoftEntraArgs
    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 providerMicrosoftEntraResource = new Authentik.ProviderMicrosoftEntra("providerMicrosoftEntraResource", new()
{
    ClientId = "string",
    ClientSecret = "string",
    TenantId = "string",
    ExcludeUsersServiceAccount = false,
    FilterGroup = "string",
    GroupDeleteAction = "string",
    Name = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    ProviderMicrosoftEntraId = "string",
    UserDeleteAction = "string",
});

    example, err := authentik.NewProviderMicrosoftEntra(ctx, "providerMicrosoftEntraResource", &authentik.ProviderMicrosoftEntraArgs{
	ClientId:                   pulumi.String("string"),
	ClientSecret:               pulumi.String("string"),
	TenantId:                   pulumi.String("string"),
	ExcludeUsersServiceAccount: pulumi.Bool(false),
	FilterGroup:                pulumi.String("string"),
	GroupDeleteAction:          pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProviderMicrosoftEntraId: pulumi.String("string"),
	UserDeleteAction:         pulumi.String("string"),
})

    var providerMicrosoftEntraResource = new ProviderMicrosoftEntra("providerMicrosoftEntraResource", ProviderMicrosoftEntraArgs.builder()
    .clientId("string")
    .clientSecret("string")
    .tenantId("string")
    .excludeUsersServiceAccount(false)
    .filterGroup("string")
    .groupDeleteAction("string")
    .name("string")
    .propertyMappings("string")
    .propertyMappingsGroups("string")
    .providerMicrosoftEntraId("string")
    .userDeleteAction("string")
    .build());

    provider_microsoft_entra_resource = authentik.ProviderMicrosoftEntra("providerMicrosoftEntraResource",
    client_id="string",
    client_secret="string",
    tenant_id="string",
    exclude_users_service_account=False,
    filter_group="string",
    group_delete_action="string",
    name="string",
    property_mappings=["string"],
    property_mappings_groups=["string"],
    provider_microsoft_entra_id="string",
    user_delete_action="string")

    const providerMicrosoftEntraResource = new authentik.ProviderMicrosoftEntra("providerMicrosoftEntraResource", {
    clientId: "string",
    clientSecret: "string",
    tenantId: "string",
    excludeUsersServiceAccount: false,
    filterGroup: "string",
    groupDeleteAction: "string",
    name: "string",
    propertyMappings: ["string"],
    propertyMappingsGroups: ["string"],
    providerMicrosoftEntraId: "string",
    userDeleteAction: "string",
});

    type: authentik:ProviderMicrosoftEntra
properties:
    clientId: string
    clientSecret: string
    excludeUsersServiceAccount: false
    filterGroup: string
    groupDeleteAction: string
    name: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    providerMicrosoftEntraId: string
    tenantId: string
    userDeleteAction: string

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

    ClientId string
    ClientSecret string
    TenantId string
    ExcludeUsersServiceAccount bool
    FilterGroup string
    GroupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    ProviderMicrosoftEntraId string
    UserDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    ClientId string
    ClientSecret string
    TenantId string
    ExcludeUsersServiceAccount bool
    FilterGroup string
    GroupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    ProviderMicrosoftEntraId string
    UserDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId String
    clientSecret String
    tenantId String
    excludeUsersServiceAccount Boolean
    filterGroup String
    groupDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerMicrosoftEntraId String
    userDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId string
    clientSecret string
    tenantId string
    excludeUsersServiceAccount boolean
    filterGroup string
    groupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    providerMicrosoftEntraId string
    userDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    client_id str
    client_secret str
    tenant_id str
    exclude_users_service_account bool
    filter_group str
    group_delete_action str
    Allowed values: - delete - do_nothing Defaults to delete.
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    provider_microsoft_entra_id str
    user_delete_action str
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId String
    clientSecret String
    tenantId String
    excludeUsersServiceAccount Boolean
    filterGroup String
    groupDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerMicrosoftEntraId String
    userDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.

    Outputs

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

    Get an existing ProviderMicrosoftEntra 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?: ProviderMicrosoftEntraState, opts?: CustomResourceOptions): ProviderMicrosoftEntra
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        exclude_users_service_account: Optional[bool] = None,
        filter_group: Optional[str] = None,
        group_delete_action: Optional[str] = None,
        name: Optional[str] = None,
        property_mappings: Optional[Sequence[str]] = None,
        property_mappings_groups: Optional[Sequence[str]] = None,
        provider_microsoft_entra_id: Optional[str] = None,
        tenant_id: Optional[str] = None,
        user_delete_action: Optional[str] = None) -> ProviderMicrosoftEntra
    func GetProviderMicrosoftEntra(ctx *Context, name string, id IDInput, state *ProviderMicrosoftEntraState, opts ...ResourceOption) (*ProviderMicrosoftEntra, error)
    public static ProviderMicrosoftEntra Get(string name, Input<string> id, ProviderMicrosoftEntraState? state, CustomResourceOptions? opts = null)
    public static ProviderMicrosoftEntra get(String name, Output<String> id, ProviderMicrosoftEntraState state, CustomResourceOptions options)
    resources:  _:    type: authentik:ProviderMicrosoftEntra    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:
    ClientId string
    ClientSecret string
    ExcludeUsersServiceAccount bool
    FilterGroup string
    GroupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    Name string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    ProviderMicrosoftEntraId string
    TenantId string
    UserDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    ClientId string
    ClientSecret string
    ExcludeUsersServiceAccount bool
    FilterGroup string
    GroupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    Name string
    PropertyMappings []string
    PropertyMappingsGroups []string
    ProviderMicrosoftEntraId string
    TenantId string
    UserDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId String
    clientSecret String
    excludeUsersServiceAccount Boolean
    filterGroup String
    groupDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerMicrosoftEntraId String
    tenantId String
    userDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId string
    clientSecret string
    excludeUsersServiceAccount boolean
    filterGroup string
    groupDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    name string
    propertyMappings string[]
    propertyMappingsGroups string[]
    providerMicrosoftEntraId string
    tenantId string
    userDeleteAction string
    Allowed values: - delete - do_nothing Defaults to delete.
    client_id str
    client_secret str
    exclude_users_service_account bool
    filter_group str
    group_delete_action str
    Allowed values: - delete - do_nothing Defaults to delete.
    name str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    provider_microsoft_entra_id str
    tenant_id str
    user_delete_action str
    Allowed values: - delete - do_nothing Defaults to delete.
    clientId String
    clientSecret String
    excludeUsersServiceAccount Boolean
    filterGroup String
    groupDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.
    name String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    providerMicrosoftEntraId String
    tenantId String
    userDeleteAction String
    Allowed values: - delete - do_nothing Defaults to delete.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik