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

package/src/generated/model/finishUserPasskeyRegistrationDefault.ts

@@ -0,0 +1,149 @@
+/**
+ * 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 FinishUserPasskeyRegistrationDefault =
+  | ({
+      /** 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.already_handed_off";
+    })
+  | ({
+      /** 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_proof";
+    })
+  | ({
+      /** 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: "att.invalid_state";
+    })
+  | ({
+      /** 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.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: "att.proof_rejected";
+    })
+  | ({
+      /** 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.stale_challenge";
+    })
+  | ({
+      /** 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/getAuthAttempt200.ts

@@ -23,8 +23,8 @@ Clients drive the attempt by:
  */
 export type GetAuthAttempt200 = {
   /**
-   * Unique identifier for this authentication attempt
-   * @pattern ^[a-zA-Z0-9_-]+$
+   * Unique identifier for this authentication attempt (dialect-minted prefixed opaque string).
+   * @pattern ^att_[a-zA-Z0-9_-]+$
    */
   attempt_id: string;
   /** @pattern ^[a-zA-Z0-9_-]+$ */

package/src/generated/model/getAuthAttempt200ChallengesItem.ts

@@ -18,8 +18,8 @@ The client verifies the proof by POST /auth_attempts/{attempt_id}/challenges/{ch
  */
 export type GetAuthAttempt200ChallengesItem = {
   /**
-   * Unique identifier for this challenge
-   * @pattern ^[a-zA-Z0-9_-]+$
+   * Unique identifier for this challenge (dialect-minted prefixed opaque string).
+   * @pattern ^ch_[a-zA-Z0-9_-]+$
    */
   challenge_id: string;
   /** An authentication factor method. */

package/src/generated/model/getAuthAttemptDefault.ts

@@ -17,6 +17,16 @@ export type GetAuthAttemptDefault =
     } & {
       code: "att.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: "auth.unauthorized";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;
@@ -26,4 +36,14 @@ export type GetAuthAttemptDefault =
       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/getBrandingById200.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 { GetBrandingById200Branding } from "./getBrandingById200Branding";
+
+/**
+ * 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 GetBrandingById200 = {
+  /** 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: GetBrandingById200Branding;
+};

package/src/generated/model/getBrandingById200Branding.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 { GetBrandingById200BrandingLayout } from "./getBrandingById200BrandingLayout";
+
+/**
+ * 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 GetBrandingById200Branding = {
+  /** 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?: GetBrandingById200BrandingLayout;
+  /**
+     * 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/getBrandingById200BrandingLayout.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 GetBrandingById200BrandingLayout =
+  (typeof GetBrandingById200BrandingLayout)[keyof typeof GetBrandingById200BrandingLayout];
+
+export const GetBrandingById200BrandingLayout = {
+  centered: "centered",
+  split: "split",
+} as const;

package/src/generated/model/{authorizeDevice400.ts → getBrandingById404.ts}

@@ -5,16 +5,16 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { AuthorizeDevice400Details } from "./authorizeDevice400Details";
+import type { GetBrandingById404Details } from "./getBrandingById404Details";
 
 /**
  * Standard error payload returned for failed API requests.
  */
-export type AuthorizeDevice400 = {
+export type GetBrandingById404 = {
   /** Stable machine-readable error code. */
   code: string;
   /** Human-readable explanation of the error. */
   message: string;
   /** Additional error-specific context. */
-  details?: AuthorizeDevice400Details;
+  details?: GetBrandingById404Details;
 };

package/src/generated/model/{getFlowStepDefaultDetails.ts → getBrandingById404Details.ts}

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

package/src/generated/model/{authorizeDeviceDefault.ts → getBrandingByIdDefault.ts}

@@ -5,16 +5,16 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { AuthorizeDeviceDefaultDetails } from "./authorizeDeviceDefaultDetails";
+import type { GetBrandingByIdDefaultDetails } from "./getBrandingByIdDefaultDetails";
 
 /**
  * Standard error payload returned for failed API requests.
  */
-export type AuthorizeDeviceDefault = {
+export type GetBrandingByIdDefault = {
   /** Stable machine-readable error code. */
   code: string;
   /** Human-readable explanation of the error. */
   message: string;
   /** Additional error-specific context. */
-  details?: AuthorizeDeviceDefaultDetails;
+  details?: GetBrandingByIdDefaultDetails;
 };

package/src/generated/model/{exchangeHandoffDefaultDetails.ts → getBrandingByIdDefaultDetails.ts}

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

package/src/generated/model/getClaimStatus200.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
+ */
+
+/**
+ * The state of a claim challenge. While pending it carries only `status`; once
+completed it also carries the owning team, the claim timestamp, and the
+dashboard URL. Modelled as discriminated variants so a `pending` response can
+never carry stale completion fields and a `completed` response always carries
+them.
+
+ */
+export type GetClaimStatus200 =
+  | {
+      /** The claim has not completed yet. */
+      status: "pending";
+    }
+  | {
+      /** The claim has completed. */
+      status: "completed";
+      /** @pattern ^[a-zA-Z0-9_-]+$ */
+      team_id: string;
+      /** The time when the project was claimed. */
+      claimed_at: string;
+      /** The dashboard URL for the owning team. */
+      dashboard_url: string;
+    };

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

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

package/src/generated/model/getClaimStatus403.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 project management API requires the project secret
+
+Error code: proj.permission_denied
+
+ */
+export type GetClaimStatus403 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: { [key: string]: unknown };
+} & {
+  code: "proj.permission_denied";
+};

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

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

package/src/generated/model/getClaimStatus410.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 claim challenge has expired
+
+Error code: proj.claim_expired
+
+ */
+export type GetClaimStatus410 = {
+  /** Stable machine-readable error code. */
+  code: string;
+  /** Human-readable explanation of the error. */
+  message: string;
+  /** Additional error-specific context. */
+  details?: { [key: string]: unknown };
+} & {
+  code: "proj.claim_expired";
+};

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

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

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

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

package/src/generated/model/{deleteFlowDefinitionParams.ts → getClaimStatusParams.ts}

@@ -6,10 +6,10 @@
  * OpenAPI spec version: 0.0.1
  */
 
-export type DeleteFlowDefinitionParams = {
+export type GetClaimStatusParams = {
   /**
-   * The project id to filter by.
-   * @pattern ^[a-zA-Z0-9_-]+$
+   * Unique identifier for this challenge (dialect-minted prefixed opaque string).
+   * @pattern ^ch_[a-zA-Z0-9_-]+$
    */
-  project_id: string;
+  challenge_id: string;
 };

package/src/generated/model/getEnvironmentByName200.ts

@@ -0,0 +1,37 @@
+/**
+ * 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
+ */
+
+/**
+ * A runtime slot on a project (ADR 035).
+
+This is identity only. The release an environment currently runs, and its
+deployment history, arrive with the deployments endpoints; environment
+lifecycle (create, rename, retire) arrives with its own ADR. Until then
+every project is seeded with a fixed set of environments at creation and
+the set cannot be changed.
+
+ */
+export type GetEnvironmentByName200 = {
+  /** The opaque, immutable resource id. */
+  readonly id: string;
+  /** @pattern ^[a-zA-Z0-9_-]+$ */
+  project_id: string;
+  /**
+     * An environment's public handle, unique within its project and immutable.
+
+  It addresses the environment on the wire and names a deploy target in the
+  CLI, so it is a lowercase DNS-style label: letters, digits, and hyphens
+  between them.
+
+     * @maxLength 63
+     * @pattern ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
+     */
+  name: string;
+  /** When the environment was created. */
+  readonly created_at: string;
+};