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

authentik.PropertyMappingProviderScope

Explore with Pulumi AI

Manage Scope Provider Property mappings

Example Usage

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

const name = new authentik.PropertyMappingProviderScope("name", {
    expression: `return {
  "policy": "readwrite",
}

`,
    scopeName: "minio",
});
Copy
import pulumi
import pulumi_authentik as authentik

name = authentik.PropertyMappingProviderScope("name",
    expression="""return {
  "policy": "readwrite",
}

""",
    scope_name="minio")
Copy
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.NewPropertyMappingProviderScope(ctx, "name", &authentik.PropertyMappingProviderScopeArgs{
			Expression: pulumi.String("return {\n  \"policy\": \"readwrite\",\n}\n\n"),
			ScopeName:  pulumi.String("minio"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var name = new Authentik.PropertyMappingProviderScope("name", new()
    {
        Expression = @"return {
  ""policy"": ""readwrite"",
}

",
        ScopeName = "minio",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.PropertyMappingProviderScope;
import com.pulumi.authentik.PropertyMappingProviderScopeArgs;
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 name = new PropertyMappingProviderScope("name", PropertyMappingProviderScopeArgs.builder()
            .expression("""
return {
  "policy": "readwrite",
}

            """)
            .scopeName("minio")
            .build());

    }
}
Copy
resources:
  name:
    type: authentik:PropertyMappingProviderScope
    properties:
      expression: |+
        return {
          "policy": "readwrite",
        }        

      scopeName: minio
Copy

Create PropertyMappingProviderScope Resource

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

Constructor syntax

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

@overload
def PropertyMappingProviderScope(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 expression: Optional[str] = None,
                                 scope_name: Optional[str] = None,
                                 description: Optional[str] = None,
                                 name: Optional[str] = None,
                                 property_mapping_provider_scope_id: Optional[str] = None)
func NewPropertyMappingProviderScope(ctx *Context, name string, args PropertyMappingProviderScopeArgs, opts ...ResourceOption) (*PropertyMappingProviderScope, error)
public PropertyMappingProviderScope(string name, PropertyMappingProviderScopeArgs args, CustomResourceOptions? opts = null)
public PropertyMappingProviderScope(String name, PropertyMappingProviderScopeArgs args)
public PropertyMappingProviderScope(String name, PropertyMappingProviderScopeArgs args, CustomResourceOptions options)
type: authentik:PropertyMappingProviderScope
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. PropertyMappingProviderScopeArgs
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. PropertyMappingProviderScopeArgs
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. PropertyMappingProviderScopeArgs
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. PropertyMappingProviderScopeArgs
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. PropertyMappingProviderScopeArgs
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 propertyMappingProviderScopeResource = new Authentik.PropertyMappingProviderScope("propertyMappingProviderScopeResource", new()
{
    Expression = "string",
    ScopeName = "string",
    Description = "string",
    Name = "string",
    PropertyMappingProviderScopeId = "string",
});
Copy
example, err := authentik.NewPropertyMappingProviderScope(ctx, "propertyMappingProviderScopeResource", &authentik.PropertyMappingProviderScopeArgs{
	Expression:                     pulumi.String("string"),
	ScopeName:                      pulumi.String("string"),
	Description:                    pulumi.String("string"),
	Name:                           pulumi.String("string"),
	PropertyMappingProviderScopeId: pulumi.String("string"),
})
Copy
var propertyMappingProviderScopeResource = new PropertyMappingProviderScope("propertyMappingProviderScopeResource", PropertyMappingProviderScopeArgs.builder()
    .expression("string")
    .scopeName("string")
    .description("string")
    .name("string")
    .propertyMappingProviderScopeId("string")
    .build());
Copy
property_mapping_provider_scope_resource = authentik.PropertyMappingProviderScope("propertyMappingProviderScopeResource",
    expression="string",
    scope_name="string",
    description="string",
    name="string",
    property_mapping_provider_scope_id="string")
Copy
const propertyMappingProviderScopeResource = new authentik.PropertyMappingProviderScope("propertyMappingProviderScopeResource", {
    expression: "string",
    scopeName: "string",
    description: "string",
    name: "string",
    propertyMappingProviderScopeId: "string",
});
Copy
type: authentik:PropertyMappingProviderScope
properties:
    description: string
    expression: string
    name: string
    propertyMappingProviderScopeId: string
    scopeName: string
Copy

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

Expression This property is required. string
ScopeName This property is required. string
Description string
Name string
PropertyMappingProviderScopeId string
The ID of this resource.
Expression This property is required. string
ScopeName This property is required. string
Description string
Name string
PropertyMappingProviderScopeId string
The ID of this resource.
expression This property is required. String
scopeName This property is required. String
description String
name String
propertyMappingProviderScopeId String
The ID of this resource.
expression This property is required. string
scopeName This property is required. string
description string
name string
propertyMappingProviderScopeId string
The ID of this resource.
expression This property is required. str
scope_name This property is required. str
description str
name str
property_mapping_provider_scope_id str
The ID of this resource.
expression This property is required. String
scopeName This property is required. String
description String
name String
propertyMappingProviderScopeId String
The ID of this resource.

Outputs

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

Get an existing PropertyMappingProviderScope 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?: PropertyMappingProviderScopeState, opts?: CustomResourceOptions): PropertyMappingProviderScope
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        expression: Optional[str] = None,
        name: Optional[str] = None,
        property_mapping_provider_scope_id: Optional[str] = None,
        scope_name: Optional[str] = None) -> PropertyMappingProviderScope
func GetPropertyMappingProviderScope(ctx *Context, name string, id IDInput, state *PropertyMappingProviderScopeState, opts ...ResourceOption) (*PropertyMappingProviderScope, error)
public static PropertyMappingProviderScope Get(string name, Input<string> id, PropertyMappingProviderScopeState? state, CustomResourceOptions? opts = null)
public static PropertyMappingProviderScope get(String name, Output<String> id, PropertyMappingProviderScopeState state, CustomResourceOptions options)
resources:  _:    type: authentik:PropertyMappingProviderScope    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:
Description string
Expression string
Name string
PropertyMappingProviderScopeId string
The ID of this resource.
ScopeName string
Description string
Expression string
Name string
PropertyMappingProviderScopeId string
The ID of this resource.
ScopeName string
description String
expression String
name String
propertyMappingProviderScopeId String
The ID of this resource.
scopeName String
description string
expression string
name string
propertyMappingProviderScopeId string
The ID of this resource.
scopeName string
description String
expression String
name String
propertyMappingProviderScopeId String
The ID of this resource.
scopeName String

Package Details

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