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

package/src/generated/model/exchangeHandoff200SessionUser.ts

@@ -0,0 +1,37 @@
+/**
+ * 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`.
+
+ */
+export type ExchangeHandoff200SessionUser = {
+  /** @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,13 @@ 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`.
    */
-  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,37 @@
+/**
+ * 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`.
+
+ */
+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,13 @@ 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`.
    */
-  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,37 @@
+/**
+ * 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`.
+
+ */
+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.

package/src/generated/model/index.ts

@@ -173,6 +173,7 @@ export * from "./createSession201SessionFactorsItemMethod";
 export * from "./createSession201SessionFactorsItemPayload";
 export * from "./createSession201SessionMetadata";
 export * from "./createSession201SessionState";
+export * from "./createSession201SessionUser";
 export * from "./createSession201SessionUserAgent";
 export * from "./createSession400";
 export * from "./createSession400Details";
@@ -249,6 +250,7 @@ export * from "./exchangeHandoff200SessionFactorsItemMethod";
 export * from "./exchangeHandoff200SessionFactorsItemPayload";
 export * from "./exchangeHandoff200SessionMetadata";
 export * from "./exchangeHandoff200SessionState";
+export * from "./exchangeHandoff200SessionUser";
 export * from "./exchangeHandoff200SessionUserAgent";
 export * from "./exchangeHandoff400";
 export * from "./exchangeHandoff400Details";
@@ -382,6 +384,7 @@ export * from "./getMySession200FactorsItemMethod";
 export * from "./getMySession200FactorsItemPayload";
 export * from "./getMySession200Metadata";
 export * from "./getMySession200State";
+export * from "./getMySession200User";
 export * from "./getMySession200UserAgent";
 export * from "./getMySession401";
 export * from "./getMySession404";
@@ -429,6 +432,7 @@ export * from "./getSession200FactorsItemMethod";
 export * from "./getSession200FactorsItemPayload";
 export * from "./getSession200Metadata";
 export * from "./getSession200State";
+export * from "./getSession200User";
 export * from "./getSession200UserAgent";
 export * from "./getSession401";
 export * from "./getSession401Details";
@@ -595,6 +599,7 @@ export * from "./querySessions200SessionsItemFactorsItemMethod";
 export * from "./querySessions200SessionsItemFactorsItemPayload";
 export * from "./querySessions200SessionsItemMetadata";
 export * from "./querySessions200SessionsItemState";
+export * from "./querySessions200SessionsItemUser";
 export * from "./querySessions200SessionsItemUserAgent";
 export * from "./querySessions400";
 export * from "./querySessions400Details";

package/src/generated/model/querySessions200SessionsItem.ts

@@ -8,6 +8,7 @@
 import type { QuerySessions200SessionsItemFactorsItem } from "./querySessions200SessionsItemFactorsItem";
 import type { QuerySessions200SessionsItemMetadata } from "./querySessions200SessionsItemMetadata";
 import type { QuerySessions200SessionsItemState } from "./querySessions200SessionsItemState";
+import type { QuerySessions200SessionsItemUser } from "./querySessions200SessionsItemUser";
 import type { QuerySessions200SessionsItemUserAgent } from "./querySessions200SessionsItemUserAgent";
 
 /**
@@ -37,23 +38,13 @@ export type QuerySessions200SessionsItem = {
   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`.
    */
-  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?: QuerySessions200SessionsItemUser;
   /** 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/querySessions200SessionsItemUser.ts

@@ -0,0 +1,37 @@
+/**
+ * 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`.
+
+ */
+export type QuerySessions200SessionsItemUser = {
+  /** @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/queryUsers200UsersItem.ts

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