@zitadel/api 0.0.0

package/src/generated/model/getFlowStep200StepChallenge.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { GetFlowStep200StepChallengeMethod } from "./getFlowStep200StepChallengeMethod";
+import type { GetFlowStep200StepChallengeOptions } from "./getFlowStep200StepChallengeOptions";
+
+/**
+ * A pending authentication challenge issued by the server. Present when the
+flow engine has issued a challenge via auth_attempts (e.g., after the user
+submits `action: "passkey"`). The `<zl-passkey>` component reads this and
+triggers the appropriate WebAuthn ceremony.
+
+The challenge is NOT present on the initial step — it appears only after
+the user explicitly selects a ceremony-based action.
+
+ */
+export type GetFlowStep200StepChallenge = {
+  /** Challenge method. Determines which component handles the ceremony. */
+  method?: GetFlowStep200StepChallengeMethod;
+  /** Server-side challenge identifier. Included in the proof submission
+  so the server can match the response to the original challenge.
+   */
+  challenge_id?: string;
+  /** Protocol-specific challenge options. For passkey, this is the
+  `PublicKeyCredentialRequestOptions` (authenticate) or
+  `PublicKeyCredentialCreationOptions` (register). Passed directly
+  to the browser's `navigator.credentials` API.
+   */
+  options?: GetFlowStep200StepChallengeOptions;
+};

package/src/generated/model/getFlowStep200StepChallengeMethod.ts

@@ -0,0 +1,17 @@
+/**
+ * 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
+ */
+
+/**
+ * Challenge method. Determines which component handles the ceremony.
+ */
+export type GetFlowStep200StepChallengeMethod =
+  (typeof GetFlowStep200StepChallengeMethod)[keyof typeof GetFlowStep200StepChallengeMethod];
+
+export const GetFlowStep200StepChallengeMethod = {
+  passkey: "passkey",
+} as const;

package/src/generated/model/getFlowStep200StepChallengeOptions.ts

@@ -0,0 +1,16 @@
+/**
+ * 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
+ */
+
+/**
+ * Protocol-specific challenge options. For passkey, this is the
+`PublicKeyCredentialRequestOptions` (authenticate) or
+`PublicKeyCredentialCreationOptions` (register). Passed directly
+to the browser's `navigator.credentials` API.
+
+ */
+export type GetFlowStep200StepChallengeOptions = { [key: string]: unknown };

package/src/generated/model/getFlowStep200StepComplete.ts

@@ -0,0 +1,21 @@
+/**
+ * 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
+ */
+
+/**
+ * Present only on terminal steps. Tells the frontend what to do:
+- redirect: navigate to redirect_uri immediately (OIDC/SAML done)
+- show: render the step as a success screen (e.g., registration confirmed)
+
+ */
+export type GetFlowStep200StepComplete =
+  (typeof GetFlowStep200StepComplete)[keyof typeof GetFlowStep200StepComplete];
+
+export const GetFlowStep200StepComplete = {
+  redirect: "redirect",
+  show: "show",
+} as const;

package/src/generated/model/getFlowStep200StepFields.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { GetFlowStep200StepFieldsType } from "./getFlowStep200StepFieldsType";
+import type { GetFlowStep200StepFieldsValidation } from "./getFlowStep200StepFieldsValidation";
+
+/**
+ * Unordered dictionary of input fields to collect. Keyed by field name.
+The LiquidJS template controls which fields appear and in what order.
+Field metadata (type, validation) is resolved by the engine from the
+flow's user schema.
+
+ */
+export type GetFlowStep200StepFields = {
+  [key: string]: {
+    /** The input kind the client should render. Encodes the formats that
+  have a matching HTML input type (email, url, date). For other
+  formats (e.g. uuid) the type is `text` and `validation.format`
+  carries the rule.
+   */
+    type: GetFlowStep200StepFieldsType;
+    /** Localization key for the field label. */
+    text_key: string;
+    /** The field MUST be present and non-empty on submit. Mirrors the
+  schema's top-level `required` array.
+   */
+    required?: boolean;
+    /** Pre-filled value (e.g., an identifier carried over from a pivot). */
+    value?: unknown;
+    /** Schema-derived rules the frontend SHOULD apply at input time. The
+  server runs the same rules on submit and is the only authority on
+  whether the step advances — these rules are a UX hint to reduce
+  round trips, not a contract guarantee.
+
+  Omitted entirely when the field has no rules beyond its `type`.
+  Each key mirrors a JSON Schema keyword on the underlying user
+  property; absent keys mean no rule.
+   */
+    validation?: GetFlowStep200StepFieldsValidation;
+  };
+};

