1. Packages
  2. Authentik Provider
  3. API Docs
  4. PropertyMappingSourceSaml
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

authentik.PropertyMappingSourceSaml

Explore with Pulumi AI

Manage SAML Source Property mappings

Create PropertyMappingSourceSaml Resource

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

Constructor syntax

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

@overload
def PropertyMappingSourceSaml(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              expression: Optional[str] = None,
                              name: Optional[str] = None,
                              property_mapping_source_saml_id: Optional[str] = None)
func NewPropertyMappingSourceSaml(ctx *Context, name string, args PropertyMappingSourceSamlArgs, opts ...ResourceOption) (*PropertyMappingSourceSaml, error)
public PropertyMappingSourceSaml(string name, PropertyMappingSourceSamlArgs args, CustomResourceOptions? opts = null)
public PropertyMappingSourceSaml(String name, PropertyMappingSourceSamlArgs args)
public PropertyMappingSourceSaml(String name, PropertyMappingSourceSamlArgs args, CustomResourceOptions options)
type: authentik:PropertyMappingSourceSaml
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. PropertyMappingSourceSamlArgs
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. PropertyMappingSourceSamlArgs
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. PropertyMappingSourceSamlArgs
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. PropertyMappingSourceSamlArgs
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. PropertyMappingSourceSamlArgs
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 propertyMappingSourceSamlResource = new Authentik.PropertyMappingSourceSaml("propertyMappingSourceSamlResource", new()
{
    Expression = "string",
    Name = "string",
    PropertyMappingSourceSamlId = "string",
});
Copy
example, err := authentik.NewPropertyMappingSourceSaml(ctx, "propertyMappingSourceSamlResource", &authentik.PropertyMappingSourceSamlArgs{
	Expression:                  pulumi.String("string"),
	Name:                        pulumi.String("string"),
	PropertyMappingSourceSamlId: pulumi.String("string"),
})
Copy
var propertyMappingSourceSamlResource = new PropertyMappingSourceSaml("propertyMappingSourceSamlResource", PropertyMappingSourceSamlArgs.builder()
    .expression("string")
    .name("string")
    .propertyMappingSourceSamlId("string")
    .build());
Copy
property_mapping_source_saml_resource = authentik.PropertyMappingSourceSaml("propertyMappingSourceSamlResource",
    expression="string",
    name="string",
    property_mapping_source_saml_id="string")
Copy
const propertyMappingSourceSamlResource = new authentik.PropertyMappingSourceSaml("propertyMappingSourceSamlResource", {
    expression: "string",
    name: "string",
    propertyMappingSourceSamlId: "string",
});
Copy
type: authentik:PropertyMappingSourceSaml
properties:
    expression: string
    name: string
    propertyMappingSourceSamlId: string
Copy

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

Expression This property is required. string
Name string
PropertyMappingSourceSamlId string
The ID of this resource.
Expression This property is required. string
Name string
PropertyMappingSourceSamlId string
The ID of this resource.
expression This property is required. String
name String
propertyMappingSourceSamlId String
The ID of this resource.
expression This property is required. string
name string
propertyMappingSourceSamlId string
The ID of this resource.
expression This property is required. str
name str
property_mapping_source_saml_id str
The ID of this resource.
expression This property is required. String
name String
propertyMappingSourceSamlId String
The ID of this resource.

Outputs

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

Get an existing PropertyMappingSourceSaml 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?: PropertyMappingSourceSamlState, opts?: CustomResourceOptions): PropertyMappingSourceSaml
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        expression: Optional[str] = None,
        name: Optional[str] = None,
        property_mapping_source_saml_id: Optional[str] = None) -> PropertyMappingSourceSaml
func GetPropertyMappingSourceSaml(ctx *Context, name string, id IDInput, state *PropertyMappingSourceSamlState, opts ...ResourceOption) (*PropertyMappingSourceSaml, error)
public static PropertyMappingSourceSaml Get(string name, Input<string> id, PropertyMappingSourceSamlState? state, CustomResourceOptions? opts = null)
public static PropertyMappingSourceSaml get(String name, Output<String> id, PropertyMappingSourceSamlState state, CustomResourceOptions options)
resources:  _:    type: authentik:PropertyMappingSourceSaml    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:
Expression string
Name string
PropertyMappingSourceSamlId string
The ID of this resource.
Expression string
Name string
PropertyMappingSourceSamlId string
The ID of this resource.
expression String
name String
propertyMappingSourceSamlId String
The ID of this resource.
expression string
name string
propertyMappingSourceSamlId string
The ID of this resource.
expression str
name str
property_mapping_source_saml_id str
The ID of this resource.
expression String
name String
propertyMappingSourceSamlId String
The ID of this resource.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.