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

package/src/generated/model/listFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemOnSuccess.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
+ */
+
+/**
+ * Server-side mutation to execute when this step completes successfully.
+Runs after field validation passes, before the transition fires.
+
+- create_user: creates the user record (registration flows)
+
+ */
+export type ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemOnSuccess =
+  (typeof ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemOnSuccess)[keyof typeof ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemOnSuccess];
+
+export const ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemOnSuccess = {
+  create_user: "create_user",
+} as const;

package/src/generated/model/listFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemSsoProvidersItem.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 ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemSsoProvidersItem = {
+  /** Provider instance identifier. */
+  id: string;
+  /** Display name for the provider. */
+  name: string;
+  /** Template hint for rendering (logo, colors). */
+  template: string;
+};

package/src/generated/model/listFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemTransitions.ts

@@ -0,0 +1,46 @@
+/**
+ * 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
+ */
+
+/**
+ * Maps action/outcome names to their transition descriptor.
+
+Keys match action names from the `actions` array. Additional keys
+come from implicit outcomes based on schema annotations
+(e.g. `user_not_found` from `x-unique` fields) and engine
+events (e.g. `sso`, `callback`).
+
+ */
+export type ListFlowDefinitions200FlowDefinitionsItemFlowDefinitionStepsItemTransitions = {
+  [key: string]: {
+    /** Step name within this flow (when `action` is null), or the name
+  of another flow (when `action` is `switch` or `pivot`).
+   */
+    target: string;
+    /** How to interpret `target`:
+  - null (omitted): transition to a step in the current flow.
+  - switch: replace the current flow with the target flow.
+    No return — the current flow is discarded.
+    Example: login ↔ register.
+  - pivot: push the target flow onto the stack. The current flow
+    is paused and resumes when the target flow completes (auto-pop).
+    Example: login → recovery → back to login.
+   */
+    action?: "switch" | "pivot" | null;
+    /** Local re-purposing. When set, taking this transition changes the
+  flow's current purpose to this value — the dispatch mode a step's
+  challenges run under — while the flow's original purpose stays
+  pinned. Must be a purpose this definition serves, and `target`
+  must be that purpose's entry step. Mutually exclusive with
+  `action`: a transition either re-purposes within this flow or
+  targets another flow, never both.
+  Example: a "Sign up" navigation on the login identifier step
+  (`{ target: register, purpose: register }`).
+   */
+    purpose?: "login" | "register" | "recovery" | "profiling" | "reauth" | "link_account" | null;
+  };
+};

package/src/generated/model/listFlowDefinitions200FlowDefinitionsItemUserSchema.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 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.
+
+ */
+export type ListFlowDefinitions200FlowDefinitionsItemUserSchema = {
+  /** The resource id: the server-minted `sch_*` identifier, or the
+  customer-supplied `$id` URI when the document declared one at creation.
+   */
+  readonly id: string;
+  /** The customer-authored JSON Schema document, served verbatim. */
+  schema: {
+    /**
+     * The type of user this schema describes. This is a customer chosen name.
+
+     * @maxLength 256
+     */
+    objectType?: string;
+    /** Discriminator value for a user schema create request. */
+    kind: "user-schema";
+    /** The user Schema version used for this schema. */
+    metaSchema: string;
+    /** A list of authentication methods supported by the user definition. */
+    "x-auth-methods": {
+      password?: {
+        /** Whether the authentication method is enabled or not */
+        enabled: boolean;
+      };
+      passkey?: {
+        /** Whether the authentication method is enabled or not */
+        enabled: boolean;
+      };
+      magic_link?: {
+        /** Whether the authentication method is enabled or not */
+        enabled: boolean;
+      };
+      sso?: {
+        /** Whether the authentication method is enabled or not */
+        enabled: boolean;
+      };
+      otp?: {
+        /** Whether the authentication method is enabled or not */
+        enabled: boolean;
+      };
+    };
+    /**
+     * Path of the leaf property whose value identifies a user (nested leaves
+  are addressed by their dot-joined attribute path). The property must
+  carry `x-unique` "project". Required when an auth method needing
+  identifier-first dispatch (password) is enabled. Passkey is exempt:
+  discoverable credentials identify the user through the assertion
+  itself, so passkey-only and API-managed schemas may designate nothing;
+  flows using identifier-first passkey are validated at the flow level
+  instead.
+
+     * @minLength 1
+     */
+    "x-identifier"?: string;
+    /**
+     * Ordered leaf property paths whose values, joined with a space, render
+  the user's display name.
+
+     * @minItems 1
+     */
+    "x-display"?: string[];
+    /** A map of additional properties for the user definition, where the
+  key is the property name and the value is the property schema
+   */
+    properties?: {
+      [key: string]: {
+        /** The level of uniqueness for this property, if applicable */
+        "x-unique"?: "unspecified" | "project" | "team" | null;
+        /** The claim name for this property, if applicable */
+        "x-claim"?: string | null;
+        /** Whether this property's value may appear in audit event payloads. Audit
+  payloads are deny-by-default: a property without this annotation
+  contributes its key but never its value.
+   */
+        "x-audit"?: boolean;
+        /** A map of additional properties for the user definition, where the key is
+  the property name and the value is the property schema.
+   */
+        properties?: { [key: string]: unknown };
+        [key: string]: unknown;
+      };
+    };
+    [key: string]: unknown;
+  };
+  metadata: {
+    /** The time when the schema was created. */
+    created_at: string;
+  };
+} | null;

