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

package/src/generated/model/revokeMySessionDefault.ts

@@ -5,16 +5,55 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { RevokeMySessionDefaultDetails } from "./revokeMySessionDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type RevokeMySessionDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: RevokeMySessionDefaultDetails;
-};
+export type RevokeMySessionDefault =
+  | ({
+      /** 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;
+      /** 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: "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: "sess.not_found";
+    });

package/src/generated/model/revokeSession403.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 { RevokeSession403Details } from "./revokeSession403Details";
+
+/**
+ * Standard error payload returned for failed API requests.
+ */
+export type RevokeSession403 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: RevokeSession403Details;
+};

package/src/generated/model/revokeSession403Details.ts

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+
+/**
+ * Additional error-specific context.
+ */
+export type RevokeSession403Details = { [key: string]: unknown };

package/src/generated/model/revokeSessionDefault.ts

@@ -5,16 +5,65 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { RevokeSessionDefaultDetails } from "./revokeSessionDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type RevokeSessionDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: RevokeSessionDefaultDetails;
-};
+export type RevokeSessionDefault =
+  | ({
+      /** 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;
+      /** 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: "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: "sess.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: "sess.permission_denied";
+    });

package/src/generated/model/setUserPasswordBody.ts

@@ -15,5 +15,5 @@ export type SetUserPasswordBody = {
   /** Whether the user is required to change their password on the next login.
   If not provided, it will default to false.
    */
-  isChangeRequired?: boolean;
+  is_change_required?: boolean;
 };

package/src/generated/model/setUserPasswordDefault.ts

@@ -5,16 +5,75 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { SetUserPasswordDefaultDetails } from "./setUserPasswordDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type SetUserPasswordDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: SetUserPasswordDefaultDetails;
-};
+export type SetUserPasswordDefault =
+  | ({
+      /** 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;
+      /** 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: "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: "user.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: "user.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: "user.permission_denied";
+    });

package/src/generated/model/submitFlowStep200.ts

@@ -24,9 +24,14 @@ export type SubmitFlowStep200 = {
   and builds name-keyed indexes locally for lookup.
    */
   step: SubmitFlowStep200Step;
-  /** 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?: SubmitFlowStep200Branding;
   /** Present when `step.complete` is `redirect`. */

package/src/generated/model/submitFlowStep200Branding.ts

@@ -8,25 +8,41 @@
 import type { SubmitFlowStep200BrandingLayout } from "./submitFlowStep200BrandingLayout";
 
 /**
- * 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 SubmitFlowStep200Branding = {
   /** 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?: SubmitFlowStep200BrandingLayout;
-  /** 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/submitFlowStep200BrandingLayout.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 SubmitFlowStep200BrandingLayout =

package/src/generated/model/submitFlowStep200Step.ts

@@ -27,7 +27,17 @@ export type SubmitFlowStep200Step = {
   The backend never sends display text — only semantic keys.
    */
   texts?: SubmitFlowStep200StepTexts;
-  /** 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/submitFlowStep200StepActionsItem.ts

@@ -5,15 +5,29 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { SubmitFlowStep200StepActionsItemKind } from "./submitFlowStep200StepActionsItemKind";
 
 /**
  * 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 SubmitFlowStep200StepActionsItem = {
   /** 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: SubmitFlowStep200StepActionsItemKind;
   /** 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/submitFlowStep200StepActionsItemKind.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 SubmitFlowStep200StepActionsItemKind =
+  (typeof SubmitFlowStep200StepActionsItemKind)[keyof typeof SubmitFlowStep200StepActionsItemKind];
+
+export const SubmitFlowStep200StepActionsItemKind = {
+  submit: "submit",
+  passkey: "passkey",
+  passkey_register: "passkey_register",
+  navigate: "navigate",
+  back: "back",
+} as const;

package/src/generated/model/submitFlowStep200StepChallengeMethod.ts

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

package/src/generated/model/submitFlowStep400.ts

@@ -24,9 +24,14 @@ export type SubmitFlowStep400 = {
   and builds name-keyed indexes locally for lookup.
    */
   step: SubmitFlowStep400Step;
-  /** 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?: SubmitFlowStep400Branding;
   /** Present when `step.complete` is `redirect`. */

package/src/generated/model/submitFlowStep400Branding.ts

@@ -8,25 +8,41 @@
 import type { SubmitFlowStep400BrandingLayout } from "./submitFlowStep400BrandingLayout";
 
 /**
- * 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 SubmitFlowStep400Branding = {
   /** 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?: SubmitFlowStep400BrandingLayout;
-  /** 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/submitFlowStep400BrandingLayout.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 SubmitFlowStep400BrandingLayout =

package/src/generated/model/submitFlowStep400Step.ts

@@ -27,7 +27,17 @@ export type SubmitFlowStep400Step = {
   The backend never sends display text — only semantic keys.
    */
   texts?: SubmitFlowStep400StepTexts;
-  /** 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/submitFlowStep400StepActionsItem.ts

@@ -5,15 +5,29 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { SubmitFlowStep400StepActionsItemKind } from "./submitFlowStep400StepActionsItemKind";
 
 /**
  * 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 SubmitFlowStep400StepActionsItem = {
   /** 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: SubmitFlowStep400StepActionsItemKind;
   /** 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/submitFlowStep400StepActionsItemKind.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 SubmitFlowStep400StepActionsItemKind =
+  (typeof SubmitFlowStep400StepActionsItemKind)[keyof typeof SubmitFlowStep400StepActionsItemKind];
+
+export const SubmitFlowStep400StepActionsItemKind = {
+  submit: "submit",
+  passkey: "passkey",
+  passkey_register: "passkey_register",
+  navigate: "navigate",
+  back: "back",
+} as const;

package/src/generated/model/submitFlowStep400StepChallengeMethod.ts

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