@zitadel/api 0.1.0-alpha.11 → 0.1.0-alpha.13
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.
- package/dist/generated/endpoints/zitadelNextGen.d.mts +2 -2
- package/dist/generated/endpoints/zitadelNextGen.mjs +55 -5
- package/dist/generated/endpoints/zitadelNextGen.mjs.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.msw.d.mts +5 -3
- package/dist/generated/endpoints/zitadelNextGen.msw.d.mts.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.msw.mjs +65 -21
- package/dist/generated/endpoints/zitadelNextGen.msw.mjs.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.zod.d.mts +151 -51
- package/dist/generated/endpoints/zitadelNextGen.zod.d.mts.map +1 -1
- package/dist/generated/endpoints/zitadelNextGen.zod.mjs +127 -52
- package/dist/generated/endpoints/zitadelNextGen.zod.mjs.map +1 -1
- package/dist/generated/model/index.d.mts +2 -2
- package/dist/generated/model/index.mjs +140 -11
- package/dist/generated/model/index.mjs.map +1 -1
- package/dist/{index-BGnjxx-b.d.mts → index-DLJ0vloQ.d.mts} +819 -77
- package/dist/index-DLJ0vloQ.d.mts.map +1 -0
- package/dist/runtime/api-factory.d.mts +1 -1
- package/dist/{zitadelNextGen-D1t6bmpx.d.mts → zitadelNextGen-CVTkhQJe.d.mts} +29 -7
- package/dist/zitadelNextGen-CVTkhQJe.d.mts.map +1 -0
- package/package.json +1 -1
- package/src/generated/endpoints/zitadelNextGen.msw.ts +92 -10
- package/src/generated/endpoints/zitadelNextGen.ts +81 -4
- package/src/generated/endpoints/zitadelNextGen.zod.ts +456 -325
- package/src/generated/model/activateFlowDefinition400.ts +20 -0
- package/src/generated/model/activateFlowDefinition400Details.ts +12 -0
- package/src/generated/model/activateFlowDefinitionDefault.ts +20 -0
- package/src/generated/model/activateFlowDefinitionDefaultDetails.ts +12 -0
- package/src/generated/model/activateFlowDefinitionParams.ts +15 -0
- package/src/generated/model/createFlow201StepActionsItem.ts +15 -1
- package/src/generated/model/createFlow201StepActionsItemKind.ts +31 -0
- package/src/generated/model/createFlow201StepChallengeMethod.ts +1 -0
- package/src/generated/model/createFlowBody.ts +5 -0
- package/src/generated/model/createFlowDefinition201.ts +0 -2
- package/src/generated/model/createFlowDefinition201FlowDefinition.ts +11 -0
- package/src/generated/model/createFlowDefinition201FlowDefinitionStatus.ts +26 -0
- package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemActionsItem.ts +15 -1
- package/src/generated/model/createFlowDefinition201FlowDefinitionStepsItemActionsItemKind.ts +31 -0
- package/src/generated/model/createFlowDefinitionBody.ts +6 -0
- package/src/generated/model/createFlowDefinitionBodyFlowDefinition.ts +11 -0
- package/src/generated/model/createFlowDefinitionBodyFlowDefinitionStatus.ts +26 -0
- package/src/generated/model/createFlowDefinitionBodyFlowDefinitionStepsItemActionsItem.ts +15 -1
- package/src/generated/model/createFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind.ts +31 -0
- package/src/generated/model/deactivateFlowDefinition400.ts +20 -0
- package/src/generated/model/deactivateFlowDefinition400Details.ts +12 -0
- package/src/generated/model/deactivateFlowDefinition409.ts +20 -0
- package/src/generated/model/deactivateFlowDefinition409Details.ts +12 -0
- package/src/generated/model/deactivateFlowDefinitionDefault.ts +20 -0
- package/src/generated/model/deactivateFlowDefinitionDefaultDetails.ts +12 -0
- package/src/generated/model/deactivateFlowDefinitionParams.ts +15 -0
- package/src/generated/model/deleteFlowDefinition409.ts +20 -0
- package/src/generated/model/deleteFlowDefinition409Details.ts +12 -0
- package/src/generated/model/getFlowDefinition200.ts +0 -2
- package/src/generated/model/getFlowDefinition200FlowDefinition.ts +11 -0
- package/src/generated/model/getFlowDefinition200FlowDefinitionStatus.ts +26 -0
- package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemActionsItem.ts +15 -1
- package/src/generated/model/getFlowDefinition200FlowDefinitionStepsItemActionsItemKind.ts +31 -0
- package/src/generated/model/getFlowStep200StepActionsItem.ts +15 -1
- package/src/generated/model/getFlowStep200StepActionsItemKind.ts +31 -0
- package/src/generated/model/getFlowStep200StepChallengeMethod.ts +1 -0
- package/src/generated/model/index.ts +40 -10
- package/src/generated/model/listFlowDefinitions200FlowDefinitionsItem.ts +11 -2
- package/src/generated/model/listFlowDefinitions200FlowDefinitionsItemStatus.ts +26 -0
- package/src/generated/model/submitFlowStep200StepActionsItem.ts +15 -1
- package/src/generated/model/submitFlowStep200StepActionsItemKind.ts +31 -0
- package/src/generated/model/submitFlowStep200StepChallengeMethod.ts +1 -0
- package/src/generated/model/submitFlowStep400StepActionsItem.ts +15 -1
- package/src/generated/model/submitFlowStep400StepActionsItemKind.ts +31 -0
- package/src/generated/model/submitFlowStep400StepChallengeMethod.ts +1 -0
- package/src/generated/model/updateFlowDefinition200.ts +0 -2
- package/src/generated/model/updateFlowDefinition200FlowDefinition.ts +11 -0
- package/src/generated/model/updateFlowDefinition200FlowDefinitionStatus.ts +26 -0
- package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemActionsItem.ts +15 -1
- package/src/generated/model/updateFlowDefinition200FlowDefinitionStepsItemActionsItemKind.ts +31 -0
- package/src/generated/model/updateFlowDefinitionBody.ts +15 -30
- package/src/generated/model/updateFlowDefinitionBodyFlowDefinition.ts +69 -0
- package/src/generated/model/{updateFlowDefinitionBodyAudience.ts → updateFlowDefinitionBodyFlowDefinitionAudience.ts} +1 -1
- package/src/generated/model/updateFlowDefinitionBodyFlowDefinitionStatus.ts +26 -0
- package/src/generated/model/{updateFlowDefinitionBodyStepsItem.ts → updateFlowDefinitionBodyFlowDefinitionStepsItem.ts} +13 -13
- package/src/generated/model/updateFlowDefinitionBodyFlowDefinitionStepsItemActionsItem.ts +42 -0
- package/src/generated/model/updateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind.ts +31 -0
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemComplete.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemComplete.ts} +3 -3
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemGates.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemGates.ts} +5 -5
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemGatesConfig.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemGatesConfig.ts} +1 -1
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemGatesKind.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemGatesKind.ts} +3 -3
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemOnSuccess.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemOnSuccess.ts} +3 -3
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemSsoProvidersItem.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemSsoProvidersItem.ts} +1 -1
- package/src/generated/model/{updateFlowDefinitionBodyStepsItemTransitions.ts → updateFlowDefinitionBodyFlowDefinitionStepsItemTransitions.ts} +1 -1
- package/dist/index-BGnjxx-b.d.mts.map +0 -1
- package/dist/zitadelNextGen-D1t6bmpx.d.mts.map +0 -1
- package/src/generated/model/updateFlowDefinitionBodyStepsItemActionsItem.ts +0 -28
|
@@ -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
|
+
import type { ActivateFlowDefinition400Details } from "./activateFlowDefinition400Details";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type ActivateFlowDefinition400 = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: ActivateFlowDefinition400Details;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type ActivateFlowDefinition400Details = { [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
|
+
import type { ActivateFlowDefinitionDefaultDetails } from "./activateFlowDefinitionDefaultDetails";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type ActivateFlowDefinitionDefault = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: ActivateFlowDefinitionDefaultDetails;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type ActivateFlowDefinitionDefaultDetails = { [key: string]: unknown };
|
|
@@ -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 ActivateFlowDefinitionParams = {
|
|
10
|
+
/**
|
|
11
|
+
* The unique identifier of the project
|
|
12
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
13
|
+
*/
|
|
14
|
+
project_id: string;
|
|
15
|
+
};
|
|
@@ -5,15 +5,29 @@
|
|
|
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 { CreateFlow201StepActionsItemKind } from "./createFlow201StepActionsItemKind";
|
|
8
9
|
|
|
9
10
|
/**
|
|
10
11
|
* Configuration for a user-invokable action on a step. The `name` is sent
|
|
11
|
-
back in the submit request as `action
|
|
12
|
+
back in the submit request as `action`; the engine resolves the action's
|
|
13
|
+
declared `kind` to decide how to handle the submission.
|
|
12
14
|
|
|
13
15
|
*/
|
|
14
16
|
export type CreateFlow201StepActionsItem = {
|
|
15
17
|
/** Action identifier. Sent back in the submit request as `action`. */
|
|
16
18
|
name: string;
|
|
19
|
+
/** Classifies how the engine handles this action:
|
|
20
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
21
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
22
|
+
fires once the returned assertion verifies.
|
|
23
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
24
|
+
transition fires once the returned attestation verifies.
|
|
25
|
+
- `navigate`: route through the transition without running the input
|
|
26
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
27
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
28
|
+
when going back is available.
|
|
29
|
+
*/
|
|
30
|
+
kind: CreateFlow201StepActionsItemKind;
|
|
17
31
|
/** Marks this as the default/primary action. The runtime template uses
|
|
18
32
|
this hint to choose visual emphasis. At most one action per step
|
|
19
33
|
should be primary; this is not enforced here.
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
* Classifies how the engine handles this action:
|
|
11
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
12
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
13
|
+
fires once the returned assertion verifies.
|
|
14
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
15
|
+
transition fires once the returned attestation verifies.
|
|
16
|
+
- `navigate`: route through the transition without running the input
|
|
17
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
18
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
19
|
+
when going back is available.
|
|
20
|
+
|
|
21
|
+
*/
|
|
22
|
+
export type CreateFlow201StepActionsItemKind =
|
|
23
|
+
(typeof CreateFlow201StepActionsItemKind)[keyof typeof CreateFlow201StepActionsItemKind];
|
|
24
|
+
|
|
25
|
+
export const CreateFlow201StepActionsItemKind = {
|
|
26
|
+
submit: "submit",
|
|
27
|
+
passkey: "passkey",
|
|
28
|
+
passkey_register: "passkey_register",
|
|
29
|
+
navigate: "navigate",
|
|
30
|
+
back: "back",
|
|
31
|
+
} as const;
|
|
@@ -20,6 +20,11 @@ export type CreateFlowBody = {
|
|
|
20
20
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
21
21
|
*/
|
|
22
22
|
flow_definition_name?: string;
|
|
23
|
+
/** Set to true to simulate the flow without actually creating any
|
|
24
|
+
user or session. Useful for testing and validation of flow definitions.
|
|
25
|
+
This requires setting the `flow_definition_name` property as well.
|
|
26
|
+
*/
|
|
27
|
+
dry_run?: boolean;
|
|
23
28
|
/**
|
|
24
29
|
* Semver version of the flow definition JSON Schema to use.
|
|
25
30
|
When omitted, the latest version is used.
|
|
@@ -12,8 +12,6 @@ export type CreateFlowDefinition201 = {
|
|
|
12
12
|
id: string;
|
|
13
13
|
/** Identifier of the project this flow definition belongs to. */
|
|
14
14
|
project_id: string;
|
|
15
|
-
/** Status of the flow definition. */
|
|
16
|
-
status: string;
|
|
17
15
|
/** A flow definition is the server-side configuration that describes a complete
|
|
18
16
|
authentication or identity flow. It is NOT sent to the frontend — the flow
|
|
19
17
|
engine evaluates it and produces FlowResponse payloads (steps with capability
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* OpenAPI spec version: 0.0.1
|
|
7
7
|
*/
|
|
8
8
|
import type { CreateFlowDefinition201FlowDefinitionAudience } from "./createFlowDefinition201FlowDefinitionAudience";
|
|
9
|
+
import type { CreateFlowDefinition201FlowDefinitionStatus } from "./createFlowDefinition201FlowDefinitionStatus";
|
|
9
10
|
import type { CreateFlowDefinition201FlowDefinitionStepsItem } from "./createFlowDefinition201FlowDefinitionStepsItem";
|
|
10
11
|
|
|
11
12
|
/**
|
|
@@ -29,6 +30,16 @@ export type CreateFlowDefinition201FlowDefinition = {
|
|
|
29
30
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
30
31
|
*/
|
|
31
32
|
name: string;
|
|
33
|
+
/** The lifecycle state of this flow definition.
|
|
34
|
+
|
|
35
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
36
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
37
|
+
|
|
38
|
+
Allowed transitions:
|
|
39
|
+
- draft -> active: To activate the flow definition.
|
|
40
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
41
|
+
*/
|
|
42
|
+
status: CreateFlowDefinition201FlowDefinitionStatus;
|
|
32
43
|
/** User schema this flow operates on. Step `fields` reference properties
|
|
33
44
|
defined in this schema. The engine resolves field types, validation,
|
|
34
45
|
and implicit outcomes from schema annotations at runtime.
|
|
@@ -0,0 +1,26 @@
|
|
|
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 lifecycle state of this flow definition.
|
|
11
|
+
|
|
12
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
13
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
14
|
+
|
|
15
|
+
Allowed transitions:
|
|
16
|
+
- draft -> active: To activate the flow definition.
|
|
17
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
18
|
+
|
|
19
|
+
*/
|
|
20
|
+
export type CreateFlowDefinition201FlowDefinitionStatus =
|
|
21
|
+
(typeof CreateFlowDefinition201FlowDefinitionStatus)[keyof typeof CreateFlowDefinition201FlowDefinitionStatus];
|
|
22
|
+
|
|
23
|
+
export const CreateFlowDefinition201FlowDefinitionStatus = {
|
|
24
|
+
active: "active",
|
|
25
|
+
draft: "draft",
|
|
26
|
+
} as const;
|
|
@@ -5,15 +5,29 @@
|
|
|
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 { CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind } from "./createFlowDefinition201FlowDefinitionStepsItemActionsItemKind";
|
|
8
9
|
|
|
9
10
|
/**
|
|
10
11
|
* Configuration for a user-invokable action on a step. The `name` is sent
|
|
11
|
-
back in the submit request as `action
|
|
12
|
+
back in the submit request as `action`; the engine resolves the action's
|
|
13
|
+
declared `kind` to decide how to handle the submission.
|
|
12
14
|
|
|
13
15
|
*/
|
|
14
16
|
export type CreateFlowDefinition201FlowDefinitionStepsItemActionsItem = {
|
|
15
17
|
/** Action identifier. Sent back in the submit request as `action`. */
|
|
16
18
|
name: string;
|
|
19
|
+
/** Classifies how the engine handles this action:
|
|
20
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
21
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
22
|
+
fires once the returned assertion verifies.
|
|
23
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
24
|
+
transition fires once the returned attestation verifies.
|
|
25
|
+
- `navigate`: route through the transition without running the input
|
|
26
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
27
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
28
|
+
when going back is available.
|
|
29
|
+
*/
|
|
30
|
+
kind: CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind;
|
|
17
31
|
/** Marks this as the default/primary action. The runtime template uses
|
|
18
32
|
this hint to choose visual emphasis. At most one action per step
|
|
19
33
|
should be primary; this is not enforced here.
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
* Classifies how the engine handles this action:
|
|
11
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
12
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
13
|
+
fires once the returned assertion verifies.
|
|
14
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
15
|
+
transition fires once the returned attestation verifies.
|
|
16
|
+
- `navigate`: route through the transition without running the input
|
|
17
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
18
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
19
|
+
when going back is available.
|
|
20
|
+
|
|
21
|
+
*/
|
|
22
|
+
export type CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind =
|
|
23
|
+
(typeof CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind)[keyof typeof CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind];
|
|
24
|
+
|
|
25
|
+
export const CreateFlowDefinition201FlowDefinitionStepsItemActionsItemKind = {
|
|
26
|
+
submit: "submit",
|
|
27
|
+
passkey: "passkey",
|
|
28
|
+
passkey_register: "passkey_register",
|
|
29
|
+
navigate: "navigate",
|
|
30
|
+
back: "back",
|
|
31
|
+
} as const;
|
|
@@ -7,6 +7,12 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import type { CreateFlowDefinitionBodyFlowDefinition } from "./createFlowDefinitionBodyFlowDefinition";
|
|
9
9
|
|
|
10
|
+
/**
|
|
11
|
+
* Creates a flow definition.
|
|
12
|
+
The flow definition is created in an `active` state by default.
|
|
13
|
+
The status can also be set via the `status` attribute in the flow definition payload.
|
|
14
|
+
|
|
15
|
+
*/
|
|
10
16
|
export type CreateFlowDefinitionBody = {
|
|
11
17
|
/** @pattern ^[a-zA-Z0-9_-]+$ */
|
|
12
18
|
project_id: string;
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* OpenAPI spec version: 0.0.1
|
|
7
7
|
*/
|
|
8
8
|
import type { CreateFlowDefinitionBodyFlowDefinitionAudience } from "./createFlowDefinitionBodyFlowDefinitionAudience";
|
|
9
|
+
import type { CreateFlowDefinitionBodyFlowDefinitionStatus } from "./createFlowDefinitionBodyFlowDefinitionStatus";
|
|
9
10
|
import type { CreateFlowDefinitionBodyFlowDefinitionStepsItem } from "./createFlowDefinitionBodyFlowDefinitionStepsItem";
|
|
10
11
|
|
|
11
12
|
/**
|
|
@@ -29,6 +30,16 @@ export type CreateFlowDefinitionBodyFlowDefinition = {
|
|
|
29
30
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
30
31
|
*/
|
|
31
32
|
name: string;
|
|
33
|
+
/** The lifecycle state of this flow definition.
|
|
34
|
+
|
|
35
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
36
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
37
|
+
|
|
38
|
+
Allowed transitions:
|
|
39
|
+
- draft -> active: To activate the flow definition.
|
|
40
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
41
|
+
*/
|
|
42
|
+
status: CreateFlowDefinitionBodyFlowDefinitionStatus;
|
|
32
43
|
/** User schema this flow operates on. Step `fields` reference properties
|
|
33
44
|
defined in this schema. The engine resolves field types, validation,
|
|
34
45
|
and implicit outcomes from schema annotations at runtime.
|
|
@@ -0,0 +1,26 @@
|
|
|
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 lifecycle state of this flow definition.
|
|
11
|
+
|
|
12
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
13
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
14
|
+
|
|
15
|
+
Allowed transitions:
|
|
16
|
+
- draft -> active: To activate the flow definition.
|
|
17
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
18
|
+
|
|
19
|
+
*/
|
|
20
|
+
export type CreateFlowDefinitionBodyFlowDefinitionStatus =
|
|
21
|
+
(typeof CreateFlowDefinitionBodyFlowDefinitionStatus)[keyof typeof CreateFlowDefinitionBodyFlowDefinitionStatus];
|
|
22
|
+
|
|
23
|
+
export const CreateFlowDefinitionBodyFlowDefinitionStatus = {
|
|
24
|
+
active: "active",
|
|
25
|
+
draft: "draft",
|
|
26
|
+
} as const;
|
|
@@ -5,15 +5,29 @@
|
|
|
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 { CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind } from "./createFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind";
|
|
8
9
|
|
|
9
10
|
/**
|
|
10
11
|
* Configuration for a user-invokable action on a step. The `name` is sent
|
|
11
|
-
back in the submit request as `action
|
|
12
|
+
back in the submit request as `action`; the engine resolves the action's
|
|
13
|
+
declared `kind` to decide how to handle the submission.
|
|
12
14
|
|
|
13
15
|
*/
|
|
14
16
|
export type CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItem = {
|
|
15
17
|
/** Action identifier. Sent back in the submit request as `action`. */
|
|
16
18
|
name: string;
|
|
19
|
+
/** Classifies how the engine handles this action:
|
|
20
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
21
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
22
|
+
fires once the returned assertion verifies.
|
|
23
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
24
|
+
transition fires once the returned attestation verifies.
|
|
25
|
+
- `navigate`: route through the transition without running the input
|
|
26
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
27
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
28
|
+
when going back is available.
|
|
29
|
+
*/
|
|
30
|
+
kind: CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind;
|
|
17
31
|
/** Marks this as the default/primary action. The runtime template uses
|
|
18
32
|
this hint to choose visual emphasis. At most one action per step
|
|
19
33
|
should be primary; this is not enforced here.
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
* Classifies how the engine handles this action:
|
|
11
|
+
- `submit`: collect the step's fields and run validate/dispatch/on_success.
|
|
12
|
+
- `passkey`: issue a WebAuthn assertion challenge; the matching transition
|
|
13
|
+
fires once the returned assertion verifies.
|
|
14
|
+
- `passkey_register`: issue a WebAuthn registration challenge; the matching
|
|
15
|
+
transition fires once the returned attestation verifies.
|
|
16
|
+
- `navigate`: route through the transition without running the input
|
|
17
|
+
pipeline. Used for pure-routing actions declared in the flow definition.
|
|
18
|
+
- `back`: return the user to the previous step. Surfaced by the engine
|
|
19
|
+
when going back is available.
|
|
20
|
+
|
|
21
|
+
*/
|
|
22
|
+
export type CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind =
|
|
23
|
+
(typeof CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind)[keyof typeof CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind];
|
|
24
|
+
|
|
25
|
+
export const CreateFlowDefinitionBodyFlowDefinitionStepsItemActionsItemKind = {
|
|
26
|
+
submit: "submit",
|
|
27
|
+
passkey: "passkey",
|
|
28
|
+
passkey_register: "passkey_register",
|
|
29
|
+
navigate: "navigate",
|
|
30
|
+
back: "back",
|
|
31
|
+
} as const;
|
|
@@ -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
|
+
import type { DeactivateFlowDefinition400Details } from "./deactivateFlowDefinition400Details";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type DeactivateFlowDefinition400 = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: DeactivateFlowDefinition400Details;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type DeactivateFlowDefinition400Details = { [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
|
+
import type { DeactivateFlowDefinition409Details } from "./deactivateFlowDefinition409Details";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type DeactivateFlowDefinition409 = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: DeactivateFlowDefinition409Details;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type DeactivateFlowDefinition409Details = { [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
|
+
import type { DeactivateFlowDefinitionDefaultDetails } from "./deactivateFlowDefinitionDefaultDetails";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type DeactivateFlowDefinitionDefault = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: DeactivateFlowDefinitionDefaultDetails;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type DeactivateFlowDefinitionDefaultDetails = { [key: string]: unknown };
|
|
@@ -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 DeactivateFlowDefinitionParams = {
|
|
10
|
+
/**
|
|
11
|
+
* The unique identifier of the project
|
|
12
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
13
|
+
*/
|
|
14
|
+
project_id: string;
|
|
15
|
+
};
|
|
@@ -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
|
+
import type { DeleteFlowDefinition409Details } from "./deleteFlowDefinition409Details";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Standard error payload returned for failed API requests.
|
|
12
|
+
*/
|
|
13
|
+
export type DeleteFlowDefinition409 = {
|
|
14
|
+
/** Stable machine-readable error code. */
|
|
15
|
+
code: string;
|
|
16
|
+
/** Human-readable explanation of the error. */
|
|
17
|
+
message: string;
|
|
18
|
+
/** Additional error-specific context. */
|
|
19
|
+
details?: DeleteFlowDefinition409Details;
|
|
20
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
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
|
+
* Additional error-specific context.
|
|
11
|
+
*/
|
|
12
|
+
export type DeleteFlowDefinition409Details = { [key: string]: unknown };
|
|
@@ -12,8 +12,6 @@ export type GetFlowDefinition200 = {
|
|
|
12
12
|
id: string;
|
|
13
13
|
/** Identifier of the project this flow definition belongs to. */
|
|
14
14
|
project_id: string;
|
|
15
|
-
/** Status of the flow definition. */
|
|
16
|
-
status: string;
|
|
17
15
|
/** A flow definition is the server-side configuration that describes a complete
|
|
18
16
|
authentication or identity flow. It is NOT sent to the frontend — the flow
|
|
19
17
|
engine evaluates it and produces FlowResponse payloads (steps with capability
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* OpenAPI spec version: 0.0.1
|
|
7
7
|
*/
|
|
8
8
|
import type { GetFlowDefinition200FlowDefinitionAudience } from "./getFlowDefinition200FlowDefinitionAudience";
|
|
9
|
+
import type { GetFlowDefinition200FlowDefinitionStatus } from "./getFlowDefinition200FlowDefinitionStatus";
|
|
9
10
|
import type { GetFlowDefinition200FlowDefinitionStepsItem } from "./getFlowDefinition200FlowDefinitionStepsItem";
|
|
10
11
|
|
|
11
12
|
/**
|
|
@@ -29,6 +30,16 @@ export type GetFlowDefinition200FlowDefinition = {
|
|
|
29
30
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
30
31
|
*/
|
|
31
32
|
name: string;
|
|
33
|
+
/** The lifecycle state of this flow definition.
|
|
34
|
+
|
|
35
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
36
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
37
|
+
|
|
38
|
+
Allowed transitions:
|
|
39
|
+
- draft -> active: To activate the flow definition.
|
|
40
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
41
|
+
*/
|
|
42
|
+
status: GetFlowDefinition200FlowDefinitionStatus;
|
|
32
43
|
/** User schema this flow operates on. Step `fields` reference properties
|
|
33
44
|
defined in this schema. The engine resolves field types, validation,
|
|
34
45
|
and implicit outcomes from schema annotations at runtime.
|
|
@@ -0,0 +1,26 @@
|
|
|
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 lifecycle state of this flow definition.
|
|
11
|
+
|
|
12
|
+
active: The flow definition is ready to be used. The flow engine can select it for new flows.
|
|
13
|
+
draft: The engine will not select it for new flows, and existing flows must handle it gracefully if they reference this definition.
|
|
14
|
+
|
|
15
|
+
Allowed transitions:
|
|
16
|
+
- draft -> active: To activate the flow definition.
|
|
17
|
+
- active -> draft: To remove the flow definition from active use immediately.
|
|
18
|
+
|
|
19
|
+
*/
|
|
20
|
+
export type GetFlowDefinition200FlowDefinitionStatus =
|
|
21
|
+
(typeof GetFlowDefinition200FlowDefinitionStatus)[keyof typeof GetFlowDefinition200FlowDefinitionStatus];
|
|
22
|
+
|
|
23
|
+
export const GetFlowDefinition200FlowDefinitionStatus = {
|
|
24
|
+
active: "active",
|
|
25
|
+
draft: "draft",
|
|
26
|
+
} as const;
|