Docs Packages
  1. Packages
  2. Auth0
  3. API Docs
  4. Action
Auth0 v2.24.3 published on Wednesday, Sep 20, 2023 by Pulumi
pulumi/pulumi-auth0

auth0.Action

Explore with Pulumi AI

auth0 logo
Auth0 v2.24.3 published on Wednesday, Sep 20, 2023 by Pulumi
pulumi/pulumi-auth0

    Actions are secure, tenant-specific, versioned functions written in Node.js that execute at certain points during the Auth0 runtime. Actions are used to customize and extend Auth0’s capabilities with custom logic.

    Create Action Resource

    new Action(name: string, args: ActionArgs, opts?: CustomResourceOptions);
    @overload
def Action(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           code: Optional[str] = None,
           dependencies: Optional[Sequence[ActionDependencyArgs]] = None,
           deploy: Optional[bool] = None,
           name: Optional[str] = None,
           runtime: Optional[str] = None,
           secrets: Optional[Sequence[ActionSecretArgs]] = None,
           supported_triggers: Optional[ActionSupportedTriggersArgs] = None)
@overload
def Action(resource_name: str,
           args: ActionArgs,
           opts: Optional[ResourceOptions] = None)
    func NewAction(ctx *Context, name string, args ActionArgs, opts ...ResourceOption) (*Action, error)
    public Action(string name, ActionArgs args, CustomResourceOptions? opts = null)
    public Action(String name, ActionArgs args)