package/src/generated/model/listFlowDefinitionsDefault.ts

@@ -5,16 +5,95 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { ListFlowDefinitionsDefaultDetails } from "./listFlowDefinitionsDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type ListFlowDefinitionsDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: ListFlowDefinitionsDefaultDetails;
-};
+export type ListFlowDefinitionsDefault =
+  | ({
+      /** 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: "flowdef.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.permission_denied";
+    })
+  | ({
+      /** 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: "sch.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: "sch.permission_denied";
+    })
+  | ({
+      /** 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.missing_project_id";
+    })
+  | ({
+      /** 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/listFlowDefinitionsExpandItem.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
+ */
+
+/**
+ * A related entity to embed on each returned flow definition.
+
+- `user_schema`: the user schema the flow operates on, embedded as
+  `user_schema` on each entry: the same object `GET /schemas/{id}` returns.
+  The property is omitted entirely when not requested and `null` when the
+  referenced schema no longer resolves or the caller may not read it, so
+  "did not ask" stays distinguishable from "cannot resolve". Requesting it
+  requires read access to schemas.
+
+ */
+export type ListFlowDefinitionsExpandItem =
+  (typeof ListFlowDefinitionsExpandItem)[keyof typeof ListFlowDefinitionsExpandItem];
+
+export const ListFlowDefinitionsExpandItem = {
+  user_schema: "user_schema",
+} as const;

package/src/generated/model/listFlowDefinitionsParams.ts

@@ -5,6 +5,7 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { ListFlowDefinitionsExpandItem } from "./listFlowDefinitionsExpandItem";
 import type { ListFlowDefinitionsPurpose } from "./listFlowDefinitionsPurpose";
 
 export type ListFlowDefinitionsParams = {
@@ -31,4 +32,8 @@ Its format is opaque and may change between releases.
    * Filter flow definitions by purpose (e.g., registration, login).
    */
   purpose?: ListFlowDefinitionsPurpose;
+  /**
+   * Related entities to embed on each returned flow definition.
+   */
+  expand?: ListFlowDefinitionsExpandItem[];
 };

package/src/generated/model/listReleases200.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
+ */
+import type { ListReleases200ReleasesItem } from "./listReleases200ReleasesItem";
+
+/**
+ * The project's releases, newest first.
+ */
+export type ListReleases200 = {
+  releases: ListReleases200ReleasesItem[];
+  /** Token to pass as `page_token` in the next request to fetch the following page.
+  Absent when there are no more results.
+   */
+  next_page_token?: string | null;
+};

package/src/generated/model/listReleases200ReleasesItem.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
+ */
+import type { ListReleases200ReleasesItemMetadata } from "./listReleases200ReleasesItemMetadata";
+
+/**
+ * A release without its pinned set — the shape `GET /releases` returns.
+
+Pointers are omitted rather than optional so that a list entry can never be
+mistaken for a release that pins nothing; fetch them with
+`GET /releases/{release_id}`.
+
+ */
+export type ListReleases200ReleasesItem = {
+  /**
+   * The opaque, immutable identifier of a release.
+   * @pattern ^rel_[a-zA-Z0-9_-]+$
+   */
+  id: string;
+  /** @pattern ^[a-zA-Z0-9_-]+$ */
+  project_id: string;
+  /** Who assembled the release, when, and from what source. Set when the release
+  is assembled and never mutated afterwards.
+   */
+  metadata: ListReleases200ReleasesItemMetadata;
+};

package/src/generated/model/listReleases200ReleasesItemMetadata.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
+ */
+
+/**
+ * Who assembled the release, when, and from what source. Set when the release
+is assembled and never mutated afterwards.
+
+ */
+export type ListReleases200ReleasesItemMetadata = {
+  /** A short caller-supplied summary of what the release changes, analogous to
+  a git commit message.
+   */
+  message?: string | null;
+  /** The source commit the caller was operating from. Recording it on both
+  releases is what lets two releases be diffed at field level in the
+  source repository they were built from.
+   */
+  git_sha?: string | null;
+  /** True when the working tree had uncommitted changes at construction time.
+  `git_sha` still points at HEAD, but the release content does not
+  correspond to that commit exactly, so consumers of the git-diff mechanism
+  should skip it when either side is dirty.
+   */
+  git_dirty: boolean;
+  /** When the release was assembled. */
+  created_at: string;
+  /** The identity that assembled the release. Absent when the caller is a
+  machine principal carrying no user identity, which is the common case for
+  releases constructed from CI or the CLI.
+   */
+  created_by?: string | null;
+  /** What kind of principal `created_by` names. */
+  created_by_type?: "human" | "service" | "system" | "agent" | null;
+};

package/src/generated/model/listReleasesDefault.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
+ */
+
+export type ListReleasesDefault =
+  | ({
+      /** 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: "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/listReleasesParams.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 ListReleasesParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+  /**
+   * Maximum number of items to return.
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: number;
+  /**
+ * Token for fetching the next page of results.
+Obtain this value from `next_page_token` in the previous response.
+Omit to start from the beginning.
+Its format is opaque and may change between releases.
+
+ */
+  page_token?: string;
+};

package/src/generated/model/listSchemas200.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
+ */
+import type { ListSchemas200SchemasItem } from "./listSchemas200SchemasItem";
+
+/**
+ * List of schemas, newest first.
+ */
+export type ListSchemas200 = {
+  schemas: ListSchemas200SchemasItem[];
+  /** Token to pass as `page_token` in the next request to fetch the following page.
+  Absent when there are no more results.
+   */
+  next_page_token?: string | null;
+};

package/src/generated/model/listSchemas200SchemasItem.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 { ListSchemas200SchemasItemMetadata } from "./listSchemas200SchemasItemMetadata";
+import type { ListSchemas200SchemasItemSchema } from "./listSchemas200SchemasItemSchema";
+
+/**
+ * A schema resource: the server-owned envelope around a customer-authored
+JSON Schema document.
+
+`schema` is the customer-authored document, served verbatim: its keys and
+contents are defined entirely by its author. The rest of the object — `id`,
+`metadata` — is the server-owned envelope. Keeping the two apart means the
+document may declare any property (including `id` or `metadata`) without
+colliding with the envelope, and the resource `id` stays distinguishable
+from the document's own `$id`.
+
+ */
+export type ListSchemas200SchemasItem = {
+  /** The resource id: the server-minted `sch_*` identifier, or the
+  customer-supplied `$id` URI when the document declared one at creation.
+   */
+  readonly id: string;
+  /** The customer-authored JSON Schema document, served verbatim. */
+  schema: ListSchemas200SchemasItemSchema;
+  metadata: ListSchemas200SchemasItemMetadata;
+};

package/src/generated/model/listSchemas200SchemasItemMetadata.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
+ */
+
+export type ListSchemas200SchemasItemMetadata = {
+  /** The time when the schema was created. */
+  created_at: string;
+};

package/src/generated/model/listSchemas200SchemasItemSchema.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 customer-authored JSON Schema document, served verbatim.
+ */
+export type ListSchemas200SchemasItemSchema = {
+  /**
+     * The type of user this schema describes. This is a customer chosen name.
+
+     * @maxLength 256
+     */
+  objectType?: string;
+  /** Discriminator value for a user schema create request. */
+  kind: "user-schema";
+  /** The user Schema version used for this schema. */
+  metaSchema: string;
+  /** A list of authentication methods supported by the user definition. */
+  "x-auth-methods": {
+    password?: {
+      /** Whether the authentication method is enabled or not */
+      enabled: boolean;
+    };
+    passkey?: {
+      /** Whether the authentication method is enabled or not */
+      enabled: boolean;
+    };
+    magic_link?: {
+      /** Whether the authentication method is enabled or not */
+      enabled: boolean;
+    };
+    sso?: {
+      /** Whether the authentication method is enabled or not */
+      enabled: boolean;
+    };
+    otp?: {
+      /** Whether the authentication method is enabled or not */
+      enabled: boolean;
+    };
+  };
+  /**
+     * Path of the leaf property whose value identifies a user (nested leaves
+  are addressed by their dot-joined attribute path). The property must
+  carry `x-unique` "project". Required when an auth method needing
+  identifier-first dispatch (password) is enabled. Passkey is exempt:
+  discoverable credentials identify the user through the assertion
+  itself, so passkey-only and API-managed schemas may designate nothing;
+  flows using identifier-first passkey are validated at the flow level
+  instead.
+
+     * @minLength 1
+     */
+  "x-identifier"?: string;
+  /**
+     * Ordered leaf property paths whose values, joined with a space, render
+  the user's display name.
+
+     * @minItems 1
+     */
+  "x-display"?: string[];
+  /** A map of additional properties for the user definition, where the
+  key is the property name and the value is the property schema
+   */
+  properties?: {
+    [key: string]: {
+      /** The level of uniqueness for this property, if applicable */
+      "x-unique"?: "unspecified" | "project" | "team" | null;
+      /** The claim name for this property, if applicable */
+      "x-claim"?: string | null;
+      /** Whether this property's value may appear in audit event payloads. Audit
+  payloads are deny-by-default: a property without this annotation
+  contributes its key but never its value.
+   */
+      "x-audit"?: boolean;
+      /** A map of additional properties for the user definition, where the key is
+  the property name and the value is the property schema.
+   */
+      properties?: { [key: string]: unknown };
+      [key: string]: unknown;
+    };
+  };
+  [key: string]: unknown;
+};

package/src/generated/model/{getUserInfoDefault.ts → listSchemasDefault.ts}

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