@zitadel/api 0.1.0-alpha.8 → 1.0.0-alpha.20

package/src/generated/model/getFlowStepDefault.ts

@@ -5,16 +5,115 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetFlowStepDefaultDetails } from "./getFlowStepDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type GetFlowStepDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: GetFlowStepDefaultDetails;
-};
+export type GetFlowStepDefault =
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.decrypt_failed";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "enc_key.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: "flow.completed";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flow.cookie_expired";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flow.cookie_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: "flow.integrity";
+    })
+  | ({
+      /** Stable machine-readable error code. */
+      code: string;
+      /** Human-readable explanation of the error. */
+      message: string;
+      /** Additional error-specific context. */
+      details?: { [key: string]: unknown };
+    } & {
+      code: "flow.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: "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: "tkn.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: "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: "enc_key.unknown_alg";
+    });

package/src/generated/model/getGrant200.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { GetGrant200ObjectType } from "./getGrant200ObjectType";
+import type { GetGrant200PrincipalType } from "./getGrant200PrincipalType";
+import type { GetGrant200Relation } from "./getGrant200Relation";
+
+/**
+ * A collaboration grant binding a principal to a project relation.
+ */
+export type GetGrant200 = {
+  /** Managed assignment id (`asgn_<opaque>`). */
+  id: string;
+  /** Project this grant is scoped to. */
+  project_id: string;
+  /** Kind of principal bound by this grant. */
+  principal_type: GetGrant200PrincipalType;
+  /** Principal id (`user_<opaque>` or `team_<opaque>`). */
+  principal_id: string;
+  /** Catalog object type. Always `project` for this API. */
+  object_type: GetGrant200ObjectType;
+  /** Catalog relation on the project. */
+  relation: GetGrant200Relation;
+  /** When the grant was created. */
+  created_at: string;
+  /** When the grant expires. Null when it does not expire. GET still
+  returns expired unrevoked grants; authorization ignores them.
+   */
+  expires_at?: string | null;
+};

package/src/generated/model/getGrant200ObjectType.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
+ */
+
+/**
+ * Catalog object type. Always `project` for this API.
+ */
+export type GetGrant200ObjectType =
+  (typeof GetGrant200ObjectType)[keyof typeof GetGrant200ObjectType];
+
+export const GetGrant200ObjectType = {
+  project: "project",
+} as const;

package/src/generated/model/getGrant200PrincipalType.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
+ */
+
+/**
+ * Kind of principal bound by this grant.
+ */
+export type GetGrant200PrincipalType =
+  (typeof GetGrant200PrincipalType)[keyof typeof GetGrant200PrincipalType];
+
+export const GetGrant200PrincipalType = {
+  user: "user",
+  team: "team",
+} as const;

package/src/generated/model/getGrant200Relation.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
+ */
+
+/**
+ * Catalog relation on the project.
+ */
+export type GetGrant200Relation = (typeof GetGrant200Relation)[keyof typeof GetGrant200Relation];
+
+export const GetGrant200Relation = {
+  viewer: "viewer",
+  editor: "editor",
+  admin: "admin",
+} as const;

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

package/src/generated/model/{listUsers500Details.ts → getGrant401Details.ts}

@@ -9,4 +9,4 @@
 /**
  * Additional error-specific context.
  */
-export type ListUsers500Details = { [key: string]: unknown };
+export type GetGrant401Details = { [key: string]: unknown };

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

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

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

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

