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

package/src/generated/model/queryProjectsDefault.ts

@@ -0,0 +1,79 @@
+/**
+ * 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 QueryProjectsDefault =
+  | ({
+      /** 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.missing_id";
+    })
+  | ({
+      /** 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";
+    });

package/src/generated/model/{listSessions200.ts → querySessions200.ts}

@@ -5,13 +5,13 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { ListSessions200SessionsItem } from "./listSessions200SessionsItem";
+import type { QuerySessions200SessionsItem } from "./querySessions200SessionsItem";
 
 /**
  * Paginated list of sessions.
  */
-export type ListSessions200 = {
-  sessions: ListSessions200SessionsItem[];
+export type QuerySessions200 = {
+  sessions: QuerySessions200SessionsItem[];
   /** Token to pass as `page_token` in the next request to fetch the following page.
   Absent when there are no more results.
    */

package/src/generated/model/{listSessions200SessionsItem.ts → querySessions200SessionsItem.ts}

@@ -5,10 +5,11 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { ListSessions200SessionsItemFactorsItem } from "./listSessions200SessionsItemFactorsItem";
-import type { ListSessions200SessionsItemMetadata } from "./listSessions200SessionsItemMetadata";
-import type { ListSessions200SessionsItemState } from "./listSessions200SessionsItemState";
-import type { ListSessions200SessionsItemUserAgent } from "./listSessions200SessionsItemUserAgent";
+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";
 
 /**
  * The current state of a session.
@@ -19,31 +20,37 @@ factors satisfy. Sessions are read-only from the client's perspective: factors f
 in through `auth_attempts`.
 
  */
-export type ListSessions200SessionsItem = {
+export type QuerySessions200SessionsItem = {
   /**
-   * Unique identifier for this session.
-   * @pattern ^[a-zA-Z0-9_-]+$
+   * Unique identifier for this session (dialect-minted prefixed opaque string).
+   * @pattern ^sess_[a-zA-Z0-9_-]+$
    */
   session_id: string;
   /** @pattern ^[a-zA-Z0-9_-]+$ */
   project_id: string;
   /** Current lifecycle state of the session:
-  - `building`: has a user factor but is still gathering authentication factors
+  - `building`: no verified authentication factors yet
   - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
   - `expired`: TTL elapsed
-  - `revoked`: explicitly revoked via DELETE
    */
-  state: ListSessions200SessionsItemState;
+  state: QuerySessions200SessionsItemState;
   /** The authenticated user. Null for anonymous sessions and until the `user`
   factor has been verified through an `auth_attempt`.
    */
   user_id?: 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`.
+   */
+  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
   method-specific properties (e.g. `user_verified`, `hardware` for passkeys).
    */
-  factors: ListSessions200SessionsItemFactorsItem[];
+  factors: QuerySessions200SessionsItemFactorsItem[];
   /** All assurance levels whose schemas the current session factors satisfy.
   This list shrinks as factor freshness windows expire and grows when step-up
   auth_attempts add or refresh factors.
@@ -51,9 +58,9 @@ export type ListSessions200SessionsItem = {
    */
   assurance_levels?: string[];
   /** Arbitrary key/value metadata attached to the session. */
-  metadata?: ListSessions200SessionsItemMetadata;
+  metadata?: QuerySessions200SessionsItemMetadata;
   /** User agent information captured at session creation. */
-  user_agent?: ListSessions200SessionsItemUserAgent;
+  user_agent?: QuerySessions200SessionsItemUserAgent;
   /** When this session was created. */
   created_at: string;
   /** When this session expires. Short TTL (10 min) for anonymous sessions;

package/src/generated/model/{listSessions200SessionsItemFactorsItem.ts → querySessions200SessionsItemFactorsItem.ts}

@@ -5,17 +5,17 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { ListSessions200SessionsItemFactorsItemMethod } from "./listSessions200SessionsItemFactorsItemMethod";
-import type { ListSessions200SessionsItemFactorsItemPayload } from "./listSessions200SessionsItemFactorsItemPayload";
+import type { QuerySessions200SessionsItemFactorsItemMethod } from "./querySessions200SessionsItemFactorsItemMethod";
+import type { QuerySessions200SessionsItemFactorsItemPayload } from "./querySessions200SessionsItemFactorsItemPayload";
 
 /**
  * A successfully verified authentication factor with verification metadata.
 Method-specific details are included in the `payload` field.
 
  */
-export type ListSessions200SessionsItemFactorsItem = {
+export type QuerySessions200SessionsItemFactorsItem = {
   /** An authentication factor method. */
-  method: ListSessions200SessionsItemFactorsItemMethod;
+  method: QuerySessions200SessionsItemFactorsItemMethod;
   /** When this factor was successfully verified */
   verified_at: string;
   /** Method-specific factor metadata. Structure depends on the `method` field.
@@ -23,5 +23,5 @@ export type ListSessions200SessionsItemFactorsItem = {
   - `password`: no additional data
   - `passkey`: includes credential details and verification flags
    */
-  payload?: ListSessions200SessionsItemFactorsItemPayload;
+  payload?: QuerySessions200SessionsItemFactorsItemPayload;
 };

package/src/generated/model/{listSessions200SessionsItemFactorsItemMethod.ts → querySessions200SessionsItemFactorsItemMethod.ts}

@@ -9,10 +9,10 @@
 /**
  * An authentication factor method.
  */
-export type ListSessions200SessionsItemFactorsItemMethod =
-  (typeof ListSessions200SessionsItemFactorsItemMethod)[keyof typeof ListSessions200SessionsItemFactorsItemMethod];
+export type QuerySessions200SessionsItemFactorsItemMethod =
+  (typeof QuerySessions200SessionsItemFactorsItemMethod)[keyof typeof QuerySessions200SessionsItemFactorsItemMethod];
 
-export const ListSessions200SessionsItemFactorsItemMethod = {
+export const QuerySessions200SessionsItemFactorsItemMethod = {
   identifier: "identifier",
   password: "password",
   passkey: "passkey",

package/src/generated/model/{listSessions200SessionsItemFactorsItemPayload.ts → querySessions200SessionsItemFactorsItemPayload.ts}

@@ -13,7 +13,7 @@
 - `passkey`: includes credential details and verification flags
 
  */
-export type ListSessions200SessionsItemFactorsItemPayload =
+export type QuerySessions200SessionsItemFactorsItemPayload =
   | {
       /** @pattern ^user_[a-zA-Z0-9_-]+$ */
       user_id: string;

package/src/generated/model/{listSessions200SessionsItemMetadata.ts → querySessions200SessionsItemMetadata.ts}

@@ -9,4 +9,4 @@
 /**
  * Arbitrary key/value metadata attached to the session.
  */
-export type ListSessions200SessionsItemMetadata = { [key: string]: unknown } | null;
+export type QuerySessions200SessionsItemMetadata = { [key: string]: unknown } | null;

package/src/generated/model/{listSessions200SessionsItemState.ts → querySessions200SessionsItemState.ts}

@@ -8,18 +8,16 @@
 
 /**
  * Current lifecycle state of the session:
-- `building`: has a user factor but is still gathering authentication factors
+- `building`: no verified authentication factors yet
 - `active`: has at least one verified authentication factor; `assurance_levels[]` may shrink as factors age
 - `expired`: TTL elapsed
-- `revoked`: explicitly revoked via DELETE
 
  */
-export type ListSessions200SessionsItemState =
-  (typeof ListSessions200SessionsItemState)[keyof typeof ListSessions200SessionsItemState];
+export type QuerySessions200SessionsItemState =
+  (typeof QuerySessions200SessionsItemState)[keyof typeof QuerySessions200SessionsItemState];
 
-export const ListSessions200SessionsItemState = {
+export const QuerySessions200SessionsItemState = {
   building: "building",
   active: "active",
   expired: "expired",
-  revoked: "revoked",
 } as const;

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/{listSessions200SessionsItemUserAgent.ts → querySessions200SessionsItemUserAgent.ts}

@@ -9,7 +9,7 @@
 /**
  * User agent information captured at session creation.
  */
-export type ListSessions200SessionsItemUserAgent = {
+export type QuerySessions200SessionsItemUserAgent = {
   /** Client-supplied device fingerprint. */
   fingerprint?: string;
   /** IP address of the client at session creation. */

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

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

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

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

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

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

package/src/generated/model/querySessionsBody.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { QuerySessionsBodyFilterItem } from "./querySessionsBodyFilterItem";
+import type { QuerySessionsBodySorting } from "./querySessionsBodySorting";
+
+/**
+ * Request to query the sessions of a project.
+ */
+export type QuerySessionsBody = {
+  /**
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: number;
+  /** Token to retrieve the next page of results. */
+  page_token?: string | null;
+  sorting?: QuerySessionsBodySorting;
+  /** Filter criteria for querying sessions. */
+  filter?: QuerySessionsBodyFilterItem[];
+};

package/src/generated/model/querySessionsBodyFilterItem.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 { QuerySessionsBodyFilterItemField } from "./querySessionsBodyFilterItemField";
+import type { QuerySessionsBodyFilterItemOperation } from "./querySessionsBodyFilterItemOperation";
+
+export type QuerySessionsBodyFilterItem = {
+  /** Field to filter sessions by:
+  - `created_at`: RFC3339 timestamp
+  - `user_id`: user id
+  - `state`: one of `building`, `active`, `expired`. State is computed at read
+    time, so a session expiring mid-request can match `active` but return `expired`.
+  - `lifecycle_owner_team_id`: team id. Matches the sessions of the users whose
+    lifecycle that team owns — the same users it can deactivate and whose
+    sessions it can revoke. Roster membership does not match: a collaborator on
+    the team's roster whose lifecycle another team (or the user themselves)
+    owns is not returned. A session is project-scoped and is not bound to a
+    team, so the link is read from the user at query time; a session of a
+    self-owned user, and a session with no user, match no team. Only `equals`
+    is supported.
+   */
+  field: QuerySessionsBodyFilterItemField;
+  /** 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: QuerySessionsBodyFilterItemOperation;
+};

package/src/generated/model/querySessionsBodyFilterItemField.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
+ */
+
+/**
+ * Field to filter sessions by:
+- `created_at`: RFC3339 timestamp
+- `user_id`: user id
+- `state`: one of `building`, `active`, `expired`. State is computed at read
+  time, so a session expiring mid-request can match `active` but return `expired`.
+- `lifecycle_owner_team_id`: team id. Matches the sessions of the users whose
+  lifecycle that team owns — the same users it can deactivate and whose
+  sessions it can revoke. Roster membership does not match: a collaborator on
+  the team's roster whose lifecycle another team (or the user themselves)
+  owns is not returned. A session is project-scoped and is not bound to a
+  team, so the link is read from the user at query time; a session of a
+  self-owned user, and a session with no user, match no team. Only `equals`
+  is supported.
+
+ */
+export type QuerySessionsBodyFilterItemField =
+  (typeof QuerySessionsBodyFilterItemField)[keyof typeof QuerySessionsBodyFilterItemField];
+
+export const QuerySessionsBodyFilterItemField = {
+  created_at: "created_at",
+  user_id: "user_id",
+  state: "state",
+  lifecycle_owner_team_id: "lifecycle_owner_team_id",
+} as const;

package/src/generated/model/querySessionsBodyFilterItemOperation.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 QuerySessionsBodyFilterItemOperation =
+  (typeof QuerySessionsBodyFilterItemOperation)[keyof typeof QuerySessionsBodyFilterItemOperation];
+
+export const QuerySessionsBodyFilterItemOperation = {
+  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/querySessionsBodySorting.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { QuerySessionsBodySortingDirection } from "./querySessionsBodySortingDirection";
+import type { QuerySessionsBodySortingField } from "./querySessionsBodySortingField";
+
+export type QuerySessionsBodySorting = {
+  /** Field to sort sessions by. Only stored columns are sortable: the keyset
+  cursor holds the last row's sort values, so a computed value such as
+  `state` would skip or duplicate rows between pages.
+   */
+  field: QuerySessionsBodySortingField;
+  direction: QuerySessionsBodySortingDirection;
+};

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

package/src/generated/model/querySessionsBodySortingField.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 sessions by. Only stored columns are sortable: the keyset
+cursor holds the last row's sort values, so a computed value such as
+`state` would skip or duplicate rows between pages.
+
+ */
+export type QuerySessionsBodySortingField =
+  (typeof QuerySessionsBodySortingField)[keyof typeof QuerySessionsBodySortingField];
+
+export const QuerySessionsBodySortingField = {
+  created_at: "created_at",
+  user_id: "user_id",
+} as const;