@zitadel/api 0.0.0 → 0.1.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/dist/generated/endpoints/zitadelNextGen.d.mts +2 -2
  2. package/dist/generated/endpoints/zitadelNextGen.d.ts +17 -7
  3. package/dist/generated/endpoints/zitadelNextGen.d.ts.map +1 -1
  4. package/dist/generated/endpoints/zitadelNextGen.mjs +69 -16
  5. package/dist/generated/endpoints/zitadelNextGen.mjs.map +1 -1
  6. package/dist/generated/endpoints/zitadelNextGen.msw.d.mts +8 -5
  7. package/dist/generated/endpoints/zitadelNextGen.msw.d.mts.map +1 -1
  8. package/dist/generated/endpoints/zitadelNextGen.msw.d.ts +7 -4
  9. package/dist/generated/endpoints/zitadelNextGen.msw.d.ts.map +1 -1
  10. package/dist/generated/endpoints/zitadelNextGen.msw.mjs +248 -228
  11. package/dist/generated/endpoints/zitadelNextGen.msw.mjs.map +1 -1
  12. package/dist/generated/endpoints/zitadelNextGen.zod.d.mts +140 -106
  13. package/dist/generated/endpoints/zitadelNextGen.zod.d.mts.map +1 -1
  14. package/dist/generated/endpoints/zitadelNextGen.zod.d.ts +137 -103
  15. package/dist/generated/endpoints/zitadelNextGen.zod.d.ts.map +1 -1
  16. package/dist/generated/endpoints/zitadelNextGen.zod.mjs +105 -83
  17. package/dist/generated/endpoints/zitadelNextGen.zod.mjs.map +1 -1
  18. package/dist/generated/model/createFlowDefinition201.d.ts +11 -144
  19. package/dist/generated/model/createFlowDefinition201.d.ts.map +1 -1
  20. package/dist/generated/model/createFlowDefinition201FlowDefinition.d.ts +56 -0
  21. package/dist/generated/model/createFlowDefinition201FlowDefinition.d.ts.map +1 -0
  22. package/dist/generated/model/createFlowDefinition201FlowDefinitionAudience.d.ts +21 -0
  23. package/dist/generated/model/createFlowDefinition201FlowDefinitionAudience.d.ts.map +1 -0
  24. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItem.d.ts +71 -0
  25. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItem.d.ts.map +1 -0
  26. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemActions.d.ts +29 -0
  27. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemActions.d.ts.map +1 -0
  28. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemComplete.d.ts +19 -0
  29. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemComplete.d.ts.map +1 -0
  30. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGates.d.ts +35 -0
  31. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGates.d.ts.map +1 -0
  32. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesConfig.d.ts +16 -0
  33. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesConfig.d.ts.map +1 -0
  34. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesKind.d.ts +18 -0
  35. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesKind.d.ts.map +1 -0
  36. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemOnSuccess.d.ts +19 -0
  37. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemOnSuccess.d.ts.map +1 -0
  38. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemSsoProvidersItem.d.ts +19 -0
  39. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemSsoProvidersItem.d.ts.map +1 -0
  40. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemTransitions.d.ts +35 -0
  41. package/dist/generated/model/createFlowDefinition201FlowDefinitionStepsItemTransitions.d.ts.map +1 -0
  42. package/dist/generated/model/deleteFlowDefinitionParams.d.ts +15 -0
  43. package/dist/generated/model/deleteFlowDefinitionParams.d.ts.map +1 -0
  44. package/dist/generated/model/getFlowDefinition200.d.ts +11 -144
  45. package/dist/generated/model/getFlowDefinition200.d.ts.map +1 -1
  46. package/dist/generated/model/getFlowDefinition200FlowDefinition.d.ts +56 -0
  47. package/dist/generated/model/getFlowDefinition200FlowDefinition.d.ts.map +1 -0
  48. package/dist/generated/model/getFlowDefinition200FlowDefinitionAudience.d.ts +21 -0
  49. package/dist/generated/model/getFlowDefinition200FlowDefinitionAudience.d.ts.map +1 -0
  50. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItem.d.ts +71 -0
  51. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItem.d.ts.map +1 -0
  52. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemActions.d.ts +29 -0
  53. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemActions.d.ts.map +1 -0
  54. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemComplete.d.ts +19 -0
  55. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemComplete.d.ts.map +1 -0
  56. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGates.d.ts +35 -0
  57. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGates.d.ts.map +1 -0
  58. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesConfig.d.ts +16 -0
  59. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesConfig.d.ts.map +1 -0
  60. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesKind.d.ts +18 -0
  61. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesKind.d.ts.map +1 -0
  62. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemOnSuccess.d.ts +19 -0
  63. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemOnSuccess.d.ts.map +1 -0
  64. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.d.ts +19 -0
  65. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.d.ts.map +1 -0
  66. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemTransitions.d.ts +35 -0
  67. package/dist/generated/model/getFlowDefinition200FlowDefinitionStepsItemTransitions.d.ts.map +1 -0
  68. package/dist/generated/model/getFlowDefinitionParams.d.ts +15 -0
  69. package/dist/generated/model/getFlowDefinitionParams.d.ts.map +1 -0
  70. package/dist/generated/model/getMyUser200.d.ts +11 -0
  71. package/dist/generated/model/getMyUser200.d.ts.map +1 -0
  72. package/dist/generated/model/{getFlowDefinition404.d.ts → getMyUser401.d.ts} +4 -4
  73. package/dist/generated/model/getMyUser401.d.ts.map +1 -0
  74. package/dist/generated/model/{getFlowDefinition404Details.d.ts → getMyUser401Details.d.ts} +2 -2
  75. package/dist/generated/model/getMyUser401Details.d.ts.map +1 -0
  76. package/dist/generated/model/getMyUser404.d.ts +26 -0
  77. package/dist/generated/model/getMyUser404.d.ts.map +1 -0
  78. package/dist/generated/model/{deleteFlowDefinition404.d.ts → getMyUserDefault.d.ts} +4 -4
  79. package/dist/generated/model/getMyUserDefault.d.ts.map +1 -0
  80. package/dist/generated/model/{deleteFlowDefinition404Details.d.ts → getMyUserDefaultDetails.d.ts} +2 -2
  81. package/dist/generated/model/getMyUserDefaultDetails.d.ts.map +1 -0
  82. package/dist/generated/model/index.d.mts +2 -2
  83. package/dist/generated/model/index.d.ts +52 -4
  84. package/dist/generated/model/index.d.ts.map +1 -1
  85. package/dist/generated/model/index.mjs +37 -1
  86. package/dist/generated/model/index.mjs.map +1 -1
  87. package/dist/generated/model/listFlowDefinitions200FlowDefinitionsItem.d.ts +1 -1
  88. package/dist/generated/model/listFlowDefinitions200FlowDefinitionsItem.d.ts.map +1 -1
  89. package/dist/generated/model/listFlowDefinitionsParams.d.ts +1 -1
  90. package/dist/generated/model/setUserPassword400.d.ts +20 -0
  91. package/dist/generated/model/setUserPassword400.d.ts.map +1 -0
  92. package/dist/generated/model/setUserPassword400Details.d.ts +14 -0
  93. package/dist/generated/model/setUserPassword400Details.d.ts.map +1 -0
  94. package/dist/generated/model/setUserPassword404.d.ts +20 -0
  95. package/dist/generated/model/setUserPassword404.d.ts.map +1 -0
  96. package/dist/generated/model/setUserPassword404Details.d.ts +14 -0
  97. package/dist/generated/model/setUserPassword404Details.d.ts.map +1 -0
  98. package/dist/generated/model/setUserPassword500.d.ts +20 -0
  99. package/dist/generated/model/setUserPassword500.d.ts.map +1 -0
  100. package/dist/generated/model/setUserPassword500Details.d.ts +14 -0
  101. package/dist/generated/model/setUserPassword500Details.d.ts.map +1 -0
  102. package/dist/generated/model/setUserPasswordBody.d.ts +19 -0
  103. package/dist/generated/model/setUserPasswordBody.d.ts.map +1 -0
  104. package/dist/generated/model/setUserPasswordDefault.d.ts +20 -0
  105. package/dist/generated/model/setUserPasswordDefault.d.ts.map +1 -0
  106. package/dist/generated/model/setUserPasswordDefaultDetails.d.ts +14 -0
  107. package/dist/generated/model/setUserPasswordDefaultDetails.d.ts.map +1 -0
  108. package/dist/generated/model/setUserPasswordParams.d.ts +15 -0
  109. package/dist/generated/model/setUserPasswordParams.d.ts.map +1 -0
  110. package/dist/generated/model/updateFlowDefinition200.d.ts +11 -144
  111. package/dist/generated/model/updateFlowDefinition200.d.ts.map +1 -1
  112. package/dist/generated/model/updateFlowDefinition200FlowDefinition.d.ts +56 -0
  113. package/dist/generated/model/updateFlowDefinition200FlowDefinition.d.ts.map +1 -0
  114. package/dist/generated/model/updateFlowDefinition200FlowDefinitionAudience.d.ts +21 -0
  115. package/dist/generated/model/updateFlowDefinition200FlowDefinitionAudience.d.ts.map +1 -0
  116. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItem.d.ts +71 -0
  117. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItem.d.ts.map +1 -0
  118. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemActions.d.ts +29 -0
  119. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemActions.d.ts.map +1 -0
  120. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemComplete.d.ts +19 -0
  121. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemComplete.d.ts.map +1 -0
  122. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGates.d.ts +35 -0
  123. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGates.d.ts.map +1 -0
  124. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesConfig.d.ts +16 -0
  125. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesConfig.d.ts.map +1 -0
  126. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesKind.d.ts +18 -0
  127. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesKind.d.ts.map +1 -0
  128. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemOnSuccess.d.ts +19 -0
  129. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemOnSuccess.d.ts.map +1 -0
  130. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.d.ts +19 -0
  131. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.d.ts.map +1 -0
  132. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemTransitions.d.ts +35 -0
  133. package/dist/generated/model/updateFlowDefinition200FlowDefinitionStepsItemTransitions.d.ts.map +1 -0
  134. package/dist/generated/model/updateFlowDefinitionParams.d.ts +15 -0
  135. package/dist/generated/model/updateFlowDefinitionParams.d.ts.map +1 -0
  136. package/dist/{index-DlEenfQJ.d.mts → index-DyBulyp9.d.mts} +1685 -938
  137. package/dist/index-DyBulyp9.d.mts.map +1 -0
  138. package/dist/runtime/api-factory.d.mts +1 -1
  139. package/dist/runtime/config.d.mts +6 -3
  140. package/dist/runtime/config.d.mts.map +1 -1
  141. package/dist/runtime/config.d.ts +6 -3
  142. package/dist/runtime/config.d.ts.map +1 -1
  143. package/dist/runtime/config.mjs +42 -11
  144. package/dist/runtime/config.mjs.map +1 -1
  145. package/dist/tsconfig.lib.tsbuildinfo +1 -1
  146. package/dist/{zitadelNextGen-C-fBEgnH.d.mts → zitadelNextGen-D6pDH5nq.d.mts} +20 -10
  147. package/dist/zitadelNextGen-D6pDH5nq.d.mts.map +1 -0
  148. package/package.json +1 -1
  149. package/src/generated/endpoints/zitadelNextGen.msw.ts +82 -34
  150. package/src/generated/endpoints/zitadelNextGen.ts +111 -16
  151. package/src/generated/endpoints/zitadelNextGen.zod.ts +452 -384
  152. package/src/generated/model/createFlowDefinition201.ts +11 -144
  153. package/src/generated/model/createFlowDefinition201FlowDefinition.ts +58 -0
  154. package/src/generated/model/createFlowDefinition201FlowDefinitionAudience.ts +21 -0
  155. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItem.ts +71 -0
  156. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemActions.ts +29 -0
  157. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemComplete.ts +21 -0
  158. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemGates.ts +35 -0
  159. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesConfig.ts +14 -0
  160. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemGatesKind.ts +20 -0
  161. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemOnSuccess.ts +21 -0
  162. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemSsoProvidersItem.ts +19 -0
  163. package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemTransitions.ts +35 -0
  164. package/src/generated/model/deleteFlowDefinitionParams.ts +15 -0
  165. package/src/generated/model/getFlowDefinition200.ts +11 -144
  166. package/src/generated/model/getFlowDefinition200FlowDefinition.ts +58 -0
  167. package/src/generated/model/getFlowDefinition200FlowDefinitionAudience.ts +21 -0
  168. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItem.ts +71 -0
  169. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemActions.ts +29 -0
  170. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemComplete.ts +21 -0
  171. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemGates.ts +35 -0
  172. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesConfig.ts +14 -0
  173. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemGatesKind.ts +20 -0
  174. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemOnSuccess.ts +21 -0
  175. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.ts +19 -0
  176. package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemTransitions.ts +35 -0
  177. package/src/generated/model/getFlowDefinitionParams.ts +15 -0
  178. package/src/generated/model/getMyUser200.ts +9 -0
  179. package/src/generated/model/{getFlowDefinition404.ts → getMyUser401.ts} +3 -3
  180. package/src/generated/model/{getFlowDefinition404Details.ts → getMyUser401Details.ts} +1 -1
  181. package/src/generated/model/getMyUser404.ts +24 -0
  182. package/src/generated/model/{deleteFlowDefinition404.ts → getMyUserDefault.ts} +3 -3
  183. package/src/generated/model/{deleteFlowDefinition404Details.ts → getMyUserDefaultDetails.ts} +1 -1
  184. package/src/generated/model/index.ts +52 -4
  185. package/src/generated/model/listFlowDefinitions200FlowDefinitionsItem.ts +1 -1
  186. package/src/generated/model/listFlowDefinitionsParams.ts +1 -1
  187. package/src/generated/model/setUserPassword400.ts +20 -0
  188. package/src/generated/model/setUserPassword400Details.ts +12 -0
  189. package/src/generated/model/setUserPassword404.ts +20 -0
  190. package/src/generated/model/setUserPassword404Details.ts +12 -0
  191. package/src/generated/model/setUserPassword500.ts +20 -0
  192. package/src/generated/model/setUserPassword500Details.ts +12 -0
  193. package/src/generated/model/setUserPasswordBody.ts +19 -0
  194. package/src/generated/model/setUserPasswordDefault.ts +20 -0
  195. package/src/generated/model/setUserPasswordDefaultDetails.ts +12 -0
  196. package/src/generated/model/setUserPasswordParams.ts +15 -0
  197. package/src/generated/model/updateFlowDefinition200.ts +11 -144
  198. package/src/generated/model/updateFlowDefinition200FlowDefinition.ts +58 -0
  199. package/src/generated/model/updateFlowDefinition200FlowDefinitionAudience.ts +21 -0
  200. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItem.ts +71 -0
  201. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemActions.ts +29 -0
  202. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemComplete.ts +21 -0
  203. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGates.ts +35 -0
  204. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesConfig.ts +14 -0
  205. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemGatesKind.ts +20 -0
  206. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemOnSuccess.ts +21 -0
  207. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem.ts +19 -0
  208. package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemTransitions.ts +35 -0
  209. package/src/generated/model/updateFlowDefinitionParams.ts +15 -0
  210. package/src/runtime/config.spec.ts +41 -0
  211. package/src/runtime/config.ts +46 -18
  212. package/dist/generated/endpoints/zitadelNextGen.d.mts.map +0 -1
  213. package/dist/generated/model/createSession201SessionFactors.d.ts +0 -18
  214. package/dist/generated/model/createSession201SessionFactors.d.ts.map +0 -1
  215. package/dist/generated/model/deleteFlowDefinition404.d.ts.map +0 -1
  216. package/dist/generated/model/deleteFlowDefinition404Details.d.ts.map +0 -1
  217. package/dist/generated/model/exchangeHandoff200SessionFactors.d.ts +0 -18
  218. package/dist/generated/model/exchangeHandoff200SessionFactors.d.ts.map +0 -1
  219. package/dist/generated/model/getFlowDefinition404.d.ts.map +0 -1
  220. package/dist/generated/model/getFlowDefinition404Details.d.ts.map +0 -1
  221. package/dist/generated/model/getMySession200Factors.d.ts +0 -18
  222. package/dist/generated/model/getMySession200Factors.d.ts.map +0 -1
  223. package/dist/generated/model/getSession200Factors.d.ts +0 -18
  224. package/dist/generated/model/getSession200Factors.d.ts.map +0 -1
  225. package/dist/generated/model/index.d.mts.map +0 -1
  226. package/dist/generated/model/listSessions200SessionsItemFactors.d.ts +0 -18
  227. package/dist/generated/model/listSessions200SessionsItemFactors.d.ts.map +0 -1
  228. package/dist/index-DlEenfQJ.d.mts.map +0 -1
  229. package/dist/zitadelNextGen-C-fBEgnH.d.mts.map +0 -1