package/src/generated/model/getFlowStep200StepFieldsType.ts

@@ -0,0 +1,28 @@
+/**
+ * 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
+ */
+
+/**
+ * The input kind the client should render. Encodes the formats that
+have a matching HTML input type (email, url, date). For other
+formats (e.g. uuid) the type is `text` and `validation.format`
+carries the rule.
+
+ */
+export type GetFlowStep200StepFieldsType =
+  (typeof GetFlowStep200StepFieldsType)[keyof typeof GetFlowStep200StepFieldsType];
+
+export const GetFlowStep200StepFieldsType = {
+  text: "text",
+  email: "email",
+  password: "password",
+  tel: "tel",
+  number: "number",
+  url: "url",
+  date: "date",
+  hidden: "hidden",
+} as const;

package/src/generated/model/getFlowStep200StepFieldsValidation.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { GetFlowStep200StepFieldsValidationFormat } from "./getFlowStep200StepFieldsValidationFormat";
+
+/**
+ * Schema-derived rules the frontend SHOULD apply at input time. The
+server runs the same rules on submit and is the only authority on
+whether the step advances — these rules are a UX hint to reduce
+round trips, not a contract guarantee.
+
+Omitted entirely when the field has no rules beyond its `type`.
+Each key mirrors a JSON Schema keyword on the underlying user
+property; absent keys mean no rule.
+
+ */
+export type GetFlowStep200StepFieldsValidation = {
+  /** Semantic format the value must match. Values mirror the user
+  meta-schema. When `type` already encodes the format (email,
+  url, date), this key is informative and the input type is
+  sufficient for client-side validation. When `type` is `text`
+  (e.g. `format: uuid`), this key is the only signal.
+   */
+  format?: GetFlowStep200StepFieldsValidationFormat;
+  /**
+   * Minimum length in characters (inclusive). Mirrors `minLength`.
+   * @minimum 0
+   */
+  min_length?: number;
+  /**
+   * Maximum length in characters (inclusive). Mirrors `maxLength`.
+   * @minimum 0
+   */
+  max_length?: number;
+};

package/src/generated/model/getFlowStep200StepFieldsValidationFormat.ts

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+
+/**
+ * Semantic format the value must match. Values mirror the user
+meta-schema. When `type` already encodes the format (email,
+url, date), this key is informative and the input type is
+sufficient for client-side validation. When `type` is `text`
+(e.g. `format: uuid`), this key is the only signal.
+
+ */
+export type GetFlowStep200StepFieldsValidationFormat =
+  (typeof GetFlowStep200StepFieldsValidationFormat)[keyof typeof GetFlowStep200StepFieldsValidationFormat];
+
+export const GetFlowStep200StepFieldsValidationFormat = {
+  email: "email",
+  "date-time": "date-time",
+  uuid: "uuid",
+  uri: "uri",
+} as const;

package/src/generated/model/getFlowStep200StepGates.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { GetFlowStep200StepGatesConfig } from "./getFlowStep200StepGatesConfig";
+import type { GetFlowStep200StepGatesKind } from "./getFlowStep200StepGatesKind";
+
+/**
+ * Security gates that must be satisfied before the step can be submitted.
+The engine injects gates dynamically based on policy, even if they
+are not declared in the flow definition.
+
+ */
+export type GetFlowStep200StepGates = {
+  [key: string]: {
+    /** The gate category. Only `captcha` is currently defined. Authenticator
+  ceremonies (e.g. passkey) are modelled as credential auth_attempts via
+  `x-credential` on a field, not as gates.
+   */
+    kind: GetFlowStep200StepGatesKind;
+    /** Provider identifier within the gate kind — e.g. `altcha`, `turnstile`,
+  `hcaptcha`. The engine looks up an implementation in its provider
+  registry.
+   */
+    provider: string;
+    /** Provider-specific configuration consumed by the implementation when
+  issuing the per-render challenge. Opaque to the engine.
+   */
+    config?: GetFlowStep200StepGatesConfig;
+  };
+};

