@zitadel/api 1.0.0-alpha.20 → 1.0.0-alpha.22

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

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

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

package/src/generated/model/getClaimWindowParams.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 GetClaimWindowParams = {
+  /**
+   * Unique identifier for this challenge (dialect-minted prefixed opaque string).
+   * @pattern ^ch_[a-zA-Z0-9_-]+$
+   */
+  challenge_id: string;
+};

package/src/generated/model/getEvent200.ts

@@ -1251,6 +1251,81 @@ export type GetEvent200 =
       flow_id?: string | null;
       /** Emit-time metadata, already redacted at write. Path A request.api may
   set client (ip, user_agent, origin) for SIEM join on request_id. Not a
+  live risk-evaluator input.
+   */
+      metadata?: {
+        /** Observed HTTP requestor context on Path A request.api only. */
+        client?: {
+          /** Client IP from the first X-Forwarded-For hop or RemoteAddr. */
+          ip?: string;
+          /** Observed User-Agent header. */
+          user_agent?: string;
+          /** Origin header when present. */
+          origin?: string;
+        };
+        [key: string]: unknown;
+      };
+    } & {
+      event_type: "release.created";
+      /** Allowlisted fields for `release.created`. The release id is already the
+  event's `entity_id`; the pinned set is repeated here so the audit stream
+  answers what a release contained without reading the release itself.
+   */
+      payload: {
+        content_hash?: string;
+        message?: string;
+        git_sha?: string;
+        git_dirty?: boolean;
+        pointers?: {
+          kind?: string;
+          handle?: string;
+          revision_id?: string;
+        }[];
+      };
+    })
+  | ({
+      /** Managed event id (`evt_<opaque>`). */
+      id: string;
+      /** @pattern ^[a-zA-Z0-9_-]+$ */
+      project_id: string;
+      /** Emit-time team scope, when the actor operated under a team. */
+      team_id?: string | null;
+      /** Semantic event name (dot-separated). Discriminator for the Event union —
+  see docs/design/api/events-catalog.md.
+   */
+      event_type: string;
+      /** Wide-event category. */
+      category: "request" | "auth" | "session" | "admin" | "entity" | "signal";
+      /** When the action happened (server/storage clock, dialect-owned). */
+      occurred_at: string;
+      /** When the row was inserted (server/storage clock, dialect-owned). */
+      created_at: string;
+      /** Who triggered the event. */
+      actor_id?: string | null;
+      /** Actor kind. */
+      actor_type?: "human" | "service" | "system" | "agent" | null;
+      /** Resource type affected. */
+      entity_type?: string | null;
+      /** Resource id affected. */
+      entity_id?: string | null;
+      /** Application or agent that produced the event. */
+      client_id: string;
+      /** Token id present at emit time, when any. */
+      token_id?: string;
+      /** Delegation kind (omit when unset). */
+      delegation_type?: "direct" | "delegated" | "pat_shared" | "exchanged";
+      delegation_id?: string;
+      grantor?: string;
+      /** Device fingerprint correlation id. */
+      fingerprint?: string;
+      /** HTTP request correlation id. */
+      request_id?: string | null;
+      /** Session correlation id. */
+      session_id?: string | null;
+      /** Login flow correlation id. */
+      flow_id?: string | null;
+      /** Emit-time metadata, already redacted at write. Path A request.api may
+  set client (ip, user_agent, origin) for SIEM join on request_id. Not a
   live risk-evaluator input.
    */
       metadata?: {

package/src/generated/model/getFlowDefinition200FlowDefinition.ts

@@ -23,9 +23,11 @@ the purpose + audience when a flow is created via POST /flow.
 export type GetFlowDefinition200FlowDefinition = {
   /**
      * Stable identifier for this flow, used as the target of cross-flow
-  `switch` and `pivot` transitions. Renaming is not supported — the
-  `name` is part of the public contract another definition may
-  reference. Acts as the human display label as well; no separate slug.
+  `switch` and `pivot` transitions. Every revision of a flow shares its
+  `name`; publishing a definition under an existing `name` adds a
+  revision to that flow. Renaming is not supported — the `name` is part
+  of the public contract another definition may reference. Acts as the
+  human display label as well; no separate slug.
 
      * @pattern ^[a-z][a-z0-9-]*$
      */

package/src/generated/model/getGrant200.ts

@@ -6,8 +6,11 @@
  * OpenAPI spec version: 0.0.1
  */
 import type { GetGrant200ObjectType } from "./getGrant200ObjectType";
+import type { GetGrant200Principal } from "./getGrant200Principal";
 import type { GetGrant200PrincipalType } from "./getGrant200PrincipalType";
 import type { GetGrant200Relation } from "./getGrant200Relation";
+import type { GetGrant200Team } from "./getGrant200Team";
+import type { GetGrant200User } from "./getGrant200User";
 
 /**
  * A collaboration grant binding a principal to a project relation.
@@ -31,4 +34,33 @@ export type GetGrant200 = {
   returns expired unrevoked grants; authorization ignores them.
    */
   expires_at?: string | null;
+  /** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+  property-named, so responses can mix users from different schemas.
+  `identifier` and `display` are resolved independently from the user
+  schema's `x-identifier` and `x-display` designations, live at read time.
+  Clients render `display`, falling back to `identifier`, then `user_id`.
+  Missing or deleted users degrade to `user_id` only.
+   */
+  user?: GetGrant200User;
+  /** A resolved reference to a team. Carries the team's id and name so a grant
+  list is readable without embedding the full Team body. Id and display ride
+  `project.read` (ADR 059 rule 8): a reference field carrying only the
+  target's id and display strings needs no gate of its own. Missing or
+  deleted teams degrade to `team_id` only.
+   */
+  team?: GetGrant200Team;
+  /** The principal named by `principal_id`, present only when the request
+  asked for it with `expand: ["principal"]` (ADR 059). Absent means it
+  was not requested; `null` means the principal cannot be loaded
+  (deleted or missing). GET and create never set this field.
+
+  When present, the body is the same representation `GET /users/{id}`
+  serves for `principal_type=user`, or `GET /teams/{id}` for
+  `principal_type=team`. Discriminate with the grant's existing
+  `principal_type`.
+
+  Requires `user.read` and `team.read` in addition to `project.read`.
+  Both are checked on the whole request before the list.
+   */
+  readonly principal?: GetGrant200Principal;
 };

package/src/generated/model/getGrant200Principal.ts

@@ -0,0 +1,147 @@
+/**
+ * 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 principal named by `principal_id`, present only when the request
+asked for it with `expand: ["principal"]` (ADR 059). Absent means it
+was not requested; `null` means the principal cannot be loaded
+(deleted or missing). GET and create never set this field.
+
+When present, the body is the same representation `GET /users/{id}`
+serves for `principal_type=user`, or `GET /teams/{id}` for
+`principal_type=team`. Discriminate with the grant's existing
+`principal_type`.
+
+Requires `user.read` and `team.read` in addition to `project.read`.
+Both are checked on the whole request before the list.
+
+ */
+export type GetGrant200Principal =
+  | {
+      /** @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: { [key: string]: unknown };
+      metadata: {
+        /** 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: "active" | "suspended" | "deactivated" | "pending_purge";
+        /** 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?: {
+          /** 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;
+      };
+      /** 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 {
+        /** 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: "pending" | "active" | "inactive";
+        /** The time when the user joined this team. */
+        created_at: string;
+        /** The time when this membership was last changed. */
+        updated_at: string;
+      }[];
+      /** 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;
+    }
+  | {
+      /** 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/getGrant200Team.ts

@@ -0,0 +1,22 @@
+/**
+ * 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
+ */
+
+/**
+ * A resolved reference to a team. Carries the team's id and name so a grant
+list is readable without embedding the full Team body. Id and display ride
+`project.read` (ADR 059 rule 8): a reference field carrying only the
+target's id and display strings needs no gate of its own. Missing or
+deleted teams degrade to `team_id` only.
+
+ */
+export type GetGrant200Team = {
+  /** The referenced team's id (`team_<opaque>`). Always present. */
+  team_id: string;
+  /** The team's name. Absent when the team can no longer be loaded. */
+  name?: string;
+};

package/src/generated/model/getGrant200User.ts

@@ -0,0 +1,38 @@
+/**
+ * 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
+ */
+
+/**
+ * A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+property-named, so responses can mix users from different schemas.
+`identifier` and `display` are resolved independently from the user
+schema's `x-identifier` and `x-display` designations, live at read time.
+Clients render `display`, falling back to `identifier`, then `user_id`.
+Missing or deleted users degrade to `user_id` only.
+
+ */
+export type GetGrant200User = {
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
+  user_id: string;
+  /** The current value of the schema's designated identifier
+  (`x-identifier`). Absent when the schema designates no identifier or
+  the user carries no value for it.
+   */
+  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.
+   */
+  identifier_property?: string;
+  /** The `x-display` rendering — the designated properties' values joined
+  in list order. Purely presentational, with no source attribution.
+  Absent when the schema designates no display properties or the user
+  carries no values for them.
+   */
+  display?: string;
+};

package/src/generated/model/getMySession200.ts

@@ -8,6 +8,7 @@
 import type { GetMySession200FactorsItem } from "./getMySession200FactorsItem";
 import type { GetMySession200Metadata } from "./getMySession200Metadata";
 import type { GetMySession200State } from "./getMySession200State";
+import type { GetMySession200User } from "./getMySession200User";
 import type { GetMySession200UserAgent } from "./getMySession200UserAgent";
 
 /**
@@ -37,23 +38,14 @@ export type GetMySession200 = {
   factor has been verified through an `auth_attempt`.
    */
   user_id?: string | null;
-  /** Human-readable name of the authenticated user, resolved from the
-  conventional user-schema properties: `name` when defined, otherwise
-  the given and family name parts joined — `givenName`/`familyName`
-  (the shipped presets' spelling) or `given_name`/`family_name`. Only
-  present on reads that hydrate the user's identity
-  (`GET /sessions/me`) and only when the session has an authenticated
-  user whose schema carries those properties; clients fall back to
-  `email`, then `user_id`.
+  /** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+  property-named, so responses can mix users from different schemas.
+  `identifier` and `display` are resolved independently from the user
+  schema's `x-identifier` and `x-display` designations, live at read time.
+  Clients render `display`, falling back to `identifier`, then `user_id`.
+  Missing or deleted users degrade to `user_id` only.
    */
-  name?: string;
-  /** Email address of the authenticated user, resolved from the
-  conventional `email` user-schema property. Only present on reads
-  that hydrate the user's identity (`GET /sessions/me`) and only when
-  the session has an authenticated user whose schema carries that
-  property.
-   */
-  email?: string;
+  user?: GetMySession200User;
   /** Verified authentication factors accumulated by this session.
   Each key is a factor type (e.g. `password`, `totp`, `passkey`).
   Each value is a factor event object with at least `verified_at` and

package/src/generated/model/getMySession200User.ts

@@ -0,0 +1,38 @@
+/**
+ * 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
+ */
+
+/**
+ * A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+property-named, so responses can mix users from different schemas.
+`identifier` and `display` are resolved independently from the user
+schema's `x-identifier` and `x-display` designations, live at read time.
+Clients render `display`, falling back to `identifier`, then `user_id`.
+Missing or deleted users degrade to `user_id` only.
+
+ */
+export type GetMySession200User = {
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
+  user_id: string;
+  /** The current value of the schema's designated identifier
+  (`x-identifier`). Absent when the schema designates no identifier or
+  the user carries no value for it.
+   */
+  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.
+   */
+  identifier_property?: string;
+  /** The `x-display` rendering — the designated properties' values joined
+  in list order. Purely presentational, with no source attribution.
+  Absent when the schema designates no display properties or the user
+  carries no values for them.
+   */
+  display?: string;
+};

package/src/generated/model/getMyUser200.ts

@@ -36,6 +36,24 @@ export type GetMyUser200 = {
    */
   attributes: GetMyUser200Attributes;
   metadata: GetMyUser200Metadata;
+  /** 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.

package/src/generated/model/getSession200.ts

@@ -8,6 +8,7 @@
 import type { GetSession200FactorsItem } from "./getSession200FactorsItem";
 import type { GetSession200Metadata } from "./getSession200Metadata";
 import type { GetSession200State } from "./getSession200State";
+import type { GetSession200User } from "./getSession200User";
 import type { GetSession200UserAgent } from "./getSession200UserAgent";
 
 /**
@@ -37,23 +38,14 @@ export type GetSession200 = {
   factor has been verified through an `auth_attempt`.
    */
   user_id?: string | null;
-  /** Human-readable name of the authenticated user, resolved from the
-  conventional user-schema properties: `name` when defined, otherwise
-  the given and family name parts joined — `givenName`/`familyName`
-  (the shipped presets' spelling) or `given_name`/`family_name`. Only
-  present on reads that hydrate the user's identity
-  (`GET /sessions/me`) and only when the session has an authenticated
-  user whose schema carries those properties; clients fall back to
-  `email`, then `user_id`.
+  /** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+  property-named, so responses can mix users from different schemas.
+  `identifier` and `display` are resolved independently from the user
+  schema's `x-identifier` and `x-display` designations, live at read time.
+  Clients render `display`, falling back to `identifier`, then `user_id`.
+  Missing or deleted users degrade to `user_id` only.
    */
-  name?: string;
-  /** Email address of the authenticated user, resolved from the
-  conventional `email` user-schema property. Only present on reads
-  that hydrate the user's identity (`GET /sessions/me`) and only when
-  the session has an authenticated user whose schema carries that
-  property.
-   */
-  email?: string;
+  user?: GetSession200User;
   /** Verified authentication factors accumulated by this session.
   Each key is a factor type (e.g. `password`, `totp`, `passkey`).
   Each value is a factor event object with at least `verified_at` and

package/src/generated/model/getSession200User.ts

@@ -0,0 +1,38 @@
+/**
+ * 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
+ */
+
+/**
+ * A resolved reference to a user (ADR 058 §3). Fields are role-named, not
+property-named, so responses can mix users from different schemas.
+`identifier` and `display` are resolved independently from the user
+schema's `x-identifier` and `x-display` designations, live at read time.
+Clients render `display`, falling back to `identifier`, then `user_id`.
+Missing or deleted users degrade to `user_id` only.
+
+ */
+export type GetSession200User = {
+  /** @pattern ^user_[a-zA-Z0-9_-]+$ */
+  user_id: string;
+  /** The current value of the schema's designated identifier
+  (`x-identifier`). Absent when the schema designates no identifier or
+  the user carries no value for it.
+   */
+  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.
+   */
+  identifier_property?: string;
+  /** The `x-display` rendering — the designated properties' values joined
+  in list order. Purely presentational, with no source attribution.
+  Absent when the schema designates no display properties or the user
+  carries no values for them.
+   */
+  display?: string;
+};

package/src/generated/model/getUserByID200.ts

@@ -36,6 +36,24 @@ export type GetUserByID200 = {
    */
   attributes: GetUserByID200Attributes;
   metadata: GetUserByID200Metadata;
+  /** 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.