@@ -5,158 +5,25 @@
5
5
  * This is the next generation of the Zitadel identity platform.
6
6
  * OpenAPI spec version: 0.0.1
7
7
  */
8
+ import type { GetFlowDefinition200FlowDefinition } from "./getFlowDefinition200FlowDefinition";
8
9
 
9
10
  export type GetFlowDefinition200 = {
10
- /**
11
- * Stable identifier for this flow, used as the target of cross-flow
12
- `switch` and `pivot` transitions. Renaming is not supported — the
13
- `name` is part of the public contract another definition may
14
- reference. Acts as the human display label as well; no separate slug.
15
-
16
- * @pattern ^[a-z][a-z0-9-]*$
17
- */
18
- name: string;
19
- /** User schema this flow operates on. Step `fields` reference properties
20
- defined in this schema. The engine resolves field types, validation,
21
- and implicit outcomes from schema annotations at runtime.
22
- */
23
- user_schema: string;
24
- /** Maps each purpose this definition handles to its entry-point step.
25
- Keys are purpose names; values must match a `name` in `steps`. A
26
- definition can serve multiple purposes (e.g. a combined login/register
27
- flow) by listing one entry per purpose.
28
- */
29
- purposes: Partial<
30
- Record<"login" | "register" | "recovery" | "profiling" | "reauth" | "link_account", string>
31
- >;
32
- /** Scopes which teams or apps this flow definition applies to. Empty or
33
- omitted fields mean "no restriction"; when both are empty the definition
34
- matches every request in the project. The engine picks the most specific
35
- matching definition: app > team > project-wide.
36
- */
37
- audience?: {
38
- /** Restrict to specific teams (organizations). Empty means no team restriction. */
39
- team_ids?: string[];
40
- /** Restrict to specific applications. Empty means no app restriction. */
41
- app_ids?: string[];
42
- };
43
- /**
44
- * Ordered list of steps in this flow. The order is for human readability —
45
- actual step sequencing is determined by transitions.
46
-
47
- * @minItems 1
48
- */
49
- steps: {
50
- /** Unique step identifier within this flow. Used as transition targets
51
- and returned in the API response as `step.name`.
52
- */
53
- name: string;
54
- /** Schema property names to collect from the user. Each entry references
55
- a property in the flow's user schema. The engine resolves field type,
56
- validation rules, and implicit outcomes from schema annotations
57
- (e.g. a property with `x-unique` set implies a `user_not_found`
58
- transition outcome).
59
- */
60
- fields?: string[];
61
- /** Actions the user can take. Keyed by action name.
62
- The action name is what the frontend sends back in the submit request.
63
- If omitted, the engine provides a default `submit` action.
64
- */
65
- actions?: {
66
- [key: string]: {
67
- /** Marks this as the default/primary action. The runtime template uses
68
- this hint to choose visual emphasis. At most one action per step
69
- should be primary; this is not enforced here.
70
- */
71
- primary?: boolean;
72
- /** Optional localization key override for the action's label. When
73
- omitted, the engine derives a key from the step and action names.
74
- Display text is resolved client-side from a locale dictionary, never
75
- by the engine.
76
- */
77
- text_key?: string;
78
- };
79
- };
80
- /** Security gates that must be satisfied before submission. Keyed by gate
81
- name. Each gate selects a kind (e.g. "captcha") and provider-specific
82
- configuration. The engine may also inject gates dynamically based on
83
- policy.
84
- */
85
- gates?: {
86
- [key: string]: {
87
- /** The gate category. Only `captcha` is currently defined. Authenticator
88
- ceremonies (e.g. passkey) are modelled as credential auth_attempts via
89
- `x-credential` on a field, not as gates.
90
- */
91
- kind: "captcha";
92
- /** Provider identifier within the gate kind — e.g. `altcha`, `turnstile`,
93
- `hcaptcha`. The engine looks up an implementation in its provider
94
- registry.
95
- */
96
- provider: string;
97
- /** Provider-specific configuration consumed by the implementation when
98
- issuing the per-render challenge. Opaque to the engine.
99
- */
100
- config?: { [key: string]: unknown };
101
- };
102
- };
103
- /** Available SSO identity providers for this step. */
104
- sso_providers?: {
105
- /** Provider instance identifier. */
106
- id: string;
107
- /** Display name for the provider. */
108
- name: string;
109
- /** Template hint for rendering (logo, colors). */
110
- template: string;
111
- }[];
112
- /** Server-side mutation to execute when this step completes successfully.
113
- Runs after field validation passes, before the transition fires.
114
-
115
- - create_user: creates the user record (registration flows)
116
- */
117
- on_success?: "create_user";
118
- /** Marks this as a terminal step. Tells the frontend what to do:
119
- - redirect: navigate to redirect_uri (OIDC/SAML callback done)
120
- - show: render as a success/info screen
121
- */
122
- complete?: "redirect" | "show";
123
- /** Maps action/outcome names to their transition descriptor.
124
-
125
- Keys match action names from the `actions` dict. Additional keys
126
- come from implicit outcomes based on schema annotations
127
- (e.g. `user_not_found` from `x-unique` fields) and engine
128
- events (e.g. `sso`, `callback`).
129
- */
130
- transitions?: {
131
- [key: string]: {
132
- /** Step name within this flow (when `action` is null), or the name
133
- of another flow (when `action` is `switch` or `pivot`).
134
- */
135
- target: string;
136
- /** How to interpret `target`:
137
- - null (omitted): transition to a step in the current flow.
138
- - switch: replace the current flow with the target flow.
139
- No return — the current flow is discarded.
140
- Example: login ↔ register.
141
- - pivot: push the target flow onto the stack. The current flow
142
- is paused and resumes when the target flow completes (auto-pop).
143
- Example: login → recovery → back to login.
144
- */
145
- action?: "switch" | "pivot" | null;
146
- };
147
- };
148
- }[];
149
- } & {
150
11
  /** Unique identifier for the flow definition. */
151
12
  id: string;
152
13
  /** Identifier of the project this flow definition belongs to. */
153
14
  project_id: string;
154
- /** URI of the flow definition schema this definition was authored against.
155
- If the schema_uri was not provided in the request, the flow definition is validated against the latest version of the schema, and the response includes the schema_uri of the latest version.
156
- */
157
- schema_uri: string;
158
15
  /** Status of the flow definition. */
159
16
  status: string;
17
+ /** A flow definition is the server-side configuration that describes a complete
18
+ authentication or identity flow. It is NOT sent to the frontend — the flow
19
+ engine evaluates it and produces FlowResponse payloads (steps with capability
20
+ dictionaries) for the client.
21
+
22
+ Flow definitions are created by administrators and stored in the project/team
23
+ configuration hierarchy. The engine selects the matching definition based on
24
+ the purpose + audience when a flow is created via POST /flow.
25
+ */
26
+ flow_definition: GetFlowDefinition200FlowDefinition;
160
27
  created_at: string;
161
28
  updated_at: string;
162
29
  };
