@zitadel/api 0.1.0-alpha.13 → 0.1.0-alpha.14

package/src/generated/endpoints/zitadelNextGen.zod.ts

@@ -1978,11 +1978,19 @@ export const CreateHandoffResponse = zod
 /**
  * @summary Create project
  */
+export const createProjectBodySeedDefaultsDefault = true;
+
 export const CreateProjectBody = zod.object({
   previewOrigins: zod
     .array(zod.string())
     .optional()
     .describe("Origins which are allowed for previewing and testing the project.\n"),
+  seedDefaults: zod
+    .boolean()
+    .default(createProjectBodySeedDefaultsDefault)
+    .describe(
+      "Whether the server should provision fallback default user schema and flow\nresources for the project. CLI-managed projects set this to false and\nupload their local .zitadel config files through the schema and flow APIs.\n",
+    ),
 });
 
 /**
@@ -2721,6 +2729,8 @@ export const CreateSchemaQueryParams = zod.strictObject({
     .describe("The unique identifier of the team"),
 });
 
+export const createSchemaBodyOneObjectTypeMax = 256;
+
 export const createSchemaBodyOneXAuthMethodsPasswordPositionMin = 0;
 
 export const createSchemaBodyOneXAuthMethodsPasskeyPositionMin = 0;
@@ -2738,6 +2748,11 @@ export const createSchemaBodyOnePropertiesXMfaDefault = false;
 export const CreateSchemaBody = zod.union([
   zod
     .object({
+      objectType: zod
+        .string()
+        .max(createSchemaBodyOneObjectTypeMax)
+        .optional()
+        .describe("The type of user this schema describes. This is a customer chosen name.\n"),
       kind: zod
         .literal("user-schema")
         .describe("Discriminator value for a user schema create request."),
@@ -2853,7 +2868,7 @@ export const CreateSchemaBody = zod.union([
         )
         .optional()
         .describe(
-          "A map of additional properties for the user definition, where the key is the property name and the value is the property schema",
+          "A map of additional properties for the user definition, where the\nkey is the property name and the value is the property schema\n",
         ),
     })
     .describe(
@@ -2871,6 +2886,47 @@ export const CreateSchemaBody = zod.union([
     ),
 ]);
 
+/**
+ * Retrieve a list of all schemas available in the system. This endpoint
+supports pagination and filtering based on schema attributes.
+
+ * @summary List all schemas
+ */
+export const listSchemasQueryProjectIdRegExp = new RegExp("^[a-zA-Z0-9_-]+$");
+export const listSchemasQueryOffsetDefault = 0;
+export const listSchemasQueryOffsetMin = 0;
+
+export const listSchemasQueryObjectTypeMax = 256;
+
+export const ListSchemasQueryParams = zod.strictObject({
+  project_id: zod
+    .string()
+    .regex(listSchemasQueryProjectIdRegExp)
+    .describe("The unique identifier of the project"),
+  offset: zod
+    .number()
+    .min(listSchemasQueryOffsetMin)
+    .default(listSchemasQueryOffsetDefault)
+    .describe("Number of items to skip before returning results."),
+  page_token: zod
+    .string()
+    .optional()
+    .describe(
+      "Token for fetching the next page of results.\nObtain this value from `next_page_token` in the previous response.\nOmit to start from the beginning.\nIts format is opaque and may change between releases.\n",
+    ),
+  object_type: zod
+    .string()
+    .max(listSchemasQueryObjectTypeMax)
+    .optional()
+    .describe("The type of object of the schema to filter by."),
+});
+
+export const ListSchemasResponseItem = zod.object({
+  id: zod.string().describe("The unique identifier for this schema."),
+  createdAt: zod.iso.datetime({ offset: true }),
+});
+export const ListSchemasResponse = zod.array(ListSchemasResponseItem);
+
 /**
  * Get a schema by its ID. This will return the default revision of the schema.
  * @summary Get schema by ID
@@ -2894,6 +2950,8 @@ export const GetSchemaByIdQueryParams = zod.strictObject({
     .describe("The unique identifier of the team"),
 });
 
+export const getSchemaByIdResponseOneObjectTypeMax = 256;
+
 export const getSchemaByIdResponseOneXAuthMethodsPasswordPositionMin = 0;
 
 export const getSchemaByIdResponseOneXAuthMethodsPasskeyPositionMin = 0;
@@ -2910,6 +2968,11 @@ export const getSchemaByIdResponseOnePropertiesXMfaDefault = false;
 
 export const GetSchemaByIdResponse = zod
   .object({
+    objectType: zod
+      .string()
+      .max(getSchemaByIdResponseOneObjectTypeMax)
+      .optional()
+      .describe("The type of user this schema describes. This is a customer chosen name.\n"),
     kind: zod
       .literal("user-schema")
       .describe("Discriminator value for a user schema create request."),
@@ -3015,7 +3078,7 @@ export const GetSchemaByIdResponse = zod
       )
       .optional()
       .describe(
-        "A map of additional properties for the user definition, where the key is the property name and the value is the property schema",
+        "A map of additional properties for the user definition, where the\nkey is the property name and the value is the property schema\n",
       ),
   })
   .describe(
@@ -3062,9 +3125,9 @@ export const CreateFlowDefinitionBody = zod
             "The lifecycle state of this flow definition. \n\nactive: The flow definition is ready to be used. The flow engine can select it for new flows.\ndraft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.\n\nAllowed transitions:\n- draft -> active: To activate the flow definition.\n- active -> draft: To remove the flow definition from active use immediately.\n",
           ),
         user_schema: zod
-          .url()
+          .string()
           .describe(
-            "User schema this flow operates on. Step `fields` reference properties\ndefined in this schema. The engine resolves field types, validation,\nand implicit outcomes from schema annotations at runtime.\n",
+            "Server-assigned identifier of the user schema this flow operates on,\nas returned by `POST \/schemas`. Opaque to the client — the shape is a\nserver implementation detail. Step `fields` reference properties\ndefined in the resolved schema; the engine resolves field types, validation, and\nimplicit outcomes from schema annotations at runtime.\n",
           ),
         purposes: zod
           .record(zod.string(), zod.string())
@@ -3354,9 +3417,9 @@ export const GetFlowDefinitionResponse = zod.object({
           "The lifecycle state of this flow definition. \n\nactive: The flow definition is ready to be used. The flow engine can select it for new flows.\ndraft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.\n\nAllowed transitions:\n- draft -> active: To activate the flow definition.\n- active -> draft: To remove the flow definition from active use immediately.\n",
         ),
       user_schema: zod
-        .url()
+        .string()
         .describe(
-          "User schema this flow operates on. Step `fields` reference properties\ndefined in this schema. The engine resolves field types, validation,\nand implicit outcomes from schema annotations at runtime.\n",
+          "Server-assigned identifier of the user schema this flow operates on,\nas returned by `POST \/schemas`. Opaque to the client — the shape is a\nserver implementation detail. Step `fields` reference properties\ndefined in the resolved schema; the engine resolves field types, validation, and\nimplicit outcomes from schema annotations at runtime.\n",
         ),
       purposes: zod
         .record(zod.string(), zod.string())
@@ -3574,9 +3637,9 @@ export const UpdateFlowDefinitionBody = zod
             "The lifecycle state of this flow definition. \n\nactive: The flow definition is ready to be used. The flow engine can select it for new flows.\ndraft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.\n\nAllowed transitions:\n- draft -> active: To activate the flow definition.\n- active -> draft: To remove the flow definition from active use immediately.\n",
           ),
         user_schema: zod
-          .url()
+          .string()
           .describe(
-            "User schema this flow operates on. Step `fields` reference properties\ndefined in this schema. The engine resolves field types, validation,\nand implicit outcomes from schema annotations at runtime.\n",
+            "Server-assigned identifier of the user schema this flow operates on,\nas returned by `POST \/schemas`. Opaque to the client — the shape is a\nserver implementation detail. Step `fields` reference properties\ndefined in the resolved schema; the engine resolves field types, validation, and\nimplicit outcomes from schema annotations at runtime.\n",
           ),
         purposes: zod
           .record(zod.string(), zod.string())
@@ -3771,9 +3834,9 @@ export const UpdateFlowDefinitionResponse = zod.object({
           "The lifecycle state of this flow definition. \n\nactive: The flow definition is ready to be used. The flow engine can select it for new flows.\ndraft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.\n\nAllowed transitions:\n- draft -> active: To activate the flow definition.\n- active -> draft: To remove the flow definition from active use immediately.\n",
         ),
       user_schema: zod
-        .url()
+        .string()
         .describe(
-          "User schema this flow operates on. Step `fields` reference properties\ndefined in this schema. The engine resolves field types, validation,\nand implicit outcomes from schema annotations at runtime.\n",
+          "Server-assigned identifier of the user schema this flow operates on,\nas returned by `POST \/schemas`. Opaque to the client — the shape is a\nserver implementation detail. Step `fields` reference properties\ndefined in the resolved schema; the engine resolves field types, validation, and\nimplicit outcomes from schema annotations at runtime.\n",
         ),
       purposes: zod
         .record(zod.string(), zod.string())

package/src/generated/model/createFlowDefinition201FlowDefinition.ts

@@ -40,9 +40,11 @@ export type CreateFlowDefinition201FlowDefinition = {
   - active -> draft: To remove the flow definition from active use immediately.
    */
   status: CreateFlowDefinition201FlowDefinitionStatus;
-  /** User schema this flow operates on. Step `fields` reference properties
-  defined in this schema. The engine resolves field types, validation,
-  and implicit outcomes from schema annotations at runtime.
+  /** Server-assigned identifier of the user schema this flow operates on,
+  as returned by `POST /schemas`. Opaque to the client — the shape is a
+  server implementation detail. Step `fields` reference properties
+  defined in the resolved schema; the engine resolves field types, validation, and
+  implicit outcomes from schema annotations at runtime.
    */
   user_schema: string;
   /** Maps each purpose this definition handles to its entry-point step.

package/src/generated/model/createFlowDefinitionBodyFlowDefinition.ts

@@ -40,9 +40,11 @@ export type CreateFlowDefinitionBodyFlowDefinition = {
   - active -> draft: To remove the flow definition from active use immediately.
    */
   status: CreateFlowDefinitionBodyFlowDefinitionStatus;
-  /** User schema this flow operates on. Step `fields` reference properties
-  defined in this schema. The engine resolves field types, validation,
-  and implicit outcomes from schema annotations at runtime.
+  /** Server-assigned identifier of the user schema this flow operates on,
+  as returned by `POST /schemas`. Opaque to the client — the shape is a
+  server implementation detail. Step `fields` reference properties
+  defined in the resolved schema; the engine resolves field types, validation, and
+  implicit outcomes from schema annotations at runtime.
    */
   user_schema: string;
   /** Maps each purpose this definition handles to its entry-point step.

package/src/generated/model/createProjectBody.ts

@@ -10,4 +10,9 @@ export type CreateProjectBody = {
   /** Origins which are allowed for previewing and testing the project.
    */
   previewOrigins?: string[];