package/src/generated/model/getGrantDefault.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 GetGrantDefault =
+  | ({
+      /** 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.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: "req.invalid";
+    });

package/src/generated/model/{getSessionParams.ts → getGrantParams.ts}

@@ -6,7 +6,7 @@
  * OpenAPI spec version: 0.0.1
  */
 
-export type GetSessionParams = {
+export type GetGrantParams = {
   /**
    * The unique identifier of the project
    * @pattern ^[a-zA-Z0-9_-]+$

package/src/generated/model/getMySession200.ts

@@ -21,23 +21,39 @@ in through `auth_attempts`.
  */
 export type GetMySession200 = {
   /**
-   * 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: GetMySession200State;
   /** The authenticated user. Null for anonymous sessions and until the `user`
   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`.
+   */
+  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;
   /** 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/getMySession200State.ts

@@ -8,10 +8,9 @@
 
 /**
  * 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 GetMySession200State = (typeof GetMySession200State)[keyof typeof GetMySession200State];
@@ -20,5 +19,4 @@ export const GetMySession200State = {
   building: "building",
   active: "active",
   expired: "expired",
-  revoked: "revoked",
 } as const;

package/src/generated/model/getMySession401.ts

@@ -5,10 +5,12 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetMySession401Details } from "./getMySession401Details";
 
 /**
- * Standard error payload returned for failed API requests.
+ * The request lacks valid authentication credentials.
+
+Error code: auth.unauthorized
+
  */
 export type GetMySession401 = {
   /** Stable machine-readable error code. */
@@ -16,5 +18,7 @@ export type GetMySession401 = {
   /** Human-readable explanation of the error. */
   message: string;
   /** Additional error-specific context. */
-  details?: GetMySession401Details;
+  details?: { [key: string]: unknown };
+} & {
+  code: "auth.unauthorized";
 };

package/src/generated/model/getMySession404.ts

@@ -5,10 +5,12 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetMySession404Details } from "./getMySession404Details";
 
 /**
- * Standard error payload returned for failed API requests.
+ * The session was not found
+
+Error code: sess.not_found
+
  */
 export type GetMySession404 = {
   /** Stable machine-readable error code. */
@@ -16,5 +18,7 @@ export type GetMySession404 = {
   /** Human-readable explanation of the error. */
   message: string;
   /** Additional error-specific context. */
-  details?: GetMySession404Details;
+  details?: { [key: string]: unknown };
+} & {
+  code: "sess.not_found";
 };

package/src/generated/model/getMySessionDefault.ts

@@ -5,16 +5,45 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
-import type { GetMySessionDefaultDetails } from "./getMySessionDefaultDetails";
 
-/**
- * Standard error payload returned for failed API requests.
- */
-export type GetMySessionDefault = {
-  /** Stable machine-readable error code. */
-  code: string;
-  /** Human-readable explanation of the error. */
-  message: string;
-  /** Additional error-specific context. */
-  details?: GetMySessionDefaultDetails;
-};
+export type GetMySessionDefault =
+  | ({
+      /** 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.not_found";
+    });

package/src/generated/model/getMyUser200.ts

@@ -5,5 +5,49 @@
  * This is the next generation of the Zitadel identity platform.
  * OpenAPI spec version: 0.0.1
  */
+import type { GetMyUser200Attributes } from "./getMyUser200Attributes";
+import type { GetMyUser200Metadata } from "./getMyUser200Metadata";
+import type { GetMyUser200TeamsItem } from "./getMyUser200TeamsItem";
 
-export type GetMyUser200 = { [key: string]: unknown };
+/**
+ * A user represents an individual identity in the system. It can be used to
+represent a human user, but also a service account or any other type of
+identity.
+
+`attributes` is the document that satisfies the user schema named by
+`schema`: its property names and types are defined entirely by that schema,
+and it is what the schema validates. The rest of the object — `id`,
+`schema`, `metadata` — is the server-owned envelope. Keeping the two apart
+means a schema may name a property `id` or `metadata` without colliding with
+the envelope, and closed-world keywords (`additionalProperties: false`,
+`propertyNames`, `unevaluatedProperties`) behave as their author expects.
+
+ */
+export type GetMyUser200 = {
+  /** @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: GetMyUser200Attributes;
+  metadata: GetMyUser200Metadata;
+  /** 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 GetMyUser200TeamsItem[];
+  /** 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;
+};

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;
+};