@@ -0,0 +1,58 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+ import type { GetFlowDefinition200FlowDefinitionAudience } from "./getFlowDefinition200FlowDefinitionAudience";
9
+ import type { GetFlowDefinition200FlowDefinitionStepsItem } from "./getFlowDefinition200FlowDefinitionStepsItem";
10
+
11
+ /**
12
+ * A flow definition is the server-side configuration that describes a complete
13
+ authentication or identity flow. It is NOT sent to the frontend — the flow
14
+ engine evaluates it and produces FlowResponse payloads (steps with capability
15
+ dictionaries) for the client.
16
+
17
+ Flow definitions are created by administrators and stored in the project/team
18
+ configuration hierarchy. The engine selects the matching definition based on
19
+ the purpose + audience when a flow is created via POST /flow.
20
+
21
+ */
22
+ export type GetFlowDefinition200FlowDefinition = {
23
+ /**
24
+ * Stable identifier for this flow, used as the target of cross-flow
25
+ `switch` and `pivot` transitions. Renaming is not supported — the
26
+ `name` is part of the public contract another definition may
27
+ reference. Acts as the human display label as well; no separate slug.
28
+
29
+ * @pattern ^[a-z][a-z0-9-]*$
30
+ */
31
+ name: string;
32
+ /** User schema this flow operates on. Step `fields` reference properties
33
+ defined in this schema. The engine resolves field types, validation,
34
+ and implicit outcomes from schema annotations at runtime.
35
+ */
36
+ user_schema: string;
37
+ /** Maps each purpose this definition handles to its entry-point step.
38
+ Keys are purpose names; values must match a `name` in `steps`. A
39
+ definition can serve multiple purposes (e.g. a combined login/register
40
+ flow) by listing one entry per purpose.
41
+ */
42
+ purposes: Partial<
43
+ Record<"login" | "register" | "recovery" | "profiling" | "reauth" | "link_account", string>
44
+ >;
45
+ /** Scopes which teams or apps this flow definition applies to. Empty or
46
+ omitted fields mean "no restriction"; when both are empty the definition
47
+ matches every request in the project. The engine picks the most specific
48
+ matching definition: app > team > project-wide.
49
+ */
50
+ audience?: GetFlowDefinition200FlowDefinitionAudience;
51
+ /**
52
+ * Ordered list of steps in this flow. The order is for human readability —
53
+ actual step sequencing is determined by transitions.
54
+
55
+ * @minItems 1
56
+ */
57
+ steps: GetFlowDefinition200FlowDefinitionStepsItem[];
58
+ };
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Scopes which teams or apps this flow definition applies to. Empty or
11
+ omitted fields mean "no restriction"; when both are empty the definition
12
+ matches every request in the project. The engine picks the most specific
13
+ matching definition: app > team > project-wide.
14
+
15
+ */
16
+ export type GetFlowDefinition200FlowDefinitionAudience = {
17
+ /** Restrict to specific teams (organizations). Empty means no team restriction. */
18
+ team_ids?: string[];
19
+ /** Restrict to specific applications. Empty means no app restriction. */
20
+ app_ids?: string[];
21
+ };
@@ -0,0 +1,71 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+ import type { GetFlowDefinition200FlowDefinitionStepsItemActions } from "./getFlowDefinition200FlowDefinitionStepsItemActions";
9
+ import type { GetFlowDefinition200FlowDefinitionStepsItemComplete } from "./getFlowDefinition200FlowDefinitionStepsItemComplete";
10
+ import type { GetFlowDefinition200FlowDefinitionStepsItemGates } from "./getFlowDefinition200FlowDefinitionStepsItemGates";
11
+ import type { GetFlowDefinition200FlowDefinitionStepsItemOnSuccess } from "./getFlowDefinition200FlowDefinitionStepsItemOnSuccess";
12
+ import type { GetFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem } from "./getFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem";
13
+ import type { GetFlowDefinition200FlowDefinitionStepsItemTransitions } from "./getFlowDefinition200FlowDefinitionStepsItemTransitions";
14
+
15
+ /**
16
+ * A step in a flow definition. This is the admin-authored configuration,
17
+ not the runtime payload sent to the frontend.
18
+
19
+ Steps are schema-driven: `fields` references properties from the flow's
20
+ user schema, and the engine resolves field metadata (type, validation,
21
+ implicit outcomes) from schema annotations at runtime.
22
+
23
+ A step with only `complete` set is a terminal step. All other steps are
24
+ rendered to the frontend as capability payloads.
25
+
26
+ */
27
+ export type GetFlowDefinition200FlowDefinitionStepsItem = {
28
+ /** Unique step identifier within this flow. Used as transition targets
29
+ and returned in the API response as `step.name`.
30
+ */
31
+ name: string;
32
+ /** Schema property names to collect from the user. Each entry references
33
+ a property in the flow's user schema. The engine resolves field type,
34
+ validation rules, and implicit outcomes from schema annotations
35
+ (e.g. a property with `x-unique` set implies a `user_not_found`
36
+ transition outcome).
37
+ */
38
+ fields?: string[];
39
+ /** Actions the user can take. Keyed by action name.
40
+ The action name is what the frontend sends back in the submit request.
41
+ If omitted, the engine provides a default `submit` action.
42
+ */
43
+ actions?: GetFlowDefinition200FlowDefinitionStepsItemActions;
44
+ /** Security gates that must be satisfied before submission. Keyed by gate
45
+ name. Each gate selects a kind (e.g. "captcha") and provider-specific
46
+ configuration. The engine may also inject gates dynamically based on
47
+ policy.
48
+ */
49
+ gates?: GetFlowDefinition200FlowDefinitionStepsItemGates;
50
+ /** Available SSO identity providers for this step. */
51
+ sso_providers?: GetFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem[];
52
+ /** Server-side mutation to execute when this step completes successfully.
53
+ Runs after field validation passes, before the transition fires.
54
+
55
+ - create_user: creates the user record (registration flows)
56
+ */
57
+ on_success?: GetFlowDefinition200FlowDefinitionStepsItemOnSuccess;
58
+ /** Marks this as a terminal step. Tells the frontend what to do:
59
+ - redirect: navigate to redirect_uri (OIDC/SAML callback done)
60
+ - show: render as a success/info screen
61
+ */
62
+ complete?: GetFlowDefinition200FlowDefinitionStepsItemComplete;
63
+ /** Maps action/outcome names to their transition descriptor.
64
+
65
+ Keys match action names from the `actions` dict. Additional keys
66
+ come from implicit outcomes based on schema annotations
67
+ (e.g. `user_not_found` from `x-unique` fields) and engine
68
+ events (e.g. `sso`, `callback`).
69
+ */
70
+ transitions?: GetFlowDefinition200FlowDefinitionStepsItemTransitions;
71
+ };
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Actions the user can take. Keyed by action name.
11
+ The action name is what the frontend sends back in the submit request.
12
+ If omitted, the engine provides a default `submit` action.
13
+
14
+ */
15
+ export type GetFlowDefinition200FlowDefinitionStepsItemActions = {
16
+ [key: string]: {
17
+ /** Marks this as the default/primary action. The runtime template uses
18
+ this hint to choose visual emphasis. At most one action per step
19
+ should be primary; this is not enforced here.
20
+ */
21
+ primary?: boolean;
22
+ /** Optional localization key override for the action's label. When
23
+ omitted, the engine derives a key from the step and action names.
24
+ Display text is resolved client-side from a locale dictionary, never
25
+ by the engine.
26
+ */
27
+ text_key?: string;
28
+ };
29
+ };
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Marks this as a terminal step. Tells the frontend what to do:
11
+ - redirect: navigate to redirect_uri (OIDC/SAML callback done)
12
+ - show: render as a success/info screen
13
+
14
+ */
15
+ export type GetFlowDefinition200FlowDefinitionStepsItemComplete =
16
+ (typeof GetFlowDefinition200FlowDefinitionStepsItemComplete)[keyof typeof GetFlowDefinition200FlowDefinitionStepsItemComplete];
17
+
18
+ export const GetFlowDefinition200FlowDefinitionStepsItemComplete = {
19
+ redirect: "redirect",
20
+ show: "show",
21
+ } as const;
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+ import type { GetFlowDefinition200FlowDefinitionStepsItemGatesConfig } from "./getFlowDefinition200FlowDefinitionStepsItemGatesConfig";
9
+ import type { GetFlowDefinition200FlowDefinitionStepsItemGatesKind } from "./getFlowDefinition200FlowDefinitionStepsItemGatesKind";
10
+
11
+ /**
12
+ * Security gates that must be satisfied before submission. Keyed by gate
13
+ name. Each gate selects a kind (e.g. "captcha") and provider-specific
14
+ configuration. The engine may also inject gates dynamically based on
15
+ policy.
16
+
17
+ */
18
+ export type GetFlowDefinition200FlowDefinitionStepsItemGates = {
19
+ [key: string]: {
20
+ /** The gate category. Only `captcha` is currently defined. Authenticator
21
+ ceremonies (e.g. passkey) are modelled as credential auth_attempts via
22
+ `x-credential` on a field, not as gates.
23
+ */
24
+ kind: GetFlowDefinition200FlowDefinitionStepsItemGatesKind;
25
+ /** Provider identifier within the gate kind — e.g. `altcha`, `turnstile`,
26
+ `hcaptcha`. The engine looks up an implementation in its provider
27
+ registry.
28
+ */
29
+ provider: string;
30
+ /** Provider-specific configuration consumed by the implementation when
31
+ issuing the per-render challenge. Opaque to the engine.
32
+ */
33
+ config?: GetFlowDefinition200FlowDefinitionStepsItemGatesConfig;
34
+ };
35
+ };
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Provider-specific configuration consumed by the implementation when
11
+ issuing the per-render challenge. Opaque to the engine.
12
+
13
+ */
14
+ export type GetFlowDefinition200FlowDefinitionStepsItemGatesConfig = { [key: string]: unknown };
@@ -0,0 +1,20 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * The gate category. Only `captcha` is currently defined. Authenticator
11
+ ceremonies (e.g. passkey) are modelled as credential auth_attempts via
12
+ `x-credential` on a field, not as gates.
13
+
14
+ */
15
+ export type GetFlowDefinition200FlowDefinitionStepsItemGatesKind =
16
+ (typeof GetFlowDefinition200FlowDefinitionStepsItemGatesKind)[keyof typeof GetFlowDefinition200FlowDefinitionStepsItemGatesKind];
17
+
18
+ export const GetFlowDefinition200FlowDefinitionStepsItemGatesKind = {
19
+ captcha: "captcha",
20
+ } as const;
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Server-side mutation to execute when this step completes successfully.
11
+ Runs after field validation passes, before the transition fires.
12
+
13
+ - create_user: creates the user record (registration flows)
14
+
15
+ */
16
+ export type GetFlowDefinition200FlowDefinitionStepsItemOnSuccess =
17
+ (typeof GetFlowDefinition200FlowDefinitionStepsItemOnSuccess)[keyof typeof GetFlowDefinition200FlowDefinitionStepsItemOnSuccess];
18
+
19
+ export const GetFlowDefinition200FlowDefinitionStepsItemOnSuccess = {
20
+ create_user: "create_user",
21
+ } as const;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * An available SSO identity provider.
11
+ */
12
+ export type GetFlowDefinition200FlowDefinitionStepsItemSsoProvidersItem = {
13
+ /** Provider instance identifier. */
14
+ id: string;
15
+ /** Display name for the provider. */
16
+ name: string;
17
+ /** Template hint for rendering (logo, colors). */
18
+ template: string;
19
+ };
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * Maps action/outcome names to their transition descriptor.
11
+
12
+ Keys match action names from the `actions` dict. Additional keys
13
+ come from implicit outcomes based on schema annotations
14
+ (e.g. `user_not_found` from `x-unique` fields) and engine
15
+ events (e.g. `sso`, `callback`).
16
+
17
+ */
18
+ export type GetFlowDefinition200FlowDefinitionStepsItemTransitions = {
19
+ [key: string]: {
20
+ /** Step name within this flow (when `action` is null), or the name
21
+ of another flow (when `action` is `switch` or `pivot`).
22
+ */
23
+ target: string;
24
+ /** How to interpret `target`:
25
+ - null (omitted): transition to a step in the current flow.
26
+ - switch: replace the current flow with the target flow.
27
+ No return — the current flow is discarded.
28
+ Example: login ↔ register.
29
+ - pivot: push the target flow onto the stack. The current flow
30
+ is paused and resumes when the target flow completes (auto-pop).
31
+ Example: login → recovery → back to login.
32
+ */
33
+ action?: "switch" | "pivot" | null;
34
+ };
35
+ };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ export type GetFlowDefinitionParams = {
10
+ /**
11
+ * The project id to filter by.
12
+ * @pattern ^[a-zA-Z0-9_-]+$
13
+ */
14
+ project_id: string;
15
+ };
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ export type GetMyUser200 = { [key: string]: unknown };
@@ -5,16 +5,16 @@
5
5
  * This is the next generation of the Zitadel identity platform.