+  /** Whether the server should provision fallback default user schema and flow
+  resources for the project. CLI-managed projects set this to false and
+  upload their local .zitadel config files through the schema and flow APIs.
+   */
+  seedDefaults?: boolean;
 };

package/src/generated/model/createSchemaBody.ts

@@ -8,6 +8,12 @@
 
 export type CreateSchemaBody =
   | {
+      /**
+     * 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. */
@@ -60,7 +66,9 @@ export type CreateSchemaBody =
           position: number;
         };
       };
-      /** A map of additional properties for the user definition, where the key is the property name and the value is the property schema */
+      /** 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 verification method for this property, if applicable */

package/src/generated/model/getFlowDefinition200FlowDefinition.ts

@@ -40,9 +40,11 @@ export type GetFlowDefinition200FlowDefinition = {
   - active -> draft: To remove the flow definition from active use immediately.
    */
   status: GetFlowDefinition200FlowDefinitionStatus;
-  /** User schema this flow operates on. Step `fields` reference properties
-  defined in this schema. The engine resolves field types, validation,
-  and implicit outcomes from schema annotations at runtime.
+  /** Server-assigned identifier of the user schema this flow operates on,
+  as returned by `POST /schemas`. Opaque to the client — the shape is a
+  server implementation detail. Step `fields` reference properties
+  defined in the resolved schema; the engine resolves field types, validation, and
+  implicit outcomes from schema annotations at runtime.
    */
   user_schema: string;
   /** Maps each purpose this definition handles to its entry-point step.

package/src/generated/model/getSchemaById200.ts

@@ -7,6 +7,12 @@
  */
 
 export type GetSchemaById200 = {
+  /**
+     * 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. */
@@ -59,7 +65,9 @@ export type GetSchemaById200 = {
       position: number;
     };
   };
-  /** A map of additional properties for the user definition, where the key is the property name and the value is the property schema */
+  /** 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 verification method for this property, if applicable */

package/src/generated/model/index.ts

@@ -362,6 +362,10 @@ export * from "./listFlowDefinitionsDefault";
 export * from "./listFlowDefinitionsDefaultDetails";
 export * from "./listFlowDefinitionsParams";
 export * from "./listFlowDefinitionsPurpose";
+export * from "./listSchemas200Item";
+export * from "./listSchemasDefault";
+export * from "./listSchemasDefaultDetails";
+export * from "./listSchemasParams";
 export * from "./listSessions200";
 export * from "./listSessions200SessionsItem";
 export * from "./listSessions200SessionsItemFactorsItem";

package/src/generated/model/listSchemas200Item.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 ListSchemas200Item = {
+  /** The unique identifier for this schema. */
+  id: string;
+  createdAt: string;
+};

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

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

package/src/generated/model/listSchemasParams.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 ListSchemasParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+  /**
+   * Number of items to skip before returning results.
+   * @minimum 0
+   */
+  offset?: 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;
+  /**
+   * The type of object of the schema to filter by.
+   * @maxLength 256
+   */
+  object_type?: string;
+};

