mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-21 23:14:26 +00:00
Marco A.andGitHub
6fdb74593c
# Which Problems Are Solved The docs ([Actions v2 concepts page](https://zitadel.com/docs/concepts/features/actions_v2) and the Actions testing guides) state that Actions v2 must be enabled via the "Actions" feature flag. That flag no longer exists — it is `reserved` in `proto/zitadel/feature/v2/instance.proto` and `system.proto` — and Actions v2 is available by default. The callout even linked to a non-existent API field. # How the Problems Are Solved - Removed the stale feature-flag callout (and the roadmap teaser callout) from `concepts/features/actions_v2.mdx`. - Removed the "Your ZITADEL instance needs to have the actions feature enabled." prerequisite bullet from the seven `guides/integrate/actions/testing-*.mdx` guides. Pure deletions, 17 lines across 8 files. # Additional Context The `SetInstanceFeatures` mentions in `hosted-login.mdx` and `webkeys.mdx` refer to flags that still exist and are untouched.
56 lines
3.5 KiB
Plaintext
56 lines
3.5 KiB
Plaintext
---
|
|
title: ZITADEL Actions v2
|
|
description: "Execute custom logic on API calls, events, or functions with ZITADEL Actions v2 to meet specific business requirements."
|
|
sidebar_label: Actions v2
|
|
---
|
|
|
|
By using ZITADEL Actions v2, you can modify ZITADEL's behavior on specific API calls, events, or functions. This is useful when you have special business requirements that ZITADEL does not support out-of-the-box.
|
|
|
|
## Why Actions?
|
|
ZITADEL can't anticipate or solve every possible business rule and integration requirement for all users. Here are some examples:
|
|
- A business requires domain-specific data validation before a user can be created or authenticated.
|
|
- A business needs to automate tasks, such as assigning roles to users based on their ADFS 2016+ groups.
|
|
- A business needs to store metadata on a user, which is used for integrating applications.
|
|
- A business needs to restrict which users are allowed to register to a certain organization by their email domains.
|
|
|
|
With Actions, ZITADEL provides a way to address such scenarios.
|
|
|
|
## How it works
|
|
There are three necessary components:
|
|
- **Endpoint:** An external endpoint with the desired logic. It can be anything, as long as it can receive an HTTP POST request.
|
|
- **Target:** A resource in ZITADEL containing all the necessary information about how to trigger an endpoint.
|
|
- **Execution:** A resource in ZITADEL specifying when to trigger which targets.
|
|
|
|
The process is that, at certain points, ZITADEL executes a defined Execution, which then calls the defined Target(s). This allows everyone to implement custom behavior for as many processes as needed.
|
|
|
|
Possible conditions for the Execution:
|
|
- **Request:** Reacts to or manipulates requests to ZITADEL, for example, by adding information to newly created users.
|
|
- **Response:** Reacts to or manipulates responses from ZITADEL, for example, provisioning newly created users to other systems.
|
|
- **Function:** Reacts to various functions in ZITADEL, replacing [Actions](/concepts/features/actions).
|
|
- **Event:** Reacts to different events created in ZITADEL, for example, to inform someone if a user gets locked.
|
|
|
|
<Callout>
|
|
Currently, defined Actions v2 will be executed in addition to [Actions](/concepts/features/actions).
|
|
</Callout>
|
|
|
|
## Migration
|
|
|
|
- [Migrate Actions v1 to Actions v2](/guides/integrate/actions/migrate-from-v1)
|
|
|
|
## Further reading
|
|
|
|
- [Actions v2 reference](/guides/integrate/actions/usage)
|
|
- [Actions v2 example execution for request](/guides/integrate/actions/testing-request)
|
|
- [Actions v2 example execution for request manipulation](/guides/integrate/actions/testing-request-manipulation)
|
|
- [Actions v2 example execution for request signature check](/guides/integrate/actions/testing-request-signature)
|
|
- [Actions v2 example execution for response](/guides/integrate/actions/testing-response)
|
|
- [Actions v2 example execution for response manipulation](/guides/integrate/actions/testing-response-manipulation)
|
|
- [Actions v2 example execution for function](/guides/integrate/actions/testing-function)
|
|
- [Actions v2 example execution for function manipulation](/guides/integrate/actions/testing-function-manipulation)
|
|
- [Actions v2 example execution for event](/guides/integrate/actions/testing-event)
|
|
|
|
## Example use cases:
|
|
The following repository contains various examples demonstrating how to use Actions v2 in different scenarios. It also includes a deployment script for testing the examples with Cloudflare Workers:
|
|
|
|
- [Actions v2 examples](https://github.com/zitadel/actions/tree/main/actions-v2-cloudflare-workers)
|