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

authentik.PropertyMappingSaml

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

    This resource is deprecated. Migrate to authentik.PropertyMappingProviderSaml.

    Create PropertyMappingSaml Resource

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

    Constructor syntax

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

@overload
def PropertyMappingSaml(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_saml_id: Optional[str] = None)
    func NewPropertyMappingSaml(ctx *Context, name string, args PropertyMappingSamlArgs, opts ...ResourceOption) (*PropertyMappingSaml, error)
    public PropertyMappingSaml(string name, PropertyMappingSamlArgs args, CustomResourceOptions? opts = null)
    public PropertyMappingSaml(String name, PropertyMappingSamlArgs args)
public PropertyMappingSaml(String name, PropertyMappingSamlArgs args, CustomResourceOptions options)

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

    example, err := authentik.NewPropertyMappingSaml(ctx, "propertyMappingSamlResource", &authentik.PropertyMappingSamlArgs{
	Expression:            pulumi.String("string"),
	SamlName:              pulumi.String("string"),
	FriendlyName:          pulumi.String("string"),
	Name:                  pulumi.String("string"),
	PropertyMappingSamlId: pulumi.String("string"),
})

    var propertyMappingSamlResource = new PropertyMappingSaml("propertyMappingSamlResource", PropertyMappingSamlArgs.builder()
    .expression("string")
    .samlName("string")
    .friendlyName("string")
    .name("string")
    .propertyMappingSamlId("string")
    .build());

    property_mapping_saml_resource = authentik.PropertyMappingSaml("propertyMappingSamlResource",
    expression="string",
    saml_name="string",
    friendly_name="string",
    name="string",
    property_mapping_saml_id="string")

    const propertyMappingSamlResource = new authentik.PropertyMappingSaml("propertyMappingSamlResource", {
    expression: "string",
    samlName: "string",
    friendlyName: "string",
    name: "string",
    propertyMappingSamlId: "string",
});

    type: authentik:PropertyMappingSaml
properties:
    expression: string
    friendlyName: string
    name: string
    propertyMappingSamlId: string
    samlName: string

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

    Expression string
    SamlName string
    FriendlyName string
    Name string
    PropertyMappingSamlId string
    The ID of this resource.
    Expression string
    SamlName string
    FriendlyName string
    Name string
    PropertyMappingSamlId string
    The ID of this resource.
    expression String
    samlName String
    friendlyName String
    name String
    propertyMappingSamlId String
    The ID of this resource.
    expression string
    samlName string
    friendlyName string
    name string
    propertyMappingSamlId string
    The ID of this resource.
    expression str
    saml_name str
    friendly_name str
    name str
    property_mapping_saml_id str
    The ID of this resource.
    expression String
    samlName String
    friendlyName String
    name String
    propertyMappingSamlId String
    The ID of this resource.

    Outputs

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

    Get an existing PropertyMappingSaml 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?: PropertyMappingSamlState, opts?: CustomResourceOptions): PropertyMappingSaml
    @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_saml_id: Optional[str] = None,
        saml_name: Optional[str] = None) -> PropertyMappingSaml
    func GetPropertyMappingSaml(ctx *Context, name string, id IDInput, state *PropertyMappingSamlState, opts ...ResourceOption) (*PropertyMappingSaml, error)
    public static PropertyMappingSaml Get(string name, Input<string> id, PropertyMappingSamlState? state, CustomResourceOptions? opts = null)
    public static PropertyMappingSaml get(String name, Output<String> id, PropertyMappingSamlState state, CustomResourceOptions options)
    resources:  _:    type: authentik:PropertyMappingSaml    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
    PropertyMappingSamlId string
    The ID of this resource.
    SamlName string
    Expression string
    FriendlyName string
    Name string
    PropertyMappingSamlId string
    The ID of this resource.
    SamlName string
    expression String
    friendlyName String
    name String
    propertyMappingSamlId String
    The ID of this resource.
    samlName String
    expression string
    friendlyName string
    name string
    propertyMappingSamlId string
    The ID of this resource.
    samlName string
    expression str
    friendly_name str
    name str
    property_mapping_saml_id str
    The ID of this resource.
    saml_name str
    expression String
    friendlyName String
    name String
    propertyMappingSamlId 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