@zitadel/api 0.1.0-alpha.9 → 1.0.0-alpha.21

package/src/generated/model/createAuthAttemptDefault.ts

@@ -17,6 +17,26 @@ export type CreateAuthAttemptDefault =
     } & {
       code: "att.invalid_request";
     })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "auth.unauthorized";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "evt.invalid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;
@@ -26,4 +46,14 @@ export type CreateAuthAttemptDefault =
       details?: { [key: string]: unknown };
     } & {
       code: "internal";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "req.invalid";
     });

package/src/generated/model/createBranding201.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { CreateBranding201Branding } from "./createBranding201Branding";
+
+/**
+ * A stored branding revision. `branding` echoes the canonical stored
+configuration so clients (e.g. the CLI sync engine) can reconcile local
+files with the server's stored state.
+
+ */
+export type CreateBranding201 = {
+  /** The unique identifier of this branding revision. */
+  id: string;
+  /** When this revision was published. */
+  created_at: string;
+  /** Branding configuration. Appears in two places with one shape:
+
+  - On flow responses as a read-only projection: the server resolves the
+    latest branding revision for the project per step response (falling
+    back to built-in defaults when none is stored). Branding is configured
+    via the Branding API / `zitadel apply`, not the Flow API.
+  - As the request body of `POST /branding`, which publishes the same
+    shape as a new immutable revision (see ADR 040).
+   */
+  branding: CreateBranding201Branding;
+};

package/src/generated/model/createBranding201Branding.ts

@@ -0,0 +1,49 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { CreateBranding201BrandingLayout } from "./createBranding201BrandingLayout";
+
+/**
+ * Branding configuration. Appears in two places with one shape:
+
+- On flow responses as a read-only projection: the server resolves the
+  latest branding revision for the project per step response (falling
+  back to built-in defaults when none is stored). Branding is configured
+  via the Branding API / `zitadel apply`, not the Flow API.
+- As the request body of `POST /branding`, which publishes the same
+  shape as a new immutable revision (see ADR 040).
+
+ */
+export type CreateBranding201Branding = {
+  /** Layout preset selector. The default.liquid master template uses this
+  to branch into layout variants. Customers who eject the template
+  can ignore this field entirely; it also serves as the degrade target
+  when a custom template fails component-side validation.
+   */
+  layout?: CreateBranding201BrandingLayout;
+  /**
+     * The LiquidJS template string for rendering this step. The orchestrator
+  parses this template, injects the capability dictionaries as context,
+  and renders the output HTML into its Shadow DOM.
+
+     * @maxLength 131072
+     */
+  liquid_template?: string;
+  /** Team logo URL. */
+  logo_url?: string;
+  /** Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in
+  v1: `POST /branding` rejects a non-empty value, because the login
+  component loads this stylesheet at document level (shadow-scoped
+  `@font-face` rules never register faces) and an arbitrary URL would
+  grant `branding.write` page-wide CSS control over the embedding
+  application. Safe tenant font delivery is an ADR 040 follow-up;
+  until then, load fonts from the embedding page.
+   */
+  font_url?: string;
+  /** Hero/background image URL (used by split layout). */
+  hero_url?: string;
+};

package/src/generated/model/createBranding201BrandingLayout.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Layout preset selector. The default.liquid master template uses this
+to branch into layout variants. Customers who eject the template
+can ignore this field entirely; it also serves as the degrade target
+when a custom template fails component-side validation.
+
+ */
+export type CreateBranding201BrandingLayout =
+  (typeof CreateBranding201BrandingLayout)[keyof typeof CreateBranding201BrandingLayout];
+
+export const CreateBranding201BrandingLayout = {
+  centered: "centered",
+  split: "split",
+} as const;

package/src/generated/model/createBranding400.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { CreateBranding400Details } from "./createBranding400Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type CreateBranding400 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: CreateBranding400Details;
+};

package/src/generated/model/{endSessionDefaultDetails.ts → createBranding400Details.ts}

@@ -9,4 +9,4 @@
 /**
  * Additional error-specific context.
  */
-export type EndSessionDefaultDetails = { [key: string]: unknown };
+export type CreateBranding400Details = { [key: string]: unknown };

package/src/generated/model/createBrandingBody.ts

@@ -0,0 +1,49 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { CreateBrandingBodyLayout } from "./createBrandingBodyLayout";
+
+/**
+ * Branding configuration. Appears in two places with one shape:
+
+- On flow responses as a read-only projection: the server resolves the
+  latest branding revision for the project per step response (falling
+  back to built-in defaults when none is stored). Branding is configured
+  via the Branding API / `zitadel apply`, not the Flow API.
+- As the request body of `POST /branding`, which publishes the same
+  shape as a new immutable revision (see ADR 040).
+
+ */
+export type CreateBrandingBody = {
+  /** Layout preset selector. The default.liquid master template uses this
+  to branch into layout variants. Customers who eject the template
+  can ignore this field entirely; it also serves as the degrade target
+  when a custom template fails component-side validation.
+   */
+  layout?: CreateBrandingBodyLayout;
+  /**
+     * The LiquidJS template string for rendering this step. The orchestrator
+  parses this template, injects the capability dictionaries as context,
+  and renders the output HTML into its Shadow DOM.
+
+     * @maxLength 131072
+     */
+  liquid_template?: string;
+  /** Team logo URL. */
+  logo_url?: string;
+  /** Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in
+  v1: `POST /branding` rejects a non-empty value, because the login
+  component loads this stylesheet at document level (shadow-scoped
+  `@font-face` rules never register faces) and an arbitrary URL would
+  grant `branding.write` page-wide CSS control over the embedding
+  application. Safe tenant font delivery is an ADR 040 follow-up;
+  until then, load fonts from the embedding page.
+   */
+  font_url?: string;
+  /** Hero/background image URL (used by split layout). */
+  hero_url?: string;
+};

package/src/generated/model/createBrandingBodyLayout.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Layout preset selector. The default.liquid master template uses this
+to branch into layout variants. Customers who eject the template
+can ignore this field entirely; it also serves as the degrade target
+when a custom template fails component-side validation.
+
+ */
+export type CreateBrandingBodyLayout =
+  (typeof CreateBrandingBodyLayout)[keyof typeof CreateBrandingBodyLayout];
+
+export const CreateBrandingBodyLayout = {
+  centered: "centered",
+  split: "split",
+} as const;

package/src/generated/model/createBrandingDefault.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+import type { CreateBrandingDefaultDetails } from "./createBrandingDefaultDetails";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type CreateBrandingDefault = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: CreateBrandingDefaultDetails;
+};

package/src/generated/model/{submitFlowStepDefaultDetails.ts → createBrandingDefaultDetails.ts}

@@ -9,4 +9,4 @@
 /**
  * Additional error-specific context.
  */
-export type SubmitFlowStepDefaultDetails = { [key: string]: unknown };
+export type CreateBrandingDefaultDetails = { [key: string]: unknown };

package/src/generated/model/{setUserPasswordParams.ts → createBrandingParams.ts}

@@ -6,7 +6,7 @@
  * OpenAPI spec version: 0.0.1
  */
 
-export type SetUserPasswordParams = {
+export type CreateBrandingParams = {
   /**
    * The unique identifier of the project
    * @pattern ^[a-zA-Z0-9_-]+$

package/src/generated/model/createFlow201.ts

@@ -24,9 +24,14 @@ export type CreateFlow201 = {
   and builds name-keyed indexes locally for lookup.
    */
   step: CreateFlow201Step;
-  /** Resolved branding configuration. Inherited from the app → team → project
-  hierarchy at flow creation time (most specific wins). Read-only projection —
-  branding is configured via the Team/App Branding API, not the Flow API.
+  /** Branding configuration. Appears in two places with one shape:
+
+  - On flow responses as a read-only projection: the server resolves the
+    latest branding revision for the project per step response (falling
+    back to built-in defaults when none is stored). Branding is configured
+    via the Branding API / `zitadel apply`, not the Flow API.
+  - As the request body of `POST /branding`, which publishes the same
+    shape as a new immutable revision (see ADR 040).
    */
   branding?: CreateFlow201Branding;
   /** Present when `step.complete` is `redirect`. */

package/src/generated/model/createFlow201Branding.ts

@@ -8,25 +8,41 @@
 import type { CreateFlow201BrandingLayout } from "./createFlow201BrandingLayout";
 
 /**
- * Resolved branding configuration. Inherited from the app → team → project
-hierarchy at flow creation time (most specific wins). Read-only projection —
-branding is configured via the Team/App Branding API, not the Flow API.
+ * Branding configuration. Appears in two places with one shape:
+
+- On flow responses as a read-only projection: the server resolves the
+  latest branding revision for the project per step response (falling
+  back to built-in defaults when none is stored). Branding is configured
+  via the Branding API / `zitadel apply`, not the Flow API.
+- As the request body of `POST /branding`, which publishes the same
+  shape as a new immutable revision (see ADR 040).
 
  */
 export type CreateFlow201Branding = {
   /** Layout preset selector. The default.liquid master template uses this
   to branch into layout variants. Customers who eject the template
-  can ignore this field entirely.
+  can ignore this field entirely; it also serves as the degrade target
+  when a custom template fails component-side validation.
    */
   layout?: CreateFlow201BrandingLayout;
-  /** The LiquidJS template string for rendering this step. The orchestrator
+  /**
+     * The LiquidJS template string for rendering this step. The orchestrator
   parses this template, injects the capability dictionaries as context,
   and renders the output HTML into its Shadow DOM.
-   */
+
+     * @maxLength 131072
+     */
   liquid_template?: string;
   /** Team logo URL. */
   logo_url?: string;
-  /** Custom font URL (e.g., Google Fonts CSS). */
+  /** Custom font stylesheet URL (e.g., Google Fonts CSS). Read-only in
+  v1: `POST /branding` rejects a non-empty value, because the login
+  component loads this stylesheet at document level (shadow-scoped
+  `@font-face` rules never register faces) and an arbitrary URL would
+  grant `branding.write` page-wide CSS control over the embedding
+  application. Safe tenant font delivery is an ADR 040 follow-up;
+  until then, load fonts from the embedding page.
+   */
   font_url?: string;
   /** Hero/background image URL (used by split layout). */
   hero_url?: string;

package/src/generated/model/createFlow201BrandingLayout.ts

@@ -9,7 +9,8 @@
 /**
  * Layout preset selector. The default.liquid master template uses this
 to branch into layout variants. Customers who eject the template
-can ignore this field entirely.
+can ignore this field entirely; it also serves as the degrade target
+when a custom template fails component-side validation.
 
  */
 export type CreateFlow201BrandingLayout =

package/src/generated/model/createFlow201Step.ts

@@ -27,7 +27,17 @@ export type CreateFlow201Step = {
   The backend never sends display text — only semantic keys.
    */
   texts?: CreateFlow201StepTexts;
-  /** Error message from a previous failed submission. */
+  /** Error from a previous failed submission. Field-validation failures
+  carry localisation text keys: `error.<field>_<rule>` per violation
+  (e.g. `error.email_required`; the `format` rule is spelled
+  `error.<field>_invalid`), multiple violations joined with `"; "`.
+  Field names appear verbatim, so clients localise unknown keys via
+  the generic `error.field_<rule>` catalog entries. Other engine
+  failures carry `error.*` catalog keys as well (e.g.
+  `error.invalid_credentials`, `error.passkey_invalid`); a
+  non-`error.` payload is an outcome token (e.g. `user_not_found`)
+  that clients keep verbatim.
+   */
   error?: string | null;
   /** Present only on terminal steps. Tells the frontend what to do:
   - redirect: navigate to redirect_uri immediately (OIDC/SAML done)

package/src/generated/model/createFlow201StepActionsItem.ts

@@ -5,15 +5,29 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { CreateFlow201StepActionsItemKind } from "./createFlow201StepActionsItemKind";
 
 /**
  * Configuration for a user-invokable action on a step. The `name` is sent
-back in the submit request as `action`.
+back in the submit request as `action`; the engine resolves the action's
+declared `kind` to decide how to handle the submission.
 
  */
 export type CreateFlow201StepActionsItem = {
   /** Action identifier. Sent back in the submit request as `action`. */
   name: string;
+  /** Classifies how the engine handles this action:
+  - `submit`: collect the step's fields and run validate/dispatch/on_success.
+  - `passkey`: issue a WebAuthn assertion challenge; the matching transition
+    fires once the returned assertion verifies.
+  - `passkey_register`: issue a WebAuthn registration challenge; the matching
+    transition fires once the returned attestation verifies.
+  - `navigate`: route through the transition without running the input
+    pipeline. Used for pure-routing actions declared in the flow definition.
+  - `back`: return the user to the previous step. Surfaced by the engine
+    when going back is available.
+   */
+  kind: CreateFlow201StepActionsItemKind;
   /** Marks this as the default/primary action. The runtime template uses
   this hint to choose visual emphasis. At most one action per step
   should be primary; this is not enforced here.

package/src/generated/model/createFlow201StepActionsItemKind.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by orval v8.10.0 🍺
+ * Do not edit manually.
+ * Zitadel NextGen
+ * This is the next generation of the Zitadel identity platform.
+ * OpenAPI spec version: 0.0.1
+ */
+
+/**
+ * Classifies how the engine handles this action:
+- `submit`: collect the step's fields and run validate/dispatch/on_success.
+- `passkey`: issue a WebAuthn assertion challenge; the matching transition
+  fires once the returned assertion verifies.
+- `passkey_register`: issue a WebAuthn registration challenge; the matching
+  transition fires once the returned attestation verifies.
+- `navigate`: route through the transition without running the input
+  pipeline. Used for pure-routing actions declared in the flow definition.
+- `back`: return the user to the previous step. Surfaced by the engine
+  when going back is available.
+
+ */
+export type CreateFlow201StepActionsItemKind =
+  (typeof CreateFlow201StepActionsItemKind)[keyof typeof CreateFlow201StepActionsItemKind];
+
+export const CreateFlow201StepActionsItemKind = {
+  submit: "submit",
+  passkey: "passkey",
+  passkey_register: "passkey_register",
+  navigate: "navigate",
+  back: "back",
+} as const;

package/src/generated/model/createFlow201StepChallengeMethod.ts

@@ -14,4 +14,5 @@ export type CreateFlow201StepChallengeMethod =
 
 export const CreateFlow201StepChallengeMethod = {
   passkey: "passkey",
+  passkey_register: "passkey_register",
 } as const;

package/src/generated/model/createFlowBody.ts

@@ -20,6 +20,11 @@ export type CreateFlowBody = {
      * @pattern ^[a-z][a-z0-9-]*$
      */
   flow_definition_name?: string;
+  /** Set to true to simulate the flow without actually creating any
+  user or session. Useful for testing and validation of flow definitions.
+  This requires setting the `flow_definition_name` property as well.
+   */
+  dry_run?: boolean;
   /**
      * Semver version of the flow definition JSON Schema to use.
   When omitted, the latest version is used.

package/src/generated/model/createFlowDefault.ts

@@ -5,16 +5,145 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { CreateFlowDefaultDetails } from "./createFlowDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type CreateFlowDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: CreateFlowDefaultDetails;
-};
+export type CreateFlowDefault =
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "att.invalid_request";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.decrypt_failed";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.encrypt_failed";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.not_found";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "evt.invalid";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flowdef.not_found";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flowdef.purpose_mismatch";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flow.integrity";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flow.invalid_purpose";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "internal";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "tkn.invalid";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "tkn.invalid_tknid";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "req.invalid";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.unknown_alg";
+    });

package/src/generated/model/createFlowDefinition201.ts

@@ -6,14 +6,13 @@
  * OpenAPI spec version: 0.0.1
  */
 import type { CreateFlowDefinition201FlowDefinition } from "./createFlowDefinition201FlowDefinition";
+import type { CreateFlowDefinition201UserSchema } from "./createFlowDefinition201UserSchema";
 
 export type CreateFlowDefinition201 = {
   /** Unique identifier for the flow definition. */
   id: string;
   /** Identifier of the project this flow definition belongs to. */
   project_id: string;
-  /** Status of the flow definition. */
-  status: string;
   /** A flow definition is the server-side configuration that describes a complete
   authentication or identity flow. It is NOT sent to the frontend — the flow
   engine evaluates it and produces FlowResponse payloads (steps with capability
@@ -24,6 +23,12 @@ export type CreateFlowDefinition201 = {
   the purpose + audience when a flow is created via POST /flow.
    */
   flow_definition: CreateFlowDefinition201FlowDefinition;
+  /** The user schema this flow operates on: the same object
+  `GET /schemas/{id}` returns. Present only when the request asked for it
+  with `expand=user_schema`; `null` when it was requested but the
+  referenced schema no longer resolves or the caller may not read it.
+   */
+  readonly user_schema?: CreateFlowDefinition201UserSchema;
   created_at: string;
   updated_at: string;
 };