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

authentik.ScopeMapping

Explore with Pulumi AI

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

    Manage Scope Provider Property mappings

    This resource is deprecated. Migrate to authentik.PropertyMappingProviderScope.

    Create ScopeMapping Resource

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

    Constructor syntax

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

@overload
def ScopeMapping(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 expression: Optional[str] = None,
                 scope_name: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 scope_mapping_id: Optional[str] = None)
    func NewScopeMapping(ctx *Context, name string, args ScopeMappingArgs, opts ...ResourceOption) (*ScopeMapping, error)
    public ScopeMapping(string name, ScopeMappingArgs args, CustomResourceOptions? opts = null)
    public ScopeMapping(String name, ScopeMappingArgs args)
public ScopeMapping(String name, ScopeMappingArgs args, CustomResourceOptions options)

    type: authentik:ScopeMapping
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 ScopeMappingArgs
    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 ScopeMappingArgs
    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 ScopeMappingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScopeMappingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScopeMappingArgs
    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 scopeMappingResource = new Authentik.ScopeMapping("scopeMappingResource", new()
{
    Expression = "string",
    ScopeName = "string",
    Description = "string",
    Name = "string",
    ScopeMappingId = "string",
});

    example, err := authentik.NewScopeMapping(ctx, "scopeMappingResource", &authentik.ScopeMappingArgs{
	Expression:     pulumi.String("string"),
	ScopeName:      pulumi.String("string"),
	Description:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	ScopeMappingId: pulumi.String("string"),
})

    var scopeMappingResource = new ScopeMapping("scopeMappingResource", ScopeMappingArgs.builder()
    .expression("string")
    .scopeName("string")
    .description("string")
    .name("string")
    .scopeMappingId("string")
    .build());

    scope_mapping_resource = authentik.ScopeMapping("scopeMappingResource",
    expression="string",
    scope_name="string",
    description="string",
    name="string",
    scope_mapping_id="string")

    const scopeMappingResource = new authentik.ScopeMapping("scopeMappingResource", {
    expression: "string",
    scopeName: "string",
    description: "string",
    name: "string",
    scopeMappingId: "string",
});

    type: authentik:ScopeMapping
properties:
    description: string
    expression: string
    name: string
    scopeMappingId: string
    scopeName: string

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

    Expression string
    ScopeName string
    Description string
    Name string
    ScopeMappingId string
    The ID of this resource.
    Expression string
    ScopeName string
    Description string
    Name string
    ScopeMappingId string
    The ID of this resource.
    expression String
    scopeName String
    description String
    name String
    scopeMappingId String
    The ID of this resource.
    expression string
    scopeName string
    description string
    name string
    scopeMappingId string
    The ID of this resource.
    expression str
    scope_name str
    description str
    name str
    scope_mapping_id str
    The ID of this resource.
    expression String
    scopeName String
    description String
    name String
    scopeMappingId String
    The ID of this resource.

    Outputs

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

    Get an existing ScopeMapping 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?: ScopeMappingState, opts?: CustomResourceOptions): ScopeMapping
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        expression: Optional[str] = None,
        name: Optional[str] = None,
        scope_mapping_id: Optional[str] = None,
        scope_name: Optional[str] = None) -> ScopeMapping
    func GetScopeMapping(ctx *Context, name string, id IDInput, state *ScopeMappingState, opts ...ResourceOption) (*ScopeMapping, error)
    public static ScopeMapping Get(string name, Input<string> id, ScopeMappingState? state, CustomResourceOptions? opts = null)
    public static ScopeMapping get(String name, Output<String> id, ScopeMappingState state, CustomResourceOptions options)
    resources:  _:    type: authentik:ScopeMapping    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:
    Description string
    Expression string
    Name string
    ScopeMappingId string
    The ID of this resource.
    ScopeName string
    Description string
    Expression string
    Name string
    ScopeMappingId string
    The ID of this resource.
    ScopeName string
    description String
    expression String
    name String
    scopeMappingId String
    The ID of this resource.
    scopeName String
    description string
    expression string
    name string
    scopeMappingId string
    The ID of this resource.
    scopeName string
    description str
    expression str
    name str
    scope_mapping_id str
    The ID of this resource.
    scope_name str
    description String
    expression String
    name String
    scopeMappingId 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.
    authentik logo
    authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
    goauthentik/terraform-provider-authentik