6
6
  * OpenAPI spec version: 0.0.1
7
7
  */
8
- import type { GetFlowDefinition404Details } from "./getFlowDefinition404Details";
8
+ import type { GetMyUser401Details } from "./getMyUser401Details";
9
9
 
10
10
  /**
11
11
  * Standard error payload returned for failed API requests.
12
12
  */
13
- export type GetFlowDefinition404 = {
13
+ export type GetMyUser401 = {
14
14
  /** Stable machine-readable error code. */
15
15
  code: string;
16
16
  /** Human-readable explanation of the error. */
17
17
  message: string;
18
18
  /** Additional error-specific context. */
19
- details?: GetFlowDefinition404Details;
19
+ details?: GetMyUser401Details;
20
20
  };
@@ -9,4 +9,4 @@
9
9
  /**
10
10
  * Additional error-specific context.
11
11
  */
12
- export type GetFlowDefinition404Details = { [key: string]: unknown };
12
+ export type GetMyUser401Details = { [key: string]: unknown };
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Generated by orval v8.10.0 🍺
3
+ * Do not edit manually.
4
+ * Zitadel NextGen
5
+ * This is the next generation of the Zitadel identity platform.
6
+ * OpenAPI spec version: 0.0.1
7
+ */
8
+
9
+ /**
10
+ * User not found
11
+
12
+ Error code: user.not_found
13
+
14
+ */
15
+ export type GetMyUser404 = {
16
+ /** Stable machine-readable error code. */
17
+ code: string;
18
+ /** Human-readable explanation of the error. */
19
+ message: string;
20
+ /** Additional error-specific context. */
21
+ details?: { [key: string]: unknown };
22
+ } & {
23
+ code: "user.not_found";
24
+ };
@@ -5,16 +5,16 @@
5
5
  * This is the next generation of the Zitadel identity platform.
6
6
  * OpenAPI spec version: 0.0.1
7
7
  */
8
- import type { DeleteFlowDefinition404Details } from "./deleteFlowDefinition404Details";
8
+ import type { GetMyUserDefaultDetails } from "./getMyUserDefaultDetails";
9
9
 
10
10
  /**
11
11
  * Standard error payload returned for failed API requests.
12
12
  */
13
- export type DeleteFlowDefinition404 = {
13
+ export type GetMyUserDefault = {
14
14
  /** Stable machine-readable error code. */
15
15
  code: string;
16
16
  /** Human-readable explanation of the error. */
17
17
  message: string;
18
18
  /** Additional error-specific context. */
19
- details?: DeleteFlowDefinition404Details;
19
+ details?: GetMyUserDefaultDetails;
20
20
  };
@@ -9,4 +9,4 @@
9
9
  /**
10
10
  * Additional error-specific context.
11
11
  */
12
- export type DeleteFlowDefinition404Details = { [key: string]: unknown };
12
+ export type GetMyUserDefaultDetails = { [key: string]: unknown };