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

authentik.PropertyMappingProviderSaml

Explore with Pulumi AI

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

    Manage SAML Provider Property mappings

    Example Usage

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

const saml_aws_rolessessionname = new authentik.PropertyMappingProviderSaml("saml-aws-rolessessionname", {
    expression: "return user.email",
    samlName: "https://aws.amazon.com/SAML/Attributes/RoleSessionName",
});

    import pulumi
import pulumi_authentik as authentik

saml_aws_rolessessionname = authentik.PropertyMappingProviderSaml("saml-aws-rolessessionname",
    expression="return user.email",
    saml_name="https://aws.amazon.com/SAML/Attributes/RoleSessionName")

    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.NewPropertyMappingProviderSaml(ctx, "saml-aws-rolessessionname", &authentik.PropertyMappingProviderSamlArgs{
			Expression: pulumi.String("return user.email"),
			SamlName:   pulumi.String("https://aws.amazon.com/SAML/Attributes/RoleSessionName"),
		})
		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 saml_aws_rolessessionname = new Authentik.PropertyMappingProviderSaml("saml-aws-rolessessionname", new()
    {
        Expression = "return user.email",
        SamlName = "https://aws.amazon.com/SAML/Attributes/RoleSessionName",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.PropertyMappingProviderSaml;
import com.pulumi.authentik.PropertyMappingProviderSamlArgs;
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 saml_aws_rolessessionname = new PropertyMappingProviderSaml("saml-aws-rolessessionname", PropertyMappingProviderSamlArgs.builder()
            .expression("return user.email")
            .samlName("https://aws.amazon.com/SAML/Attributes/RoleSessionName")
            .build());

    }
}

    resources:
  saml-aws-rolessessionname:
    type: authentik:PropertyMappingProviderSaml
    properties:
      expression: return user.email
      samlName: https://aws.amazon.com/SAML/Attributes/RoleSessionName

    Create PropertyMappingProviderSaml Resource

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

    Constructor syntax

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

@overload
def PropertyMappingProviderSaml(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                expression: Optional[str] = None,
                                saml_name: Optional[str] = None,
                                friendly_name: Optional[str] = None,
                                name: Optional[str] = None,
                                property_mapping_provider_saml_id: Optional[str] = None)
    func NewPropertyMappingProviderSaml(ctx *Context, name string, args PropertyMappingProviderSamlArgs, opts ...ResourceOption) (*PropertyMappingProviderSaml, error)
    public PropertyMappingProviderSaml(string name, PropertyMappingProviderSamlArgs args, CustomResourceOptions? opts = null)
    public PropertyMappingProviderSaml(String name, PropertyMappingProviderSamlArgs args)
public PropertyMappingProviderSaml(String name, PropertyMappingProviderSamlArgs args, CustomResourceOptions options)

    type: authentik:PropertyMappingProviderSaml
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 PropertyMappingProviderSamlArgs
    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 PropertyMappingProviderSamlArgs
    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 PropertyMappingProviderSamlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PropertyMappingProviderSamlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PropertyMappingProviderSamlArgs
    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 propertyMappingProviderSamlResource = new Authentik.PropertyMappingProviderSaml("propertyMappingProviderSamlResource", new()
{
    Expression = "string",
    SamlName = "string",
    FriendlyName = "string",
    Name = "string",
    PropertyMappingProviderSamlId = "string",
});

    example, err := authentik.NewPropertyMappingProviderSaml(ctx, "propertyMappingProviderSamlResource", &authentik.PropertyMappingProviderSamlArgs{
	Expression:                    pulumi.String("string"),
	SamlName:                      pulumi.String("string"),
	FriendlyName:                  pulumi.String("string"),
	Name:                          pulumi.String("string"),
	PropertyMappingProviderSamlId: pulumi.String("string"),
})

    var propertyMappingProviderSamlResource = new PropertyMappingProviderSaml("propertyMappingProviderSamlResource", PropertyMappingProviderSamlArgs.builder()
    .expression("string")
    .samlName("string")
    .friendlyName("string")
    .name("string")
    .propertyMappingProviderSamlId("string")
    .build());

    property_mapping_provider_saml_resource = authentik.PropertyMappingProviderSaml("propertyMappingProviderSamlResource",
    expression="string",
    saml_name="string",
    friendly_name="string",
    name="string",
    property_mapping_provider_saml_id="string")

    const propertyMappingProviderSamlResource = new authentik.PropertyMappingProviderSaml("propertyMappingProviderSamlResource", {
    expression: "string",
    samlName: "string",
    friendlyName: "string",
    name: "string",
    propertyMappingProviderSamlId: "string",
});

    type: authentik:PropertyMappingProviderSaml
properties:
    expression: string
    friendlyName: string
    name: string
    propertyMappingProviderSamlId: string
    samlName: string

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

    Expression string
    SamlName string
    FriendlyName string
    Name string
    PropertyMappingProviderSamlId string
    The ID of this resource.
    Expression string
    SamlName string
    FriendlyName string
    Name string
    PropertyMappingProviderSamlId string
    The ID of this resource.
    expression String
    samlName String
    friendlyName String
    name String
    propertyMappingProviderSamlId String
    The ID of this resource.
    expression string
    samlName string
    friendlyName string
    name string
    propertyMappingProviderSamlId string
    The ID of this resource.
    expression String
    samlName String
    friendlyName String
    name String
    propertyMappingProviderSamlId String
    The ID of this resource.

    Outputs

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

    Get an existing PropertyMappingProviderSaml 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?: PropertyMappingProviderSamlState, opts?: CustomResourceOptions): PropertyMappingProviderSaml
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        expression: Optional[str] = None,
        friendly_name: Optional[str] = None,
        name: Optional[str] = None,
        property_mapping_provider_saml_id: Optional[str] = None,
        saml_name: Optional[str] = None) -> PropertyMappingProviderSaml
    func GetPropertyMappingProviderSaml(ctx *Context, name string, id IDInput, state *PropertyMappingProviderSamlState, opts ...ResourceOption) (*PropertyMappingProviderSaml, error)
    public static PropertyMappingProviderSaml Get(string name, Input<string> id, PropertyMappingProviderSamlState? state, CustomResourceOptions? opts = null)
    public static PropertyMappingProviderSaml get(String name, Output<String> id, PropertyMappingProviderSamlState state, CustomResourceOptions options)
    resources:  _:    type: authentik:PropertyMappingProviderSaml    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:
    Expression string
    FriendlyName string
    Name string
    PropertyMappingProviderSamlId string
    The ID of this resource.
    SamlName string
    Expression string
    FriendlyName string
    Name string
    PropertyMappingProviderSamlId string
    The ID of this resource.
    SamlName string
    expression String
    friendlyName String
    name String
    propertyMappingProviderSamlId String
    The ID of this resource.
    samlName String
    expression string
    friendlyName string
    name string
    propertyMappingProviderSamlId string
    The ID of this resource.
    samlName string
    expression String
    friendlyName String
    name String
    propertyMappingProviderSamlId String
    The ID of this resource.
    samlName 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.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik