1. Packages
  2. Zitadel
  3. API Docs
  4. TriggerActions
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

zitadel.TriggerActions

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse

    Resource representing triggers, when actions get started

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumiverse.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Zitadel.TriggerActions("default", new()
        {
            OrgId = data.Zitadel_org.Default.Id,
            FlowType = "FLOW_TYPE_CUSTOMISE_TOKEN",
            TriggerType = "TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION",
            ActionIds = new[]
            {
                data.Zitadel_action.Default.Id,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zitadel.NewTriggerActions(ctx, "default", &zitadel.TriggerActionsArgs{
    			OrgId:       pulumi.Any(data.Zitadel_org.Default.Id),
    			FlowType:    pulumi.String("FLOW_TYPE_CUSTOMISE_TOKEN"),
    			TriggerType: pulumi.String("TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION"),
    			ActionIds: pulumi.StringArray{
    				data.Zitadel_action.Default.Id,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.TriggerActions;
    import com.pulumi.zitadel.TriggerActionsArgs;
    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 default_ = new TriggerActions("default", TriggerActionsArgs.builder()        
                .orgId(data.zitadel_org().default().id())
                .flowType("FLOW_TYPE_CUSTOMISE_TOKEN")
                .triggerType("TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION")
                .actionIds(data.zitadel_action().default().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_zitadel as zitadel
    
    default = zitadel.TriggerActions("default",
        org_id=data["zitadel_org"]["default"]["id"],
        flow_type="FLOW_TYPE_CUSTOMISE_TOKEN",
        trigger_type="TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION",
        action_ids=[data["zitadel_action"]["default"]["id"]])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumiverse/zitadel";
    
    const _default = new zitadel.TriggerActions("default", {
        orgId: data.zitadel_org["default"].id,
        flowType: "FLOW_TYPE_CUSTOMISE_TOKEN",
        triggerType: "TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION",
        actionIds: [data.zitadel_action["default"].id],
    });
    
    resources:
      default:
        type: zitadel:TriggerActions
        properties:
          orgId: ${data.zitadel_org.default.id}
          flowType: FLOW_TYPE_CUSTOMISE_TOKEN
          triggerType: TRIGGER_TYPE_PRE_ACCESS_TOKEN_CREATION
          actionIds:
            - ${data.zitadel_action.default.id}
    

    Create TriggerActions Resource

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

    Constructor syntax

    new TriggerActions(name: string, args: TriggerActionsArgs, opts?: CustomResourceOptions);
    @overload
    def TriggerActions(resource_name: str,
                       args: TriggerActionsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def TriggerActions(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       action_ids: Optional[Sequence[str]] = None,
                       flow_type: Optional[str] = None,
                       trigger_type: Optional[str] = None,
                       org_id: Optional[str] = None)
    func NewTriggerActions(ctx *Context, name string, args TriggerActionsArgs, opts ...ResourceOption) (*TriggerActions, error)
    public TriggerActions(string name, TriggerActionsArgs args, CustomResourceOptions? opts = null)
    public TriggerActions(String name, TriggerActionsArgs args)
    public TriggerActions(String name, TriggerActionsArgs args, CustomResourceOptions options)
    
    type: zitadel:TriggerActions
    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 TriggerActionsArgs
    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 TriggerActionsArgs
    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 TriggerActionsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TriggerActionsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TriggerActionsArgs
    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 triggerActionsResource = new Zitadel.TriggerActions("triggerActionsResource", new()
    {
        ActionIds = new[]
        {
            "string",
        },
        FlowType = "string",
        TriggerType = "string",
        OrgId = "string",
    });
    
    example, err := zitadel.NewTriggerActions(ctx, "triggerActionsResource", &zitadel.TriggerActionsArgs{
    	ActionIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	FlowType:    pulumi.String("string"),
    	TriggerType: pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    })
    
    var triggerActionsResource = new TriggerActions("triggerActionsResource", TriggerActionsArgs.builder()
        .actionIds("string")
        .flowType("string")
        .triggerType("string")
        .orgId("string")
        .build());
    
    trigger_actions_resource = zitadel.TriggerActions("triggerActionsResource",
        action_ids=["string"],
        flow_type="string",
        trigger_type="string",
        org_id="string")
    
    const triggerActionsResource = new zitadel.TriggerActions("triggerActionsResource", {
        actionIds: ["string"],
        flowType: "string",
        triggerType: "string",
        orgId: "string",
    });
    
    type: zitadel:TriggerActions
    properties:
        actionIds:
            - string
        flowType: string
        orgId: string
        triggerType: string
    

    TriggerActions Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TriggerActions resource accepts the following input properties:

    ActionIds List<string>
    IDs of the triggered actions
    FlowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    TriggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    OrgId string
    ID of the organization
    ActionIds []string
    IDs of the triggered actions
    FlowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    TriggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    OrgId string
    ID of the organization
    actionIds List<String>
    IDs of the triggered actions
    flowType String
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    triggerType String
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    orgId String
    ID of the organization
    actionIds string[]
    IDs of the triggered actions
    flowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    triggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    orgId string
    ID of the organization
    action_ids Sequence[str]
    IDs of the triggered actions
    flow_type str
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    trigger_type str
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    org_id str
    ID of the organization
    actionIds List<String>
    IDs of the triggered actions
    flowType String
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    triggerType String
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    orgId String
    ID of the organization

    Outputs

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

    Get an existing TriggerActions 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?: TriggerActionsState, opts?: CustomResourceOptions): TriggerActions
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            action_ids: Optional[Sequence[str]] = None,
            flow_type: Optional[str] = None,
            org_id: Optional[str] = None,
            trigger_type: Optional[str] = None) -> TriggerActions
    func GetTriggerActions(ctx *Context, name string, id IDInput, state *TriggerActionsState, opts ...ResourceOption) (*TriggerActions, error)
    public static TriggerActions Get(string name, Input<string> id, TriggerActionsState? state, CustomResourceOptions? opts = null)
    public static TriggerActions get(String name, Output<String> id, TriggerActionsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ActionIds List<string>
    IDs of the triggered actions
    FlowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    OrgId string
    ID of the organization
    TriggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    ActionIds []string
    IDs of the triggered actions
    FlowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    OrgId string
    ID of the organization
    TriggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    actionIds List<String>
    IDs of the triggered actions
    flowType String
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    orgId String
    ID of the organization
    triggerType String
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    actionIds string[]
    IDs of the triggered actions
    flowType string
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    orgId string
    ID of the organization
    triggerType string
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    action_ids Sequence[str]
    IDs of the triggered actions
    flow_type str
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    org_id str
    ID of the organization
    trigger_type str
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION
    actionIds List<String>
    IDs of the triggered actions
    flowType String
    Type of the flow to which the action triggers belong, supported values: FLOWTYPEEXTERNALAUTHENTICATION, FLOWTYPECUSTOMISETOKEN, FLOWTYPEINTERNALAUTHENTICATION, FLOWTYPESAMLRESPONSE
    orgId String
    ID of the organization
    triggerType String
    Trigger type on when the actions get triggered, supported values: TRIGGERTYPEPOSTAUTHENTICATION, TRIGGERTYPEPRECREATION, TRIGGERTYPEPOSTCREATION, TRIGGERTYPEPREUSERINFOCREATION, TRIGGERTYPEPREACCESSTOKENCREATION, TRIGGERTYPEPRESAMLRESPONSE_CREATION

    Import

    terraform The resource can be imported using the ID format <flow_type:trigger_type[:org_id]>, e.g.

     $ pulumi import zitadel:index/triggerActions:TriggerActions imported 'FLOW_TYPE_EXTERNAL_AUTHENTICATION:TRIGGER_TYPE_POST_CREATION:123456789012345678'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse