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

package/src/generated/model/getMyUserDefault.ts

@@ -5,16 +5,55 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetMyUserDefaultDetails } from "./getMyUserDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type GetMyUserDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: GetMyUserDefaultDetails;
-};
+export type GetMyUserDefault =
+  | ({
+      /** 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";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "sess.token_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";
+    });

package/src/generated/model/getProject200.ts

@@ -16,9 +16,9 @@ export type GetProject200 = {
   name: string;
   /** Origins which are allowed for previewing and testing the project.
    */
-  previewOrigins?: string[];
+  preview_origins?: string[];
   /** The time when the project was created. */
-  createdAt: string;
+  created_at: string;
   /** The time when the project was last updated. */
-  updatedAt: string;
+  updated_at: string;
 };

package/src/generated/model/getProjectDefault.ts

@@ -5,16 +5,75 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetProjectDefaultDetails } from "./getProjectDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type GetProjectDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: GetProjectDefaultDetails;
-};
+export type GetProjectDefault =
+  | ({
+      /** 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: "not_implemented";
+    })
+  | ({
+      /** 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.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: "proj.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: "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: "unavailable";
+    });

package/src/generated/model/getSchemaById200.ts

@@ -22,47 +22,22 @@ export type GetSchemaById200 = {
     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
@@ -70,19 +45,18 @@ export type GetSchemaById200 = {
    */
   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;
-      /** A map of additional properties for the user definition, where the key is the property name and the value is the property schema */
+      /** 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;
     };

package/src/generated/model/getSchemaByIdParams.ts

@@ -7,11 +7,6 @@
  */
 
 export type GetSchemaByIdParams = {
-  /**
-   * The unique identifier of the project
-   * @pattern ^[a-zA-Z0-9_-]+$
-   */
-  project_id: string;
   /**
    * The unique identifier of the team
    * @pattern ^[a-zA-Z0-9_-]+$

package/src/generated/model/getSession200.ts

@@ -21,17 +21,16 @@ in through `auth_attempts`.
  */
 export type GetSession200 = {
   /**
-   * Unique identifier for this session.
-   * @pattern ^[a-zA-Z0-9_-]+$
+   * Unique identifier for this session (dialect-minted prefixed opaque string).
+   * @pattern ^sess_[a-zA-Z0-9_-]+$
    */
   session_id: string;
   /** @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
-  - `revoked`: explicitly revoked via DELETE
    */
   state: GetSession200State;
   /** The authenticated user. Null for anonymous sessions and until the `user`

package/src/generated/model/getSession200State.ts

@@ -8,10 +8,9 @@
 
 /**
  * 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
-- `revoked`: explicitly revoked via DELETE
 
  */
 export type GetSession200State = (typeof GetSession200State)[keyof typeof GetSession200State];
@@ -20,5 +19,4 @@ export const GetSession200State = {
   building: "building",
   active: "active",
   expired: "expired",
-  revoked: "revoked",
 } as const;

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

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

package/src/generated/model/getSessionDefault.ts

@@ -15,7 +15,7 @@ export type GetSessionDefault =
       /** Additional error-specific context. */
       details?: { [key: string]: unknown };
     } & {
-      code: "sess.not_found";
+      code: "auth.unauthorized";
     })
   | ({
       /** Stable machine-readable error code. */
@@ -26,4 +26,34 @@ export type GetSessionDefault =
       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: "sess.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: "sess.permission_denied";
     });

package/src/generated/model/getTeam200.ts

@@ -5,15 +5,24 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { GetTeam200Status } from "./getTeam200Status";
 
 /**
- * The current state of a team.
+ * Details of a team.
  */
 export type GetTeam200 = {
   /** The unique identifier of the team. */
   id: string;
+  /** The name of the team. */
+  name: string;
+  /** The lifecycle state of a team.
+
+  active: The team is available for use.
+  deactivated: The team is no longer active but is retained for historical and audit purposes.
+   */
+  status: GetTeam200Status;
   /** The time when the team was created. */
-  createdAt: string;
+  created_at: string;
   /** The time when the team was last updated. */
-  updatedAt: string;
+  updated_at: string;
 };

package/src/generated/model/getTeam200Status.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
+ */
+
+/**
+ * The lifecycle state of a team.
+
+active: The team is available for use.
+deactivated: The team is no longer active but is retained for historical and audit purposes.
+
+ */
+export type GetTeam200Status = (typeof GetTeam200Status)[keyof typeof GetTeam200Status];
+
+export const GetTeam200Status = {
+  active: "active",
+  deactivated: "deactivated",
+} as const;

package/src/generated/model/getUserByID200.ts

@@ -5,5 +5,34 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { GetUserByID200Attributes } from "./getUserByID200Attributes";
+import type { GetUserByID200Metadata } from "./getUserByID200Metadata";
 
-export type GetUserByID200 = { [key: string]: unknown };
+/**
+ * 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 GetUserByID200 = {
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
+  id: string;
+  /** 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: GetUserByID200Attributes;
+  metadata: GetUserByID200Metadata;
+};

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

package/src/generated/model/getUserByID200Metadata.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
+ */
+import type { GetUserByID200MetadataStatus } from "./getUserByID200MetadataStatus";
+
+export type GetUserByID200Metadata = {
+  /** 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: GetUserByID200MetadataStatus;
+  /** 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
+  which teams the user collaborates in. The roster is its own paginated
+  resource — `GET /users/{user_id}/teams`.
+   */
+  lifecycle_owner_team_id?: string | null;
+};

package/src/generated/model/getUserByID200MetadataStatus.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 status of the user.
+ */
+export type GetUserByID200MetadataStatus =
+  (typeof GetUserByID200MetadataStatus)[keyof typeof GetUserByID200MetadataStatus];
+
+export const GetUserByID200MetadataStatus = {
+  active: "active",
+  suspended: "suspended",
+  deactivated: "deactivated",
+  pending_purge: "pending_purge",
+} as const;

package/src/generated/model/getUserByIDDefault.ts

@@ -5,16 +5,55 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetUserByIDDefaultDetails } from "./getUserByIDDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type GetUserByIDDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: GetUserByIDDefaultDetails;
-};
+export type GetUserByIDDefault =
+  | ({
+      /** 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";
+    })
+  | ({
+      /** 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/getUserByIDParams.ts

@@ -7,11 +7,6 @@
  */
 
 export type GetUserByIDParams = {
-  /**
-   * The unique identifier of the project
-   * @pattern ^[a-zA-Z0-9_-]+$
-   */
-  project_id: string;
   /**
    * The unique identifier of the team
    * @pattern ^[a-zA-Z0-9_-]+$