@zitadel/api 0.1.0-alpha.18 → 0.1.0-alpha.19

package/src/generated/model/createAuthAttemptDefault.ts

@@ -27,6 +27,16 @@ export type CreateAuthAttemptDefault =
     } & {
       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;

package/src/generated/model/createFlowDefault.ts

@@ -47,6 +47,16 @@ export type CreateFlowDefault =
     } & {
       code: "enc_key.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: "evt.invalid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;

package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemTransitions.ts

@@ -31,5 +31,16 @@ export type CreateFlowDefinition201FlowDefinitionStepsItemTransitions = {
     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/createFlowDefinitionBodyFlowDefinitionStepsItemTransitions.ts

@@ -31,5 +31,16 @@ export type CreateFlowDefinitionBodyFlowDefinitionStepsItemTransitions = {
     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/createFlowDefinitionDefault.ts

@@ -17,6 +17,16 @@ export type CreateFlowDefinitionDefault =
     } & {
       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;

package/src/generated/model/createHandoffDefault.ts

@@ -57,6 +57,16 @@ export type CreateHandoffDefault =
     } & {
       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;

package/src/generated/model/createProjectDefault.ts

@@ -27,6 +27,16 @@ export type CreateProjectDefault =
     } & {
       code: "enc_key.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: "evt.invalid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;
@@ -47,6 +57,16 @@ export type CreateProjectDefault =
     } & {
       code: "tkn.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: "tkn.invalid_tknid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;

package/src/generated/model/createSchemaBody.ts

@@ -23,47 +23,22 @@ export type CreateSchemaBody =
         password?: {
           /** Whether the authentication method is enabled or not */
           enabled: boolean;
-          /**
-           * The position of the authentication method in the list of supported methods
-           * @minimum 0
-           */
-          position: number;
         };
         passkey?: {
           /** Whether the authentication method is enabled or not */
           enabled: boolean;
-          /**
-           * The position of the authentication method in the list of supported methods
-           * @minimum 0
-           */
-          position: number;
         };
         magic_link?: {
           /** Whether the authentication method is enabled or not */
           enabled: boolean;
-          /**
-           * The position of the authentication method in the list of supported methods
-           * @minimum 0
-           */
-          position: number;
         };
         sso?: {
           /** Whether the authentication method is enabled or not */
           enabled: boolean;
-          /**
-           * The position of the authentication method in the list of supported methods
-           * @minimum 0
-           */
-          position: number;
         };
         otp?: {
           /** Whether the authentication method is enabled or not */
           enabled: boolean;
-          /**
-           * The position of the authentication method in the list of supported methods
-           * @minimum 0
-           */
-          position: number;
         };
       };
       /** A map of additional properties for the user definition, where the
@@ -71,19 +46,15 @@ export type CreateSchemaBody =
    */
       properties?: {
         [key: string]: {
-          /** The verification method for this property, if applicable */
-          "x-verify"?: string | null;
           /** 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 is editable by the user or not */
-          "x-editable"?: boolean;
-          /** Whether this property contains sensitive information or not */
-          "x-sensitive"?: boolean;
-          /** Whether this property is used for multi-factor authentication or not
-           */
-          "x-mfa"?: boolean;
+          /** 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.
    */

package/src/generated/model/createSession201Session.ts

@@ -28,7 +28,7 @@ export type CreateSession201Session = {
   /** @pattern ^[a-zA-Z0-9_-]+$ */
   project_id: string;
   /** Current lifecycle state of the session:
-  - `building`: has a user factor but is still gathering authentication factors
+  - `building`: no verified authentication factors yet
   - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
   - `expired`: TTL elapsed
    */

package/src/generated/model/createSession201SessionState.ts

@@ -8,7 +8,7 @@
 
 /**
  * Current lifecycle state of the session:
-- `building`: has a user factor but is still gathering authentication factors
+- `building`: no verified authentication factors yet
 - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
 - `expired`: TTL elapsed
 

package/src/generated/model/createSessionDefault.ts

@@ -37,6 +37,16 @@ export type CreateSessionDefault =
     } & {
       code: "enc_key.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: "evt.invalid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;
@@ -57,6 +67,16 @@ export type CreateSessionDefault =
     } & {
       code: "tkn.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: "tkn.invalid_tknid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;

package/src/generated/model/createUser201.ts

@@ -5,14 +5,34 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { CreateUser201Attributes } from "./createUser201Attributes";
+import type { CreateUser201Metadata } from "./createUser201Metadata";
 
 /**
- * The content of this response is determined by the configured
-schema for users.
+ * A user represents an individual identity in the system. It can be used to
+represent a human user, but also a service account or any other type of
+identity.
+
+`attributes` is the document that satisfies the user schema named by
+`schema`: its property names and types are defined entirely by that schema,
+and it is what the schema validates. The rest of the object — `id`,
+`schema`, `metadata` — is the server-owned envelope. Keeping the two apart
+means a schema may name a property `id` or `metadata` without colliding with
+the envelope, and closed-world keywords (`additionalProperties: false`,
+`propertyNames`, `unevaluatedProperties`) behave as their author expects.
 
  */
 export type CreateUser201 = {
-  /** The unique identifier of the created user. */
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
   id: string;
-  [key: string]: unknown;
+  /** The schema that defines the content of `attributes`. These schemas can be
+  created using the `/schemas` endpoint. A default schema is provided.
+  This schema can be retrieved using the same endpoint.
+   */
+  schema: string;
+  /** The user's content, satisfying the schema named by `schema`. Property
+  names and types are determined entirely by that schema.
+   */
+  attributes: CreateUser201Attributes;
+  metadata: CreateUser201Metadata;
 };

package/src/generated/model/createUser201Attributes.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
+ */
+
+/**
+ * The user's content, satisfying the schema named by `schema`. Property
+names and types are determined entirely by that schema.
+
+ */
+export type CreateUser201Attributes = { [key: string]: unknown };

package/src/generated/model/{createUserBodyMetadata.ts → createUser201Metadata.ts}

@@ -5,15 +5,15 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { CreateUserBodyMetadataStatus } from "./createUserBodyMetadataStatus";
+import type { CreateUser201MetadataStatus } from "./createUser201MetadataStatus";
 
-export type CreateUserBodyMetadata = {
+export type CreateUser201Metadata = {
   /** The time when the user was created. */
   created_at: string;
   /** The time when the user was last updated. */
   updated_at: string;
   /** The status of the user. */
-  status: CreateUserBodyMetadataStatus;
+  status: CreateUser201MetadataStatus;
   /** The team that owns this user's identity lifecycle, or `null` when the
   user is self-owned. This is a single team and a different concept from
   the user's team roster: it decides who may deprovision the user, not

package/src/generated/model/{createUserBodyMetadataStatus.ts → createUser201MetadataStatus.ts}

@@ -9,10 +9,10 @@
 /**
  * The status of the user.
  */
-export type CreateUserBodyMetadataStatus =
-  (typeof CreateUserBodyMetadataStatus)[keyof typeof CreateUserBodyMetadataStatus];
+export type CreateUser201MetadataStatus =
+  (typeof CreateUser201MetadataStatus)[keyof typeof CreateUser201MetadataStatus];
 
-export const CreateUserBodyMetadataStatus = {
+export const CreateUser201MetadataStatus = {
   active: "active",
   suspended: "suspended",
   deactivated: "deactivated",

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

package/src/generated/model/{deleteTeamParams.ts → createUser500Details.ts}

@@ -6,10 +6,7 @@
  * OpenAPI spec version: 0.0.1
  */
 
-export type DeleteTeamParams = {
-  /**
-   * The unique identifier of the project
-   * @pattern ^[a-zA-Z0-9_-]+$
-   */
-  project_id: string;
-};
+/**
+ * Additional error-specific context.
+ */
+export type CreateUser500Details = { [key: string]: unknown };

package/src/generated/model/createUserBody.ts

@@ -5,21 +5,32 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { CreateUserBodyMetadata } from "./createUserBodyMetadata";
+import type { CreateUserBodyAttributes } from "./createUserBodyAttributes";
 
 /**
- * A user represents an individual identity in the system. It can be used to
-represent a human user, but also a service account or any other type of
-identity. The content of a user is determined by the configured schema for
-users, this is only a base schema.
+ * `attributes` is the document that must satisfy the user schema named by
+`schema`.
 
-The server assigns the resource primary key (`id`) on create. Clients must
-not send `id` in the create body; it is returned in the create response.
+The resource primary key is server-assigned and returned in the response, so
+the request carries no `id`; `metadata` is server-owned for the same reason.
+Neither is part of this schema, which is what frees a user schema to declare
+properties of those names.
+
+A request carrying any other top-level property is rejected rather than
+ignored. `attributes` stays open, since the user schema is what determines
+what belongs in it.
 
  */
 export type CreateUserBody = {
-  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
-  id?: string;
-  metadata?: CreateUserBodyMetadata;
-  [key: string]: unknown;
+  /**
+     * The schema that defines the content of `attributes`. These schemas can be
+  created using the `/schemas` endpoint. A default schema is provided.
+
+     * @minLength 1
+     */
+  schema: string;
+  /** The user's schema-defined content. Validated against `schema`; a
+  property the schema does not permit is rejected with `user.invalid`.
+   */
+  attributes: CreateUserBodyAttributes;
 };

package/src/generated/model/createUserBodyAttributes.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
+ */
+
+/**
+ * The user's schema-defined content. Validated against `schema`; a
+property the schema does not permit is rejected with `user.invalid`.
+
+ */
+export type CreateUserBodyAttributes = { [key: string]: unknown };

package/src/generated/model/createUserDefault.ts

@@ -17,6 +17,16 @@ export type CreateUserDefault =
     } & {
       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;

package/src/generated/model/deleteFlowDefinitionDefault.ts

@@ -17,6 +17,16 @@ export type DeleteFlowDefinitionDefault =
     } & {
       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;

package/src/generated/model/deleteUserByIDDefault.ts

@@ -17,6 +17,16 @@ export type DeleteUserByIDDefault =
     } & {
       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;

package/src/generated/model/exchangeHandoff200Session.ts

@@ -28,7 +28,7 @@ export type ExchangeHandoff200Session = {
   /** @pattern ^[a-zA-Z0-9_-]+$ */
   project_id: string;
   /** Current lifecycle state of the session:
-  - `building`: has a user factor but is still gathering authentication factors
+  - `building`: no verified authentication factors yet
   - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
   - `expired`: TTL elapsed
    */

package/src/generated/model/exchangeHandoff200SessionState.ts

@@ -8,7 +8,7 @@
 
 /**
  * Current lifecycle state of the session:
-- `building`: has a user factor but is still gathering authentication factors
+- `building`: no verified authentication factors yet
 - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
 - `expired`: TTL elapsed
 

package/src/generated/model/exchangeHandoffDefault.ts

@@ -47,6 +47,16 @@ export type ExchangeHandoffDefault =
     } & {
       code: "enc_key.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: "evt.invalid";
+    })
   | ({
       /** Stable machine-readable error code. */
       code: string;