@workos/openapi-spec 0.3.0 → 0.5.0

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.
@@ -2607,6 +2607,178 @@ export interface paths {
2607
2607
  patch?: never;
2608
2608
  trace?: never;
2609
2609
  };
2610
+ "/vault/v1/keys/data-key": {
2611
+ parameters: {
2612
+ query?: never;
2613
+ header?: never;
2614
+ path?: never;
2615
+ cookie?: never;
2616
+ };
2617
+ get?: never;
2618
+ put?: never;
2619
+ /**
2620
+ * Create a data key
2621
+ * @description Generate an isolated encryption key for local encryption operations.
2622
+ */
2623
+ post: operations["JumpWireWeb.KeyController.create_data_key"];
2624
+ delete?: never;
2625
+ options?: never;
2626
+ head?: never;
2627
+ patch?: never;
2628
+ trace?: never;
2629
+ };
2630
+ "/vault/v1/keys/decrypt": {
2631
+ parameters: {
2632
+ query?: never;
2633
+ header?: never;
2634
+ path?: never;
2635
+ cookie?: never;
2636
+ };
2637
+ get?: never;
2638
+ put?: never;
2639
+ /**
2640
+ * Decrypt a data key
2641
+ * @description Decrypt a previously encrypted data key from WorkOS Vault.
2642
+ */
2643
+ post: operations["JumpWireWeb.KeyController.decrypt"];
2644
+ delete?: never;
2645
+ options?: never;
2646
+ head?: never;
2647
+ patch?: never;
2648
+ trace?: never;
2649
+ };
2650
+ "/vault/v1/keys/rekey": {
2651
+ parameters: {
2652
+ query?: never;
2653
+ header?: never;
2654
+ path?: never;
2655
+ cookie?: never;
2656
+ };
2657
+ get?: never;
2658
+ put?: never;
2659
+ /**
2660
+ * Re-encrypt a data key
2661
+ * @description Decrypt an existing data key and re-encrypt it under a new key context.
2662
+ */
2663
+ post: operations["JumpWireWeb.KeyController.rekey"];
2664
+ delete?: never;
2665
+ options?: never;
2666
+ head?: never;
2667
+ patch?: never;
2668
+ trace?: never;
2669
+ };
2670
+ "/vault/v1/kv": {
2671
+ parameters: {
2672
+ query?: never;
2673
+ header?: never;
2674
+ path?: never;
2675
+ cookie?: never;
2676
+ };
2677
+ /**
2678
+ * List objects
2679
+ * @description List all encrypted objects with cursor-based pagination.
2680
+ */
2681
+ get: operations["JumpWireWeb.DataVaultController.index"];
2682
+ put?: never;
2683
+ /**
2684
+ * Create an object
2685
+ * @description Encrypt and store a new key-value object.
2686
+ */
2687
+ post: operations["JumpWireWeb.DataVaultController.create"];
2688
+ delete?: never;
2689
+ options?: never;
2690
+ head?: never;
2691
+ patch?: never;
2692
+ trace?: never;
2693
+ };
2694
+ "/vault/v1/kv/name/{name}": {
2695
+ parameters: {
2696
+ query?: never;
2697
+ header?: never;
2698
+ path?: never;
2699
+ cookie?: never;
2700
+ };
2701
+ /**
2702
+ * Read an object by name
2703
+ * @description Fetch and decrypt an object by its unique name.
2704
+ */
2705
+ get: operations["JumpWireWeb.DataVaultController.show_by_name"];
2706
+ put?: never;
2707
+ post?: never;
2708
+ delete?: never;
2709
+ options?: never;
2710
+ head?: never;
2711
+ patch?: never;
2712
+ trace?: never;
2713
+ };
2714
+ "/vault/v1/kv/{id}": {
2715
+ parameters: {
2716
+ query?: never;
2717
+ header?: never;
2718
+ path?: never;
2719
+ cookie?: never;
2720
+ };
2721
+ /**
2722
+ * Read an object by ID
2723
+ * @description Fetch and decrypt an object by its unique identifier.
2724
+ */
2725
+ get: operations["JumpWireWeb.DataVaultController.show_by_id"];
2726
+ /**
2727
+ * Update an object
2728
+ * @description Update the value of an existing encrypted object.
2729
+ */
2730
+ put: operations["JumpWireWeb.DataVaultController.update"];
2731
+ post?: never;
2732
+ /**
2733
+ * Delete an object
2734
+ * @description Delete an encrypted object.
2735
+ */
2736
+ delete: operations["JumpWireWeb.DataVaultController.delete"];
2737
+ options?: never;
2738
+ head?: never;
2739
+ patch?: never;
2740
+ trace?: never;
2741
+ };
2742
+ "/vault/v1/kv/{id}/metadata": {
2743
+ parameters: {
2744
+ query?: never;
2745
+ header?: never;
2746
+ path?: never;
2747
+ cookie?: never;
2748
+ };
2749
+ /**
2750
+ * Describe an object
2751
+ * @description Fetch metadata for an object without decrypting it.
2752
+ */
2753
+ get: operations["JumpWireWeb.DataVaultController.describe"];
2754
+ put?: never;
2755
+ post?: never;
2756
+ delete?: never;
2757
+ options?: never;
2758
+ head?: never;
2759
+ patch?: never;
2760
+ trace?: never;
2761
+ };
2762
+ "/vault/v1/kv/{id}/versions": {
2763
+ parameters: {
2764
+ query?: never;
2765
+ header?: never;
2766
+ path?: never;
2767
+ cookie?: never;
2768
+ };
2769
+ /**
2770
+ * List object versions
2771
+ * @description Retrieve all versions for a specific object.
2772
+ */
2773
+ get: operations["JumpWireWeb.DataVaultController.versions"];
2774
+ put?: never;
2775
+ post?: never;
2776
+ delete?: never;
2777
+ options?: never;
2778
+ head?: never;
2779
+ patch?: never;
2780
+ trace?: never;
2781
+ };
2610
2782
  "/webhook_endpoints": {
2611
2783
  parameters: {
2612
2784
  query?: never;
@@ -3460,6 +3632,12 @@ export interface components {
3460
3632
  * ]
3461
3633
  */
3462
3634
  permissions?: string[];
3635
+ /**
3636
+ * Format: date-time
3637
+ * @description The timestamp when the API key should expire. Must be a future timestamp. If omitted, the key does not expire.
3638
+ * @example 2030-01-01T00:00:00.000Z
3639
+ */
3640
+ expires_at?: string;
3463
3641
  };
3464
3642
  OrganizationDomainDataDto: {
3465
3643
  /**
@@ -3760,6 +3938,12 @@ export interface components {
3760
3938
  * ]
3761
3939
  */
3762
3940
  permissions?: string[];
3941
+ /**
3942
+ * Format: date-time
3943
+ * @description The timestamp when the API key should expire. Must be a future timestamp. If omitted, the key does not expire.
3944
+ * @example 2030-01-01T00:00:00.000Z
3945
+ */
3946
+ expires_at?: string;
3763
3947
  };
3764
3948
  CreateUserlandUserDto: {
3765
3949
  /**
@@ -3942,7 +4126,7 @@ export interface components {
3942
4126
  * "dsync.user.created"
3943
4127
  * ]
3944
4128
  */
3945
- events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4129
+ events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
3946
4130
  };
3947
4131
  UpdateWebhookEndpointDto: {
3948
4132
  /**
@@ -3963,7 +4147,7 @@ export interface components {
3963
4147
  * "dsync.user.created"
3964
4148
  * ]
3965
4149
  */
3966
- events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4150
+ events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
3967
4151
  };
3968
4152
  WidgetSessionTokenDto: {
3969
4153
  /**
@@ -4007,128 +4191,449 @@ export interface components {
4007
4191
  */
4008
4192
  grant_type: "authorization_code";
4009
4193
  };
4010
- ExternalAuthCompleteResponse: {
4194
+ /**
4195
+ * Actor
4196
+ * @description The user or API key that performed an action.
4197
+ */
4198
+ Actor: {
4011
4199
  /**
4012
- * @description URI to redirect the user back to AuthKit to complete the OAuth flow.
4013
- * @example https://your-authkit-domain.workos.com/oauth/authorize/complete?state=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdGF0ZSI6InJhbmRvbV9zdGF0ZV9zdHJpbmciLCJpYXQiOjE3NDI2MDQ4NTN9.abc123def456ghi789
4200
+ * @description Unique identifier of the actor.
4201
+ * @example key_01K8ZYT4AWJ6XP0E0S8CTBHE3P
4014
4202
  */
4015
- redirect_uri: string;
4016
- };
4017
- ApiKey: {
4203
+ id: string;
4018
4204
  /**
4019
- * @description Distinguishes the API Key object.
4020
- * @constant
4205
+ * @description Display name of the actor.
4206
+ * @example My API Key
4021
4207
  */
4022
- object: "api_key";
4208
+ name: string;
4209
+ };
4210
+ /** CreateDataKeyRequest */
4211
+ CreateDataKeyRequest: {
4023
4212
  /**
4024
- * @description Unique identifier of the API Key.
4025
- * @example api_key_01EHZNVPK3SFK441A1RGBFSHRT
4213
+ * @description Map of values used to determine the encryption key.
4214
+ * @example {
4215
+ * "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"
4216
+ * }
4026
4217
  */
4027
- id: string;
4218
+ context: {
4219
+ [key: string]: string;
4220
+ };
4221
+ };
4222
+ /** CreateDataKeyResponse */
4223
+ CreateDataKeyResponse: {
4028
4224
  /**
4029
- * @description The entity that owns the API Key.
4225
+ * @description Map of values used to determine the encryption key.
4030
4226
  * @example {
4031
- * "type": "organization",
4032
- * "id": "org_01EHZNVPK3SFK441A1RGBFSHRT"
4227
+ * "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"
4033
4228
  * }
4034
4229
  */
4035
- owner: {
4036
- /**
4037
- * @description The type of the API Key owner.
4038
- * @example organization
4039
- * @constant
4040
- */
4041
- type: "organization";
4042
- /**
4043
- * @description Unique identifier of the API Key owner.
4044
- * @example org_01EHZNVPK3SFK441A1RGBFSHRT
4045
- */
4046
- id: string;
4047
- } | {
4048
- /**
4049
- * @description The type of the API Key owner.
4050
- * @example user
4051
- * @constant
4052
- */
4053
- type: "user";
4054
- /**
4055
- * @description Unique identifier of the API Key owner.
4056
- * @example user_01EHZNVPK3SFK441A1RGBFSHRT
4057
- */
4058
- id: string;
4059
- /**
4060
- * @description Unique identifier of the organization the API Key can access.
4061
- * @example org_01EHZNVPK3SFK441A1RGBFSHRT
4062
- */
4063
- organization_id: string;
4230
+ context: {
4231
+ [key: string]: string;
4064
4232
  };
4065
4233
  /**
4066
- * @description A descriptive name for the API Key.
4067
- * @example Production API Key
4234
+ * @description Base64-encoded data encryption key.
4235
+ * @example DR9idtey9MpMrA1VRFrz30HB1yNgL2PoHZyjAkFeWgg=
4068
4236
  */
4069
- name: string;
4237
+ data_key: string;
4070
4238
  /**
4071
- * @description An obfuscated representation of the API Key value.
4072
- * @example sk_...3456
4239
+ * @description Base64-encoded encrypted data key blob.
4240
+ * @example V09TLkVLTS52MQBiZjUxY2NlYy03OGI0LTUyMDAtYjM4My0zNTczMGU3MWVmNjEBATEBJGJmNjVlMzI2LTQzYTAtNGIyMC04OGM0LTA3ZmYzZGU1NDM0YwF0YmY2NWUzMjYtNDNhMC00YjIwLTg4YzQtMDdmZjNkZTU0MzRj
4073
4241
  */
4074
- obfuscated_value: string;
4242
+ encrypted_keys: string;
4075
4243
  /**
4076
- * Format: date-time
4077
- * @description Timestamp of when the API Key was last used.
4078
- * @example null
4244
+ * @description Unique identifier for the generated data key.
4245
+ * @example bf51ccec-78b4-5200-b383-35730e71ef61
4079
4246
  */
4080
- last_used_at: string | null;
4247
+ id: string;
4248
+ };
4249
+ /** CreateObjectRequest */
4250
+ CreateObjectRequest: {
4081
4251
  /**
4082
- * @description The permission slugs assigned to the API Key.
4083
- * @example [
4084
- * "posts:read",
4085
- * "posts:write"
4086
- * ]
4252
+ * @description Map of values used to determine the encryption key.
4253
+ * @example {
4254
+ * "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"
4255
+ * }
4087
4256
  */
4088
- permissions: string[];
4257
+ key_context: {
4258
+ [key: string]: string;
4259
+ };
4089
4260
  /**
4090
- * Format: date-time
4091
- * @description An ISO 8601 timestamp.
4092
- * @example 2026-01-15T12:00:00.000Z
4261
+ * @description Unique name for the object.
4262
+ * @example my-secret
4093
4263
  */
4094
- created_at: string;
4264
+ name: string;
4095
4265
  /**
4096
- * Format: date-time
4097
- * @description An ISO 8601 timestamp.
4098
- * @example 2026-01-15T12:00:00.000Z
4266
+ * @description Plaintext data to encrypt and store.
4267
+ * @example s3cr3t-v4lu3
4099
4268
  */
4100
- updated_at: string;
4269
+ value: string;
4101
4270
  };
4102
- ApiKeyValidationResponse: {
4103
- api_key: components["schemas"]["ApiKey"] | null;
4271
+ /** DecryptRequest */
4272
+ DecryptRequest: {
4273
+ /**
4274
+ * @description Base64-encoded encrypted data key to decrypt.
4275
+ * @example V09TLkVLTS52MQBiZjUxY2NlYy03OGI0LTUyMDAtYjM4My0zNTczMGU3MWVmNjEBATEBJGJmNjVlMzI2LTQzYTAtNGIyMC04OGM0LTA3ZmYzZGU1NDM0YwF0YmY2NWUzMjYtNDNhMC00YjIwLTg4YzQtMDdmZjNkZTU0MzRj
4276
+ */
4277
+ keys: string;
4104
4278
  };
4105
- ConnectApplication: {
4279
+ /** DecryptResponse */
4280
+ DecryptResponse: {
4106
4281
  /**
4107
- * @description Distinguishes the connect application object.
4108
- * @example connect_application
4109
- * @constant
4282
+ * @description Base64-encoded decrypted data key.
4283
+ * @example DR9idtey9MpMrA1VRFrz30HB1yNgL2PoHZyjAkFeWgg=
4110
4284
  */
4111
- object: "connect_application";
4285
+ data_key: string;
4112
4286
  /**
4113
- * @description The unique ID of the connect application.
4114
- * @example conn_app_01HXYZ123456789ABCDEFGHIJ
4287
+ * @description Unique identifier of the decrypted data key.
4288
+ * @example bf51ccec-78b4-5200-b383-35730e71ef61
4115
4289
  */
4116
4290
  id: string;
4291
+ };
4292
+ /** DeleteObjectResponse */
4293
+ DeleteObjectResponse: {
4117
4294
  /**
4118
- * @description The client ID of the connect application.
4119
- * @example client_01HXYZ123456789ABCDEFGHIJ
4295
+ * @description Name of the deleted object.
4296
+ * @example my-secret
4120
4297
  */
4121
- client_id: string;
4298
+ name: string;
4122
4299
  /**
4123
- * @description A description of the connect application.
4124
- * @example An application for managing user access
4300
+ * @description Whether the deletion succeeded.
4301
+ * @example true
4125
4302
  */
4126
- description: string | null;
4303
+ success: boolean;
4304
+ };
4305
+ /**
4306
+ * Error
4307
+ * @description Error response body.
4308
+ */
4309
+ Error: {
4127
4310
  /**
4128
- * @description The name of the connect application.
4129
- * @example My Application
4311
+ * @description A human-readable description of the error.
4312
+ * @example Invalid request parameters.
4130
4313
  */
4131
- name: string;
4314
+ error: string;
4315
+ };
4316
+ /**
4317
+ * ListMetadata
4318
+ * @description Cursor-based pagination metadata.
4319
+ */
4320
+ ListMetadata: {
4321
+ /**
4322
+ * @description Cursor for the next page of results.
4323
+ * @example b21f3a8c-7e4d-4b1a-9c5e-2d8f6a7b3c4e
4324
+ */
4325
+ after?: string | null;
4326
+ /**
4327
+ * @description Cursor for the previous page of results.
4328
+ * @example a10e2b7d-6c3f-4a2b-8d1e-3f9a5b8c7d6e
4329
+ */
4330
+ before?: string | null;
4331
+ };
4332
+ /**
4333
+ * Object
4334
+ * @description An encrypted object with its decrypted value and metadata.
4335
+ */
4336
+ Object: {
4337
+ /**
4338
+ * @description Unique identifier of the object.
4339
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
4340
+ */
4341
+ id: string;
4342
+ metadata: components["schemas"]["ObjectMetadata"];
4343
+ /**
4344
+ * @description Unique name of the object.
4345
+ * @example my-secret
4346
+ */
4347
+ name: string;
4348
+ /**
4349
+ * @description Decrypted plaintext value.
4350
+ * @example s3cr3t-v4lu3
4351
+ */
4352
+ value: string;
4353
+ };
4354
+ /** ObjectListResponse */
4355
+ ObjectListResponse: {
4356
+ /** @description List of object summaries. */
4357
+ data: components["schemas"]["ObjectSummary"][];
4358
+ list_metadata: components["schemas"]["ListMetadata"];
4359
+ };
4360
+ /**
4361
+ * ObjectMetadata
4362
+ * @description Metadata for a stored encrypted object.
4363
+ */
4364
+ ObjectMetadata: {
4365
+ /**
4366
+ * @description Map of values used to determine the encryption key.
4367
+ * @example {
4368
+ * "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"
4369
+ * }
4370
+ */
4371
+ context: {
4372
+ [key: string]: string;
4373
+ };
4374
+ /**
4375
+ * @description Environment the object belongs to.
4376
+ * @example environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P
4377
+ */
4378
+ environment_id: string;
4379
+ /**
4380
+ * @description Unique identifier of the object.
4381
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
4382
+ */
4383
+ id: string;
4384
+ /**
4385
+ * @description Encryption key identifier.
4386
+ * @example bf65e326-43a0-4b20-88c4-07ff3de5434c
4387
+ */
4388
+ key_id: string;
4389
+ /**
4390
+ * Format: date-time
4391
+ * @description Timestamp of the last update.
4392
+ * @example 2024-06-15T10:30:00Z
4393
+ */
4394
+ updated_at: string;
4395
+ updated_by: components["schemas"]["Actor"];
4396
+ /**
4397
+ * @description Current version identifier of the object.
4398
+ * @example c3d4e5f6-7890-abcd-ef12-34567890abcd
4399
+ */
4400
+ version_id?: string | null;
4401
+ };
4402
+ /**
4403
+ * ObjectSummary
4404
+ * @description Summary of an encrypted object returned in list responses.
4405
+ */
4406
+ ObjectSummary: {
4407
+ /**
4408
+ * @description Unique identifier of the object.
4409
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
4410
+ */
4411
+ id: string;
4412
+ /**
4413
+ * @description Unique name of the object.
4414
+ * @example my-secret
4415
+ */
4416
+ name: string;
4417
+ /**
4418
+ * Format: date-time
4419
+ * @description Timestamp of the last update.
4420
+ * @example 2024-06-15T10:30:00Z
4421
+ */
4422
+ updated_at?: string | null;
4423
+ };
4424
+ /**
4425
+ * ObjectVersion
4426
+ * @description A static snapshot of an encrypted object.
4427
+ */
4428
+ ObjectVersion: {
4429
+ /**
4430
+ * Format: date-time
4431
+ * @description Timestamp when the version was created.
4432
+ * @example 2024-06-15T10:30:00Z
4433
+ */
4434
+ created_at: string;
4435
+ /**
4436
+ * @description Whether this is the active version.
4437
+ * @example true
4438
+ */
4439
+ current_version: boolean;
4440
+ /**
4441
+ * @description Hash of the object value.
4442
+ * @example d41d8cd98f00b204e9800998ecf8427e
4443
+ */
4444
+ etag: string;
4445
+ /**
4446
+ * @description Unique identifier of the version.
4447
+ * @example c3d4e5f6-7890-abcd-ef12-34567890abcd
4448
+ */
4449
+ id: string;
4450
+ /**
4451
+ * @description Number of bytes of stored data.
4452
+ * @example 256
4453
+ */
4454
+ size: number;
4455
+ };
4456
+ /**
4457
+ * ObjectWithoutValue
4458
+ * @description An encrypted object's metadata (value excluded).
4459
+ */
4460
+ ObjectWithoutValue: {
4461
+ /**
4462
+ * @description Unique identifier of the object.
4463
+ * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
4464
+ */
4465
+ id: string;
4466
+ metadata: components["schemas"]["ObjectMetadata"];
4467
+ /**
4468
+ * @description Unique name of the object.
4469
+ * @example my-secret
4470
+ */
4471
+ name: string;
4472
+ };
4473
+ /** RekeyRequest */
4474
+ RekeyRequest: {
4475
+ /**
4476
+ * @description Map of values used to determine the new encryption key.
4477
+ * @example {
4478
+ * "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"
4479
+ * }
4480
+ */
4481
+ context: {
4482
+ [key: string]: string;
4483
+ };
4484
+ /**
4485
+ * @description Base64-encoded encrypted data key blob to re-encrypt.
4486
+ * @example V09TLkVLTS52MQBiZjUxY2NlYy03OGI0LTUyMDAtYjM4My0zNTczMGU3MWVmNjEBATEBJGJmNjVlMzI2LTQzYTAtNGIyMC04OGM0LTA3ZmYzZGU1NDM0YwF0YmY2NWUzMjYtNDNhMC00YjIwLTg4YzQtMDdmZjNkZTU0MzRj
4487
+ */
4488
+ encrypted_keys: string;
4489
+ };
4490
+ /** UpdateObjectRequest */
4491
+ UpdateObjectRequest: {
4492
+ /**
4493
+ * @description New plaintext value.
4494
+ * @example upd4t3d-v4lu3
4495
+ */
4496
+ value: string;
4497
+ /**
4498
+ * @description ID of the expected current version for optimistic locking.
4499
+ * @example c3d4e5f6-7890-abcd-ef12-34567890abcd
4500
+ */
4501
+ version_check?: string | null;
4502
+ };
4503
+ /** VersionListResponse */
4504
+ VersionListResponse: {
4505
+ /** @description List of object versions. */
4506
+ data: components["schemas"]["ObjectVersion"][];
4507
+ list_metadata: components["schemas"]["ListMetadata"];
4508
+ };
4509
+ ExternalAuthCompleteResponse: {
4510
+ /**
4511
+ * @description URI to redirect the user back to AuthKit to complete the OAuth flow.
4512
+ * @example https://your-authkit-domain.workos.com/oauth/authorize/complete?state=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdGF0ZSI6InJhbmRvbV9zdGF0ZV9zdHJpbmciLCJpYXQiOjE3NDI2MDQ4NTN9.abc123def456ghi789
4513
+ */
4514
+ redirect_uri: string;
4515
+ };
4516
+ ApiKey: {
4517
+ /**
4518
+ * @description Distinguishes the API Key object.
4519
+ * @constant
4520
+ */
4521
+ object: "api_key";
4522
+ /**
4523
+ * @description Unique identifier of the API Key.
4524
+ * @example api_key_01EHZNVPK3SFK441A1RGBFSHRT
4525
+ */
4526
+ id: string;
4527
+ /**
4528
+ * @description The entity that owns the API Key.
4529
+ * @example {
4530
+ * "type": "organization",
4531
+ * "id": "org_01EHZNVPK3SFK441A1RGBFSHRT"
4532
+ * }
4533
+ */
4534
+ owner: {
4535
+ /**
4536
+ * @description The type of the API Key owner.
4537
+ * @example organization
4538
+ * @constant
4539
+ */
4540
+ type: "organization";
4541
+ /**
4542
+ * @description Unique identifier of the API Key owner.
4543
+ * @example org_01EHZNVPK3SFK441A1RGBFSHRT
4544
+ */
4545
+ id: string;
4546
+ } | {
4547
+ /**
4548
+ * @description The type of the API Key owner.
4549
+ * @example user
4550
+ * @constant
4551
+ */
4552
+ type: "user";
4553
+ /**
4554
+ * @description Unique identifier of the API Key owner.
4555
+ * @example user_01EHZNVPK3SFK441A1RGBFSHRT
4556
+ */
4557
+ id: string;
4558
+ /**
4559
+ * @description Unique identifier of the organization the API Key can access.
4560
+ * @example org_01EHZNVPK3SFK441A1RGBFSHRT
4561
+ */
4562
+ organization_id: string;
4563
+ };
4564
+ /**
4565
+ * @description A descriptive name for the API Key.
4566
+ * @example Production API Key
4567
+ */
4568
+ name: string;
4569
+ /**
4570
+ * @description An obfuscated representation of the API Key value.
4571
+ * @example sk_...3456
4572
+ */
4573
+ obfuscated_value: string;
4574
+ /**
4575
+ * Format: date-time
4576
+ * @description Timestamp of when the API Key was last used.
4577
+ * @example null
4578
+ */
4579
+ last_used_at: string | null;
4580
+ /**
4581
+ * Format: date-time
4582
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
4583
+ * @example null
4584
+ */
4585
+ expires_at: string | null;
4586
+ /**
4587
+ * @description The permission slugs assigned to the API Key.
4588
+ * @example [
4589
+ * "posts:read",
4590
+ * "posts:write"
4591
+ * ]
4592
+ */
4593
+ permissions: string[];
4594
+ /**
4595
+ * Format: date-time
4596
+ * @description An ISO 8601 timestamp.
4597
+ * @example 2026-01-15T12:00:00.000Z
4598
+ */
4599
+ created_at: string;
4600
+ /**
4601
+ * Format: date-time
4602
+ * @description An ISO 8601 timestamp.
4603
+ * @example 2026-01-15T12:00:00.000Z
4604
+ */
4605
+ updated_at: string;
4606
+ };
4607
+ ApiKeyValidationResponse: {
4608
+ api_key: components["schemas"]["ApiKey"] | null;
4609
+ };
4610
+ ConnectApplication: {
4611
+ /**
4612
+ * @description Distinguishes the connect application object.
4613
+ * @example connect_application
4614
+ * @constant
4615
+ */
4616
+ object: "connect_application";
4617
+ /**
4618
+ * @description The unique ID of the connect application.
4619
+ * @example conn_app_01HXYZ123456789ABCDEFGHIJ
4620
+ */
4621
+ id: string;
4622
+ /**
4623
+ * @description The client ID of the connect application.
4624
+ * @example client_01HXYZ123456789ABCDEFGHIJ
4625
+ */
4626
+ client_id: string;
4627
+ /**
4628
+ * @description A description of the connect application.
4629
+ * @example An application for managing user access
4630
+ */
4631
+ description: string | null;
4632
+ /**
4633
+ * @description The name of the connect application.
4634
+ * @example My Application
4635
+ */
4636
+ name: string;
4132
4637
  /**
4133
4638
  * @description The scopes available for this application.
4134
4639
  * @example [
@@ -4313,6 +4818,7 @@ export interface components {
4313
4818
  */
4314
4819
  secret_hint: string;
4315
4820
  /**
4821
+ * Format: date-time
4316
4822
  * @description The timestamp when the client secret was last used, or null if never used.
4317
4823
  * @example null
4318
4824
  */
@@ -5903,44 +6409,103 @@ export interface components {
5903
6409
  */
5904
6410
  updated_at: string;
5905
6411
  };
5906
- /**
5907
- * @description The external key provider used for BYOK.
5908
- * @example AWS_KMS
5909
- * @enum {string}
5910
- */
5911
- VaultByokKeyProvider: "AWS_KMS" | "GCP_KMS" | "AZURE_KEY_VAULT";
5912
- WaitlistUser: {
6412
+ PipesConnectedAccount: {
5913
6413
  /**
5914
- * @description Distinguishes the Waitlist User object.
6414
+ * @description The connected account object.
6415
+ * @example connected_account
5915
6416
  * @constant
5916
6417
  */
5917
- object: "waitlist_user";
6418
+ object: "connected_account";
5918
6419
  /**
5919
- * @description The unique ID of the Waitlist User.
5920
- * @example wl_user_01E4ZCR3C56J083X43JQXF3JK5
6420
+ * @description The unique ID of the connected account.
6421
+ * @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
5921
6422
  */
5922
6423
  id: string;
5923
6424
  /**
5924
- * @description The email address of the Waitlist User.
5925
- * @example marcelina.davis@example.com
6425
+ * @description The unique ID of the data integration.
6426
+ * @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
5926
6427
  */
5927
- email: string;
6428
+ data_integration_id: string;
5928
6429
  /**
5929
- * @description The state of the Waitlist User.
5930
- * @example pending
5931
- * @enum {string}
6430
+ * @description The provider slug for this connected account.
6431
+ * @example github
5932
6432
  */
5933
- state: "pending" | "approved" | "denied";
6433
+ provider_slug: string;
5934
6434
  /**
5935
- * Format: date-time
5936
- * @description The timestamp when the Waitlist User was approved, or null if not yet approved.
5937
- * @example null
6435
+ * @description The ID of the User the connected account belongs to.
6436
+ * @example user_01EHZNVPK3SFK441A1RGBFSHRT
5938
6437
  */
5939
- approved_at: string | null;
6438
+ user_id: string | null;
5940
6439
  /**
5941
- * Format: date-time
5942
- * @description An ISO 8601 timestamp.
5943
- * @example 2026-01-15T12:00:00.000Z
6440
+ * @description The ID of the Organization the connected account belongs to.
6441
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
6442
+ */
6443
+ organization_id: string | null;
6444
+ /**
6445
+ * @description The OAuth scopes granted for this connected account.
6446
+ * @example [
6447
+ * "repo",
6448
+ * "user:email"
6449
+ * ]
6450
+ */
6451
+ scopes: string[];
6452
+ /**
6453
+ * @description The state of the connected account.
6454
+ * @example connected
6455
+ * @enum {string}
6456
+ */
6457
+ state: "connected" | "needs_reauthorization";
6458
+ /**
6459
+ * Format: date-time
6460
+ * @description An ISO 8601 timestamp.
6461
+ * @example 2026-01-15T12:00:00.000Z
6462
+ */
6463
+ created_at: string;
6464
+ /**
6465
+ * Format: date-time
6466
+ * @description An ISO 8601 timestamp.
6467
+ * @example 2026-01-15T12:00:00.000Z
6468
+ */
6469
+ updated_at: string;
6470
+ };
6471
+ /**
6472
+ * @description The external key provider used for BYOK.
6473
+ * @example AWS_KMS
6474
+ * @enum {string}
6475
+ */
6476
+ VaultByokKeyProvider: "AWS_KMS" | "GCP_KMS" | "AZURE_KEY_VAULT";
6477
+ WaitlistUser: {
6478
+ /**
6479
+ * @description Distinguishes the Waitlist User object.
6480
+ * @constant
6481
+ */
6482
+ object: "waitlist_user";
6483
+ /**
6484
+ * @description The unique ID of the Waitlist User.
6485
+ * @example wl_user_01E4ZCR3C56J083X43JQXF3JK5
6486
+ */
6487
+ id: string;
6488
+ /**
6489
+ * @description The email address of the Waitlist User.
6490
+ * @example marcelina.davis@example.com
6491
+ */
6492
+ email: string;
6493
+ /**
6494
+ * @description The state of the Waitlist User.
6495
+ * @example pending
6496
+ * @enum {string}
6497
+ */
6498
+ state: "pending" | "approved" | "denied";
6499
+ /**
6500
+ * Format: date-time
6501
+ * @description The timestamp when the Waitlist User was approved, or null if not yet approved.
6502
+ * @example null
6503
+ */
6504
+ approved_at: string | null;
6505
+ /**
6506
+ * Format: date-time
6507
+ * @description An ISO 8601 timestamp.
6508
+ * @example 2026-01-15T12:00:00.000Z
5944
6509
  */
5945
6510
  created_at: string;
5946
6511
  /**
@@ -6233,6 +6798,12 @@ export interface components {
6233
6798
  * @example 2026-01-15T12:00:00.000Z
6234
6799
  */
6235
6800
  last_used_at: string | null;
6801
+ /**
6802
+ * Format: date-time
6803
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
6804
+ * @example null
6805
+ */
6806
+ expires_at?: string | null;
6236
6807
  /**
6237
6808
  * @description The permissions granted to the API key.
6238
6809
  * @example [
@@ -6328,6 +6899,12 @@ export interface components {
6328
6899
  * @example 2026-01-15T12:00:00.000Z
6329
6900
  */
6330
6901
  last_used_at: string | null;
6902
+ /**
6903
+ * Format: date-time
6904
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
6905
+ * @example null
6906
+ */
6907
+ expires_at?: string | null;
6331
6908
  /**
6332
6909
  * @description The permissions granted to the API key.
6333
6910
  * @example [
@@ -11091,6 +11668,72 @@ export interface components {
11091
11668
  * @constant
11092
11669
  */
11093
11670
  object: "event";
11671
+ } | {
11672
+ /**
11673
+ * @description Unique identifier for the event.
11674
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
11675
+ */
11676
+ id: string;
11677
+ /** @constant */
11678
+ event: "pipes.connected_account.connected";
11679
+ /** @description The event payload. */
11680
+ data: components["schemas"]["PipesConnectedAccount"];
11681
+ /**
11682
+ * Format: date-time
11683
+ * @description An ISO 8601 timestamp.
11684
+ * @example 2026-01-15T12:00:00.000Z
11685
+ */
11686
+ created_at: string;
11687
+ context?: components["schemas"]["EventContextDto"];
11688
+ /**
11689
+ * @description Distinguishes the Event object.
11690
+ * @constant
11691
+ */
11692
+ object: "event";
11693
+ } | {
11694
+ /**
11695
+ * @description Unique identifier for the event.
11696
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
11697
+ */
11698
+ id: string;
11699
+ /** @constant */
11700
+ event: "pipes.connected_account.disconnected";
11701
+ /** @description The event payload. */
11702
+ data: components["schemas"]["PipesConnectedAccount"];
11703
+ /**
11704
+ * Format: date-time
11705
+ * @description An ISO 8601 timestamp.
11706
+ * @example 2026-01-15T12:00:00.000Z
11707
+ */
11708
+ created_at: string;
11709
+ context?: components["schemas"]["EventContextDto"];
11710
+ /**
11711
+ * @description Distinguishes the Event object.
11712
+ * @constant
11713
+ */
11714
+ object: "event";
11715
+ } | {
11716
+ /**
11717
+ * @description Unique identifier for the event.
11718
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
11719
+ */
11720
+ id: string;
11721
+ /** @constant */
11722
+ event: "pipes.connected_account.reauthorization_needed";
11723
+ /** @description The event payload. */
11724
+ data: components["schemas"]["PipesConnectedAccount"];
11725
+ /**
11726
+ * Format: date-time
11727
+ * @description An ISO 8601 timestamp.
11728
+ * @example 2026-01-15T12:00:00.000Z
11729
+ */
11730
+ created_at: string;
11731
+ context?: components["schemas"]["EventContextDto"];
11732
+ /**
11733
+ * @description Distinguishes the Event object.
11734
+ * @constant
11735
+ */
11736
+ object: "event";
11094
11737
  } | {
11095
11738
  /**
11096
11739
  * @description Unique identifier for the event.
@@ -12323,6 +12966,12 @@ export interface components {
12323
12966
  * @example null
12324
12967
  */
12325
12968
  last_used_at: string | null;
12969
+ /**
12970
+ * Format: date-time
12971
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
12972
+ * @example null
12973
+ */
12974
+ expires_at: string | null;
12326
12975
  /**
12327
12976
  * @description The permission slugs assigned to the API Key.
12328
12977
  * @example [
@@ -12407,6 +13056,12 @@ export interface components {
12407
13056
  * @example null
12408
13057
  */
12409
13058
  last_used_at: string | null;
13059
+ /**
13060
+ * Format: date-time
13061
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
13062
+ * @example 2030-01-01T00:00:00.000Z
13063
+ */
13064
+ expires_at: string | null;
12410
13065
  /**
12411
13066
  * @description The permission slugs assigned to the API Key.
12412
13067
  * @example [
@@ -12909,7 +13564,7 @@ export interface components {
12909
13564
  * @example bot_detection
12910
13565
  * @enum {string}
12911
13566
  */
12912
- control?: "bot_detection" | "brute_force_attack" | "credential_stuffing" | "domain_sign_up_rate_limit" | "ip_sign_up_rate_limit" | "impossible_travel" | "repeat_sign_up" | "stale_account" | "unrecognized_device" | "restriction";
13567
+ control?: "bot_detection" | "brute_force_attack" | "domain_sign_up_rate_limit" | "impossible_travel" | "repeat_sign_up" | "stale_account" | "unrecognized_device" | "restriction";
12913
13568
  /**
12914
13569
  * @description The type of blocklist entry that triggered the verdict. Only present if the control is `restriction`.
12915
13570
  * @example ip_address
@@ -13223,6 +13878,12 @@ export interface components {
13223
13878
  * @example null
13224
13879
  */
13225
13880
  last_used_at: string | null;
13881
+ /**
13882
+ * Format: date-time
13883
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
13884
+ * @example null
13885
+ */
13886
+ expires_at: string | null;
13226
13887
  /**
13227
13888
  * @description The permission slugs assigned to the API Key.
13228
13889
  * @example [
@@ -13312,6 +13973,12 @@ export interface components {
13312
13973
  * @example null
13313
13974
  */
13314
13975
  last_used_at: string | null;
13976
+ /**
13977
+ * Format: date-time
13978
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
13979
+ * @example 2030-01-01T00:00:00.000Z
13980
+ */
13981
+ expires_at: string | null;
13315
13982
  /**
13316
13983
  * @description The permission slugs assigned to the API Key.
13317
13984
  * @example [
@@ -13704,7 +14371,7 @@ export interface components {
13704
14371
  connection_id: string;
13705
14372
  /**
13706
14373
  * @description The type of SSO connection.
13707
- * @example GoogleOAuth
14374
+ * @example OktaSAML
13708
14375
  * @enum {string}
13709
14376
  */
13710
14377
  connection_type: "Pending" | "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0Migration" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "ClassLinkSAML" | "CleverOIDC" | "CloudflareSAML" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GitHubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "TestIdp" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
@@ -19025,6 +19692,7 @@ export interface operations {
19025
19692
  */
19026
19693
  secret_hint: string;
19027
19694
  /**
19695
+ * Format: date-time
19028
19696
  * @description The timestamp when the client secret was last used, or null if never used.
19029
19697
  * @example null
19030
19698
  */
@@ -22157,20 +22825,10 @@ export interface operations {
22157
22825
  auth_method: "Password" | "Passkey" | "Authenticator" | "SMS_OTP" | "Email_OTP" | "Social" | "SSO" | "Other";
22158
22826
  /**
22159
22827
  * @description The action being performed.
22160
- * @example login
22828
+ * @example sign-in
22161
22829
  * @enum {string}
22162
22830
  */
22163
- action: "login" | "signup" | "sign-up" | "sign-in" | "sign_up" | "sign_in" | "sign in" | "sign up";
22164
- /**
22165
- * @description An optional device fingerprint for the request.
22166
- * @example fp_abc123
22167
- */
22168
- device_fingerprint?: string;
22169
- /**
22170
- * @description An optional bot detection score for the request.
22171
- * @example 0.1
22172
- */
22173
- bot_score?: string;
22831
+ action: "sign-up" | "sign-in";
22174
22832
  };
22175
22833
  };
22176
22834
  };
@@ -27909,6 +28567,483 @@ export interface operations {
27909
28567
  };
27910
28568
  };
27911
28569
  };
28570
+ "JumpWireWeb.KeyController.create_data_key": {
28571
+ parameters: {
28572
+ query?: never;
28573
+ header?: never;
28574
+ path?: never;
28575
+ cookie?: never;
28576
+ };
28577
+ /** @description Data key request. */
28578
+ requestBody: {
28579
+ content: {
28580
+ "application/json": components["schemas"]["CreateDataKeyRequest"];
28581
+ };
28582
+ };
28583
+ responses: {
28584
+ /** @description Data key. */
28585
+ 200: {
28586
+ headers: {
28587
+ [name: string]: unknown;
28588
+ };
28589
+ content: {
28590
+ "application/json": components["schemas"]["CreateDataKeyResponse"];
28591
+ };
28592
+ };
28593
+ /** @description Bad request. */
28594
+ 400: {
28595
+ headers: {
28596
+ [name: string]: unknown;
28597
+ };
28598
+ content: {
28599
+ "application/json": components["schemas"]["Error"];
28600
+ };
28601
+ };
28602
+ /** @description Validation error. */
28603
+ 422: {
28604
+ headers: {
28605
+ [name: string]: unknown;
28606
+ };
28607
+ content: {
28608
+ "application/json": components["schemas"]["Error"];
28609
+ };
28610
+ };
28611
+ };
28612
+ };
28613
+ "JumpWireWeb.KeyController.decrypt": {
28614
+ parameters: {
28615
+ query?: never;
28616
+ header?: never;
28617
+ path?: never;
28618
+ cookie?: never;
28619
+ };
28620
+ /** @description Decrypt request. */
28621
+ requestBody: {
28622
+ content: {
28623
+ "application/json": components["schemas"]["DecryptRequest"];
28624
+ };
28625
+ };
28626
+ responses: {
28627
+ /** @description Decrypted key. */
28628
+ 200: {
28629
+ headers: {
28630
+ [name: string]: unknown;
28631
+ };
28632
+ content: {
28633
+ "application/json": components["schemas"]["DecryptResponse"];
28634
+ };
28635
+ };
28636
+ /** @description Bad request. */
28637
+ 400: {
28638
+ headers: {
28639
+ [name: string]: unknown;
28640
+ };
28641
+ content: {
28642
+ "application/json": components["schemas"]["Error"];
28643
+ };
28644
+ };
28645
+ };
28646
+ };
28647
+ "JumpWireWeb.KeyController.rekey": {
28648
+ parameters: {
28649
+ query?: never;
28650
+ header?: never;
28651
+ path?: never;
28652
+ cookie?: never;
28653
+ };
28654
+ /** @description Rekey request. */
28655
+ requestBody: {
28656
+ content: {
28657
+ "application/json": components["schemas"]["RekeyRequest"];
28658
+ };
28659
+ };
28660
+ responses: {
28661
+ /** @description Re-encrypted key. */
28662
+ 200: {
28663
+ headers: {
28664
+ [name: string]: unknown;
28665
+ };
28666
+ content: {
28667
+ "application/json": components["schemas"]["CreateDataKeyResponse"];
28668
+ };
28669
+ };
28670
+ /** @description Bad request. */
28671
+ 400: {
28672
+ headers: {
28673
+ [name: string]: unknown;
28674
+ };
28675
+ content: {
28676
+ "application/json": components["schemas"]["Error"];
28677
+ };
28678
+ };
28679
+ /** @description Validation error. */
28680
+ 422: {
28681
+ headers: {
28682
+ [name: string]: unknown;
28683
+ };
28684
+ content: {
28685
+ "application/json": components["schemas"]["Error"];
28686
+ };
28687
+ };
28688
+ };
28689
+ };
28690
+ "JumpWireWeb.DataVaultController.index": {
28691
+ parameters: {
28692
+ query?: {
28693
+ /** @description Upper limit on the number of objects to return. */
28694
+ limit?: number;
28695
+ /** @description Cursor for the previous page of results. */
28696
+ before?: string;
28697
+ /** @description Cursor for the next page of results. */
28698
+ after?: string;
28699
+ /** @description Sort direction for results. */
28700
+ order?: "asc" | "desc";
28701
+ /** @description Filter results by name or structured search JSON. */
28702
+ search?: string;
28703
+ /** @description ISO 8601 timestamp to filter by last modified time. */
28704
+ updatedAfter?: string;
28705
+ };
28706
+ header?: never;
28707
+ path?: never;
28708
+ cookie?: never;
28709
+ };
28710
+ requestBody?: never;
28711
+ responses: {
28712
+ /** @description Object list. */
28713
+ 200: {
28714
+ headers: {
28715
+ [name: string]: unknown;
28716
+ };
28717
+ content: {
28718
+ "application/json": components["schemas"]["ObjectListResponse"];
28719
+ };
28720
+ };
28721
+ /** @description Bad request. */
28722
+ 400: {
28723
+ headers: {
28724
+ [name: string]: unknown;
28725
+ };
28726
+ content: {
28727
+ "application/json": components["schemas"]["Error"];
28728
+ };
28729
+ };
28730
+ };
28731
+ };
28732
+ "JumpWireWeb.DataVaultController.create": {
28733
+ parameters: {
28734
+ query?: never;
28735
+ header?: never;
28736
+ path?: never;
28737
+ cookie?: never;
28738
+ };
28739
+ /** @description Create object. */
28740
+ requestBody: {
28741
+ content: {
28742
+ "application/json": components["schemas"]["CreateObjectRequest"];
28743
+ };
28744
+ };
28745
+ responses: {
28746
+ /** @description Object created. */
28747
+ 201: {
28748
+ headers: {
28749
+ [name: string]: unknown;
28750
+ };
28751
+ content: {
28752
+ "application/json": components["schemas"]["ObjectMetadata"];
28753
+ };
28754
+ };
28755
+ /** @description Bad request. */
28756
+ 400: {
28757
+ headers: {
28758
+ [name: string]: unknown;
28759
+ };
28760
+ content: {
28761
+ "application/json": components["schemas"]["Error"];
28762
+ };
28763
+ };
28764
+ /** @description Conflict. */
28765
+ 409: {
28766
+ headers: {
28767
+ [name: string]: unknown;
28768
+ };
28769
+ content: {
28770
+ "application/json": components["schemas"]["Error"];
28771
+ };
28772
+ };
28773
+ /** @description Validation error. */
28774
+ 422: {
28775
+ headers: {
28776
+ [name: string]: unknown;
28777
+ };
28778
+ content: {
28779
+ "application/json": components["schemas"]["Error"];
28780
+ };
28781
+ };
28782
+ };
28783
+ };
28784
+ "JumpWireWeb.DataVaultController.show_by_name": {
28785
+ parameters: {
28786
+ query?: never;
28787
+ header?: never;
28788
+ path: {
28789
+ /** @description Unique name of the object. */
28790
+ name: string;
28791
+ };
28792
+ cookie?: never;
28793
+ };
28794
+ requestBody?: never;
28795
+ responses: {
28796
+ /** @description Object. */
28797
+ 200: {
28798
+ headers: {
28799
+ [name: string]: unknown;
28800
+ };
28801
+ content: {
28802
+ "application/json": components["schemas"]["Object"];
28803
+ };
28804
+ };
28805
+ /** @description Bad request. */
28806
+ 400: {
28807
+ headers: {
28808
+ [name: string]: unknown;
28809
+ };
28810
+ content: {
28811
+ "application/json": components["schemas"]["Error"];
28812
+ };
28813
+ };
28814
+ /** @description Not found. */
28815
+ 404: {
28816
+ headers: {
28817
+ [name: string]: unknown;
28818
+ };
28819
+ content: {
28820
+ "application/json": components["schemas"]["Error"];
28821
+ };
28822
+ };
28823
+ };
28824
+ };
28825
+ "JumpWireWeb.DataVaultController.show_by_id": {
28826
+ parameters: {
28827
+ query?: never;
28828
+ header?: never;
28829
+ path: {
28830
+ /** @description Unique identifier of the object. */
28831
+ id: string;
28832
+ };
28833
+ cookie?: never;
28834
+ };
28835
+ requestBody?: never;
28836
+ responses: {
28837
+ /** @description Object. */
28838
+ 200: {
28839
+ headers: {
28840
+ [name: string]: unknown;
28841
+ };
28842
+ content: {
28843
+ "application/json": components["schemas"]["Object"];
28844
+ };
28845
+ };
28846
+ /** @description Bad request. */
28847
+ 400: {
28848
+ headers: {
28849
+ [name: string]: unknown;
28850
+ };
28851
+ content: {
28852
+ "application/json": components["schemas"]["Error"];
28853
+ };
28854
+ };
28855
+ /** @description Not found. */
28856
+ 404: {
28857
+ headers: {
28858
+ [name: string]: unknown;
28859
+ };
28860
+ content: {
28861
+ "application/json": components["schemas"]["Error"];
28862
+ };
28863
+ };
28864
+ };
28865
+ };
28866
+ "JumpWireWeb.DataVaultController.update": {
28867
+ parameters: {
28868
+ query?: never;
28869
+ header?: never;
28870
+ path: {
28871
+ /** @description Unique identifier of the object. */
28872
+ id: string;
28873
+ };
28874
+ cookie?: never;
28875
+ };
28876
+ /** @description Update object. */
28877
+ requestBody: {
28878
+ content: {
28879
+ "application/json": components["schemas"]["UpdateObjectRequest"];
28880
+ };
28881
+ };
28882
+ responses: {
28883
+ /** @description Object updated. */
28884
+ 201: {
28885
+ headers: {
28886
+ [name: string]: unknown;
28887
+ };
28888
+ content: {
28889
+ "application/json": components["schemas"]["ObjectWithoutValue"];
28890
+ };
28891
+ };
28892
+ /** @description Bad request. */
28893
+ 400: {
28894
+ headers: {
28895
+ [name: string]: unknown;
28896
+ };
28897
+ content: {
28898
+ "application/json": components["schemas"]["Error"];
28899
+ };
28900
+ };
28901
+ /** @description Version mismatch. */
28902
+ 409: {
28903
+ headers: {
28904
+ [name: string]: unknown;
28905
+ };
28906
+ content: {
28907
+ "application/json": components["schemas"]["Error"];
28908
+ };
28909
+ };
28910
+ };
28911
+ };
28912
+ "JumpWireWeb.DataVaultController.delete": {
28913
+ parameters: {
28914
+ query?: {
28915
+ /** @description Expected current version for optimistic locking. */
28916
+ version_check?: string;
28917
+ };
28918
+ header?: never;
28919
+ path: {
28920
+ /** @description Unique identifier of the object. */
28921
+ id: string;
28922
+ };
28923
+ cookie?: never;
28924
+ };
28925
+ requestBody?: never;
28926
+ responses: {
28927
+ /** @description Deletion result. */
28928
+ 200: {
28929
+ headers: {
28930
+ [name: string]: unknown;
28931
+ };
28932
+ content: {
28933
+ "application/json": components["schemas"]["DeleteObjectResponse"];
28934
+ };
28935
+ };
28936
+ /** @description Not found. */
28937
+ 404: {
28938
+ headers: {
28939
+ [name: string]: unknown;
28940
+ };
28941
+ content: {
28942
+ "application/json": components["schemas"]["Error"];
28943
+ };
28944
+ };
28945
+ /** @description Version mismatch. */
28946
+ 409: {
28947
+ headers: {
28948
+ [name: string]: unknown;
28949
+ };
28950
+ content: {
28951
+ "application/json": components["schemas"]["Error"];
28952
+ };
28953
+ };
28954
+ /** @description Internal error. */
28955
+ 500: {
28956
+ headers: {
28957
+ [name: string]: unknown;
28958
+ };
28959
+ content: {
28960
+ "application/json": components["schemas"]["Error"];
28961
+ };
28962
+ };
28963
+ };
28964
+ };
28965
+ "JumpWireWeb.DataVaultController.describe": {
28966
+ parameters: {
28967
+ query?: never;
28968
+ header?: never;
28969
+ path: {
28970
+ /** @description Unique identifier of the object. */
28971
+ id: string;
28972
+ };
28973
+ cookie?: never;
28974
+ };
28975
+ requestBody?: never;
28976
+ responses: {
28977
+ /** @description Object metadata. */
28978
+ 200: {
28979
+ headers: {
28980
+ [name: string]: unknown;
28981
+ };
28982
+ content: {
28983
+ "application/json": components["schemas"]["ObjectWithoutValue"];
28984
+ };
28985
+ };
28986
+ /** @description Bad request. */
28987
+ 400: {
28988
+ headers: {
28989
+ [name: string]: unknown;
28990
+ };
28991
+ content: {
28992
+ "application/json": components["schemas"]["Error"];
28993
+ };
28994
+ };
28995
+ /** @description Not found. */
28996
+ 404: {
28997
+ headers: {
28998
+ [name: string]: unknown;
28999
+ };
29000
+ content: {
29001
+ "application/json": components["schemas"]["Error"];
29002
+ };
29003
+ };
29004
+ };
29005
+ };
29006
+ "JumpWireWeb.DataVaultController.versions": {
29007
+ parameters: {
29008
+ query?: never;
29009
+ header?: never;
29010
+ path: {
29011
+ /** @description Unique identifier of the object. */
29012
+ id: string;
29013
+ };
29014
+ cookie?: never;
29015
+ };
29016
+ requestBody?: never;
29017
+ responses: {
29018
+ /** @description Version list. */
29019
+ 200: {
29020
+ headers: {
29021
+ [name: string]: unknown;
29022
+ };
29023
+ content: {
29024
+ "application/json": components["schemas"]["VersionListResponse"];
29025
+ };
29026
+ };
29027
+ /** @description Bad request. */
29028
+ 400: {
29029
+ headers: {
29030
+ [name: string]: unknown;
29031
+ };
29032
+ content: {
29033
+ "application/json": components["schemas"]["Error"];
29034
+ };
29035
+ };
29036
+ /** @description Not found. */
29037
+ 404: {
29038
+ headers: {
29039
+ [name: string]: unknown;
29040
+ };
29041
+ content: {
29042
+ "application/json": components["schemas"]["Error"];
29043
+ };
29044
+ };
29045
+ };
29046
+ };
27912
29047
  WebhookEndpointsController_list: {
27913
29048
  parameters: {
27914
29049
  query?: {