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

package/src/generated/model/createSessionDefault.ts

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

package/src/generated/model/createTeam201.ts

@@ -5,10 +5,24 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { CreateTeam201Status } from "./createTeam201Status";
 
+/**
+ * Details of a team.
+ */
 export type CreateTeam201 = {
   /** 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: CreateTeam201Status;
   /** The time when the team was created. */
-  createdAt: string;
+  created_at: string;
+  /** The time when the team was last updated. */
+  updated_at: string;
 };

package/src/generated/model/createTeam201Status.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 CreateTeam201Status = (typeof CreateTeam201Status)[keyof typeof CreateTeam201Status];
+
+export const CreateTeam201Status = {
+  active: "active",
+  deactivated: "deactivated",
+} as const;

package/src/generated/model/{introspect400.ts → createTeam401.ts}

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

package/src/generated/model/{endSession400Details.ts → createTeam401Details.ts}

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

package/src/generated/model/{endSession400.ts → createTeam403.ts}

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

package/src/generated/model/{introspect400Details.ts → createTeam403Details.ts}

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

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

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

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

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

package/src/generated/model/createTeamBody.ts

@@ -6,4 +6,11 @@
  * OpenAPI spec version: 0.0.1
  */
 
-export type CreateTeamBody = { [key: string]: unknown };
+export type CreateTeamBody = {
+  /**
+   * The name of the team. Must be unique within the project.
+   * @minLength 1
+   * @maxLength 200
+   */
+  name: string;
+};

package/src/generated/model/createUser201.ts

@@ -5,14 +5,67 @@
  * 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";
+import type { CreateUser201TeamsItem } from "./createUser201TeamsItem";
 
 /**
- * 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;
+  /** The current value of the user schema's designated identifier
+  (`x-identifier`), resolved live at read time. Absent when the schema
+  designates no identifier or the user carries no value for it.
+   */
+  readonly identifier?: string;
+  /** The schema property `identifier` came from, so clients can reach the
+  property's schema for semantics (a mailto link, a field label)
+  instead of guessing from the value. Present exactly when
+  `identifier` is.
+   */
+  readonly identifier_property?: string;
+  /** The `x-display` rendering — the designated properties' values joined
+  in list order, resolved live at read time. Purely presentational.
+  Absent when the schema designates no display properties or the user
+  carries no values for them. Clients render `display`, falling back
+  to `identifier`, then `id`.
+   */
+  readonly display?: string;
+  /** The user's team memberships, present only when the request asked for them with
+  `expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
+  means the user has none.
+
+  Deliberately outside `metadata`: memberships are a related collection, not
+  part of the server-owned envelope, and it is a different concept from
+  `metadata.lifecycle_owner_team_id` (ADR 024).
+   */
+  readonly teams?: readonly CreateUser201TeamsItem[];
+  /** True when the user is on more teams than the embedded list carries. The
+  embedded list is capped and cannot be paged; read them all at
+  `GET /users/{user_id}/teams`. Present only alongside `teams`.
+   */
+  readonly teams_truncated?: boolean;
 };

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/createUser201Metadata.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { CreateUser201MetadataLifecycleOwnerTeam } from "./createUser201MetadataLifecycleOwnerTeam";
+import type { CreateUser201MetadataStatus } from "./createUser201MetadataStatus";
+
+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: 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 memberships: it decides who may deprovision the user, not
+  which teams the user collaborates in. Memberships are their own paginated
+  resource — `GET /users/{user_id}/teams`.
+   */
+  lifecycle_owner_team_id?: string | null;
+  /** The team named by `lifecycle_owner_team_id`, present only when the
+  request asked for it with `expand: ["lifecycle_owner_team"]` (ADR 059).
+  Absent means it was not requested; `null` means the user is self-owned
+  and there is no owner to resolve.
+
+  Requesting it does not guarantee it is present on every user. Today
+  `team.read` is checked once for the whole request, so it is; once that
+  check is per team, a page may contain a user whose owner the caller may
+  not read, and such a row answers with neither the team nor `null` —
+  `null` already means self-owned. What it answers with instead is decided
+  with the granular scopes (#420); do not read the two cases above as the
+  complete set.
+
+  This is the same representation `GET /teams/{team_id}` serves. It is a
+  single team, not a collection, so it carries no cap and no truncation
+  flag.
+   */
+  readonly lifecycle_owner_team?: CreateUser201MetadataLifecycleOwnerTeam;
+};