public Action(String name, ActionArgs args, CustomResourceOptions options)

    type: auth0:Action
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionArgs
    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 ActionArgs
    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 ActionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ActionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ActionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Code string

    The source code of the action.

    SupportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    Dependencies List<ActionDependency>

    List of third party npm modules, and their versions, that this action depends on.

    Deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    Name string

    The name of the action.

    Runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    Secrets List<ActionSecret>

    List of secrets that are included in an action or a version of an action.

    Code string

    The source code of the action.

    SupportedTriggers ActionSupportedTriggersArgs

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    Dependencies []ActionDependencyArgs

    List of third party npm modules, and their versions, that this action depends on.

    Deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    Name string

    The name of the action.

    Runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    Secrets []ActionSecretArgs

    List of secrets that are included in an action or a version of an action.

    code String

    The source code of the action.

    supportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    dependencies List<ActionDependency>

    List of third party npm modules, and their versions, that this action depends on.

    deploy Boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name String

    The name of the action.

    runtime String

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets List<ActionSecret>

    List of secrets that are included in an action or a version of an action.

    code string

    The source code of the action.

    supportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    dependencies ActionDependency[]

    List of third party npm modules, and their versions, that this action depends on.

    deploy boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name string

    The name of the action.

    runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets ActionSecret[]

    List of secrets that are included in an action or a version of an action.

    code str

    The source code of the action.

    supported_triggers ActionSupportedTriggersArgs

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    dependencies Sequence[ActionDependencyArgs]

    List of third party npm modules, and their versions, that this action depends on.

    deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name str

    The name of the action.

    runtime str

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets Sequence[ActionSecretArgs]

    List of secrets that are included in an action or a version of an action.

    code String

    The source code of the action.

    supportedTriggers Property Map

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    dependencies List<Property Map>

    List of third party npm modules, and their versions, that this action depends on.

    deploy Boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name String

    The name of the action.

    runtime String

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets List<Property Map>

    List of secrets that are included in an action or a version of an action.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Action resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    VersionId string

    Version ID of the action. This value is available if deploy is set to true.

    Id string

    The provider-assigned unique ID for this managed resource.

    VersionId string

    Version ID of the action. This value is available if deploy is set to true.

    id String

    The provider-assigned unique ID for this managed resource.

    versionId String

    Version ID of the action. This value is available if deploy is set to true.

    id string

    The provider-assigned unique ID for this managed resource.

    versionId string

    Version ID of the action. This value is available if deploy is set to true.

    id str

    The provider-assigned unique ID for this managed resource.

    version_id str

    Version ID of the action. This value is available if deploy is set to true.

    id String

    The provider-assigned unique ID for this managed resource.

    versionId String

    Version ID of the action. This value is available if deploy is set to true.

    Look up Existing Action Resource

    Get an existing Action 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?: ActionState, opts?: CustomResourceOptions): Action
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        code: Optional[str] = None,
        dependencies: Optional[Sequence[ActionDependencyArgs]] = None,
        deploy: Optional[bool] = None,
        name: Optional[str] = None,
        runtime: Optional[str] = None,
        secrets: Optional[Sequence[ActionSecretArgs]] = None,
        supported_triggers: Optional[ActionSupportedTriggersArgs] = None,
        version_id: Optional[str] = None) -> Action
    func GetAction(ctx *Context, name string, id IDInput, state *ActionState, opts ...ResourceOption) (*Action, error)
    public static Action Get(string name, Input<string> id, ActionState? state, CustomResourceOptions? opts = null)
    public static Action get(String name, Output<String> id, ActionState 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:
    Code string

    The source code of the action.

    Dependencies List<ActionDependency>

    List of third party npm modules, and their versions, that this action depends on.

    Deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    Name string

    The name of the action.

    Runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    Secrets List<ActionSecret>

    List of secrets that are included in an action or a version of an action.

    SupportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    VersionId string

    Version ID of the action. This value is available if deploy is set to true.

    Code string

    The source code of the action.

    Dependencies []ActionDependencyArgs

    List of third party npm modules, and their versions, that this action depends on.

    Deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    Name string

    The name of the action.

    Runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    Secrets []ActionSecretArgs

    List of secrets that are included in an action or a version of an action.

    SupportedTriggers ActionSupportedTriggersArgs

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    VersionId string

    Version ID of the action. This value is available if deploy is set to true.

    code String

    The source code of the action.

    dependencies List<ActionDependency>

    List of third party npm modules, and their versions, that this action depends on.

    deploy Boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name String

    The name of the action.

    runtime String

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets List<ActionSecret>

    List of secrets that are included in an action or a version of an action.

    supportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    versionId String

    Version ID of the action. This value is available if deploy is set to true.

    code string

    The source code of the action.

    dependencies ActionDependency[]

    List of third party npm modules, and their versions, that this action depends on.

    deploy boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name string

    The name of the action.

    runtime string

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets ActionSecret[]

    List of secrets that are included in an action or a version of an action.

    supportedTriggers ActionSupportedTriggers

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    versionId string

    Version ID of the action. This value is available if deploy is set to true.

    code str

    The source code of the action.

    dependencies Sequence[ActionDependencyArgs]

    List of third party npm modules, and their versions, that this action depends on.

    deploy bool

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name str

    The name of the action.

    runtime str

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets Sequence[ActionSecretArgs]

    List of secrets that are included in an action or a version of an action.

    supported_triggers ActionSupportedTriggersArgs

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    version_id str

    Version ID of the action. This value is available if deploy is set to true.

    code String

    The source code of the action.

    dependencies List<Property Map>

    List of third party npm modules, and their versions, that this action depends on.

    deploy Boolean

    Deploying an action will create a new immutable version of the action. If the action is currently bound to a trigger, then the system will begin executing the newly deployed version of the action immediately.

    name String

    The name of the action.

    runtime String

    The Node runtime. Defaults to node12. Possible values are: node12, node16, node18 (beta) or node18-actions (GA).

    secrets List<Property Map>

    List of secrets that are included in an action or a version of an action.

    supportedTriggers Property Map

    List of triggers that this action supports. At this time, an action can only target a single trigger at a time. Read Retrieving the set of triggers available within actions to retrieve the latest trigger versions supported.

    versionId String

    Version ID of the action. This value is available if deploy is set to true.

    Supporting Types

    ActionDependency, ActionDependencyArgs

    Name string

    Dependency name, e.g. lodash.

    Version string

    Dependency version, e.g. latest or 4.17.21.

    Name string

    Dependency name, e.g. lodash.

    Version string

    Dependency version, e.g. latest or 4.17.21.

    name String

    Dependency name, e.g. lodash.

    version String

    Dependency version, e.g. latest or 4.17.21.

    name string

    Dependency name, e.g. lodash.

    version string

    Dependency version, e.g. latest or 4.17.21.

    name str

    Dependency name, e.g. lodash.

    version str

    Dependency version, e.g. latest or 4.17.21.

    name String

    Dependency name, e.g. lodash.

    version String

    Dependency version, e.g. latest or 4.17.21.

    ActionSecret, ActionSecretArgs

    Name string

    Secret name.

    Value string

    Secret value.

    Name string

    Secret name.

    Value string

    Secret value.

    name String

    Secret name.

    value String

    Secret value.

    name string

    Secret name.

    value string

    Secret value.

    name str

    Secret name.

    value str

    Secret value.

    name String

    Secret name.

    value String

    Secret value.

    ActionSupportedTriggers, ActionSupportedTriggersArgs

    Id string

    The trigger ID.

    Version string

    The trigger version. This regulates which runtime versions are supported.

    Id string

    The trigger ID.

    Version string

    The trigger version. This regulates which runtime versions are supported.

    id String

    The trigger ID.

    version String

    The trigger version. This regulates which runtime versions are supported.

    id string

    The trigger ID.

    version string

    The trigger version. This regulates which runtime versions are supported.

    id str

    The trigger ID.

    version str

    The trigger version. This regulates which runtime versions are supported.

    id String

    The trigger ID.

    version String

    The trigger version. This regulates which runtime versions are supported.

    Import

    An action can be imported using the action’s ID. # Example

     $ pulumi import auth0:index/action:Action my_action 12f4f21b-017a-319d-92e7-2291c1ca36c4

    ~> For security reasons importing secrets is not allowed. Therefore, it is advised to import the action without secrets and adding them back after the action has been imported.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the auth0 Terraform Provider.

    auth0 logo
    Auth0 v2.24.3 published on Wednesday, Sep 20, 2023 by Pulumi
    pulumi/pulumi-auth0