@zitadel/components 1.0.0-alpha.20 → 1.0.0-alpha.22
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/atoms/index.d.mts +1 -1
- package/dist/atoms/index.mjs +1 -1
- package/dist/{atoms-DSxjEHca.mjs → atoms-Boaxh79f.mjs} +2 -2
- package/dist/atoms-Boaxh79f.mjs.map +1 -0
- package/dist/{index-CaScNIBy.d.mts → index-BaS893QZ.d.mts} +60 -18
- package/dist/index-BaS893QZ.d.mts.map +1 -0
- package/dist/{index-BPgWdWx7.d.mts → index-DMPCvLh_.d.mts} +1421 -126
- package/dist/index-DMPCvLh_.d.mts.map +1 -0
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +2 -2
- package/dist/manifests.mjs +1 -1
- package/dist/orchestrator/index.d.mts +1 -1
- package/dist/orchestrator/index.mjs +1 -1
- package/dist/{orchestrator-ixQm2RIC.mjs → orchestrator-BPX0Uc77.mjs} +171 -68
- package/dist/orchestrator-BPX0Uc77.mjs.map +1 -0
- package/dist/standalone.mjs +171 -68
- package/package.json +3 -3
- package/dist/atoms-DSxjEHca.mjs.map +0 -1
- package/dist/index-BPgWdWx7.d.mts.map +0 -1
- package/dist/index-CaScNIBy.d.mts.map +0 -1
- package/dist/orchestrator-ixQm2RIC.mjs.map +0 -1
|
@@ -334,7 +334,7 @@ declare global {
|
|
|
334
334
|
}
|
|
335
335
|
} //# sourceMappingURL=zl-checkbox.d.ts.map
|
|
336
336
|
//#endregion
|
|
337
|
-
//#region ../api/dist/index-
|
|
337
|
+
//#region ../api/dist/index-DtExHu2p.d.mts
|
|
338
338
|
//#region src/generated/model/beginUserPasskeyRegistration201Options.d.ts
|
|
339
339
|
/**
|
|
340
340
|
* Generated by orval v8.10.0 🍺
|
|
@@ -1862,9 +1862,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
1862
1862
|
type CreateFlowDefinition201FlowDefinition = {
|
|
1863
1863
|
/**
|
|
1864
1864
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
1865
|
-
`switch` and `pivot` transitions.
|
|
1866
|
-
`name
|
|
1867
|
-
|
|
1865
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
1866
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
1867
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
1868
|
+
of the public contract another definition may reference. Acts as the
|
|
1869
|
+
human display label as well; no separate slug.
|
|
1868
1870
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
1869
1871
|
*/
|
|
1870
1872
|
name: string;
|
|
@@ -2361,9 +2363,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
2361
2363
|
type CreateFlowDefinitionBodyFlowDefinition = {
|
|
2362
2364
|
/**
|
|
2363
2365
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
2364
|
-
`switch` and `pivot` transitions.
|
|
2365
|
-
`name
|
|
2366
|
-
|
|
2366
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
2367
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
2368
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
2369
|
+
of the public contract another definition may reference. Acts as the
|
|
2370
|
+
human display label as well; no separate slug.
|
|
2367
2371
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
2368
2372
|
*/
|
|
2369
2373
|
name: string;
|
|
@@ -2449,6 +2453,131 @@ type CreateGrant201ObjectType = (typeof CreateGrant201ObjectType)[keyof typeof C
|
|
|
2449
2453
|
declare const CreateGrant201ObjectType: {
|
|
2450
2454
|
readonly project: "project";
|
|
2451
2455
|
}; //#endregion
|
|
2456
|
+
//#region src/generated/model/createGrant201Principal.d.ts
|
|
2457
|
+
/**
|
|
2458
|
+
* Generated by orval v8.10.0 🍺
|
|
2459
|
+
* Do not edit manually.
|
|
2460
|
+
* Zitadel NextGen
|
|
2461
|
+
* This is the next generation of the Zitadel identity platform.
|
|
2462
|
+
* OpenAPI spec version: 0.0.1
|
|
2463
|
+
*/
|
|
2464
|
+
/**
|
|
2465
|
+
* The principal named by `principal_id`, present only when the request
|
|
2466
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
2467
|
+
was not requested; `null` means the principal cannot be loaded
|
|
2468
|
+
(deleted or missing). GET and create never set this field.
|
|
2469
|
+
|
|
2470
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
2471
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
2472
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
2473
|
+
`principal_type`.
|
|
2474
|
+
|
|
2475
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
2476
|
+
Both are checked on the whole request before the list.
|
|
2477
|
+
|
|
2478
|
+
*/
|
|
2479
|
+
type CreateGrant201Principal = {
|
|
2480
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */id: string;
|
|
2481
|
+
/** The schema that defines the content of `attributes`. These schemas can be
|
|
2482
|
+
created using the `/schemas` endpoint. A default schema is provided.
|
|
2483
|
+
This schema can be retrieved using the same endpoint.
|
|
2484
|
+
*/
|
|
2485
|
+
schema: string;
|
|
2486
|
+
/** The user's content, satisfying the schema named by `schema`. Property
|
|
2487
|
+
names and types are determined entirely by that schema.
|
|
2488
|
+
*/
|
|
2489
|
+
attributes: {
|
|
2490
|
+
[key: string]: unknown;
|
|
2491
|
+
};
|
|
2492
|
+
metadata: {
|
|
2493
|
+
/** The time when the user was created. */created_at: string; /** The time when the user was last updated. */
|
|
2494
|
+
updated_at: string; /** The status of the user. */
|
|
2495
|
+
status: "active" | "suspended" | "deactivated" | "pending_purge";
|
|
2496
|
+
/** The team that owns this user's identity lifecycle, or `null` when the
|
|
2497
|
+
user is self-owned. This is a single team and a different concept from
|
|
2498
|
+
the user's team memberships: it decides who may deprovision the user, not
|
|
2499
|
+
which teams the user collaborates in. Memberships are their own paginated
|
|
2500
|
+
resource — `GET /users/{user_id}/teams`.
|
|
2501
|
+
*/
|
|
2502
|
+
lifecycle_owner_team_id?: string | null;
|
|
2503
|
+
/** The team named by `lifecycle_owner_team_id`, present only when the
|
|
2504
|
+
request asked for it with `expand: ["lifecycle_owner_team"]` (ADR 059).
|
|
2505
|
+
Absent means it was not requested; `null` means the user is self-owned
|
|
2506
|
+
and there is no owner to resolve.
|
|
2507
|
+
Requesting it does not guarantee it is present on every user. Today
|
|
2508
|
+
`team.read` is checked once for the whole request, so it is; once that
|
|
2509
|
+
check is per team, a page may contain a user whose owner the caller may
|
|
2510
|
+
not read, and such a row answers with neither the team nor `null` —
|
|
2511
|
+
`null` already means self-owned. What it answers with instead is decided
|
|
2512
|
+
with the granular scopes (#420); do not read the two cases above as the
|
|
2513
|
+
complete set.
|
|
2514
|
+
This is the same representation `GET /teams/{team_id}` serves. It is a
|
|
2515
|
+
single team, not a collection, so it carries no cap and no truncation
|
|
2516
|
+
flag.
|
|
2517
|
+
*/
|
|
2518
|
+
readonly lifecycle_owner_team?: {
|
|
2519
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
2520
|
+
name: string;
|
|
2521
|
+
/** The lifecycle state of a team.
|
|
2522
|
+
active: The team is available for use.
|
|
2523
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
2524
|
+
*/
|
|
2525
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
2526
|
+
created_at: string; /** The time when the team was last updated. */
|
|
2527
|
+
updated_at: string;
|
|
2528
|
+
} | null;
|
|
2529
|
+
};
|
|
2530
|
+
/** The current value of the user schema's designated identifier
|
|
2531
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
2532
|
+
designates no identifier or the user carries no value for it.
|
|
2533
|
+
*/
|
|
2534
|
+
readonly identifier?: string;
|
|
2535
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
2536
|
+
property's schema for semantics (a mailto link, a field label)
|
|
2537
|
+
instead of guessing from the value. Present exactly when
|
|
2538
|
+
`identifier` is.
|
|
2539
|
+
*/
|
|
2540
|
+
readonly identifier_property?: string;
|
|
2541
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
2542
|
+
in list order, resolved live at read time. Purely presentational.
|
|
2543
|
+
Absent when the schema designates no display properties or the user
|
|
2544
|
+
carries no values for them. Clients render `display`, falling back
|
|
2545
|
+
to `identifier`, then `id`.
|
|
2546
|
+
*/
|
|
2547
|
+
readonly display?: string;
|
|
2548
|
+
/** The user's team memberships, present only when the request asked for them with
|
|
2549
|
+
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
2550
|
+
means the user has none.
|
|
2551
|
+
Deliberately outside `metadata`: memberships are a related collection, not
|
|
2552
|
+
part of the server-owned envelope, and it is a different concept from
|
|
2553
|
+
`metadata.lifecycle_owner_team_id` (ADR 024).
|
|
2554
|
+
*/
|
|
2555
|
+
readonly teams?: readonly {
|
|
2556
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
2557
|
+
name: string;
|
|
2558
|
+
/** The user's participation state on this team. Memberships the user was
|
|
2559
|
+
removed from are not returned.
|
|
2560
|
+
*/
|
|
2561
|
+
membership_status: "pending" | "active" | "inactive"; /** The time when the user joined this team. */
|
|
2562
|
+
created_at: string; /** The time when this membership was last changed. */
|
|
2563
|
+
updated_at: string;
|
|
2564
|
+
}[];
|
|
2565
|
+
/** True when the user is on more teams than the embedded list carries. The
|
|
2566
|
+
embedded list is capped and cannot be paged; read them all at
|
|
2567
|
+
`GET /users/{user_id}/teams`. Present only alongside `teams`.
|
|
2568
|
+
*/
|
|
2569
|
+
readonly teams_truncated?: boolean;
|
|
2570
|
+
} | {
|
|
2571
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
2572
|
+
name: string;
|
|
2573
|
+
/** The lifecycle state of a team.
|
|
2574
|
+
active: The team is available for use.
|
|
2575
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
2576
|
+
*/
|
|
2577
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
2578
|
+
created_at: string; /** The time when the team was last updated. */
|
|
2579
|
+
updated_at: string;
|
|
2580
|
+
} | null; //#endregion
|
|
2452
2581
|
//#region src/generated/model/createGrant201PrincipalType.d.ts
|
|
2453
2582
|
/**
|
|
2454
2583
|
* Generated by orval v8.10.0 🍺
|
|
@@ -2482,6 +2611,63 @@ declare const CreateGrant201Relation: {
|
|
|
2482
2611
|
readonly editor: "editor";
|
|
2483
2612
|
readonly admin: "admin";
|
|
2484
2613
|
}; //#endregion
|
|
2614
|
+
//#region src/generated/model/createGrant201Team.d.ts
|
|
2615
|
+
/**
|
|
2616
|
+
* Generated by orval v8.10.0 🍺
|
|
2617
|
+
* Do not edit manually.
|
|
2618
|
+
* Zitadel NextGen
|
|
2619
|
+
* This is the next generation of the Zitadel identity platform.
|
|
2620
|
+
* OpenAPI spec version: 0.0.1
|
|
2621
|
+
*/
|
|
2622
|
+
/**
|
|
2623
|
+
* A resolved reference to a team. Carries the team's id and name so a grant
|
|
2624
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
2625
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
2626
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
2627
|
+
deleted teams degrade to `team_id` only.
|
|
2628
|
+
|
|
2629
|
+
*/
|
|
2630
|
+
type CreateGrant201Team = {
|
|
2631
|
+
/** The referenced team's id (`team_<opaque>`). Always present. */team_id: string; /** The team's name. Absent when the team can no longer be loaded. */
|
|
2632
|
+
name?: string;
|
|
2633
|
+
}; //#endregion
|
|
2634
|
+
//#region src/generated/model/createGrant201User.d.ts
|
|
2635
|
+
/**
|
|
2636
|
+
* Generated by orval v8.10.0 🍺
|
|
2637
|
+
* Do not edit manually.
|
|
2638
|
+
* Zitadel NextGen
|
|
2639
|
+
* This is the next generation of the Zitadel identity platform.
|
|
2640
|
+
* OpenAPI spec version: 0.0.1
|
|
2641
|
+
*/
|
|
2642
|
+
/**
|
|
2643
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
2644
|
+
property-named, so responses can mix users from different schemas.
|
|
2645
|
+
`identifier` and `display` are resolved independently from the user
|
|
2646
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
2647
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
2648
|
+
Missing or deleted users degrade to `user_id` only.
|
|
2649
|
+
|
|
2650
|
+
*/
|
|
2651
|
+
type CreateGrant201User = {
|
|
2652
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
2653
|
+
/** The current value of the schema's designated identifier
|
|
2654
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
2655
|
+
the user carries no value for it.
|
|
2656
|
+
*/
|
|
2657
|
+
identifier?: string;
|
|
2658
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
2659
|
+
property's schema for semantics (a mailto link, a field label)
|
|
2660
|
+
instead of guessing from the value. Present exactly when
|
|
2661
|
+
`identifier` is.
|
|
2662
|
+
*/
|
|
2663
|
+
identifier_property?: string;
|
|
2664
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
2665
|
+
in list order. Purely presentational, with no source attribution.
|
|
2666
|
+
Absent when the schema designates no display properties or the user
|
|
2667
|
+
carries no values for them.
|
|
2668
|
+
*/
|
|
2669
|
+
display?: string;
|
|
2670
|
+
}; //#endregion
|
|
2485
2671
|
//#region src/generated/model/createGrant201.d.ts
|
|
2486
2672
|
/**
|
|
2487
2673
|
* A collaboration grant binding a principal to a project relation.
|
|
@@ -2498,6 +2684,33 @@ type CreateGrant201 = {
|
|
|
2498
2684
|
returns expired unrevoked grants; authorization ignores them.
|
|
2499
2685
|
*/
|
|
2500
2686
|
expires_at?: string | null;
|
|
2687
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
2688
|
+
property-named, so responses can mix users from different schemas.
|
|
2689
|
+
`identifier` and `display` are resolved independently from the user
|
|
2690
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
2691
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
2692
|
+
Missing or deleted users degrade to `user_id` only.
|
|
2693
|
+
*/
|
|
2694
|
+
user?: CreateGrant201User;
|
|
2695
|
+
/** A resolved reference to a team. Carries the team's id and name so a grant
|
|
2696
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
2697
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
2698
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
2699
|
+
deleted teams degrade to `team_id` only.
|
|
2700
|
+
*/
|
|
2701
|
+
team?: CreateGrant201Team;
|
|
2702
|
+
/** The principal named by `principal_id`, present only when the request
|
|
2703
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
2704
|
+
was not requested; `null` means the principal cannot be loaded
|
|
2705
|
+
(deleted or missing). GET and create never set this field.
|
|
2706
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
2707
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
2708
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
2709
|
+
`principal_type`.
|
|
2710
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
2711
|
+
Both are checked on the whole request before the list.
|
|
2712
|
+
*/
|
|
2713
|
+
readonly principal?: CreateGrant201Principal;
|
|
2501
2714
|
}; //#endregion
|
|
2502
2715
|
//#region src/generated/model/createGrant400Details.d.ts
|
|
2503
2716
|
/**
|
|
@@ -3296,6 +3509,43 @@ declare const CreateSession201SessionState: {
|
|
|
3296
3509
|
readonly active: "active";
|
|
3297
3510
|
readonly expired: "expired";
|
|
3298
3511
|
}; //#endregion
|
|
3512
|
+
//#region src/generated/model/createSession201SessionUser.d.ts
|
|
3513
|
+
/**
|
|
3514
|
+
* Generated by orval v8.10.0 🍺
|
|
3515
|
+
* Do not edit manually.
|
|
3516
|
+
* Zitadel NextGen
|
|
3517
|
+
* This is the next generation of the Zitadel identity platform.
|
|
3518
|
+
* OpenAPI spec version: 0.0.1
|
|
3519
|
+
*/
|
|
3520
|
+
/**
|
|
3521
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
3522
|
+
property-named, so responses can mix users from different schemas.
|
|
3523
|
+
`identifier` and `display` are resolved independently from the user
|
|
3524
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
3525
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
3526
|
+
Missing or deleted users degrade to `user_id` only.
|
|
3527
|
+
|
|
3528
|
+
*/
|
|
3529
|
+
type CreateSession201SessionUser = {
|
|
3530
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
3531
|
+
/** The current value of the schema's designated identifier
|
|
3532
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
3533
|
+
the user carries no value for it.
|
|
3534
|
+
*/
|
|
3535
|
+
identifier?: string;
|
|
3536
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
3537
|
+
property's schema for semantics (a mailto link, a field label)
|
|
3538
|
+
instead of guessing from the value. Present exactly when
|
|
3539
|
+
`identifier` is.
|
|
3540
|
+
*/
|
|
3541
|
+
identifier_property?: string;
|
|
3542
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
3543
|
+
in list order. Purely presentational, with no source attribution.
|
|
3544
|
+
Absent when the schema designates no display properties or the user
|
|
3545
|
+
carries no values for them.
|
|
3546
|
+
*/
|
|
3547
|
+
display?: string;
|
|
3548
|
+
}; //#endregion
|
|
3299
3549
|
//#region src/generated/model/createSession201SessionUserAgent.d.ts
|
|
3300
3550
|
/**
|
|
3301
3551
|
* Generated by orval v8.10.0 🍺
|
|
@@ -3339,23 +3589,14 @@ type CreateSession201Session = {
|
|
|
3339
3589
|
factor has been verified through an `auth_attempt`.
|
|
3340
3590
|
*/
|
|
3341
3591
|
user_id?: string | null;
|
|
3342
|
-
/**
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
|
|
3349
|
-
|
|
3350
|
-
*/
|
|
3351
|
-
name?: string;
|
|
3352
|
-
/** Email address of the authenticated user, resolved from the
|
|
3353
|
-
conventional `email` user-schema property. Only present on reads
|
|
3354
|
-
that hydrate the user's identity (`GET /sessions/me`) and only when
|
|
3355
|
-
the session has an authenticated user whose schema carries that
|
|
3356
|
-
property.
|
|
3357
|
-
*/
|
|
3358
|
-
email?: string;
|
|
3592
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
3593
|
+
property-named, so responses can mix users from different schemas.
|
|
3594
|
+
`identifier` and `display` are resolved independently from the user
|
|
3595
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
3596
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
3597
|
+
Missing or deleted users degrade to `user_id` only.
|
|
3598
|
+
*/
|
|
3599
|
+
user?: CreateSession201SessionUser;
|
|
3359
3600
|
/** Verified authentication factors accumulated by this session.
|
|
3360
3601
|
Each key is a factor type (e.g. `password`, `totp`, `passkey`).
|
|
3361
3602
|
Each value is a factor event object with at least `verified_at` and
|
|
@@ -3706,6 +3947,24 @@ type CreateUser201 = {
|
|
|
3706
3947
|
*/
|
|
3707
3948
|
attributes: CreateUser201Attributes;
|
|
3708
3949
|
metadata: CreateUser201Metadata;
|
|
3950
|
+
/** The current value of the user schema's designated identifier
|
|
3951
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
3952
|
+
designates no identifier or the user carries no value for it.
|
|
3953
|
+
*/
|
|
3954
|
+
readonly identifier?: string;
|
|
3955
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
3956
|
+
property's schema for semantics (a mailto link, a field label)
|
|
3957
|
+
instead of guessing from the value. Present exactly when
|
|
3958
|
+
`identifier` is.
|
|
3959
|
+
*/
|
|
3960
|
+
readonly identifier_property?: string;
|
|
3961
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
3962
|
+
in list order, resolved live at read time. Purely presentational.
|
|
3963
|
+
Absent when the schema designates no display properties or the user
|
|
3964
|
+
carries no values for them. Clients render `display`, falling back
|
|
3965
|
+
to `identifier`, then `id`.
|
|
3966
|
+
*/
|
|
3967
|
+
readonly display?: string;
|
|
3709
3968
|
/** The user's team memberships, present only when the request asked for them with
|
|
3710
3969
|
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
3711
3970
|
means the user has none.
|
|
@@ -3946,6 +4205,43 @@ declare const ExchangeHandoff200SessionState: {
|
|
|
3946
4205
|
readonly active: "active";
|
|
3947
4206
|
readonly expired: "expired";
|
|
3948
4207
|
}; //#endregion
|
|
4208
|
+
//#region src/generated/model/exchangeHandoff200SessionUser.d.ts
|
|
4209
|
+
/**
|
|
4210
|
+
* Generated by orval v8.10.0 🍺
|
|
4211
|
+
* Do not edit manually.
|
|
4212
|
+
* Zitadel NextGen
|
|
4213
|
+
* This is the next generation of the Zitadel identity platform.
|
|
4214
|
+
* OpenAPI spec version: 0.0.1
|
|
4215
|
+
*/
|
|
4216
|
+
/**
|
|
4217
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
4218
|
+
property-named, so responses can mix users from different schemas.
|
|
4219
|
+
`identifier` and `display` are resolved independently from the user
|
|
4220
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
4221
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
4222
|
+
Missing or deleted users degrade to `user_id` only.
|
|
4223
|
+
|
|
4224
|
+
*/
|
|
4225
|
+
type ExchangeHandoff200SessionUser = {
|
|
4226
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
4227
|
+
/** The current value of the schema's designated identifier
|
|
4228
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
4229
|
+
the user carries no value for it.
|
|
4230
|
+
*/
|
|
4231
|
+
identifier?: string;
|
|
4232
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
4233
|
+
property's schema for semantics (a mailto link, a field label)
|
|
4234
|
+
instead of guessing from the value. Present exactly when
|
|
4235
|
+
`identifier` is.
|
|
4236
|
+
*/
|
|
4237
|
+
identifier_property?: string;
|
|
4238
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
4239
|
+
in list order. Purely presentational, with no source attribution.
|
|
4240
|
+
Absent when the schema designates no display properties or the user
|
|
4241
|
+
carries no values for them.
|
|
4242
|
+
*/
|
|
4243
|
+
display?: string;
|
|
4244
|
+
}; //#endregion
|
|
3949
4245
|
//#region src/generated/model/exchangeHandoff200SessionUserAgent.d.ts
|
|
3950
4246
|
/**
|
|
3951
4247
|
* Generated by orval v8.10.0 🍺
|
|
@@ -3989,23 +4285,14 @@ type ExchangeHandoff200Session = {
|
|
|
3989
4285
|
factor has been verified through an `auth_attempt`.
|
|
3990
4286
|
*/
|
|
3991
4287
|
user_id?: string | null;
|
|
3992
|
-
/**
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
|
|
3997
|
-
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
*/
|
|
4001
|
-
name?: string;
|
|
4002
|
-
/** Email address of the authenticated user, resolved from the
|
|
4003
|
-
conventional `email` user-schema property. Only present on reads
|
|
4004
|
-
that hydrate the user's identity (`GET /sessions/me`) and only when
|
|
4005
|
-
the session has an authenticated user whose schema carries that
|
|
4006
|
-
property.
|
|
4007
|
-
*/
|
|
4008
|
-
email?: string;
|
|
4288
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
4289
|
+
property-named, so responses can mix users from different schemas.
|
|
4290
|
+
`identifier` and `display` are resolved independently from the user
|
|
4291
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
4292
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
4293
|
+
Missing or deleted users degrade to `user_id` only.
|
|
4294
|
+
*/
|
|
4295
|
+
user?: ExchangeHandoff200SessionUser;
|
|
4009
4296
|
/** Verified authentication factors accumulated by this session.
|
|
4010
4297
|
Each key is a factor type (e.g. `password`, `totp`, `passkey`).
|
|
4011
4298
|
Each value is a factor event object with at least `verified_at` and
|
|
@@ -4567,6 +4854,55 @@ type GetClaimStatusParams = {
|
|
|
4567
4854
|
*/
|
|
4568
4855
|
challenge_id: string;
|
|
4569
4856
|
}; //#endregion
|
|
4857
|
+
//#region src/generated/model/getClaimWindow200.d.ts
|
|
4858
|
+
/**
|
|
4859
|
+
* Generated by orval v8.10.0 🍺
|
|
4860
|
+
* Do not edit manually.
|
|
4861
|
+
* Zitadel NextGen
|
|
4862
|
+
* This is the next generation of the Zitadel identity platform.
|
|
4863
|
+
* OpenAPI spec version: 0.0.1
|
|
4864
|
+
*/
|
|
4865
|
+
/**
|
|
4866
|
+
* How long the project can still be claimed. Derived from the project's
|
|
4867
|
+
creation time and the fixed 14-day claim window (ADR 046); it does not
|
|
4868
|
+
depend on the challenge, which has its own much shorter expiry.
|
|
4869
|
+
|
|
4870
|
+
*/
|
|
4871
|
+
type GetClaimWindow200 = {
|
|
4872
|
+
/** The time when the project's claim window closes. */expires_at: string;
|
|
4873
|
+
/** Whether the window has already closed. Reported alongside `expires_at`
|
|
4874
|
+
rather than left to the client so a skewed browser clock cannot show a
|
|
4875
|
+
claimable project as expired, or the reverse.
|
|
4876
|
+
*/
|
|
4877
|
+
expired: boolean;
|
|
4878
|
+
}; //#endregion
|
|
4879
|
+
//#region src/generated/model/getClaimWindow404Details.d.ts
|
|
4880
|
+
/**
|
|
4881
|
+
* Generated by orval v8.10.0 🍺
|
|
4882
|
+
* Do not edit manually.
|
|
4883
|
+
* Zitadel NextGen
|
|
4884
|
+
* This is the next generation of the Zitadel identity platform.
|
|
4885
|
+
* OpenAPI spec version: 0.0.1
|
|
4886
|
+
*/
|
|
4887
|
+
/**
|
|
4888
|
+
* Additional error-specific context.
|
|
4889
|
+
*/
|
|
4890
|
+
//#endregion
|
|
4891
|
+
//#region src/generated/model/getClaimWindowParams.d.ts
|
|
4892
|
+
/**
|
|
4893
|
+
* Generated by orval v8.10.0 🍺
|
|
4894
|
+
* Do not edit manually.
|
|
4895
|
+
* Zitadel NextGen
|
|
4896
|
+
* This is the next generation of the Zitadel identity platform.
|
|
4897
|
+
* OpenAPI spec version: 0.0.1
|
|
4898
|
+
*/
|
|
4899
|
+
type GetClaimWindowParams = {
|
|
4900
|
+
/**
|
|
4901
|
+
* Unique identifier for this challenge (dialect-minted prefixed opaque string).
|
|
4902
|
+
* @pattern ^ch_[a-zA-Z0-9_-]+$
|
|
4903
|
+
*/
|
|
4904
|
+
challenge_id: string;
|
|
4905
|
+
}; //#endregion
|
|
4570
4906
|
//#region src/generated/model/getEnvironmentByName200.d.ts
|
|
4571
4907
|
/**
|
|
4572
4908
|
* Generated by orval v8.10.0 🍺
|
|
@@ -5481,6 +5817,59 @@ type GetEvent200 = ({
|
|
|
5481
5817
|
};
|
|
5482
5818
|
[key: string]: unknown;
|
|
5483
5819
|
};
|
|
5820
|
+
} & {
|
|
5821
|
+
event_type: "release.created";
|
|
5822
|
+
/** Allowlisted fields for `release.created`. The release id is already the
|
|
5823
|
+
event's `entity_id`; the pinned set is repeated here so the audit stream
|
|
5824
|
+
answers what a release contained without reading the release itself.
|
|
5825
|
+
*/
|
|
5826
|
+
payload: {
|
|
5827
|
+
content_hash?: string;
|
|
5828
|
+
message?: string;
|
|
5829
|
+
git_sha?: string;
|
|
5830
|
+
git_dirty?: boolean;
|
|
5831
|
+
pointers?: {
|
|
5832
|
+
kind?: string;
|
|
5833
|
+
handle?: string;
|
|
5834
|
+
revision_id?: string;
|
|
5835
|
+
}[];
|
|
5836
|
+
};
|
|
5837
|
+
}) | ({
|
|
5838
|
+
/** Managed event id (`evt_<opaque>`). */id: string; /** @pattern ^[a-zA-Z0-9_-]+$ */
|
|
5839
|
+
project_id: string; /** Emit-time team scope, when the actor operated under a team. */
|
|
5840
|
+
team_id?: string | null;
|
|
5841
|
+
/** Semantic event name (dot-separated). Discriminator for the Event union —
|
|
5842
|
+
see docs/design/api/events-catalog.md.
|
|
5843
|
+
*/
|
|
5844
|
+
event_type: string; /** Wide-event category. */
|
|
5845
|
+
category: "request" | "auth" | "session" | "admin" | "entity" | "signal"; /** When the action happened (server/storage clock, dialect-owned). */
|
|
5846
|
+
occurred_at: string; /** When the row was inserted (server/storage clock, dialect-owned). */
|
|
5847
|
+
created_at: string; /** Who triggered the event. */
|
|
5848
|
+
actor_id?: string | null; /** Actor kind. */
|
|
5849
|
+
actor_type?: "human" | "service" | "system" | "agent" | null; /** Resource type affected. */
|
|
5850
|
+
entity_type?: string | null; /** Resource id affected. */
|
|
5851
|
+
entity_id?: string | null; /** Application or agent that produced the event. */
|
|
5852
|
+
client_id: string; /** Token id present at emit time, when any. */
|
|
5853
|
+
token_id?: string; /** Delegation kind (omit when unset). */
|
|
5854
|
+
delegation_type?: "direct" | "delegated" | "pat_shared" | "exchanged";
|
|
5855
|
+
delegation_id?: string;
|
|
5856
|
+
grantor?: string; /** Device fingerprint correlation id. */
|
|
5857
|
+
fingerprint?: string; /** HTTP request correlation id. */
|
|
5858
|
+
request_id?: string | null; /** Session correlation id. */
|
|
5859
|
+
session_id?: string | null; /** Login flow correlation id. */
|
|
5860
|
+
flow_id?: string | null;
|
|
5861
|
+
/** Emit-time metadata, already redacted at write. Path A request.api may
|
|
5862
|
+
set client (ip, user_agent, origin) for SIEM join on request_id. Not a
|
|
5863
|
+
live risk-evaluator input.
|
|
5864
|
+
*/
|
|
5865
|
+
metadata?: {
|
|
5866
|
+
/** Observed HTTP requestor context on Path A request.api only. */client?: {
|
|
5867
|
+
/** Client IP from the first X-Forwarded-For hop or RemoteAddr. */ip?: string; /** Observed User-Agent header. */
|
|
5868
|
+
user_agent?: string; /** Origin header when present. */
|
|
5869
|
+
origin?: string;
|
|
5870
|
+
};
|
|
5871
|
+
[key: string]: unknown;
|
|
5872
|
+
};
|
|
5484
5873
|
} & {
|
|
5485
5874
|
event_type: "request.api"; /** Payload for `request.api` events. */
|
|
5486
5875
|
payload: {
|
|
@@ -6256,9 +6645,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
6256
6645
|
type GetFlowDefinition200FlowDefinition = {
|
|
6257
6646
|
/**
|
|
6258
6647
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
6259
|
-
`switch` and `pivot` transitions.
|
|
6260
|
-
`name
|
|
6261
|
-
|
|
6648
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
6649
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
6650
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
6651
|
+
of the public contract another definition may reference. Acts as the
|
|
6652
|
+
human display label as well; no separate slug.
|
|
6262
6653
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
6263
6654
|
*/
|
|
6264
6655
|
name: string;
|
|
@@ -6948,6 +7339,131 @@ type GetGrant200ObjectType = (typeof GetGrant200ObjectType)[keyof typeof GetGran
|
|
|
6948
7339
|
declare const GetGrant200ObjectType: {
|
|
6949
7340
|
readonly project: "project";
|
|
6950
7341
|
}; //#endregion
|
|
7342
|
+
//#region src/generated/model/getGrant200Principal.d.ts
|
|
7343
|
+
/**
|
|
7344
|
+
* Generated by orval v8.10.0 🍺
|
|
7345
|
+
* Do not edit manually.
|
|
7346
|
+
* Zitadel NextGen
|
|
7347
|
+
* This is the next generation of the Zitadel identity platform.
|
|
7348
|
+
* OpenAPI spec version: 0.0.1
|
|
7349
|
+
*/
|
|
7350
|
+
/**
|
|
7351
|
+
* The principal named by `principal_id`, present only when the request
|
|
7352
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
7353
|
+
was not requested; `null` means the principal cannot be loaded
|
|
7354
|
+
(deleted or missing). GET and create never set this field.
|
|
7355
|
+
|
|
7356
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
7357
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
7358
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
7359
|
+
`principal_type`.
|
|
7360
|
+
|
|
7361
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
7362
|
+
Both are checked on the whole request before the list.
|
|
7363
|
+
|
|
7364
|
+
*/
|
|
7365
|
+
type GetGrant200Principal = {
|
|
7366
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */id: string;
|
|
7367
|
+
/** The schema that defines the content of `attributes`. These schemas can be
|
|
7368
|
+
created using the `/schemas` endpoint. A default schema is provided.
|
|
7369
|
+
This schema can be retrieved using the same endpoint.
|
|
7370
|
+
*/
|
|
7371
|
+
schema: string;
|
|
7372
|
+
/** The user's content, satisfying the schema named by `schema`. Property
|
|
7373
|
+
names and types are determined entirely by that schema.
|
|
7374
|
+
*/
|
|
7375
|
+
attributes: {
|
|
7376
|
+
[key: string]: unknown;
|
|
7377
|
+
};
|
|
7378
|
+
metadata: {
|
|
7379
|
+
/** The time when the user was created. */created_at: string; /** The time when the user was last updated. */
|
|
7380
|
+
updated_at: string; /** The status of the user. */
|
|
7381
|
+
status: "active" | "suspended" | "deactivated" | "pending_purge";
|
|
7382
|
+
/** The team that owns this user's identity lifecycle, or `null` when the
|
|
7383
|
+
user is self-owned. This is a single team and a different concept from
|
|
7384
|
+
the user's team memberships: it decides who may deprovision the user, not
|
|
7385
|
+
which teams the user collaborates in. Memberships are their own paginated
|
|
7386
|
+
resource — `GET /users/{user_id}/teams`.
|
|
7387
|
+
*/
|
|
7388
|
+
lifecycle_owner_team_id?: string | null;
|
|
7389
|
+
/** The team named by `lifecycle_owner_team_id`, present only when the
|
|
7390
|
+
request asked for it with `expand: ["lifecycle_owner_team"]` (ADR 059).
|
|
7391
|
+
Absent means it was not requested; `null` means the user is self-owned
|
|
7392
|
+
and there is no owner to resolve.
|
|
7393
|
+
Requesting it does not guarantee it is present on every user. Today
|
|
7394
|
+
`team.read` is checked once for the whole request, so it is; once that
|
|
7395
|
+
check is per team, a page may contain a user whose owner the caller may
|
|
7396
|
+
not read, and such a row answers with neither the team nor `null` —
|
|
7397
|
+
`null` already means self-owned. What it answers with instead is decided
|
|
7398
|
+
with the granular scopes (#420); do not read the two cases above as the
|
|
7399
|
+
complete set.
|
|
7400
|
+
This is the same representation `GET /teams/{team_id}` serves. It is a
|
|
7401
|
+
single team, not a collection, so it carries no cap and no truncation
|
|
7402
|
+
flag.
|
|
7403
|
+
*/
|
|
7404
|
+
readonly lifecycle_owner_team?: {
|
|
7405
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
7406
|
+
name: string;
|
|
7407
|
+
/** The lifecycle state of a team.
|
|
7408
|
+
active: The team is available for use.
|
|
7409
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
7410
|
+
*/
|
|
7411
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
7412
|
+
created_at: string; /** The time when the team was last updated. */
|
|
7413
|
+
updated_at: string;
|
|
7414
|
+
} | null;
|
|
7415
|
+
};
|
|
7416
|
+
/** The current value of the user schema's designated identifier
|
|
7417
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
7418
|
+
designates no identifier or the user carries no value for it.
|
|
7419
|
+
*/
|
|
7420
|
+
readonly identifier?: string;
|
|
7421
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
7422
|
+
property's schema for semantics (a mailto link, a field label)
|
|
7423
|
+
instead of guessing from the value. Present exactly when
|
|
7424
|
+
`identifier` is.
|
|
7425
|
+
*/
|
|
7426
|
+
readonly identifier_property?: string;
|
|
7427
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
7428
|
+
in list order, resolved live at read time. Purely presentational.
|
|
7429
|
+
Absent when the schema designates no display properties or the user
|
|
7430
|
+
carries no values for them. Clients render `display`, falling back
|
|
7431
|
+
to `identifier`, then `id`.
|
|
7432
|
+
*/
|
|
7433
|
+
readonly display?: string;
|
|
7434
|
+
/** The user's team memberships, present only when the request asked for them with
|
|
7435
|
+
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
7436
|
+
means the user has none.
|
|
7437
|
+
Deliberately outside `metadata`: memberships are a related collection, not
|
|
7438
|
+
part of the server-owned envelope, and it is a different concept from
|
|
7439
|
+
`metadata.lifecycle_owner_team_id` (ADR 024).
|
|
7440
|
+
*/
|
|
7441
|
+
readonly teams?: readonly {
|
|
7442
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
7443
|
+
name: string;
|
|
7444
|
+
/** The user's participation state on this team. Memberships the user was
|
|
7445
|
+
removed from are not returned.
|
|
7446
|
+
*/
|
|
7447
|
+
membership_status: "pending" | "active" | "inactive"; /** The time when the user joined this team. */
|
|
7448
|
+
created_at: string; /** The time when this membership was last changed. */
|
|
7449
|
+
updated_at: string;
|
|
7450
|
+
}[];
|
|
7451
|
+
/** True when the user is on more teams than the embedded list carries. The
|
|
7452
|
+
embedded list is capped and cannot be paged; read them all at
|
|
7453
|
+
`GET /users/{user_id}/teams`. Present only alongside `teams`.
|
|
7454
|
+
*/
|
|
7455
|
+
readonly teams_truncated?: boolean;
|
|
7456
|
+
} | {
|
|
7457
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
7458
|
+
name: string;
|
|
7459
|
+
/** The lifecycle state of a team.
|
|
7460
|
+
active: The team is available for use.
|
|
7461
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
7462
|
+
*/
|
|
7463
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
7464
|
+
created_at: string; /** The time when the team was last updated. */
|
|
7465
|
+
updated_at: string;
|
|
7466
|
+
} | null; //#endregion
|
|
6951
7467
|
//#region src/generated/model/getGrant200PrincipalType.d.ts
|
|
6952
7468
|
/**
|
|
6953
7469
|
* Generated by orval v8.10.0 🍺
|
|
@@ -6981,24 +7497,7 @@ declare const GetGrant200Relation: {
|
|
|
6981
7497
|
readonly editor: "editor";
|
|
6982
7498
|
readonly admin: "admin";
|
|
6983
7499
|
}; //#endregion
|
|
6984
|
-
//#region src/generated/model/
|
|
6985
|
-
/**
|
|
6986
|
-
* A collaboration grant binding a principal to a project relation.
|
|
6987
|
-
*/
|
|
6988
|
-
type GetGrant200 = {
|
|
6989
|
-
/** Managed assignment id (`asgn_<opaque>`). */id: string; /** Project this grant is scoped to. */
|
|
6990
|
-
project_id: string; /** Kind of principal bound by this grant. */
|
|
6991
|
-
principal_type: GetGrant200PrincipalType; /** Principal id (`user_<opaque>` or `team_<opaque>`). */
|
|
6992
|
-
principal_id: string; /** Catalog object type. Always `project` for this API. */
|
|
6993
|
-
object_type: GetGrant200ObjectType; /** Catalog relation on the project. */
|
|
6994
|
-
relation: GetGrant200Relation; /** When the grant was created. */
|
|
6995
|
-
created_at: string;
|
|
6996
|
-
/** When the grant expires. Null when it does not expire. GET still
|
|
6997
|
-
returns expired unrevoked grants; authorization ignores them.
|
|
6998
|
-
*/
|
|
6999
|
-
expires_at?: string | null;
|
|
7000
|
-
}; //#endregion
|
|
7001
|
-
//#region src/generated/model/getGrant401Details.d.ts
|
|
7500
|
+
//#region src/generated/model/getGrant200Team.d.ts
|
|
7002
7501
|
/**
|
|
7003
7502
|
* Generated by orval v8.10.0 🍺
|
|
7004
7503
|
* Do not edit manually.
|
|
@@ -7007,7 +7506,108 @@ type GetGrant200 = {
|
|
|
7007
7506
|
* OpenAPI spec version: 0.0.1
|
|
7008
7507
|
*/
|
|
7009
7508
|
/**
|
|
7010
|
-
*
|
|
7509
|
+
* A resolved reference to a team. Carries the team's id and name so a grant
|
|
7510
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
7511
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
7512
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
7513
|
+
deleted teams degrade to `team_id` only.
|
|
7514
|
+
|
|
7515
|
+
*/
|
|
7516
|
+
type GetGrant200Team = {
|
|
7517
|
+
/** The referenced team's id (`team_<opaque>`). Always present. */team_id: string; /** The team's name. Absent when the team can no longer be loaded. */
|
|
7518
|
+
name?: string;
|
|
7519
|
+
}; //#endregion
|
|
7520
|
+
//#region src/generated/model/getGrant200User.d.ts
|
|
7521
|
+
/**
|
|
7522
|
+
* Generated by orval v8.10.0 🍺
|
|
7523
|
+
* Do not edit manually.
|
|
7524
|
+
* Zitadel NextGen
|
|
7525
|
+
* This is the next generation of the Zitadel identity platform.
|
|
7526
|
+
* OpenAPI spec version: 0.0.1
|
|
7527
|
+
*/
|
|
7528
|
+
/**
|
|
7529
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
7530
|
+
property-named, so responses can mix users from different schemas.
|
|
7531
|
+
`identifier` and `display` are resolved independently from the user
|
|
7532
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
7533
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
7534
|
+
Missing or deleted users degrade to `user_id` only.
|
|
7535
|
+
|
|
7536
|
+
*/
|
|
7537
|
+
type GetGrant200User = {
|
|
7538
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
7539
|
+
/** The current value of the schema's designated identifier
|
|
7540
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
7541
|
+
the user carries no value for it.
|
|
7542
|
+
*/
|
|
7543
|
+
identifier?: string;
|
|
7544
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
7545
|
+
property's schema for semantics (a mailto link, a field label)
|
|
7546
|
+
instead of guessing from the value. Present exactly when
|
|
7547
|
+
`identifier` is.
|
|
7548
|
+
*/
|
|
7549
|
+
identifier_property?: string;
|
|
7550
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
7551
|
+
in list order. Purely presentational, with no source attribution.
|
|
7552
|
+
Absent when the schema designates no display properties or the user
|
|
7553
|
+
carries no values for them.
|
|
7554
|
+
*/
|
|
7555
|
+
display?: string;
|
|
7556
|
+
}; //#endregion
|
|
7557
|
+
//#region src/generated/model/getGrant200.d.ts
|
|
7558
|
+
/**
|
|
7559
|
+
* A collaboration grant binding a principal to a project relation.
|
|
7560
|
+
*/
|
|
7561
|
+
type GetGrant200 = {
|
|
7562
|
+
/** Managed assignment id (`asgn_<opaque>`). */id: string; /** Project this grant is scoped to. */
|
|
7563
|
+
project_id: string; /** Kind of principal bound by this grant. */
|
|
7564
|
+
principal_type: GetGrant200PrincipalType; /** Principal id (`user_<opaque>` or `team_<opaque>`). */
|
|
7565
|
+
principal_id: string; /** Catalog object type. Always `project` for this API. */
|
|
7566
|
+
object_type: GetGrant200ObjectType; /** Catalog relation on the project. */
|
|
7567
|
+
relation: GetGrant200Relation; /** When the grant was created. */
|
|
7568
|
+
created_at: string;
|
|
7569
|
+
/** When the grant expires. Null when it does not expire. GET still
|
|
7570
|
+
returns expired unrevoked grants; authorization ignores them.
|
|
7571
|
+
*/
|
|
7572
|
+
expires_at?: string | null;
|
|
7573
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
7574
|
+
property-named, so responses can mix users from different schemas.
|
|
7575
|
+
`identifier` and `display` are resolved independently from the user
|
|
7576
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
7577
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
7578
|
+
Missing or deleted users degrade to `user_id` only.
|
|
7579
|
+
*/
|
|
7580
|
+
user?: GetGrant200User;
|
|
7581
|
+
/** A resolved reference to a team. Carries the team's id and name so a grant
|
|
7582
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
7583
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
7584
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
7585
|
+
deleted teams degrade to `team_id` only.
|
|
7586
|
+
*/
|
|
7587
|
+
team?: GetGrant200Team;
|
|
7588
|
+
/** The principal named by `principal_id`, present only when the request
|
|
7589
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
7590
|
+
was not requested; `null` means the principal cannot be loaded
|
|
7591
|
+
(deleted or missing). GET and create never set this field.
|
|
7592
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
7593
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
7594
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
7595
|
+
`principal_type`.
|
|
7596
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
7597
|
+
Both are checked on the whole request before the list.
|
|
7598
|
+
*/
|
|
7599
|
+
readonly principal?: GetGrant200Principal;
|
|
7600
|
+
}; //#endregion
|
|
7601
|
+
//#region src/generated/model/getGrant401Details.d.ts
|
|
7602
|
+
/**
|
|
7603
|
+
* Generated by orval v8.10.0 🍺
|
|
7604
|
+
* Do not edit manually.
|
|
7605
|
+
* Zitadel NextGen
|
|
7606
|
+
* This is the next generation of the Zitadel identity platform.
|
|
7607
|
+
* OpenAPI spec version: 0.0.1
|
|
7608
|
+
*/
|
|
7609
|
+
/**
|
|
7610
|
+
* Additional error-specific context.
|
|
7011
7611
|
*/
|
|
7012
7612
|
//#endregion
|
|
7013
7613
|
//#region src/generated/model/getGrantParams.d.ts
|
|
@@ -7189,6 +7789,43 @@ declare const GetMySession200State: {
|
|
|
7189
7789
|
readonly active: "active";
|
|
7190
7790
|
readonly expired: "expired";
|
|
7191
7791
|
}; //#endregion
|
|
7792
|
+
//#region src/generated/model/getMySession200User.d.ts
|
|
7793
|
+
/**
|
|
7794
|
+
* Generated by orval v8.10.0 🍺
|
|
7795
|
+
* Do not edit manually.
|
|
7796
|
+
* Zitadel NextGen
|
|
7797
|
+
* This is the next generation of the Zitadel identity platform.
|
|
7798
|
+
* OpenAPI spec version: 0.0.1
|
|
7799
|
+
*/
|
|
7800
|
+
/**
|
|
7801
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
7802
|
+
property-named, so responses can mix users from different schemas.
|
|
7803
|
+
`identifier` and `display` are resolved independently from the user
|
|
7804
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
7805
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
7806
|
+
Missing or deleted users degrade to `user_id` only.
|
|
7807
|
+
|
|
7808
|
+
*/
|
|
7809
|
+
type GetMySession200User = {
|
|
7810
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
7811
|
+
/** The current value of the schema's designated identifier
|
|
7812
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
7813
|
+
the user carries no value for it.
|
|
7814
|
+
*/
|
|
7815
|
+
identifier?: string;
|
|
7816
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
7817
|
+
property's schema for semantics (a mailto link, a field label)
|
|
7818
|
+
instead of guessing from the value. Present exactly when
|
|
7819
|
+
`identifier` is.
|
|
7820
|
+
*/
|
|
7821
|
+
identifier_property?: string;
|
|
7822
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
7823
|
+
in list order. Purely presentational, with no source attribution.
|
|
7824
|
+
Absent when the schema designates no display properties or the user
|
|
7825
|
+
carries no values for them.
|
|
7826
|
+
*/
|
|
7827
|
+
display?: string;
|
|
7828
|
+
}; //#endregion
|
|
7192
7829
|
//#region src/generated/model/getMySession200UserAgent.d.ts
|
|
7193
7830
|
/**
|
|
7194
7831
|
* Generated by orval v8.10.0 🍺
|
|
@@ -7232,23 +7869,14 @@ type GetMySession200 = {
|
|
|
7232
7869
|
factor has been verified through an `auth_attempt`.
|
|
7233
7870
|
*/
|
|
7234
7871
|
user_id?: string | null;
|
|
7235
|
-
/**
|
|
7236
|
-
|
|
7237
|
-
|
|
7238
|
-
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
*/
|
|
7244
|
-
name?: string;
|
|
7245
|
-
/** Email address of the authenticated user, resolved from the
|
|
7246
|
-
conventional `email` user-schema property. Only present on reads
|
|
7247
|
-
that hydrate the user's identity (`GET /sessions/me`) and only when
|
|
7248
|
-
the session has an authenticated user whose schema carries that
|
|
7249
|
-
property.
|
|
7250
|
-
*/
|
|
7251
|
-
email?: string;
|
|
7872
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
7873
|
+
property-named, so responses can mix users from different schemas.
|
|
7874
|
+
`identifier` and `display` are resolved independently from the user
|
|
7875
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
7876
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
7877
|
+
Missing or deleted users degrade to `user_id` only.
|
|
7878
|
+
*/
|
|
7879
|
+
user?: GetMySession200User;
|
|
7252
7880
|
/** Verified authentication factors accumulated by this session.
|
|
7253
7881
|
Each key is a factor type (e.g. `password`, `totp`, `passkey`).
|
|
7254
7882
|
Each value is a factor event object with at least `verified_at` and
|
|
@@ -7452,6 +8080,24 @@ type GetMyUser200 = {
|
|
|
7452
8080
|
*/
|
|
7453
8081
|
attributes: GetMyUser200Attributes;
|
|
7454
8082
|
metadata: GetMyUser200Metadata;
|
|
8083
|
+
/** The current value of the user schema's designated identifier
|
|
8084
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
8085
|
+
designates no identifier or the user carries no value for it.
|
|
8086
|
+
*/
|
|
8087
|
+
readonly identifier?: string;
|
|
8088
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
8089
|
+
property's schema for semantics (a mailto link, a field label)
|
|
8090
|
+
instead of guessing from the value. Present exactly when
|
|
8091
|
+
`identifier` is.
|
|
8092
|
+
*/
|
|
8093
|
+
readonly identifier_property?: string;
|
|
8094
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
8095
|
+
in list order, resolved live at read time. Purely presentational.
|
|
8096
|
+
Absent when the schema designates no display properties or the user
|
|
8097
|
+
carries no values for them. Clients render `display`, falling back
|
|
8098
|
+
to `identifier`, then `id`.
|
|
8099
|
+
*/
|
|
8100
|
+
readonly display?: string;
|
|
7455
8101
|
/** The user's team memberships, present only when the request asked for them with
|
|
7456
8102
|
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
7457
8103
|
means the user has none.
|
|
@@ -7924,6 +8570,43 @@ declare const GetSession200State: {
|
|
|
7924
8570
|
readonly active: "active";
|
|
7925
8571
|
readonly expired: "expired";
|
|
7926
8572
|
}; //#endregion
|
|
8573
|
+
//#region src/generated/model/getSession200User.d.ts
|
|
8574
|
+
/**
|
|
8575
|
+
* Generated by orval v8.10.0 🍺
|
|
8576
|
+
* Do not edit manually.
|
|
8577
|
+
* Zitadel NextGen
|
|
8578
|
+
* This is the next generation of the Zitadel identity platform.
|
|
8579
|
+
* OpenAPI spec version: 0.0.1
|
|
8580
|
+
*/
|
|
8581
|
+
/**
|
|
8582
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
8583
|
+
property-named, so responses can mix users from different schemas.
|
|
8584
|
+
`identifier` and `display` are resolved independently from the user
|
|
8585
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
8586
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
8587
|
+
Missing or deleted users degrade to `user_id` only.
|
|
8588
|
+
|
|
8589
|
+
*/
|
|
8590
|
+
type GetSession200User = {
|
|
8591
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
8592
|
+
/** The current value of the schema's designated identifier
|
|
8593
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
8594
|
+
the user carries no value for it.
|
|
8595
|
+
*/
|
|
8596
|
+
identifier?: string;
|
|
8597
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
8598
|
+
property's schema for semantics (a mailto link, a field label)
|
|
8599
|
+
instead of guessing from the value. Present exactly when
|
|
8600
|
+
`identifier` is.
|
|
8601
|
+
*/
|
|
8602
|
+
identifier_property?: string;
|
|
8603
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
8604
|
+
in list order. Purely presentational, with no source attribution.
|
|
8605
|
+
Absent when the schema designates no display properties or the user
|
|
8606
|
+
carries no values for them.
|
|
8607
|
+
*/
|
|
8608
|
+
display?: string;
|
|
8609
|
+
}; //#endregion
|
|
7927
8610
|
//#region src/generated/model/getSession200UserAgent.d.ts
|
|
7928
8611
|
/**
|
|
7929
8612
|
* Generated by orval v8.10.0 🍺
|
|
@@ -7967,23 +8650,14 @@ type GetSession200 = {
|
|
|
7967
8650
|
factor has been verified through an `auth_attempt`.
|
|
7968
8651
|
*/
|
|
7969
8652
|
user_id?: string | null;
|
|
7970
|
-
/**
|
|
7971
|
-
|
|
7972
|
-
|
|
7973
|
-
|
|
7974
|
-
|
|
7975
|
-
|
|
7976
|
-
|
|
7977
|
-
|
|
7978
|
-
*/
|
|
7979
|
-
name?: string;
|
|
7980
|
-
/** Email address of the authenticated user, resolved from the
|
|
7981
|
-
conventional `email` user-schema property. Only present on reads
|
|
7982
|
-
that hydrate the user's identity (`GET /sessions/me`) and only when
|
|
7983
|
-
the session has an authenticated user whose schema carries that
|
|
7984
|
-
property.
|
|
7985
|
-
*/
|
|
7986
|
-
email?: string;
|
|
8653
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
8654
|
+
property-named, so responses can mix users from different schemas.
|
|
8655
|
+
`identifier` and `display` are resolved independently from the user
|
|
8656
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
8657
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
8658
|
+
Missing or deleted users degrade to `user_id` only.
|
|
8659
|
+
*/
|
|
8660
|
+
user?: GetSession200User;
|
|
7987
8661
|
/** Verified authentication factors accumulated by this session.
|
|
7988
8662
|
Each key is a factor type (e.g. `password`, `totp`, `passkey`).
|
|
7989
8663
|
Each value is a factor event object with at least `verified_at` and
|
|
@@ -8231,6 +8905,24 @@ type GetUserByID200 = {
|
|
|
8231
8905
|
*/
|
|
8232
8906
|
attributes: GetUserByID200Attributes;
|
|
8233
8907
|
metadata: GetUserByID200Metadata;
|
|
8908
|
+
/** The current value of the user schema's designated identifier
|
|
8909
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
8910
|
+
designates no identifier or the user carries no value for it.
|
|
8911
|
+
*/
|
|
8912
|
+
readonly identifier?: string;
|
|
8913
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
8914
|
+
property's schema for semantics (a mailto link, a field label)
|
|
8915
|
+
instead of guessing from the value. Present exactly when
|
|
8916
|
+
`identifier` is.
|
|
8917
|
+
*/
|
|
8918
|
+
readonly identifier_property?: string;
|
|
8919
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
8920
|
+
in list order, resolved live at read time. Purely presentational.
|
|
8921
|
+
Absent when the schema designates no display properties or the user
|
|
8922
|
+
carries no values for them. Clients render `display`, falling back
|
|
8923
|
+
to `identifier`, then `id`.
|
|
8924
|
+
*/
|
|
8925
|
+
readonly display?: string;
|
|
8234
8926
|
/** The user's team memberships, present only when the request asked for them with
|
|
8235
8927
|
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
8236
8928
|
means the user has none.
|
|
@@ -9455,6 +10147,59 @@ type ListEvents200DataItem = ({
|
|
|
9455
10147
|
};
|
|
9456
10148
|
[key: string]: unknown;
|
|
9457
10149
|
};
|
|
10150
|
+
} & {
|
|
10151
|
+
event_type: "release.created";
|
|
10152
|
+
/** Allowlisted fields for `release.created`. The release id is already the
|
|
10153
|
+
event's `entity_id`; the pinned set is repeated here so the audit stream
|
|
10154
|
+
answers what a release contained without reading the release itself.
|
|
10155
|
+
*/
|
|
10156
|
+
payload: {
|
|
10157
|
+
content_hash?: string;
|
|
10158
|
+
message?: string;
|
|
10159
|
+
git_sha?: string;
|
|
10160
|
+
git_dirty?: boolean;
|
|
10161
|
+
pointers?: {
|
|
10162
|
+
kind?: string;
|
|
10163
|
+
handle?: string;
|
|
10164
|
+
revision_id?: string;
|
|
10165
|
+
}[];
|
|
10166
|
+
};
|
|
10167
|
+
}) | ({
|
|
10168
|
+
/** Managed event id (`evt_<opaque>`). */id: string; /** @pattern ^[a-zA-Z0-9_-]+$ */
|
|
10169
|
+
project_id: string; /** Emit-time team scope, when the actor operated under a team. */
|
|
10170
|
+
team_id?: string | null;
|
|
10171
|
+
/** Semantic event name (dot-separated). Discriminator for the Event union —
|
|
10172
|
+
see docs/design/api/events-catalog.md.
|
|
10173
|
+
*/
|
|
10174
|
+
event_type: string; /** Wide-event category. */
|
|
10175
|
+
category: "request" | "auth" | "session" | "admin" | "entity" | "signal"; /** When the action happened (server/storage clock, dialect-owned). */
|
|
10176
|
+
occurred_at: string; /** When the row was inserted (server/storage clock, dialect-owned). */
|
|
10177
|
+
created_at: string; /** Who triggered the event. */
|
|
10178
|
+
actor_id?: string | null; /** Actor kind. */
|
|
10179
|
+
actor_type?: "human" | "service" | "system" | "agent" | null; /** Resource type affected. */
|
|
10180
|
+
entity_type?: string | null; /** Resource id affected. */
|
|
10181
|
+
entity_id?: string | null; /** Application or agent that produced the event. */
|
|
10182
|
+
client_id: string; /** Token id present at emit time, when any. */
|
|
10183
|
+
token_id?: string; /** Delegation kind (omit when unset). */
|
|
10184
|
+
delegation_type?: "direct" | "delegated" | "pat_shared" | "exchanged";
|
|
10185
|
+
delegation_id?: string;
|
|
10186
|
+
grantor?: string; /** Device fingerprint correlation id. */
|
|
10187
|
+
fingerprint?: string; /** HTTP request correlation id. */
|
|
10188
|
+
request_id?: string | null; /** Session correlation id. */
|
|
10189
|
+
session_id?: string | null; /** Login flow correlation id. */
|
|
10190
|
+
flow_id?: string | null;
|
|
10191
|
+
/** Emit-time metadata, already redacted at write. Path A request.api may
|
|
10192
|
+
set client (ip, user_agent, origin) for SIEM join on request_id. Not a
|
|
10193
|
+
live risk-evaluator input.
|
|
10194
|
+
*/
|
|
10195
|
+
metadata?: {
|
|
10196
|
+
/** Observed HTTP requestor context on Path A request.api only. */client?: {
|
|
10197
|
+
/** Client IP from the first X-Forwarded-For hop or RemoteAddr. */ip?: string; /** Observed User-Agent header. */
|
|
10198
|
+
user_agent?: string; /** Origin header when present. */
|
|
10199
|
+
origin?: string;
|
|
10200
|
+
};
|
|
10201
|
+
[key: string]: unknown;
|
|
10202
|
+
};
|
|
9458
10203
|
} & {
|
|
9459
10204
|
event_type: "request.api"; /** Payload for `request.api` events. */
|
|
9460
10205
|
payload: {
|
|
@@ -10322,9 +11067,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
10322
11067
|
type ListFlowDefinitions200FlowDefinitionsItemFlowDefinition = {
|
|
10323
11068
|
/**
|
|
10324
11069
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
10325
|
-
`switch` and `pivot` transitions.
|
|
10326
|
-
`name
|
|
10327
|
-
|
|
11070
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
11071
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
11072
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
11073
|
+
of the public contract another definition may reference. Acts as the
|
|
11074
|
+
human display label as well; no separate slug.
|
|
10328
11075
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
10329
11076
|
*/
|
|
10330
11077
|
name: string;
|
|
@@ -10475,6 +11222,9 @@ type ListFlowDefinitions200FlowDefinitionsItem = {
|
|
|
10475
11222
|
updated_at: string;
|
|
10476
11223
|
}; //#endregion
|
|
10477
11224
|
//#region src/generated/model/listFlowDefinitions200.d.ts
|
|
11225
|
+
/**
|
|
11226
|
+
* List of flow definitions, newest by creation time first.
|
|
11227
|
+
*/
|
|
10478
11228
|
type ListFlowDefinitions200 = {
|
|
10479
11229
|
flow_definitions: ListFlowDefinitions200FlowDefinitionsItem[]; /** The token to retrieve the next page of results. Absent if there are no more results. */
|
|
10480
11230
|
next_page_token?: string | null;
|
|
@@ -10555,6 +11305,13 @@ type ListFlowDefinitionsParams = {
|
|
|
10555
11305
|
* Filter flow definitions by purpose (e.g., registration, login).
|
|
10556
11306
|
*/
|
|
10557
11307
|
purpose?: ListFlowDefinitionsPurpose;
|
|
11308
|
+
/**
|
|
11309
|
+
* The flow name to filter by. Every revision of a flow shares its
|
|
11310
|
+
`name`, so the result is that flow's revisions, newest by creation
|
|
11311
|
+
time first.
|
|
11312
|
+
* @pattern ^[a-z][a-z0-9-]*$
|
|
11313
|
+
*/
|
|
11314
|
+
name?: string;
|
|
10558
11315
|
/**
|
|
10559
11316
|
* Related entities to embed on each returned flow definition.
|
|
10560
11317
|
*/
|
|
@@ -11068,6 +11825,494 @@ type PatchProjectBody = {
|
|
|
11068
11825
|
* OpenAPI spec version: 0.0.1
|
|
11069
11826
|
*/
|
|
11070
11827
|
//#endregion
|
|
11828
|
+
//#region src/generated/model/queryGrants200GrantsItemObjectType.d.ts
|
|
11829
|
+
/**
|
|
11830
|
+
* Generated by orval v8.10.0 🍺
|
|
11831
|
+
* Do not edit manually.
|
|
11832
|
+
* Zitadel NextGen
|
|
11833
|
+
* This is the next generation of the Zitadel identity platform.
|
|
11834
|
+
* OpenAPI spec version: 0.0.1
|
|
11835
|
+
*/
|
|
11836
|
+
/**
|
|
11837
|
+
* Catalog object type. Always `project` for this API.
|
|
11838
|
+
*/
|
|
11839
|
+
type QueryGrants200GrantsItemObjectType = (typeof QueryGrants200GrantsItemObjectType)[keyof typeof QueryGrants200GrantsItemObjectType];
|
|
11840
|
+
declare const QueryGrants200GrantsItemObjectType: {
|
|
11841
|
+
readonly project: "project";
|
|
11842
|
+
}; //#endregion
|
|
11843
|
+
//#region src/generated/model/queryGrants200GrantsItemPrincipal.d.ts
|
|
11844
|
+
/**
|
|
11845
|
+
* Generated by orval v8.10.0 🍺
|
|
11846
|
+
* Do not edit manually.
|
|
11847
|
+
* Zitadel NextGen
|
|
11848
|
+
* This is the next generation of the Zitadel identity platform.
|
|
11849
|
+
* OpenAPI spec version: 0.0.1
|
|
11850
|
+
*/
|
|
11851
|
+
/**
|
|
11852
|
+
* The principal named by `principal_id`, present only when the request
|
|
11853
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
11854
|
+
was not requested; `null` means the principal cannot be loaded
|
|
11855
|
+
(deleted or missing). GET and create never set this field.
|
|
11856
|
+
|
|
11857
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
11858
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
11859
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
11860
|
+
`principal_type`.
|
|
11861
|
+
|
|
11862
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
11863
|
+
Both are checked on the whole request before the list.
|
|
11864
|
+
|
|
11865
|
+
*/
|
|
11866
|
+
type QueryGrants200GrantsItemPrincipal = {
|
|
11867
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */id: string;
|
|
11868
|
+
/** The schema that defines the content of `attributes`. These schemas can be
|
|
11869
|
+
created using the `/schemas` endpoint. A default schema is provided.
|
|
11870
|
+
This schema can be retrieved using the same endpoint.
|
|
11871
|
+
*/
|
|
11872
|
+
schema: string;
|
|
11873
|
+
/** The user's content, satisfying the schema named by `schema`. Property
|
|
11874
|
+
names and types are determined entirely by that schema.
|
|
11875
|
+
*/
|
|
11876
|
+
attributes: {
|
|
11877
|
+
[key: string]: unknown;
|
|
11878
|
+
};
|
|
11879
|
+
metadata: {
|
|
11880
|
+
/** The time when the user was created. */created_at: string; /** The time when the user was last updated. */
|
|
11881
|
+
updated_at: string; /** The status of the user. */
|
|
11882
|
+
status: "active" | "suspended" | "deactivated" | "pending_purge";
|
|
11883
|
+
/** The team that owns this user's identity lifecycle, or `null` when the
|
|
11884
|
+
user is self-owned. This is a single team and a different concept from
|
|
11885
|
+
the user's team memberships: it decides who may deprovision the user, not
|
|
11886
|
+
which teams the user collaborates in. Memberships are their own paginated
|
|
11887
|
+
resource — `GET /users/{user_id}/teams`.
|
|
11888
|
+
*/
|
|
11889
|
+
lifecycle_owner_team_id?: string | null;
|
|
11890
|
+
/** The team named by `lifecycle_owner_team_id`, present only when the
|
|
11891
|
+
request asked for it with `expand: ["lifecycle_owner_team"]` (ADR 059).
|
|
11892
|
+
Absent means it was not requested; `null` means the user is self-owned
|
|
11893
|
+
and there is no owner to resolve.
|
|
11894
|
+
Requesting it does not guarantee it is present on every user. Today
|
|
11895
|
+
`team.read` is checked once for the whole request, so it is; once that
|
|
11896
|
+
check is per team, a page may contain a user whose owner the caller may
|
|
11897
|
+
not read, and such a row answers with neither the team nor `null` —
|
|
11898
|
+
`null` already means self-owned. What it answers with instead is decided
|
|
11899
|
+
with the granular scopes (#420); do not read the two cases above as the
|
|
11900
|
+
complete set.
|
|
11901
|
+
This is the same representation `GET /teams/{team_id}` serves. It is a
|
|
11902
|
+
single team, not a collection, so it carries no cap and no truncation
|
|
11903
|
+
flag.
|
|
11904
|
+
*/
|
|
11905
|
+
readonly lifecycle_owner_team?: {
|
|
11906
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
11907
|
+
name: string;
|
|
11908
|
+
/** The lifecycle state of a team.
|
|
11909
|
+
active: The team is available for use.
|
|
11910
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
11911
|
+
*/
|
|
11912
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
11913
|
+
created_at: string; /** The time when the team was last updated. */
|
|
11914
|
+
updated_at: string;
|
|
11915
|
+
} | null;
|
|
11916
|
+
};
|
|
11917
|
+
/** The current value of the user schema's designated identifier
|
|
11918
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
11919
|
+
designates no identifier or the user carries no value for it.
|
|
11920
|
+
*/
|
|
11921
|
+
readonly identifier?: string;
|
|
11922
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
11923
|
+
property's schema for semantics (a mailto link, a field label)
|
|
11924
|
+
instead of guessing from the value. Present exactly when
|
|
11925
|
+
`identifier` is.
|
|
11926
|
+
*/
|
|
11927
|
+
readonly identifier_property?: string;
|
|
11928
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
11929
|
+
in list order, resolved live at read time. Purely presentational.
|
|
11930
|
+
Absent when the schema designates no display properties or the user
|
|
11931
|
+
carries no values for them. Clients render `display`, falling back
|
|
11932
|
+
to `identifier`, then `id`.
|
|
11933
|
+
*/
|
|
11934
|
+
readonly display?: string;
|
|
11935
|
+
/** The user's team memberships, present only when the request asked for them with
|
|
11936
|
+
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
11937
|
+
means the user has none.
|
|
11938
|
+
Deliberately outside `metadata`: memberships are a related collection, not
|
|
11939
|
+
part of the server-owned envelope, and it is a different concept from
|
|
11940
|
+
`metadata.lifecycle_owner_team_id` (ADR 024).
|
|
11941
|
+
*/
|
|
11942
|
+
readonly teams?: readonly {
|
|
11943
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
11944
|
+
name: string;
|
|
11945
|
+
/** The user's participation state on this team. Memberships the user was
|
|
11946
|
+
removed from are not returned.
|
|
11947
|
+
*/
|
|
11948
|
+
membership_status: "pending" | "active" | "inactive"; /** The time when the user joined this team. */
|
|
11949
|
+
created_at: string; /** The time when this membership was last changed. */
|
|
11950
|
+
updated_at: string;
|
|
11951
|
+
}[];
|
|
11952
|
+
/** True when the user is on more teams than the embedded list carries. The
|
|
11953
|
+
embedded list is capped and cannot be paged; read them all at
|
|
11954
|
+
`GET /users/{user_id}/teams`. Present only alongside `teams`.
|
|
11955
|
+
*/
|
|
11956
|
+
readonly teams_truncated?: boolean;
|
|
11957
|
+
} | {
|
|
11958
|
+
/** The unique identifier of the team. */id: string; /** The name of the team. */
|
|
11959
|
+
name: string;
|
|
11960
|
+
/** The lifecycle state of a team.
|
|
11961
|
+
active: The team is available for use.
|
|
11962
|
+
deactivated: The team is no longer active but is retained for historical and audit purposes.
|
|
11963
|
+
*/
|
|
11964
|
+
status: "active" | "deactivated"; /** The time when the team was created. */
|
|
11965
|
+
created_at: string; /** The time when the team was last updated. */
|
|
11966
|
+
updated_at: string;
|
|
11967
|
+
} | null; //#endregion
|
|
11968
|
+
//#region src/generated/model/queryGrants200GrantsItemPrincipalType.d.ts
|
|
11969
|
+
/**
|
|
11970
|
+
* Generated by orval v8.10.0 🍺
|
|
11971
|
+
* Do not edit manually.
|
|
11972
|
+
* Zitadel NextGen
|
|
11973
|
+
* This is the next generation of the Zitadel identity platform.
|
|
11974
|
+
* OpenAPI spec version: 0.0.1
|
|
11975
|
+
*/
|
|
11976
|
+
/**
|
|
11977
|
+
* Kind of principal bound by this grant.
|
|
11978
|
+
*/
|
|
11979
|
+
type QueryGrants200GrantsItemPrincipalType = (typeof QueryGrants200GrantsItemPrincipalType)[keyof typeof QueryGrants200GrantsItemPrincipalType];
|
|
11980
|
+
declare const QueryGrants200GrantsItemPrincipalType: {
|
|
11981
|
+
readonly user: "user";
|
|
11982
|
+
readonly team: "team";
|
|
11983
|
+
}; //#endregion
|
|
11984
|
+
//#region src/generated/model/queryGrants200GrantsItemRelation.d.ts
|
|
11985
|
+
/**
|
|
11986
|
+
* Generated by orval v8.10.0 🍺
|
|
11987
|
+
* Do not edit manually.
|
|
11988
|
+
* Zitadel NextGen
|
|
11989
|
+
* This is the next generation of the Zitadel identity platform.
|
|
11990
|
+
* OpenAPI spec version: 0.0.1
|
|
11991
|
+
*/
|
|
11992
|
+
/**
|
|
11993
|
+
* Catalog relation on the project.
|
|
11994
|
+
*/
|
|
11995
|
+
type QueryGrants200GrantsItemRelation = (typeof QueryGrants200GrantsItemRelation)[keyof typeof QueryGrants200GrantsItemRelation];
|
|
11996
|
+
declare const QueryGrants200GrantsItemRelation: {
|
|
11997
|
+
readonly viewer: "viewer";
|
|
11998
|
+
readonly editor: "editor";
|
|
11999
|
+
readonly admin: "admin";
|
|
12000
|
+
}; //#endregion
|
|
12001
|
+
//#region src/generated/model/queryGrants200GrantsItemTeam.d.ts
|
|
12002
|
+
/**
|
|
12003
|
+
* Generated by orval v8.10.0 🍺
|
|
12004
|
+
* Do not edit manually.
|
|
12005
|
+
* Zitadel NextGen
|
|
12006
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12007
|
+
* OpenAPI spec version: 0.0.1
|
|
12008
|
+
*/
|
|
12009
|
+
/**
|
|
12010
|
+
* A resolved reference to a team. Carries the team's id and name so a grant
|
|
12011
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
12012
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
12013
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
12014
|
+
deleted teams degrade to `team_id` only.
|
|
12015
|
+
|
|
12016
|
+
*/
|
|
12017
|
+
type QueryGrants200GrantsItemTeam = {
|
|
12018
|
+
/** The referenced team's id (`team_<opaque>`). Always present. */team_id: string; /** The team's name. Absent when the team can no longer be loaded. */
|
|
12019
|
+
name?: string;
|
|
12020
|
+
}; //#endregion
|
|
12021
|
+
//#region src/generated/model/queryGrants200GrantsItemUser.d.ts
|
|
12022
|
+
/**
|
|
12023
|
+
* Generated by orval v8.10.0 🍺
|
|
12024
|
+
* Do not edit manually.
|
|
12025
|
+
* Zitadel NextGen
|
|
12026
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12027
|
+
* OpenAPI spec version: 0.0.1
|
|
12028
|
+
*/
|
|
12029
|
+
/**
|
|
12030
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
12031
|
+
property-named, so responses can mix users from different schemas.
|
|
12032
|
+
`identifier` and `display` are resolved independently from the user
|
|
12033
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
12034
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
12035
|
+
Missing or deleted users degrade to `user_id` only.
|
|
12036
|
+
|
|
12037
|
+
*/
|
|
12038
|
+
type QueryGrants200GrantsItemUser = {
|
|
12039
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
12040
|
+
/** The current value of the schema's designated identifier
|
|
12041
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
12042
|
+
the user carries no value for it.
|
|
12043
|
+
*/
|
|
12044
|
+
identifier?: string;
|
|
12045
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
12046
|
+
property's schema for semantics (a mailto link, a field label)
|
|
12047
|
+
instead of guessing from the value. Present exactly when
|
|
12048
|
+
`identifier` is.
|
|
12049
|
+
*/
|
|
12050
|
+
identifier_property?: string;
|
|
12051
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
12052
|
+
in list order. Purely presentational, with no source attribution.
|
|
12053
|
+
Absent when the schema designates no display properties or the user
|
|
12054
|
+
carries no values for them.
|
|
12055
|
+
*/
|
|
12056
|
+
display?: string;
|
|
12057
|
+
}; //#endregion
|
|
12058
|
+
//#region src/generated/model/queryGrants200GrantsItem.d.ts
|
|
12059
|
+
/**
|
|
12060
|
+
* A collaboration grant binding a principal to a project relation.
|
|
12061
|
+
*/
|
|
12062
|
+
type QueryGrants200GrantsItem = {
|
|
12063
|
+
/** Managed assignment id (`asgn_<opaque>`). */id: string; /** Project this grant is scoped to. */
|
|
12064
|
+
project_id: string; /** Kind of principal bound by this grant. */
|
|
12065
|
+
principal_type: QueryGrants200GrantsItemPrincipalType; /** Principal id (`user_<opaque>` or `team_<opaque>`). */
|
|
12066
|
+
principal_id: string; /** Catalog object type. Always `project` for this API. */
|
|
12067
|
+
object_type: QueryGrants200GrantsItemObjectType; /** Catalog relation on the project. */
|
|
12068
|
+
relation: QueryGrants200GrantsItemRelation; /** When the grant was created. */
|
|
12069
|
+
created_at: string;
|
|
12070
|
+
/** When the grant expires. Null when it does not expire. GET still
|
|
12071
|
+
returns expired unrevoked grants; authorization ignores them.
|
|
12072
|
+
*/
|
|
12073
|
+
expires_at?: string | null;
|
|
12074
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
12075
|
+
property-named, so responses can mix users from different schemas.
|
|
12076
|
+
`identifier` and `display` are resolved independently from the user
|
|
12077
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
12078
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
12079
|
+
Missing or deleted users degrade to `user_id` only.
|
|
12080
|
+
*/
|
|
12081
|
+
user?: QueryGrants200GrantsItemUser;
|
|
12082
|
+
/** A resolved reference to a team. Carries the team's id and name so a grant
|
|
12083
|
+
list is readable without embedding the full Team body. Id and display ride
|
|
12084
|
+
`project.read` (ADR 059 rule 8): a reference field carrying only the
|
|
12085
|
+
target's id and display strings needs no gate of its own. Missing or
|
|
12086
|
+
deleted teams degrade to `team_id` only.
|
|
12087
|
+
*/
|
|
12088
|
+
team?: QueryGrants200GrantsItemTeam;
|
|
12089
|
+
/** The principal named by `principal_id`, present only when the request
|
|
12090
|
+
asked for it with `expand: ["principal"]` (ADR 059). Absent means it
|
|
12091
|
+
was not requested; `null` means the principal cannot be loaded
|
|
12092
|
+
(deleted or missing). GET and create never set this field.
|
|
12093
|
+
When present, the body is the same representation `GET /users/{id}`
|
|
12094
|
+
serves for `principal_type=user`, or `GET /teams/{id}` for
|
|
12095
|
+
`principal_type=team`. Discriminate with the grant's existing
|
|
12096
|
+
`principal_type`.
|
|
12097
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
12098
|
+
Both are checked on the whole request before the list.
|
|
12099
|
+
*/
|
|
12100
|
+
readonly principal?: QueryGrants200GrantsItemPrincipal;
|
|
12101
|
+
}; //#endregion
|
|
12102
|
+
//#region src/generated/model/queryGrants200.d.ts
|
|
12103
|
+
/**
|
|
12104
|
+
* Paginated list of grants.
|
|
12105
|
+
*/
|
|
12106
|
+
type QueryGrants200 = {
|
|
12107
|
+
grants: QueryGrants200GrantsItem[];
|
|
12108
|
+
/** Token to pass as `page_token` in the next request to fetch the following page.
|
|
12109
|
+
Absent when there are no more results. The follow-up request must repeat the
|
|
12110
|
+
same `sorting` that produced this token (omit only when both pages use the default).
|
|
12111
|
+
*/
|
|
12112
|
+
next_page_token?: string | null;
|
|
12113
|
+
}; //#endregion
|
|
12114
|
+
//#region src/generated/model/queryGrants400Details.d.ts
|
|
12115
|
+
/**
|
|
12116
|
+
* Generated by orval v8.10.0 🍺
|
|
12117
|
+
* Do not edit manually.
|
|
12118
|
+
* Zitadel NextGen
|
|
12119
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12120
|
+
* OpenAPI spec version: 0.0.1
|
|
12121
|
+
*/
|
|
12122
|
+
/**
|
|
12123
|
+
* Additional error-specific context.
|
|
12124
|
+
*/
|
|
12125
|
+
//#endregion
|
|
12126
|
+
//#region src/generated/model/queryGrantsBodyExpandItem.d.ts
|
|
12127
|
+
/**
|
|
12128
|
+
* Generated by orval v8.10.0 🍺
|
|
12129
|
+
* Do not edit manually.
|
|
12130
|
+
* Zitadel NextGen
|
|
12131
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12132
|
+
* OpenAPI spec version: 0.0.1
|
|
12133
|
+
*/
|
|
12134
|
+
/**
|
|
12135
|
+
* A related object to embed on each returned grant (ADR 059).
|
|
12136
|
+
|
|
12137
|
+
- `principal`: the principal named by `principal_id`, as `principal` on
|
|
12138
|
+
each grant. The property is omitted entirely when not requested. When
|
|
12139
|
+
requested, it is the same body `GET /users/{id}` serves for
|
|
12140
|
+
`principal_type=user`, or `GET /teams/{id}` for `principal_type=team`,
|
|
12141
|
+
and `null` when that principal cannot be loaded. Discriminate with the
|
|
12142
|
+
grant's existing `principal_type`.
|
|
12143
|
+
|
|
12144
|
+
Requires `user.read` and `team.read` in addition to `project.read`.
|
|
12145
|
+
Both are checked on the whole request before the list, because a mixed
|
|
12146
|
+
page is the common case. A caller who may not read either resource
|
|
12147
|
+
receives 403 rather than a silently missing `principal`.
|
|
12148
|
+
|
|
12149
|
+
*/
|
|
12150
|
+
type QueryGrantsBodyExpandItem = (typeof QueryGrantsBodyExpandItem)[keyof typeof QueryGrantsBodyExpandItem];
|
|
12151
|
+
declare const QueryGrantsBodyExpandItem: {
|
|
12152
|
+
readonly principal: "principal";
|
|
12153
|
+
}; //#endregion
|
|
12154
|
+
//#region src/generated/model/queryGrantsBodyFilterItemField.d.ts
|
|
12155
|
+
/**
|
|
12156
|
+
* Generated by orval v8.10.0 🍺
|
|
12157
|
+
* Do not edit manually.
|
|
12158
|
+
* Zitadel NextGen
|
|
12159
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12160
|
+
* OpenAPI spec version: 0.0.1
|
|
12161
|
+
*/
|
|
12162
|
+
/**
|
|
12163
|
+
* Field to filter grants by:
|
|
12164
|
+
- `created_at`: RFC3339 timestamp
|
|
12165
|
+
- `principal_type`: `user` or `team`
|
|
12166
|
+
- `principal_id`: principal id (`user_<opaque>` or `team_<opaque>`)
|
|
12167
|
+
- `relation`: `viewer`, `editor`, or `admin`
|
|
12168
|
+
- `expires_at`: RFC3339 timestamp (null when the grant does not expire)
|
|
12169
|
+
|
|
12170
|
+
*/
|
|
12171
|
+
type QueryGrantsBodyFilterItemField = (typeof QueryGrantsBodyFilterItemField)[keyof typeof QueryGrantsBodyFilterItemField];
|
|
12172
|
+
declare const QueryGrantsBodyFilterItemField: {
|
|
12173
|
+
readonly created_at: "created_at";
|
|
12174
|
+
readonly principal_type: "principal_type";
|
|
12175
|
+
readonly principal_id: "principal_id";
|
|
12176
|
+
readonly relation: "relation";
|
|
12177
|
+
readonly expires_at: "expires_at";
|
|
12178
|
+
}; //#endregion
|
|
12179
|
+
//#region src/generated/model/queryGrantsBodyFilterItemOperation.d.ts
|
|
12180
|
+
/**
|
|
12181
|
+
* Generated by orval v8.10.0 🍺
|
|
12182
|
+
* Do not edit manually.
|
|
12183
|
+
* Zitadel NextGen
|
|
12184
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12185
|
+
* OpenAPI spec version: 0.0.1
|
|
12186
|
+
*/
|
|
12187
|
+
/**
|
|
12188
|
+
* Filter operation defines the operations which can be used when filtering on a
|
|
12189
|
+
query endpoint.
|
|
12190
|
+
|
|
12191
|
+
On text fields, `contains` is a case-insensitive substring match. `equals`
|
|
12192
|
+
compares the whole value and is case-sensitive unless the field documents
|
|
12193
|
+
otherwise.
|
|
12194
|
+
|
|
12195
|
+
*/
|
|
12196
|
+
type QueryGrantsBodyFilterItemOperation = (typeof QueryGrantsBodyFilterItemOperation)[keyof typeof QueryGrantsBodyFilterItemOperation];
|
|
12197
|
+
declare const QueryGrantsBodyFilterItemOperation: {
|
|
12198
|
+
readonly equals: "equals";
|
|
12199
|
+
readonly not_equals: "not_equals";
|
|
12200
|
+
readonly contains: "contains";
|
|
12201
|
+
readonly not_contains: "not_contains";
|
|
12202
|
+
readonly less_than: "less_than";
|
|
12203
|
+
readonly less_than_or_equal: "less_than_or_equal";
|
|
12204
|
+
readonly greater_than: "greater_than";
|
|
12205
|
+
readonly greater_than_or_equal: "greater_than_or_equal";
|
|
12206
|
+
}; //#endregion
|
|
12207
|
+
//#region src/generated/model/queryGrantsBodyFilterItem.d.ts
|
|
12208
|
+
type QueryGrantsBodyFilterItem = {
|
|
12209
|
+
/** Field to filter grants by:
|
|
12210
|
+
- `created_at`: RFC3339 timestamp
|
|
12211
|
+
- `principal_type`: `user` or `team`
|
|
12212
|
+
- `principal_id`: principal id (`user_<opaque>` or `team_<opaque>`)
|
|
12213
|
+
- `relation`: `viewer`, `editor`, or `admin`
|
|
12214
|
+
- `expires_at`: RFC3339 timestamp (null when the grant does not expire)
|
|
12215
|
+
*/
|
|
12216
|
+
field: QueryGrantsBodyFilterItemField;
|
|
12217
|
+
/** Filter-value specifies which values can be filtered by a query endpoint. This
|
|
12218
|
+
is a union of types. When a value is specified which is not assignable to the
|
|
12219
|
+
field which is being filtered, a 400 error will be returned.
|
|
12220
|
+
*/
|
|
12221
|
+
value?: string | number | boolean | null;
|
|
12222
|
+
/** Filter operation defines the operations which can be used when filtering on a
|
|
12223
|
+
query endpoint.
|
|
12224
|
+
On text fields, `contains` is a case-insensitive substring match. `equals`
|
|
12225
|
+
compares the whole value and is case-sensitive unless the field documents
|
|
12226
|
+
otherwise.
|
|
12227
|
+
*/
|
|
12228
|
+
operation: QueryGrantsBodyFilterItemOperation;
|
|
12229
|
+
}; //#endregion
|
|
12230
|
+
//#region src/generated/model/queryGrantsBodySortingDirection.d.ts
|
|
12231
|
+
/**
|
|
12232
|
+
* Generated by orval v8.10.0 🍺
|
|
12233
|
+
* Do not edit manually.
|
|
12234
|
+
* Zitadel NextGen
|
|
12235
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12236
|
+
* OpenAPI spec version: 0.0.1
|
|
12237
|
+
*/
|
|
12238
|
+
type QueryGrantsBodySortingDirection = (typeof QueryGrantsBodySortingDirection)[keyof typeof QueryGrantsBodySortingDirection];
|
|
12239
|
+
declare const QueryGrantsBodySortingDirection: {
|
|
12240
|
+
readonly asc: "asc";
|
|
12241
|
+
readonly desc: "desc";
|
|
12242
|
+
}; //#endregion
|
|
12243
|
+
//#region src/generated/model/queryGrantsBodySortingField.d.ts
|
|
12244
|
+
/**
|
|
12245
|
+
* Generated by orval v8.10.0 🍺
|
|
12246
|
+
* Do not edit manually.
|
|
12247
|
+
* Zitadel NextGen
|
|
12248
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12249
|
+
* OpenAPI spec version: 0.0.1
|
|
12250
|
+
*/
|
|
12251
|
+
/**
|
|
12252
|
+
* Field to sort grants by. Default is `created_at` ascending with `id` as
|
|
12253
|
+
the tiebreaker.
|
|
12254
|
+
|
|
12255
|
+
*/
|
|
12256
|
+
type QueryGrantsBodySortingField = (typeof QueryGrantsBodySortingField)[keyof typeof QueryGrantsBodySortingField];
|
|
12257
|
+
declare const QueryGrantsBodySortingField: {
|
|
12258
|
+
readonly created_at: "created_at";
|
|
12259
|
+
readonly expires_at: "expires_at";
|
|
12260
|
+
readonly id: "id";
|
|
12261
|
+
}; //#endregion
|
|
12262
|
+
//#region src/generated/model/queryGrantsBodySorting.d.ts
|
|
12263
|
+
type QueryGrantsBodySorting = {
|
|
12264
|
+
/** Field to sort grants by. Default is `created_at` ascending with `id` as
|
|
12265
|
+
the tiebreaker.
|
|
12266
|
+
*/
|
|
12267
|
+
field: QueryGrantsBodySortingField;
|
|
12268
|
+
direction: QueryGrantsBodySortingDirection;
|
|
12269
|
+
}; //#endregion
|
|
12270
|
+
//#region src/generated/model/queryGrantsBody.d.ts
|
|
12271
|
+
/**
|
|
12272
|
+
* Request to query the grants of a project.
|
|
12273
|
+
*/
|
|
12274
|
+
type QueryGrantsBody = {
|
|
12275
|
+
/**
|
|
12276
|
+
* @minimum 1
|
|
12277
|
+
* @maximum 100
|
|
12278
|
+
*/
|
|
12279
|
+
limit?: number;
|
|
12280
|
+
/** Token to retrieve the next page of results. Must be sent with the same
|
|
12281
|
+
`sorting` as the request that issued the token. Omitting `sorting` reuses
|
|
12282
|
+
the default sort and only succeeds when that default matches the token.
|
|
12283
|
+
*/
|
|
12284
|
+
page_token?: string | null;
|
|
12285
|
+
/** Related objects to embed on each grant (ADR 059). Omit it and no
|
|
12286
|
+
embedded object is returned. An unrecognised value is rejected.
|
|
12287
|
+
*/
|
|
12288
|
+
expand?: QueryGrantsBodyExpandItem[];
|
|
12289
|
+
sorting?: QueryGrantsBodySorting; /** Filter criteria for querying grants. Combined with AND. */
|
|
12290
|
+
filter?: QueryGrantsBodyFilterItem[];
|
|
12291
|
+
}; //#endregion
|
|
12292
|
+
//#region src/generated/model/queryGrantsDefault.d.ts
|
|
12293
|
+
/**
|
|
12294
|
+
* Generated by orval v8.10.0 🍺
|
|
12295
|
+
* Do not edit manually.
|
|
12296
|
+
* Zitadel NextGen
|
|
12297
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12298
|
+
* OpenAPI spec version: 0.0.1
|
|
12299
|
+
*/
|
|
12300
|
+
//#endregion
|
|
12301
|
+
//#region src/generated/model/queryGrantsParams.d.ts
|
|
12302
|
+
/**
|
|
12303
|
+
* Generated by orval v8.10.0 🍺
|
|
12304
|
+
* Do not edit manually.
|
|
12305
|
+
* Zitadel NextGen
|
|
12306
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12307
|
+
* OpenAPI spec version: 0.0.1
|
|
12308
|
+
*/
|
|
12309
|
+
type QueryGrantsParams = {
|
|
12310
|
+
/**
|
|
12311
|
+
* The unique identifier of the project
|
|
12312
|
+
* @pattern ^[a-zA-Z0-9_-]+$
|
|
12313
|
+
*/
|
|
12314
|
+
project_id: string;
|
|
12315
|
+
}; //#endregion
|
|
11071
12316
|
//#region src/generated/model/queryProjects200ProjectsItem.d.ts
|
|
11072
12317
|
/**
|
|
11073
12318
|
* Generated by orval v8.10.0 🍺
|
|
@@ -11319,6 +12564,43 @@ declare const QuerySessions200SessionsItemState: {
|
|
|
11319
12564
|
readonly active: "active";
|
|
11320
12565
|
readonly expired: "expired";
|
|
11321
12566
|
}; //#endregion
|
|
12567
|
+
//#region src/generated/model/querySessions200SessionsItemUser.d.ts
|
|
12568
|
+
/**
|
|
12569
|
+
* Generated by orval v8.10.0 🍺
|
|
12570
|
+
* Do not edit manually.
|
|
12571
|
+
* Zitadel NextGen
|
|
12572
|
+
* This is the next generation of the Zitadel identity platform.
|
|
12573
|
+
* OpenAPI spec version: 0.0.1
|
|
12574
|
+
*/
|
|
12575
|
+
/**
|
|
12576
|
+
* A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
12577
|
+
property-named, so responses can mix users from different schemas.
|
|
12578
|
+
`identifier` and `display` are resolved independently from the user
|
|
12579
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
12580
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
12581
|
+
Missing or deleted users degrade to `user_id` only.
|
|
12582
|
+
|
|
12583
|
+
*/
|
|
12584
|
+
type QuerySessions200SessionsItemUser = {
|
|
12585
|
+
/** @pattern ^user_[a-zA-Z0-9_-]+$ */user_id: string;
|
|
12586
|
+
/** The current value of the schema's designated identifier
|
|
12587
|
+
(`x-identifier`). Absent when the schema designates no identifier or
|
|
12588
|
+
the user carries no value for it.
|
|
12589
|
+
*/
|
|
12590
|
+
identifier?: string;
|
|
12591
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
12592
|
+
property's schema for semantics (a mailto link, a field label)
|
|
12593
|
+
instead of guessing from the value. Present exactly when
|
|
12594
|
+
`identifier` is.
|
|
12595
|
+
*/
|
|
12596
|
+
identifier_property?: string;
|
|
12597
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
12598
|
+
in list order. Purely presentational, with no source attribution.
|
|
12599
|
+
Absent when the schema designates no display properties or the user
|
|
12600
|
+
carries no values for them.
|
|
12601
|
+
*/
|
|
12602
|
+
display?: string;
|
|
12603
|
+
}; //#endregion
|
|
11322
12604
|
//#region src/generated/model/querySessions200SessionsItemUserAgent.d.ts
|
|
11323
12605
|
/**
|
|
11324
12606
|
* Generated by orval v8.10.0 🍺
|
|
@@ -11362,23 +12644,14 @@ type QuerySessions200SessionsItem = {
|
|
|
11362
12644
|
factor has been verified through an `auth_attempt`.
|
|
11363
12645
|
*/
|
|
11364
12646
|
user_id?: string | null;
|
|
11365
|
-
/**
|
|
11366
|
-
|
|
11367
|
-
|
|
11368
|
-
|
|
11369
|
-
|
|
11370
|
-
|
|
11371
|
-
|
|
11372
|
-
|
|
11373
|
-
*/
|
|
11374
|
-
name?: string;
|
|
11375
|
-
/** Email address of the authenticated user, resolved from the
|
|
11376
|
-
conventional `email` user-schema property. Only present on reads
|
|
11377
|
-
that hydrate the user's identity (`GET /sessions/me`) and only when
|
|
11378
|
-
the session has an authenticated user whose schema carries that
|
|
11379
|
-
property.
|
|
11380
|
-
*/
|
|
11381
|
-
email?: string;
|
|
12647
|
+
/** A resolved reference to a user (ADR 058 §3). Fields are role-named, not
|
|
12648
|
+
property-named, so responses can mix users from different schemas.
|
|
12649
|
+
`identifier` and `display` are resolved independently from the user
|
|
12650
|
+
schema's `x-identifier` and `x-display` designations, live at read time.
|
|
12651
|
+
Clients render `display`, falling back to `identifier`, then `user_id`.
|
|
12652
|
+
Missing or deleted users degrade to `user_id` only.
|
|
12653
|
+
*/
|
|
12654
|
+
user?: QuerySessions200SessionsItemUser;
|
|
11382
12655
|
/** Verified authentication factors accumulated by this session.
|
|
11383
12656
|
Each key is a factor type (e.g. `password`, `totp`, `passkey`).
|
|
11384
12657
|
Each value is a factor event object with at least `verified_at` and
|
|
@@ -11974,6 +13247,24 @@ type QueryUsers200UsersItem = {
|
|
|
11974
13247
|
*/
|
|
11975
13248
|
attributes: QueryUsers200UsersItemAttributes;
|
|
11976
13249
|
metadata: QueryUsers200UsersItemMetadata;
|
|
13250
|
+
/** The current value of the user schema's designated identifier
|
|
13251
|
+
(`x-identifier`), resolved live at read time. Absent when the schema
|
|
13252
|
+
designates no identifier or the user carries no value for it.
|
|
13253
|
+
*/
|
|
13254
|
+
readonly identifier?: string;
|
|
13255
|
+
/** The schema property `identifier` came from, so clients can reach the
|
|
13256
|
+
property's schema for semantics (a mailto link, a field label)
|
|
13257
|
+
instead of guessing from the value. Present exactly when
|
|
13258
|
+
`identifier` is.
|
|
13259
|
+
*/
|
|
13260
|
+
readonly identifier_property?: string;
|
|
13261
|
+
/** The `x-display` rendering — the designated properties' values joined
|
|
13262
|
+
in list order, resolved live at read time. Purely presentational.
|
|
13263
|
+
Absent when the schema designates no display properties or the user
|
|
13264
|
+
carries no values for them. Clients render `display`, falling back
|
|
13265
|
+
to `identifier`, then `id`.
|
|
13266
|
+
*/
|
|
13267
|
+
readonly display?: string;
|
|
11977
13268
|
/** The user's team memberships, present only when the request asked for them with
|
|
11978
13269
|
`expand: ["teams"]` (ADR 059). Absent means it was not requested; `[]`
|
|
11979
13270
|
means the user has none.
|
|
@@ -13227,9 +14518,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
13227
14518
|
type UpdateFlowDefinition200FlowDefinition = {
|
|
13228
14519
|
/**
|
|
13229
14520
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
13230
|
-
`switch` and `pivot` transitions.
|
|
13231
|
-
`name
|
|
13232
|
-
|
|
14521
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
14522
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
14523
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
14524
|
+
of the public contract another definition may reference. Acts as the
|
|
14525
|
+
human display label as well; no separate slug.
|
|
13233
14526
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
13234
14527
|
*/
|
|
13235
14528
|
name: string;
|
|
@@ -13726,9 +15019,11 @@ the purpose + audience when a flow is created via POST /flow.
|
|
|
13726
15019
|
type UpdateFlowDefinitionBodyFlowDefinition = {
|
|
13727
15020
|
/**
|
|
13728
15021
|
* Stable identifier for this flow, used as the target of cross-flow
|
|
13729
|
-
`switch` and `pivot` transitions.
|
|
13730
|
-
`name
|
|
13731
|
-
|
|
15022
|
+
`switch` and `pivot` transitions. Every revision of a flow shares its
|
|
15023
|
+
`name`; publishing a definition under an existing `name` adds a
|
|
15024
|
+
revision to that flow. Renaming is not supported — the `name` is part
|
|
15025
|
+
of the public contract another definition may reference. Acts as the
|
|
15026
|
+
human display label as well; no separate slug.
|
|
13732
15027
|
* @pattern ^[a-z][a-z0-9-]*$
|
|
13733
15028
|
*/
|
|
13734
15029
|
name: string;
|
|
@@ -14430,7 +15725,7 @@ declare class ZlPasskey extends LitElement {
|
|
|
14430
15725
|
*/
|
|
14431
15726
|
startCeremony(): Promise<void>;
|
|
14432
15727
|
private handleCancelSubmit;
|
|
14433
|
-
render():
|
|
15728
|
+
render(): _$lit.TemplateResult<1> | typeof nothing;
|
|
14434
15729
|
/**
|
|
14435
15730
|
* `navigator.credentials.get()` — authentication ceremony.
|
|
14436
15731
|
*/
|
|
@@ -14638,5 +15933,5 @@ declare global {
|
|
|
14638
15933
|
}
|
|
14639
15934
|
} //# sourceMappingURL=zl-select.d.ts.map
|
|
14640
15935
|
//#endregion
|
|
14641
|
-
export { CreateTeam201 as $,
|
|
14642
|
-
//# sourceMappingURL=index-
|
|
15936
|
+
export { CreateTeam201 as $, ListSchemasParams as $t, CreateFlow201StepChallenge as A, zlCheckboxManifest as An, GetReadyDefault as At, CreateGrantParams as B, ZlIcon as Bn, IssueChallenge201 as Bt, CreateBrandingBody as C, UpdateFlowDefinitionBody as Cn, GetGrant200 as Ct, CreateFlow201BrandingLayout as D, VerifyChallengeProofBody as Dn, GetMySession200 as Dt, CreateFlow201Branding as E, VerifyChallengeProof200 as En, GetLiveDefault as Et, CreateFlowBodyPurpose as F, ZlAlert as Fn, GetSession200 as Ft, CreateRelease201 as G, ListEnvironmentsParams as Gt, CreateProject201 as H, ListBranding200Item as Ht, CreateFlowDefinition201 as I, zlAlertManifest as In, GetTeam200 as It, CreateSchema201 as J, ListFlowDefinitions200 as Jt, CreateReleaseBody as K, ListEvents200 as Kt, CreateFlowDefinitionBody as L, IconName as Ln, GetUserByID200 as Lt, CreateFlow201StepGates as M, zlCardManifest as Mn, GetReleaseByIdParams as Mt, CreateFlow201StepSsoProvidersItem as N, ZlButton as Nn, GetSchemaById200 as Nt, CreateFlow201Step as O, ZlCheckbox as On, GetMyUser200 as Ot, CreateFlowBody as P, zlButtonManifest as Pn, GetSchemaByIdParams as Pt, CreateSessionBody as Q, ListSchemas200 as Qt, CreateGrant201 as R, IconSize as Rn, GetUserByIDParams as Rt, CreateBranding201 as S, UpdateFlowDefinition200 as Sn, GetFlowStep200 as St, CreateFlow201 as T, UpdateTeamBody as Tn, GetHealthDefault as Tt, CreateProjectBody as U, ListBrandingParams as Ut, CreateHandoff200 as V, zlIconManifest as Vn, IssueChallengeBody as Vt, CreateRelease200 as W, ListEnvironments200 as Wt, CreateSchemaParams as X, ListReleases200 as Xt, CreateSchemaBody as Y, ListFlowDefinitionsParams as Yt, CreateSession201 as Z, ListReleasesParams as Zt, BeginUserPasskeyRegistrationBody as _, QueryUsers200 as _n, GetEnvironmentByName200 as _t, ZlPill as a, PatchProjectBody as an, DeleteGrantParams as at, CreateAuthAttempt201 as b, SubmitFlowStep200 as bn, GetEventParams as bt, ZlPasskeyErrorDetail as c, QueryGrantsParams as cn, ExchangeHandoffParams as ct, ZlPageShell as d, QuerySessions200 as dn, GetAuthAttempt200 as dt, ListUserPasskeys200 as en, CreateTeamBody as et, zlPageShellManifest as f, QuerySessionsBody as fn, GetBrandingById200 as ft, BeginUserPasskeyRegistration201 as g, QueryTeamsParams as gn, GetClaimWindowParams as gt, zlFieldManifest as h, QueryTeamsBody as hn, GetClaimWindow200 as ht, zlSelectManifest as i, PatchProject200 as in, CreateUserParams as it, CreateFlow201StepFieldsItem as j, ZlCard as jn, GetReleaseById200 as jt, CreateFlow201StepActionsItem as k, ZlCheckboxChangeDetail as kn, GetProject200 as kt, ZlPasskeyResultDetail as l, QueryProjects200 as ln, FinishUserPasskeyRegistration201 as lt, ZlFieldType as m, QueryTeams200 as mn, GetClaimStatusParams as mt, ZlSelectChangeDetail as n, ListUserTeams200 as nn, CreateUser201 as nt, zlPillManifest as o, QueryGrants200 as on, ExchangeHandoff200 as ot, ZlField as p, QuerySessionsParams as pn, GetClaimStatus200 as pt, CreateReleaseParams as q, ListEventsParams as qt, ZlSelectOption as r, ListUserTeamsParams as rn, CreateUserBody as rt, ZlPasskey as s, QueryGrantsBody as sn, ExchangeHandoffBody as st, ZlSelect as t, ListUserPasskeysParams as tn, CreateTeamParams as tt, zlPasskeyManifest as u, QueryProjectsBody as un, FinishUserPasskeyRegistrationBody as ut, CompleteClaim200 as v, QueryUsersBody as vn, GetEnvironmentByNameParams as vt, CreateBrandingParams as w, UpdateTeam200 as wn, GetGrantParams as wt, CreateAuthAttemptBody as x, SubmitFlowStepBody as xn, GetFlowDefinition200 as xt, CompleteClaimBody as y, SetUserPasswordBody as yn, GetEvent200 as yt, CreateGrantBody as z, IconTone as zn, InitClaim201 as zt };
|
|
15937
|
+
//# sourceMappingURL=index-DMPCvLh_.d.mts.map
|