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

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

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

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

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

package/src/generated/model/queryGrantsBody.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 { QueryGrantsBodyExpandItem } from "./queryGrantsBodyExpandItem";
+import type { QueryGrantsBodyFilterItem } from "./queryGrantsBodyFilterItem";
+import type { QueryGrantsBodySorting } from "./queryGrantsBodySorting";
+
+/**
+ * Request to query the grants of a project.
+ */
+export type QueryGrantsBody = {
+  /**
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: number;
+  /** Token to retrieve the next page of results. Must be sent with the same
+  `sorting` as the request that issued the token. Omitting `sorting` reuses
+  the default sort and only succeeds when that default matches the token.
+   */
+  page_token?: string | null;
+  /** Related objects to embed on each grant (ADR 059). Omit it and no
+  embedded object is returned. An unrecognised value is rejected.
+   */
+  expand?: QueryGrantsBodyExpandItem[];
+  sorting?: QueryGrantsBodySorting;
+  /** Filter criteria for querying grants. Combined with AND. */
+  filter?: QueryGrantsBodyFilterItem[];
+};

package/src/generated/model/queryGrantsBodyExpandItem.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 related object to embed on each returned grant (ADR 059).
+
+- `principal`: the principal named by `principal_id`, as `principal` on
+  each grant. The property is omitted entirely when not requested. When
+  requested, it is the same body `GET /users/{id}` serves for
+  `principal_type=user`, or `GET /teams/{id}` for `principal_type=team`,
+  and `null` when that principal cannot be loaded. 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, because a mixed
+  page is the common case. A caller who may not read either resource
+  receives 403 rather than a silently missing `principal`.
+
+ */
+export type QueryGrantsBodyExpandItem =
+  (typeof QueryGrantsBodyExpandItem)[keyof typeof QueryGrantsBodyExpandItem];
+
+export const QueryGrantsBodyExpandItem = {
+  principal: "principal",
+} as const;

package/src/generated/model/queryGrantsBodyFilterItem.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 { QueryGrantsBodyFilterItemField } from "./queryGrantsBodyFilterItemField";
+import type { QueryGrantsBodyFilterItemOperation } from "./queryGrantsBodyFilterItemOperation";
+
+export type QueryGrantsBodyFilterItem = {
+  /** Field to filter grants by:
+  - `created_at`: RFC3339 timestamp
+  - `principal_type`: `user` or `team`
+  - `principal_id`: principal id (`user_<opaque>` or `team_<opaque>`)
+  - `relation`: `viewer`, `editor`, or `admin`
+  - `expires_at`: RFC3339 timestamp (null when the grant does not expire)
+   */
+  field: QueryGrantsBodyFilterItemField;
+  /** Filter-value specifies which values can be filtered by a query endpoint. This
+  is a union of types. When a value is specified which is not assignable to the
+  field which is being filtered, a 400 error will be returned.
+   */
+  value?: string | number | boolean | null;
+  /** Filter operation defines the operations which can be used when filtering on a
+  query endpoint.
+
+  On text fields, `contains` is a case-insensitive substring match. `equals`
+  compares the whole value and is case-sensitive unless the field documents
+  otherwise.
+   */
+  operation: QueryGrantsBodyFilterItemOperation;
+};

package/src/generated/model/queryGrantsBodyFilterItemField.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
+ */
+
+/**
+ * Field to filter grants by:
+- `created_at`: RFC3339 timestamp
+- `principal_type`: `user` or `team`
+- `principal_id`: principal id (`user_<opaque>` or `team_<opaque>`)
+- `relation`: `viewer`, `editor`, or `admin`
+- `expires_at`: RFC3339 timestamp (null when the grant does not expire)
+
+ */
+export type QueryGrantsBodyFilterItemField =
+  (typeof QueryGrantsBodyFilterItemField)[keyof typeof QueryGrantsBodyFilterItemField];
+
+export const QueryGrantsBodyFilterItemField = {
+  created_at: "created_at",
+  principal_type: "principal_type",
+  principal_id: "principal_id",
+  relation: "relation",
+  expires_at: "expires_at",
+} as const;

package/src/generated/model/queryGrantsBodyFilterItemOperation.ts

@@ -0,0 +1,30 @@
+/**
+ * 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
+ */
+
+/**
+ * Filter operation defines the operations which can be used when filtering on a
+query endpoint.
+
+On text fields, `contains` is a case-insensitive substring match. `equals`
+compares the whole value and is case-sensitive unless the field documents
+otherwise.
+
+ */
+export type QueryGrantsBodyFilterItemOperation =
+  (typeof QueryGrantsBodyFilterItemOperation)[keyof typeof QueryGrantsBodyFilterItemOperation];
+
+export const QueryGrantsBodyFilterItemOperation = {
+  equals: "equals",
+  not_equals: "not_equals",
+  contains: "contains",
+  not_contains: "not_contains",
+  less_than: "less_than",
+  less_than_or_equal: "less_than_or_equal",
+  greater_than: "greater_than",
+  greater_than_or_equal: "greater_than_or_equal",
+} as const;

package/src/generated/model/queryGrantsBodySorting.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 { QueryGrantsBodySortingDirection } from "./queryGrantsBodySortingDirection";
+import type { QueryGrantsBodySortingField } from "./queryGrantsBodySortingField";
+
+export type QueryGrantsBodySorting = {
+  /** Field to sort grants by. Default is `created_at` ascending with `id` as
+  the tiebreaker.
+   */
+  field: QueryGrantsBodySortingField;
+  direction: QueryGrantsBodySortingDirection;
+};

package/src/generated/model/queryGrantsBodySortingDirection.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 QueryGrantsBodySortingDirection =
+  (typeof QueryGrantsBodySortingDirection)[keyof typeof QueryGrantsBodySortingDirection];
+
+export const QueryGrantsBodySortingDirection = {
+  asc: "asc",
+  desc: "desc",
+} as const;

package/src/generated/model/queryGrantsBodySortingField.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
+ */
+
+/**
+ * Field to sort grants by. Default is `created_at` ascending with `id` as
+the tiebreaker.
+
+ */
+export type QueryGrantsBodySortingField =
+  (typeof QueryGrantsBodySortingField)[keyof typeof QueryGrantsBodySortingField];
+
+export const QueryGrantsBodySortingField = {
+  created_at: "created_at",
+  expires_at: "expires_at",
+  id: "id",
+} as const;

package/src/generated/model/queryGrantsDefault.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 QueryGrantsDefault =
+  | ({
+      /** 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: "grant.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: "grant.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: "grant.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: "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: "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: "team.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: "user.permission_denied";
+    });

package/src/generated/model/queryGrantsParams.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 QueryGrantsParams = {
+  /**
+   * The unique identifier of the project
+   * @pattern ^[a-zA-Z0-9_-]+$
+   */
+  project_id: string;
+};

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,14 @@ 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`.
+  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?: 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,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 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.

package/src/generated/model/updateFlowDefinition200FlowDefinition.ts

@@ -23,9 +23,11 @@ the purpose + audience when a flow is created via POST /flow.
 export type UpdateFlowDefinition200FlowDefinition = {
   /**
      * 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/updateFlowDefinitionBodyFlowDefinition.ts

@@ -23,9 +23,11 @@ the purpose + audience when a flow is created via POST /flow.
 export type UpdateFlowDefinitionBodyFlowDefinition = {
   /**
      * 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-]*$
      */