package/src/generated/model/updateFlowDefinition200FlowDefinition.ts

@@ -40,9 +40,11 @@ export type UpdateFlowDefinition200FlowDefinition = {
   - active -> draft: To remove the flow definition from active use immediately.
    */
   status: UpdateFlowDefinition200FlowDefinitionStatus;
-  /** User schema this flow operates on. Step `fields` reference properties
-  defined in this schema. The engine resolves field types, validation,
-  and implicit outcomes from schema annotations at runtime.
+  /** Server-assigned identifier of the user schema this flow operates on,
+  as returned by `POST /schemas`. Opaque to the client — the shape is a
+  server implementation detail. Step `fields` reference properties
+  defined in the resolved schema; the engine resolves field types, validation, and
+  implicit outcomes from schema annotations at runtime.
    */
   user_schema: string;
   /** Maps each purpose this definition handles to its entry-point step.

package/src/generated/model/updateFlowDefinitionBodyFlowDefinition.ts

@@ -40,9 +40,11 @@ export type UpdateFlowDefinitionBodyFlowDefinition = {
   - active -> draft: To remove the flow definition from active use immediately.
    */
   status: UpdateFlowDefinitionBodyFlowDefinitionStatus;
-  /** User schema this flow operates on. Step `fields` reference properties
-  defined in this schema. The engine resolves field types, validation,
-  and implicit outcomes from schema annotations at runtime.
+  /** Server-assigned identifier of the user schema this flow operates on,
+  as returned by `POST /schemas`. Opaque to the client — the shape is a
+  server implementation detail. Step `fields` reference properties
+  defined in the resolved schema; the engine resolves field types, validation, and
+  implicit outcomes from schema annotations at runtime.
    */
   user_schema: string;
   /** Maps each purpose this definition handles to its entry-point step.