package/src/generated/model/createUser201MetadataLifecycleOwnerTeam.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 team named by `lifecycle_owner_team_id`, present only when the
+request asked for it with `expand: ["lifecycle_owner_team"]` (ADR 059).
+Absent means it was not requested; `null` means the user is self-owned
+and there is no owner to resolve.
+
+Requesting it does not guarantee it is present on every user. Today
+`team.read` is checked once for the whole request, so it is; once that
+check is per team, a page may contain a user whose owner the caller may
+not read, and such a row answers with neither the team nor `null` —
+`null` already means self-owned. What it answers with instead is decided
+with the granular scopes (#420); do not read the two cases above as the
+complete set.
+
+This is the same representation `GET /teams/{team_id}` serves. It is a
+single team, not a collection, so it carries no cap and no truncation
+flag.
+
+ */
+export type CreateUser201MetadataLifecycleOwnerTeam = {
+  /** 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: "active" | "deactivated";
+  /** The time when the team was created. */
+  created_at: string;
+  /** The time when the team was last updated. */
+  updated_at: string;
+} | null;

package/src/generated/model/createUser201MetadataStatus.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 CreateUser201MetadataStatus =
+  (typeof CreateUser201MetadataStatus)[keyof typeof CreateUser201MetadataStatus];
+
+export const CreateUser201MetadataStatus = {
+  active: "active",
+  suspended: "suspended",
+  deactivated: "deactivated",
+  pending_purge: "pending_purge",
+} as const;

package/src/generated/model/createUser201TeamsItem.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
+ */
+import type { CreateUser201TeamsItemMembershipStatus } from "./createUser201TeamsItemMembershipStatus";
+
+/**
+ * One entry of a user's team roster: a team the user belongs to, with the
+membership's participation state. The team's `name` travels with the entry, so
+a page renders without a follow-up `POST /teams/query` per row.
+
+Roster membership is not lifecycle ownership. A user can belong to many teams
+while still owning their own lifecycle — that single owning team is reported
+as `metadata.lifecycle_owner_team_id` on the user itself.
+
+ */
+export type CreateUser201TeamsItem = {
+  /** The unique identifier of the team. */
+  id: string;
+  /** The name of the team. */
+  name: string;
+  /** The user's participation state on this team. Memberships the user was
+  removed from are not returned.
+   */
+  membership_status: CreateUser201TeamsItemMembershipStatus;
+  /** The time when the user joined this team. */
+  created_at: string;
+  /** The time when this membership was last changed. */
+  updated_at: string;
+};

package/src/generated/model/createUser201TeamsItemMembershipStatus.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 user's participation state on this team. Memberships the user was
+removed from are not returned.
+
+ */
+export type CreateUser201TeamsItemMembershipStatus =
+  (typeof CreateUser201TeamsItemMembershipStatus)[keyof typeof CreateUser201TeamsItemMembershipStatus];
+
+export const CreateUser201TeamsItemMembershipStatus = {
+  pending: "pending",
+  active: "active",
+  inactive: "inactive",
+} as const;

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/createUser500Details.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 CreateUser500Details = { [key: string]: unknown };

package/src/generated/model/createUserBody.ts

@@ -5,12 +5,32 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+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 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 = { [key: string]: unknown };
+export type CreateUserBody = {
+  /**
+     * 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 };