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

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

package/src/generated/model/getMyUser200Metadata.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 { GetMyUser200MetadataLifecycleOwnerTeam } from "./getMyUser200MetadataLifecycleOwnerTeam";
+import type { GetMyUser200MetadataStatus } from "./getMyUser200MetadataStatus";
+
+export type GetMyUser200Metadata = {
+  /** 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: GetMyUser200MetadataStatus;
+  /** 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?: GetMyUser200MetadataLifecycleOwnerTeam;
+};

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

package/src/generated/model/getMyUser200TeamsItem.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 { GetMyUser200TeamsItemMembershipStatus } from "./getMyUser200TeamsItemMembershipStatus";
+
+/**
+ * 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 GetMyUser200TeamsItem = {
+  /** 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: GetMyUser200TeamsItemMembershipStatus;
+  /** 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/getMyUser200TeamsItemMembershipStatus.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 GetMyUser200TeamsItemMembershipStatus =
+  (typeof GetMyUser200TeamsItemMembershipStatus)[keyof typeof GetMyUser200TeamsItemMembershipStatus];
+
+export const GetMyUser200TeamsItemMembershipStatus = {
+  pending: "pending",
+  active: "active",
+  inactive: "inactive",
+} as const;

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

@@ -12,8 +12,13 @@
 export type GetProject200 = {
   /** The unique identifier of the project. */
   id: string;
+  /** The name of the project. */
+  name: string;
+  /** Origins which are allowed for previewing and testing the project.
+   */
+  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/getReleaseById200.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 { GetReleaseById200Metadata } from "./getReleaseById200Metadata";
+import type { GetReleaseById200PointersItem } from "./getReleaseById200PointersItem";
+
+/**
+ * An immutable, project-scoped snapshot that pins one revision of every
+resource it includes.
+
+A release owns pointers and metadata, not content — it records *which*
+revisions belong together. Callers that need the resource bytes resolve each
+`revision_id` through the per-kind read endpoints (`GET /schemas/{id}`,
+`GET /flow_definitions/{id}`, …).
+
+A release exists on its own and is not tied to an environment. Deploying it
+is a separate call.
+
+ */
+export type GetReleaseById200 = {
+  /**
+   * 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: GetReleaseById200Metadata;
+  /**
+     * The revisions this release pins, one entry per `(kind, handle)`. Never
+  empty: a release must contain at least one resource.
+
+     * @minItems 1
+     */
+  readonly pointers: readonly GetReleaseById200PointersItem[];
+};

package/src/generated/model/getReleaseById200Metadata.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 GetReleaseById200Metadata = {
+  /** 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/getReleaseById200PointersItem.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { GetReleaseById200PointersItemKind } from "./getReleaseById200PointersItemKind";
+
+/**
+ * One entry of the set a release pins: the revision of a single resource that
+this release includes.
+
+ */
+export type GetReleaseById200PointersItem = {
+  /** The kind of resource a release pointer pins.
+
+  Carried explicitly rather than inferred from `revision_id`, because a
+  revision id is not always shaped distinctly enough to identify its kind: a
+  schema's is its `$id`, which may be any URL.
+
+  `flow_definition` rather than `flow`: a release pins the definitions served
+  at `/flow_definitions`, not the runtime flows at `/flow`.
+   */
+  kind: GetReleaseById200PointersItemKind;
+  /**
+     * Which resource this pointer pins, independent of which revision of it.
+  `revision_id` chooses the revision; `handle` says what the revision is a
+  revision *of*. Determined when the release is assembled, not supplied by
+  the caller:
+
+  - `schema` — the document's `objectType`, so `human-user` and
+    `machine-user` are separate resources a release pins separately
+  - `flow_definition` — the definition's `name`, likewise for
+    `default-login` and `b2b-login`
+  - `branding` — always `default`. A project has one branding, so there is
+    nothing to distinguish; it is revisioned like everything else, and
+    `revision_id` is what varies between releases.
+
+  Resources inside a release reference each other by handle rather than by
+  revision id, so the same handle names the same resource in every release.
+
+     * @minLength 1
+     * @maxLength 256
+     */
+  handle: string;
+  /**
+     * The revision of that resource this release pins.
+
+  Deliberately not constrained to a prefixed id: for `kind: schema` this is
+  the schema's `$id`, which is a URL whenever the document supplied one and
+  only a generated `sch_*` value otherwise.
+
+     * @minLength 1
+     * @maxLength 512
+     */
+  revision_id: string;
+};

package/src/generated/model/getReleaseById200PointersItemKind.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 kind of resource a release pointer pins.
+
+Carried explicitly rather than inferred from `revision_id`, because a
+revision id is not always shaped distinctly enough to identify its kind: a
+schema's is its `$id`, which may be any URL.
+
+`flow_definition` rather than `flow`: a release pins the definitions served
+at `/flow_definitions`, not the runtime flows at `/flow`.
+
+ */
+export type GetReleaseById200PointersItemKind =
+  (typeof GetReleaseById200PointersItemKind)[keyof typeof GetReleaseById200PointersItemKind];
+
+export const GetReleaseById200PointersItemKind = {
+  schema: "schema",
+  flow_definition: "flow_definition",
+  branding: "branding",
+} as const;

package/src/generated/model/getReleaseByIdDefault.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 GetReleaseByIdDefault =
+  | ({
+      /** 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/getReleaseByIdParams.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 GetReleaseByIdParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+};