package/src/generated/model/getFlowStep200StepGatesConfig.ts

@@ -0,0 +1,14 @@
+/**
+ * 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
+ */
+
+/**
+ * Provider-specific configuration consumed by the implementation when
+issuing the per-render challenge. Opaque to the engine.
+
+ */
+export type GetFlowStep200StepGatesConfig = { [key: string]: unknown };

package/src/generated/model/getFlowStep200StepGatesKind.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
+ */
+
+/**
+ * The gate category. Only `captcha` is currently defined. Authenticator
+ceremonies (e.g. passkey) are modelled as credential auth_attempts via
+`x-credential` on a field, not as gates.
+
+ */
+export type GetFlowStep200StepGatesKind =
+  (typeof GetFlowStep200StepGatesKind)[keyof typeof GetFlowStep200StepGatesKind];
+
+export const GetFlowStep200StepGatesKind = {
+  captcha: "captcha",
+} as const;

package/src/generated/model/getFlowStep200StepSsoProvidersItem.ts

@@ -0,0 +1,19 @@
+/**
+ * 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
+ */
+
+/**
+ * An available SSO identity provider.
+ */
+export type GetFlowStep200StepSsoProvidersItem = {
+  /** Provider instance identifier. */
+  id: string;
+  /** Display name for the provider. */
+  name: string;
+  /** Template hint for rendering (logo, colors). */
+  template: string;
+};

package/src/generated/model/getFlowStep200StepTexts.ts

@@ -0,0 +1,19 @@
+/**
+ * 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
+ */
+
+/**
+ * Step-level localization keys. Resolved client-side via the `| t` LiquidJS filter.
+The backend never sends display text — only semantic keys.
+
+ */
+export type GetFlowStep200StepTexts = {
+  /** Localization key for the step heading. */
+  title_key?: string;
+  /** Localization key for explanatory text. */
+  description_key?: string | null;
+};

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

package/src/generated/model/getFlowStep404Details.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 GetFlowStep404Details = { [key: string]: unknown };

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

package/src/generated/model/getFlowStep410Details.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 GetFlowStep410Details = { [key: string]: unknown };

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

package/src/generated/model/getFlowStepDefaultDetails.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 GetFlowStepDefaultDetails = { [key: string]: unknown };

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

package/src/generated/model/getHealth4xxDetails.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 GetHealth4xxDetails = { [key: string]: unknown };

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

package/src/generated/model/getHealthDefaultDetails.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 GetHealthDefaultDetails = { [key: string]: unknown };

package/src/generated/model/getKeys200.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
+ */
+import type { GetKeys200KeysItem } from "./getKeys200KeysItem";
+
+export type GetKeys200 = {
+  keys?: GetKeys200KeysItem[];
+};

package/src/generated/model/getKeys200KeysItem.ts

@@ -0,0 +1,30 @@
+/**
+ * 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
+ */
+
+export type GetKeys200KeysItem = {
+  use?: string;
+  kty?: string;
+  kid?: string;
+  crv?: string;
+  alg?: string;
+  k?: string;
+  x?: string;
+  y?: string;
+  n?: string;
+  e?: string;
+  d?: string;
+  p?: string;
+  q?: string;
+  dp?: string;
+  dq?: string;
+  qi?: string;
+  x5c?: string[];
+  x5u?: string;
+  x5t?: string;
+  x5tS256?: string;
+};

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

package/src/generated/model/getKeys4xxDetails.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 GetKeys4xxDetails = { [key: string]: unknown };

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

package/src/generated/model/getKeysDefaultDetails.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 GetKeysDefaultDetails = { [key: string]: unknown };

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

package/src/generated/model/getLive4xxDetails.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 GetLive4xxDetails = { [key: string]: unknown };