@workos/openapi-spec 0.15.0 → 0.17.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.
Files changed (5) hide show
  1. package/dist/open-api-spec.yaml +1845 -608
  2. package/dist/services.d.mts +1 -1
  3. package/dist/services.mjs +30 -0
  4. package/dist/types.d.ts +1307 -259
  5. package/package.json +2 -2
package/dist/types.d.ts CHANGED
@@ -4,6 +4,46 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
+ "/agents/credentials/validate": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ get?: never;
15
+ put?: never;
16
+ /**
17
+ * Validate an agent credential
18
+ * @description Validate an agent credential — an API key or access token — against the environment of the API key used to authenticate the request. This is a read-only check: it never consumes or mutates the credential.
19
+ */
20
+ post: operations["AgentAdminController_validateCredential"];
21
+ delete?: never;
22
+ options?: never;
23
+ head?: never;
24
+ patch?: never;
25
+ trace?: never;
26
+ };
27
+ "/agents/registrations/{id}": {
28
+ parameters: {
29
+ query?: never;
30
+ header?: never;
31
+ path?: never;
32
+ cookie?: never;
33
+ };
34
+ /**
35
+ * Get an agent registration
36
+ * @description Retrieve the details of an agent registration by ID. The registration is scoped to the environment of the API key used to authenticate the request.
37
+ */
38
+ get: operations["AgentAdminController_getRegistration"];
39
+ put?: never;
40
+ post?: never;
41
+ delete?: never;
42
+ options?: never;
43
+ head?: never;
44
+ patch?: never;
45
+ trace?: never;
46
+ };
7
47
  "/api_keys/validations": {
8
48
  parameters: {
9
49
  query?: never;
@@ -1013,6 +1053,26 @@ export interface paths {
1013
1053
  patch?: never;
1014
1054
  trace?: never;
1015
1055
  };
1056
+ "/data-integrations/{slug}/api-key": {
1057
+ parameters: {
1058
+ query?: never;
1059
+ header?: never;
1060
+ path?: never;
1061
+ cookie?: never;
1062
+ };
1063
+ get?: never;
1064
+ /**
1065
+ * Upsert an API key for a connected account
1066
+ * @description Creates or updates an API-key-based installation for the specified integration and user. If an installation already exists, the stored API key is rotated to the new value.
1067
+ */
1068
+ put: operations["DataIntegrationsController_upsertApiKey"];
1069
+ post?: never;
1070
+ delete?: never;
1071
+ options?: never;
1072
+ head?: never;
1073
+ patch?: never;
1074
+ trace?: never;
1075
+ };
1016
1076
  "/data-integrations/{slug}/authorize": {
1017
1077
  parameters: {
1018
1078
  query?: never;
@@ -1033,6 +1093,26 @@ export interface paths {
1033
1093
  patch?: never;
1034
1094
  trace?: never;
1035
1095
  };
1096
+ "/data-integrations/{slug}/credentials": {
1097
+ parameters: {
1098
+ query?: never;
1099
+ header?: never;
1100
+ path?: never;
1101
+ cookie?: never;
1102
+ };
1103
+ get?: never;
1104
+ put?: never;
1105
+ /**
1106
+ * Vend credentials for a connected account
1107
+ * @description Returns credentials for a user's connected account. Branches on the installation's `auth_method`: OAuth installations return an access token (refreshed if needed); API-key installations return the stored secret.
1108
+ */
1109
+ post: operations["DataIntegrationsController_vendCredentials"];
1110
+ delete?: never;
1111
+ options?: never;
1112
+ head?: never;
1113
+ patch?: never;
1114
+ trace?: never;
1115
+ };
1036
1116
  "/data-integrations/{slug}/token": {
1037
1117
  parameters: {
1038
1118
  query?: never;
@@ -1934,7 +2014,11 @@ export interface paths {
1934
2014
  path?: never;
1935
2015
  cookie?: never;
1936
2016
  };
1937
- get?: never;
2017
+ /**
2018
+ * List CORS origins
2019
+ * @description Lists the CORS origins for the current environment.
2020
+ */
2021
+ get: operations["CorsOriginsController_list"];
1938
2022
  put?: never;
1939
2023
  /**
1940
2024
  * Create a CORS origin
@@ -2346,7 +2430,11 @@ export interface paths {
2346
2430
  path?: never;
2347
2431
  cookie?: never;
2348
2432
  };
2349
- get?: never;
2433
+ /**
2434
+ * List redirect URIs
2435
+ * @description Lists the redirect URIs for an environment.
2436
+ */
2437
+ get: operations["RedirectUrisController_list"];
2350
2438
  put?: never;
2351
2439
  /**
2352
2440
  * Create a redirect URI
@@ -3947,32 +4035,6 @@ export interface components {
3947
4035
  */
3948
4036
  external_id?: string | null;
3949
4037
  };
3950
- SsoIntentOptions: {
3951
- /**
3952
- * @description The bookmark slug to use for SSO.
3953
- * @example chatgpt
3954
- */
3955
- bookmark_slug?: string;
3956
- /**
3957
- * @description The SSO provider type to configure.
3958
- * @example GoogleSAML
3959
- * @constant
3960
- */
3961
- provider_type?: "GoogleSAML";
3962
- };
3963
- DomainVerificationIntentOptions: {
3964
- /**
3965
- * @description The domain name to verify. When provided, the domain verification flow will skip the domain entry form and go directly to the verification step.
3966
- * @example example.com
3967
- */
3968
- domain_name?: string;
3969
- };
3970
- IntentOptions: {
3971
- /** @description SSO-specific options for the Admin Portal. */
3972
- sso?: components["schemas"]["SsoIntentOptions"];
3973
- /** @description Domain verification-specific options for the Admin Portal. */
3974
- domain_verification?: components["schemas"]["DomainVerificationIntentOptions"];
3975
- };
3976
4038
  GenerateLinkDto: {
3977
4039
  /**
3978
4040
  * @description The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
@@ -4002,8 +4064,6 @@ export interface components {
4002
4064
  * @enum {string}
4003
4065
  */
4004
4066
  intent?: "sso" | "dsync" | "audit_logs" | "log_streams" | "domain_verification" | "certificate_renewal" | "bring_your_own_key";
4005
- /** @description Options to configure the Admin Portal based on the intent. */
4006
- intent_options?: components["schemas"]["IntentOptions"];
4007
4067
  /**
4008
4068
  * @description The email addresses of the IT contacts to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.
4009
4069
  * @example [
@@ -4350,7 +4410,7 @@ export interface components {
4350
4410
  * "dsync.user.created"
4351
4411
  * ]
4352
4412
  */
4353
- 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" | "api_key.updated" | "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.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4413
+ events: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.organization.switched" | "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" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "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.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4354
4414
  };
4355
4415
  UpdateWebhookEndpointDto: {
4356
4416
  /**
@@ -4371,7 +4431,7 @@ export interface components {
4371
4431
  * "dsync.user.created"
4372
4432
  * ]
4373
4433
  */
4374
- 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" | "api_key.updated" | "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.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4434
+ events?: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.organization.switched" | "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" | "authentication.reauthentication_succeeded" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "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.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
4375
4435
  };
4376
4436
  WidgetSessionTokenDto: {
4377
4437
  /**
@@ -4749,6 +4809,143 @@ export interface components {
4749
4809
  */
4750
4810
  redirect_uri: string;
4751
4811
  };
4812
+ AgentRegistration: {
4813
+ /**
4814
+ * @description Unique identifier of the agent registration.
4815
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
4816
+ */
4817
+ id: string;
4818
+ /** @description The agent identity associated with this registration. */
4819
+ agent_identity: {
4820
+ /**
4821
+ * @description Unique identifier of the agent identity.
4822
+ * @example agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
4823
+ */
4824
+ id: string;
4825
+ /**
4826
+ * @description Identifier of the AuthKit user the agent identity is bound to, or `null` when the agent is not associated with a user.
4827
+ * @example user_01E4ZCR3C56J083X43JQXF3JK5
4828
+ */
4829
+ userland_user_id: string | null;
4830
+ /**
4831
+ * Format: date-time
4832
+ * @description The timestamp when the agent identity was created.
4833
+ * @example 2026-01-15T12:00:00.000Z
4834
+ */
4835
+ created_at: string;
4836
+ /**
4837
+ * Format: date-time
4838
+ * @description The timestamp when the agent identity was last updated.
4839
+ * @example 2026-01-15T12:00:00.000Z
4840
+ */
4841
+ updated_at: string;
4842
+ };
4843
+ /**
4844
+ * @description Identifier of the organization the agent is registered to.
4845
+ * @example org_01EHQMYV6MBK39QC5PZXHY59C3
4846
+ */
4847
+ organization_id: string;
4848
+ /**
4849
+ * @description The current verification status of the registration.
4850
+ * @example verified
4851
+ * @enum {string}
4852
+ */
4853
+ status: "unverified" | "verified" | "expired" | "revoked";
4854
+ /**
4855
+ * @description The kind of agent registration.
4856
+ * @example service_auth
4857
+ * @enum {string}
4858
+ */
4859
+ kind: "anonymous" | "service_auth" | "identity_assertion";
4860
+ /** @description The claim associated with this registration, or `null` if the registration has no claim. */
4861
+ claim: {
4862
+ /**
4863
+ * @description Unique identifier of the claim.
4864
+ * @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
4865
+ */
4866
+ id: string;
4867
+ /** @description The completion record for the claim, or `null` if the claim has not been completed. */
4868
+ claim_completion: {
4869
+ /**
4870
+ * @description Unique identifier of the claim completion.
4871
+ * @example agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
4872
+ */
4873
+ id: string;
4874
+ /**
4875
+ * Format: date-time
4876
+ * @description The timestamp when the claim completion was created.
4877
+ * @example 2026-01-15T12:00:00.000Z
4878
+ */
4879
+ created_at: string;
4880
+ /**
4881
+ * Format: date-time
4882
+ * @description The timestamp when the claim completion was last updated.
4883
+ * @example 2026-01-15T12:00:00.000Z
4884
+ */
4885
+ updated_at: string;
4886
+ /**
4887
+ * Format: date-time
4888
+ * @description The timestamp when the claim completion expires.
4889
+ * @example 2026-01-15T12:00:00.000Z
4890
+ */
4891
+ expires_at: string;
4892
+ /**
4893
+ * Format: date-time
4894
+ * @description The timestamp when the claim was completed.
4895
+ * @example 2026-01-15T12:00:00.000Z
4896
+ */
4897
+ claimed_at: string;
4898
+ } | null;
4899
+ /**
4900
+ * Format: date-time
4901
+ * @description The timestamp when the claim was created.
4902
+ * @example 2026-01-15T12:00:00.000Z
4903
+ */
4904
+ created_at: string;
4905
+ /**
4906
+ * Format: date-time
4907
+ * @description The timestamp when the claim was last updated.
4908
+ * @example 2026-01-15T12:00:00.000Z
4909
+ */
4910
+ updated_at: string;
4911
+ /**
4912
+ * Format: date-time
4913
+ * @description The timestamp when the claim expires.
4914
+ * @example 2026-01-15T12:00:00.000Z
4915
+ */
4916
+ expires_at: string;
4917
+ } | null;
4918
+ /**
4919
+ * Format: date-time
4920
+ * @description The timestamp when the registration was created.
4921
+ * @example 2026-01-15T12:00:00.000Z
4922
+ */
4923
+ created_at: string;
4924
+ /**
4925
+ * Format: date-time
4926
+ * @description The timestamp when the registration was last updated.
4927
+ * @example 2026-01-15T12:00:00.000Z
4928
+ */
4929
+ updated_at: string;
4930
+ };
4931
+ AgentCredentialValidation: {
4932
+ /**
4933
+ * @description Whether the presented credential is valid.
4934
+ * @example true
4935
+ */
4936
+ valid: boolean;
4937
+ /**
4938
+ * @description Identifier of the agent registration the credential belongs to, or `null` when the credential is invalid.
4939
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
4940
+ */
4941
+ registration_id: string | null;
4942
+ /**
4943
+ * Format: date-time
4944
+ * @description The timestamp when the credential expires, or `null` when the credential is invalid.
4945
+ * @example 2026-01-15T12:00:00.000Z
4946
+ */
4947
+ expires_at: string | null;
4948
+ };
4752
4949
  ApiKey: {
4753
4950
  /**
4754
4951
  * @description Distinguishes the API Key object.
@@ -4842,6 +5039,11 @@ export interface components {
4842
5039
  };
4843
5040
  ApiKeyValidationResponse: {
4844
5041
  api_key: components["schemas"]["ApiKey"] | null;
5042
+ /**
5043
+ * @description The ID of the agent registration this API Key was issued for. Present only when the API Key is assigned to an agent registration.
5044
+ * @example agent_reg_01EHZNVPK3SFK441A1RGBFSHRT
5045
+ */
5046
+ agent_registration_id?: string;
4845
5047
  };
4846
5048
  ConnectApplication: {
4847
5049
  /**
@@ -5688,6 +5890,19 @@ export interface components {
5688
5890
  */
5689
5891
  resource_type_slug: string;
5690
5892
  };
5893
+ /** @description The origin of the role assignment. */
5894
+ source: {
5895
+ /**
5896
+ * @description Whether the role was assigned directly or derived from a group.
5897
+ * @enum {string}
5898
+ */
5899
+ type: "direct" | "group";
5900
+ /**
5901
+ * @description The ID of the group role assignment the role was derived from, or null if direct.
5902
+ * @example null
5903
+ */
5904
+ group_role_assignment_id: string | null;
5905
+ };
5691
5906
  /**
5692
5907
  * Format: date-time
5693
5908
  * @description An ISO 8601 timestamp.
@@ -7053,85 +7268,47 @@ export interface components {
7053
7268
  */
7054
7269
  id: string;
7055
7270
  /** @constant */
7056
- event: "api_key.created";
7271
+ event: "agent.registration.claim.attempt.created";
7057
7272
  /** @description The event payload. */
7058
7273
  data: {
7059
7274
  /**
7060
- * @description Distinguishes the API key object.
7275
+ * @description Distinguishes the agent registration claim attempt object.
7061
7276
  * @constant
7062
7277
  */
7063
- object: "api_key";
7278
+ object: "agent_registration_claim_attempt";
7064
7279
  /**
7065
- * @description Unique identifier of the API key.
7066
- * @example api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
7280
+ * @description Unique identifier of the agent registration claim attempt.
7281
+ * @example agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
7067
7282
  */
7068
7283
  id: string;
7069
- /** @description The owner of the API key. */
7070
- owner: {
7071
- /**
7072
- * @description The type of the API key owner.
7073
- * @constant
7074
- */
7075
- type: "organization";
7076
- /**
7077
- * @description The unique identifier of the API key owner.
7078
- * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7079
- */
7080
- id: string;
7081
- } | {
7082
- /**
7083
- * @description The type of the API key owner.
7084
- * @constant
7085
- */
7086
- type: "user";
7087
- /**
7088
- * @description The unique identifier of the user who owns the API key.
7089
- * @example user_01EHWNCE74X7JSDV0X3SZ3KJNY
7090
- */
7091
- id: string;
7092
- /**
7093
- * @description The unique identifier of the organization the API key belongs to.
7094
- * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7095
- */
7096
- organization_id: string;
7097
- };
7098
- /**
7099
- * @description The name of the API key.
7100
- * @example My API Key
7101
- */
7102
- name: string;
7103
7284
  /**
7104
- * @description The obfuscated value of the API key.
7105
- * @example sk_test_...1234
7285
+ * @description The ID of the agent registration.
7286
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7106
7287
  */
7107
- obfuscated_value: string;
7288
+ agent_registration_id: string;
7108
7289
  /**
7109
- * @description The timestamp when the API key was last used.
7110
- * @example 2026-01-15T12:00:00.000Z
7290
+ * @description The ID of the agent registration claim.
7291
+ * @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
7111
7292
  */
7112
- last_used_at: string | null;
7293
+ agent_registration_claim_id: string;
7113
7294
  /**
7114
- * Format: date-time
7115
- * @description Timestamp when the API Key expires. Null means the key does not expire.
7116
- * @example null
7295
+ * @description The login hint for the claim attempt.
7296
+ * @example jane@example.com
7117
7297
  */
7118
- expires_at: string | null;
7298
+ login_hint: string;
7119
7299
  /**
7120
- * @description The permissions granted to the API key.
7121
- * @example [
7122
- * "users:read",
7123
- * "users:write"
7124
- * ]
7300
+ * @description The timestamp when the claim attempt expires.
7301
+ * @example 2024-01-15T10:35:00.000Z
7125
7302
  */
7126
- permissions: string[];
7303
+ expires_at: string;
7127
7304
  /**
7128
- * @description The timestamp when the API key was created.
7129
- * @example 2026-01-15T12:00:00.000Z
7305
+ * @description The timestamp when the claim attempt was created.
7306
+ * @example 2024-01-15T10:30:00.000Z
7130
7307
  */
7131
7308
  created_at: string;
7132
7309
  /**
7133
- * @description The timestamp when the API key was last updated.
7134
- * @example 2026-01-15T12:00:00.000Z
7310
+ * @description The timestamp when the claim attempt was last updated.
7311
+ * @example 2024-01-15T10:30:00.000Z
7135
7312
  */
7136
7313
  updated_at: string;
7137
7314
  };
@@ -7154,23 +7331,394 @@ export interface components {
7154
7331
  */
7155
7332
  id: string;
7156
7333
  /** @constant */
7157
- event: "api_key.revoked";
7334
+ event: "agent.registration.claim.completed";
7158
7335
  /** @description The event payload. */
7159
7336
  data: {
7160
7337
  /**
7161
- * @description Distinguishes the API key object.
7338
+ * @description Distinguishes the agent registration claim object.
7162
7339
  * @constant
7163
7340
  */
7164
- object: "api_key";
7341
+ object: "agent_registration_claim";
7165
7342
  /**
7166
- * @description Unique identifier of the API key.
7167
- * @example api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
7343
+ * @description Unique identifier of the agent registration claim.
7344
+ * @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
7168
7345
  */
7169
7346
  id: string;
7170
- /** @description The owner of the API key. */
7171
- owner: {
7172
- /**
7173
- * @description The type of the API key owner.
7347
+ /**
7348
+ * @description The ID of the agent registration.
7349
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7350
+ */
7351
+ agent_registration_id: string;
7352
+ /**
7353
+ * @description The ID of the claim attempt that completed the claim.
7354
+ * @example agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
7355
+ */
7356
+ completed_by_attempt_id: string;
7357
+ /** @description The user who completed the claim. */
7358
+ claimed_by: {
7359
+ /**
7360
+ * @description The ID of the user who completed the claim.
7361
+ * @example user_01EHWNCE74X7JSDV0X3SZ3KJNY
7362
+ */
7363
+ user_id: string;
7364
+ /**
7365
+ * @description The ID of the organization the claiming user belongs to.
7366
+ * @example null
7367
+ */
7368
+ organization_id: string | ("null" | null);
7369
+ };
7370
+ /**
7371
+ * @description The timestamp when the claim was completed.
7372
+ * @example 2024-01-15T10:32:00.000Z
7373
+ */
7374
+ completed_at: string;
7375
+ /**
7376
+ * @description The timestamp when the claim was created.
7377
+ * @example 2024-01-15T10:30:00.000Z
7378
+ */
7379
+ created_at: string;
7380
+ /**
7381
+ * @description The timestamp when the claim was last updated.
7382
+ * @example 2024-01-15T10:32:00.000Z
7383
+ */
7384
+ updated_at: string;
7385
+ };
7386
+ /**
7387
+ * Format: date-time
7388
+ * @description An ISO 8601 timestamp.
7389
+ * @example 2026-01-15T12:00:00.000Z
7390
+ */
7391
+ created_at: string;
7392
+ context?: components["schemas"]["EventContextDto"];
7393
+ /**
7394
+ * @description Distinguishes the Event object.
7395
+ * @constant
7396
+ */
7397
+ object: "event";
7398
+ } | {
7399
+ /**
7400
+ * @description Unique identifier for the event.
7401
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7402
+ */
7403
+ id: string;
7404
+ /** @constant */
7405
+ event: "agent.registration.created";
7406
+ /** @description The event payload. */
7407
+ data: {
7408
+ /**
7409
+ * @description Distinguishes the agent registration object.
7410
+ * @constant
7411
+ */
7412
+ object: "agent_registration";
7413
+ /**
7414
+ * @description Unique identifier of the agent registration.
7415
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7416
+ */
7417
+ id: string;
7418
+ /** @description The agent identity for this registration. */
7419
+ agent_identity: {
7420
+ /**
7421
+ * @description Distinguishes the agent identity object.
7422
+ * @constant
7423
+ */
7424
+ object: "agent_identity";
7425
+ /**
7426
+ * @description Unique identifier of the agent identity.
7427
+ * @example agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
7428
+ */
7429
+ id: string;
7430
+ /**
7431
+ * @description The ID of the userland user bound to this agent identity.
7432
+ * @example null
7433
+ */
7434
+ userland_user_id: string | ("null" | null);
7435
+ };
7436
+ /**
7437
+ * @description The ID of the organization the registration belongs to.
7438
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7439
+ */
7440
+ organization_id: string;
7441
+ /**
7442
+ * @description The current status of the registration.
7443
+ * @example unverified
7444
+ * @enum {string}
7445
+ */
7446
+ status: "unverified" | "verified" | "expired" | "revoked";
7447
+ /**
7448
+ * @description The kind of the registration.
7449
+ * @example anonymous
7450
+ * @enum {string}
7451
+ */
7452
+ kind: "anonymous" | "service_auth" | "identity_assertion";
7453
+ /**
7454
+ * @description The authentication method of the registration.
7455
+ * @example anonymous
7456
+ * @enum {string}
7457
+ */
7458
+ method: "anonymous" | "service_auth" | "id_jag";
7459
+ /**
7460
+ * @description The timestamp when the registration was created.
7461
+ * @example 2024-01-15T10:30:00.000Z
7462
+ */
7463
+ created_at: string;
7464
+ /**
7465
+ * @description The timestamp when the registration was last updated.
7466
+ * @example 2024-01-15T10:30:00.000Z
7467
+ */
7468
+ updated_at: string;
7469
+ };
7470
+ /**
7471
+ * Format: date-time
7472
+ * @description An ISO 8601 timestamp.
7473
+ * @example 2026-01-15T12:00:00.000Z
7474
+ */
7475
+ created_at: string;
7476
+ context?: components["schemas"]["EventContextDto"];
7477
+ /**
7478
+ * @description Distinguishes the Event object.
7479
+ * @constant
7480
+ */
7481
+ object: "event";
7482
+ } | {
7483
+ /**
7484
+ * @description Unique identifier for the event.
7485
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7486
+ */
7487
+ id: string;
7488
+ /** @constant */
7489
+ event: "agent.registration.credential.issued";
7490
+ /** @description The event payload. */
7491
+ data: {
7492
+ /**
7493
+ * @description Distinguishes the agent registration credential object.
7494
+ * @constant
7495
+ */
7496
+ object: "agent_registration_credential";
7497
+ /**
7498
+ * @description Unique identifier of the agent registration credential.
7499
+ * @example agent_reg_credential_01EHWNCE74X7JSDV0X3SZ3KJNY
7500
+ */
7501
+ id: string;
7502
+ /**
7503
+ * @description The ID of the agent registration.
7504
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7505
+ */
7506
+ agent_registration_id: string;
7507
+ /** @description Details of the issued credential. */
7508
+ detail: {
7509
+ /**
7510
+ * @description The kind of credential issued.
7511
+ * @constant
7512
+ */
7513
+ kind: "api_key";
7514
+ /**
7515
+ * @description The ID of the issued API key.
7516
+ * @example api_key_01HWDP91J37GZW2FT9GCEX8YWV
7517
+ */
7518
+ api_key_id: string;
7519
+ } | {
7520
+ /**
7521
+ * @description The kind of credential issued.
7522
+ * @constant
7523
+ */
7524
+ kind: "access_token";
7525
+ /**
7526
+ * @description The JWT ID of the issued access token.
7527
+ * @example jti_01EHWNCE74X7JSDV0X3SZ3KJNY
7528
+ */
7529
+ jti: string;
7530
+ /**
7531
+ * @description The timestamp when the access token expires.
7532
+ * @example 2024-01-15T11:30:00.000Z
7533
+ */
7534
+ expires_at: string | ("null" | null);
7535
+ };
7536
+ /**
7537
+ * @description The timestamp when the credential was issued.
7538
+ * @example 2024-01-15T10:33:00.000Z
7539
+ */
7540
+ created_at: string;
7541
+ /**
7542
+ * @description The timestamp when the credential was last updated.
7543
+ * @example 2024-01-15T10:33:00.000Z
7544
+ */
7545
+ updated_at: string;
7546
+ };
7547
+ /**
7548
+ * Format: date-time
7549
+ * @description An ISO 8601 timestamp.
7550
+ * @example 2026-01-15T12:00:00.000Z
7551
+ */
7552
+ created_at: string;
7553
+ context?: components["schemas"]["EventContextDto"];
7554
+ /**
7555
+ * @description Distinguishes the Event object.
7556
+ * @constant
7557
+ */
7558
+ object: "event";
7559
+ } | {
7560
+ /**
7561
+ * @description Unique identifier for the event.
7562
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7563
+ */
7564
+ id: string;
7565
+ /** @constant */
7566
+ event: "agent.registration.organization.switched";
7567
+ /** @description The event payload. */
7568
+ data: {
7569
+ /**
7570
+ * @description The agent registration that was moved.
7571
+ * @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
7572
+ */
7573
+ agent_registration_id: string;
7574
+ /**
7575
+ * @description The agent-created organization the registration is moving off of. Migrate its resources to `to_organization_id`, then delete it.
7576
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7577
+ */
7578
+ from_organization_id: string;
7579
+ /**
7580
+ * @description The organization the registration now belongs to.
7581
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNZ
7582
+ */
7583
+ to_organization_id: string;
7584
+ };
7585
+ /**
7586
+ * Format: date-time
7587
+ * @description An ISO 8601 timestamp.
7588
+ * @example 2026-01-15T12:00:00.000Z
7589
+ */
7590
+ created_at: string;
7591
+ context?: components["schemas"]["EventContextDto"];
7592
+ /**
7593
+ * @description Distinguishes the Event object.
7594
+ * @constant
7595
+ */
7596
+ object: "event";
7597
+ } | {
7598
+ /**
7599
+ * @description Unique identifier for the event.
7600
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7601
+ */
7602
+ id: string;
7603
+ /** @constant */
7604
+ event: "api_key.created";
7605
+ /** @description The event payload. */
7606
+ data: {
7607
+ /**
7608
+ * @description Distinguishes the API key object.
7609
+ * @constant
7610
+ */
7611
+ object: "api_key";
7612
+ /**
7613
+ * @description Unique identifier of the API key.
7614
+ * @example api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
7615
+ */
7616
+ id: string;
7617
+ /** @description The owner of the API key. */
7618
+ owner: {
7619
+ /**
7620
+ * @description The type of the API key owner.
7621
+ * @constant
7622
+ */
7623
+ type: "organization";
7624
+ /**
7625
+ * @description The unique identifier of the API key owner.
7626
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7627
+ */
7628
+ id: string;
7629
+ } | {
7630
+ /**
7631
+ * @description The type of the API key owner.
7632
+ * @constant
7633
+ */
7634
+ type: "user";
7635
+ /**
7636
+ * @description The unique identifier of the user who owns the API key.
7637
+ * @example user_01EHWNCE74X7JSDV0X3SZ3KJNY
7638
+ */
7639
+ id: string;
7640
+ /**
7641
+ * @description The unique identifier of the organization the API key belongs to.
7642
+ * @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
7643
+ */
7644
+ organization_id: string;
7645
+ };
7646
+ /**
7647
+ * @description The name of the API key.
7648
+ * @example My API Key
7649
+ */
7650
+ name: string;
7651
+ /**
7652
+ * @description The obfuscated value of the API key.
7653
+ * @example sk_test_...1234
7654
+ */
7655
+ obfuscated_value: string;
7656
+ /**
7657
+ * @description The timestamp when the API key was last used.
7658
+ * @example 2026-01-15T12:00:00.000Z
7659
+ */
7660
+ last_used_at: string | null;
7661
+ /**
7662
+ * Format: date-time
7663
+ * @description Timestamp when the API Key expires. Null means the key does not expire.
7664
+ * @example null
7665
+ */
7666
+ expires_at: string | null;
7667
+ /**
7668
+ * @description The permissions granted to the API key.
7669
+ * @example [
7670
+ * "users:read",
7671
+ * "users:write"
7672
+ * ]
7673
+ */
7674
+ permissions: string[];
7675
+ /**
7676
+ * @description The timestamp when the API key was created.
7677
+ * @example 2026-01-15T12:00:00.000Z
7678
+ */
7679
+ created_at: string;
7680
+ /**
7681
+ * @description The timestamp when the API key was last updated.
7682
+ * @example 2026-01-15T12:00:00.000Z
7683
+ */
7684
+ updated_at: string;
7685
+ };
7686
+ /**
7687
+ * Format: date-time
7688
+ * @description An ISO 8601 timestamp.
7689
+ * @example 2026-01-15T12:00:00.000Z
7690
+ */
7691
+ created_at: string;
7692
+ context?: components["schemas"]["EventContextDto"];
7693
+ /**
7694
+ * @description Distinguishes the Event object.
7695
+ * @constant
7696
+ */
7697
+ object: "event";
7698
+ } | {
7699
+ /**
7700
+ * @description Unique identifier for the event.
7701
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
7702
+ */
7703
+ id: string;
7704
+ /** @constant */
7705
+ event: "api_key.revoked";
7706
+ /** @description The event payload. */
7707
+ data: {
7708
+ /**
7709
+ * @description Distinguishes the API key object.
7710
+ * @constant
7711
+ */
7712
+ object: "api_key";
7713
+ /**
7714
+ * @description Unique identifier of the API key.
7715
+ * @example api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
7716
+ */
7717
+ id: string;
7718
+ /** @description The owner of the API key. */
7719
+ owner: {
7720
+ /**
7721
+ * @description The type of the API key owner.
7174
7722
  * @constant
7175
7723
  */
7176
7724
  type: "organization";
@@ -8060,6 +8608,53 @@ export interface components {
8060
8608
  * @constant
8061
8609
  */
8062
8610
  object: "event";
8611
+ } | {
8612
+ /**
8613
+ * @description Unique identifier for the event.
8614
+ * @example event_01EHZNVPK3SFK441A1RGBFSHRT
8615
+ */
8616
+ id: string;
8617
+ /** @constant */
8618
+ event: "authentication.reauthentication_succeeded";
8619
+ /** @description The event payload. */
8620
+ data: {
8621
+ /** @constant */
8622
+ type: "reauthentication";
8623
+ /** @constant */
8624
+ status: "succeeded";
8625
+ /**
8626
+ * @description The IP address of the request.
8627
+ * @example 203.0.113.42
8628
+ */
8629
+ ip_address: string | null;
8630
+ /**
8631
+ * @description The user agent of the request.
8632
+ * @example Mozilla/5.0
8633
+ */
8634
+ user_agent: string | null;
8635
+ /**
8636
+ * @description The ID of the user.
8637
+ * @example user_01E4ZCR3C56J083X43JQXF3JK5
8638
+ */
8639
+ user_id: string;
8640
+ /**
8641
+ * @description The email address of the user.
8642
+ * @example user@example.com
8643
+ */
8644
+ email: string;
8645
+ };
8646
+ /**
8647
+ * Format: date-time
8648
+ * @description An ISO 8601 timestamp.
8649
+ * @example 2026-01-15T12:00:00.000Z
8650
+ */
8651
+ created_at: string;
8652
+ context?: components["schemas"]["EventContextDto"];
8653
+ /**
8654
+ * @description Distinguishes the Event object.
8655
+ * @constant
8656
+ */
8657
+ object: "event";
8063
8658
  } | {
8064
8659
  /**
8065
8660
  * @description Unique identifier for the event.
@@ -11953,6 +12548,11 @@ export interface components {
11953
12548
  * @example false
11954
12549
  */
11955
12550
  system: boolean;
12551
+ /**
12552
+ * @description The slug of the resource type the permission applies to.
12553
+ * @example organization
12554
+ */
12555
+ resource_type_slug: string;
11956
12556
  /**
11957
12557
  * Format: date-time
11958
12558
  * @description An ISO 8601 timestamp.
@@ -12018,6 +12618,11 @@ export interface components {
12018
12618
  * @example false
12019
12619
  */
12020
12620
  system: boolean;
12621
+ /**
12622
+ * @description The slug of the resource type the permission applies to.
12623
+ * @example organization
12624
+ */
12625
+ resource_type_slug: string;
12021
12626
  /**
12022
12627
  * Format: date-time
12023
12628
  * @description An ISO 8601 timestamp.
@@ -12083,6 +12688,11 @@ export interface components {
12083
12688
  * @example false
12084
12689
  */
12085
12690
  system: boolean;
12691
+ /**
12692
+ * @description The slug of the resource type the permission applies to.
12693
+ * @example organization
12694
+ */
12695
+ resource_type_slug: string;
12086
12696
  /**
12087
12697
  * Format: date-time
12088
12698
  * @description An ISO 8601 timestamp.
@@ -12528,108 +13138,6 @@ export interface components {
12528
13138
  * @constant
12529
13139
  */
12530
13140
  object: "event";
12531
- } | {
12532
- /**
12533
- * @description Unique identifier for the event.
12534
- * @example event_01EHZNVPK3SFK441A1RGBFSHRT
12535
- */
12536
- id: string;
12537
- /** @constant */
12538
- event: "session.reauthenticated";
12539
- /** @description The event payload. */
12540
- data: {
12541
- /**
12542
- * @description Distinguishes the session object.
12543
- * @constant
12544
- */
12545
- object: "session";
12546
- /**
12547
- * @description The unique ID of the session.
12548
- * @example session_01H93ZY4F80QPBEZ1R5B2SHQG8
12549
- */
12550
- id: string;
12551
- /** @description Information about the impersonator if this session was created via impersonation. */
12552
- impersonator?: {
12553
- /**
12554
- * @description The email address of the WorkOS Dashboard user who is impersonating the user.
12555
- * @example admin@foocorp.com
12556
- */
12557
- email: string;
12558
- /**
12559
- * @description The justification the impersonator gave for impersonating the user.
12560
- * @example Investigating an issue with the customer's account.
12561
- */
12562
- reason: string | null;
12563
- };
12564
- /**
12565
- * @description The IP address from which the session was created.
12566
- * @example 198.51.100.42
12567
- */
12568
- ip_address: string | null;
12569
- /**
12570
- * @description The ID of the organization this session is associated with.
12571
- * @example org_01H945H0YD4F97JN9MATX7BYAG
12572
- */
12573
- organization_id?: string;
12574
- /**
12575
- * @description The user agent string from the device that created the session.
12576
- * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
12577
- */
12578
- user_agent: string | null;
12579
- /**
12580
- * @description The ID of the user this session belongs to.
12581
- * @example user_01E4ZCR3C56J083X43JQXF3JK5
12582
- */
12583
- user_id: string;
12584
- /**
12585
- * @description The authentication method used to create this session.
12586
- * @example sso
12587
- * @enum {string}
12588
- */
12589
- auth_method: "cross_app_auth" | "external_auth" | "impersonation" | "magic_code" | "migrated_session" | "oauth" | "passkey" | "password" | "sso" | "unknown";
12590
- /**
12591
- * @description The current status of the session.
12592
- * @example active
12593
- * @enum {string}
12594
- */
12595
- status: "active" | "expired" | "revoked";
12596
- /**
12597
- * Format: date-time
12598
- * @description The timestamp when the session expires.
12599
- * @example 2026-01-15T12:00:00.000Z
12600
- */
12601
- expires_at: string;
12602
- /**
12603
- * Format: date-time
12604
- * @description The timestamp when the session ended.
12605
- * @example null
12606
- */
12607
- ended_at: string | null;
12608
- /**
12609
- * Format: date-time
12610
- * @description An ISO 8601 timestamp.
12611
- * @example 2026-01-15T12:00:00.000Z
12612
- */
12613
- created_at: string;
12614
- /**
12615
- * Format: date-time
12616
- * @description An ISO 8601 timestamp.
12617
- * @example 2026-01-15T12:00:00.000Z
12618
- */
12619
- updated_at: string;
12620
- };
12621
- /**
12622
- * Format: date-time
12623
- * @description An ISO 8601 timestamp.
12624
- * @example 2026-01-15T12:00:00.000Z
12625
- */
12626
- created_at: string;
12627
- context?: components["schemas"]["EventContextDto"];
12628
- /**
12629
- * @description Distinguishes the Event object.
12630
- * @constant
12631
- */
12632
- object: "event";
12633
13141
  } | {
12634
13142
  /**
12635
13143
  * @description Unique identifier for the event.
@@ -14073,7 +14581,88 @@ export interface components {
14073
14581
  * @description A human-readable explanation of the mismatch.
14074
14582
  * @example This installation uses oauth authentication. Use the POST /:slug/token endpoint instead.
14075
14583
  */
14076
- message: string;
14584
+ message: string;
14585
+ };
14586
+ DataIntegrationCredentialsResponse: {
14587
+ /**
14588
+ * @description Indicates credentials are available.
14589
+ * @constant
14590
+ */
14591
+ active: true;
14592
+ /** @description The credential object containing the vended secret. */
14593
+ credential: {
14594
+ /**
14595
+ * @description Distinguishes the credential object.
14596
+ * @constant
14597
+ */
14598
+ object: "credential";
14599
+ /**
14600
+ * @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
14601
+ * @constant
14602
+ */
14603
+ auth_method: "oauth";
14604
+ /**
14605
+ * @description The OAuth access token.
14606
+ * @example gho_16C7e42F292c6912E7710c838347Ae178B4a
14607
+ */
14608
+ value: string;
14609
+ /**
14610
+ * @description The ISO-8601 formatted timestamp indicating when the credential expires.
14611
+ * @example 2025-12-31T23:59:59.000Z
14612
+ */
14613
+ expires_at: string | null;
14614
+ /**
14615
+ * @description The scopes granted to the access token.
14616
+ * @example [
14617
+ * "repo",
14618
+ * "user:email"
14619
+ * ]
14620
+ */
14621
+ scopes: string[];
14622
+ /**
14623
+ * @description If the integration has requested scopes that aren't present on the access token, they're listed here.
14624
+ * @example []
14625
+ */
14626
+ missing_scopes: string[];
14627
+ };
14628
+ } | {
14629
+ /**
14630
+ * @description Indicates credentials are available.
14631
+ * @constant
14632
+ */
14633
+ active: true;
14634
+ /** @description The credential object containing the vended secret. */
14635
+ credential: {
14636
+ /**
14637
+ * @description Distinguishes the credential object.
14638
+ * @constant
14639
+ */
14640
+ object: "credential";
14641
+ /**
14642
+ * @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
14643
+ * @constant
14644
+ */
14645
+ auth_method: "api_key";
14646
+ /**
14647
+ * @description The API key secret.
14648
+ * @example sk-1234567890abcdef
14649
+ */
14650
+ value: string;
14651
+ };
14652
+ } | {
14653
+ /**
14654
+ * @description Indicates credentials are not available.
14655
+ * @constant
14656
+ */
14657
+ active: false;
14658
+ /**
14659
+ * @description The reason credentials are unavailable. Additional values may be added in the future; handle unknown values gracefully.
14660
+ * - `"not_installed"`: The user does not have the integration installed.
14661
+ * - `"needs_reauthorization"`: The user needs to reauthorize the integration.
14662
+ * @example not_installed
14663
+ * @enum {string}
14664
+ */
14665
+ error: "not_installed" | "needs_reauthorization";
14077
14666
  };
14078
14667
  ConnectedAccount: {
14079
14668
  /**
@@ -15369,6 +15958,106 @@ export interface components {
15369
15958
  }
15370
15959
  export type $defs = Record<string, never>;
15371
15960
  export interface operations {
15961
+ AgentAdminController_validateCredential: {
15962
+ parameters: {
15963
+ query?: never;
15964
+ header?: never;
15965
+ path?: never;
15966
+ cookie?: never;
15967
+ };
15968
+ requestBody: {
15969
+ content: {
15970
+ "application/json": {
15971
+ /**
15972
+ * @description The kind of credential being validated — an agent API key or an agent access token.
15973
+ * @example access_token
15974
+ * @enum {string}
15975
+ */
15976
+ type: "api_key" | "access_token";
15977
+ /**
15978
+ * @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
15979
+ * @example sk_agent_example_1234567890
15980
+ */
15981
+ credential: string;
15982
+ /**
15983
+ * @description Only applies to `access_token` credentials. When provided, the access token's `aud` claim is verified against this value — tokens issued for a different resource are rejected. Not permitted for `api_key` credentials.
15984
+ * @example https://api.example.com
15985
+ */
15986
+ audience?: string;
15987
+ };
15988
+ };
15989
+ };
15990
+ responses: {
15991
+ /** @description OK */
15992
+ 200: {
15993
+ headers: {
15994
+ [name: string]: unknown;
15995
+ };
15996
+ content: {
15997
+ "application/json": components["schemas"]["AgentCredentialValidation"];
15998
+ };
15999
+ };
16000
+ /** @description Bad Request */
16001
+ 400: {
16002
+ headers: {
16003
+ [name: string]: unknown;
16004
+ };
16005
+ content: {
16006
+ "application/json": {
16007
+ /**
16008
+ * @description The error code identifying the type of error.
16009
+ * @example invalid_request
16010
+ * @constant
16011
+ */
16012
+ code: "invalid_request";
16013
+ /**
16014
+ * @description A human-readable description of the error.
16015
+ * @example Request could not be processed.
16016
+ */
16017
+ message: string;
16018
+ };
16019
+ };
16020
+ };
16021
+ };
16022
+ };
16023
+ AgentAdminController_getRegistration: {
16024
+ parameters: {
16025
+ query?: never;
16026
+ header?: never;
16027
+ path: {
16028
+ /** @description The unique ID of the agent registration. */
16029
+ id: string;
16030
+ };
16031
+ cookie?: never;
16032
+ };
16033
+ requestBody?: never;
16034
+ responses: {
16035
+ /** @description OK */
16036
+ 200: {
16037
+ headers: {
16038
+ [name: string]: unknown;
16039
+ };
16040
+ content: {
16041
+ "application/json": components["schemas"]["AgentRegistration"];
16042
+ };
16043
+ };
16044
+ /** @description Not Found */
16045
+ 404: {
16046
+ headers: {
16047
+ [name: string]: unknown;
16048
+ };
16049
+ content: {
16050
+ "application/json": {
16051
+ /**
16052
+ * @description A human-readable description of the error.
16053
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
16054
+ */
16055
+ message: string;
16056
+ };
16057
+ };
16058
+ };
16059
+ };
16060
+ };
15372
16061
  ApiKeysController_validateApiKey: {
15373
16062
  parameters: {
15374
16063
  query?: never;
@@ -17306,6 +17995,10 @@ export interface operations {
17306
17995
  * "external_id": "project-ext-456",
17307
17996
  * "resource_type_slug": "project"
17308
17997
  * },
17998
+ * "source": {
17999
+ * "type": "direct",
18000
+ * "group_role_assignment_id": null
18001
+ * },
17309
18002
  * "created_at": "2026-01-15T12:00:00.000Z",
17310
18003
  * "updated_at": "2026-01-15T12:00:00.000Z"
17311
18004
  * }
@@ -20858,6 +21551,8 @@ export interface operations {
20858
21551
  limit?: number;
20859
21552
  /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). */
20860
21553
  order?: components["schemas"]["PaginationOrder"];
21554
+ /** @description Filter Connect Applications by registration type. Specify multiple as a comma-separated list (e.g. `registration_types=dynamic,authenticated`). Defaults to `authenticated` only when not specified. */
21555
+ registration_types?: ("dynamic" | "authenticated")[];
20861
21556
  /** @description Filter Connect Applications by organization ID. */
20862
21557
  organization_id?: string;
20863
21558
  };
@@ -21293,8 +21988,191 @@ export interface operations {
21293
21988
  };
21294
21989
  };
21295
21990
  };
21296
- /** @description Unprocessable Entity */
21297
- 422: {
21991
+ /** @description Unprocessable Entity */
21992
+ 422: {
21993
+ headers: {
21994
+ [name: string]: unknown;
21995
+ };
21996
+ content: {
21997
+ "application/json": {
21998
+ /**
21999
+ * @description A human-readable description of the error.
22000
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22001
+ */
22002
+ message: string;
22003
+ };
22004
+ };
22005
+ };
22006
+ };
22007
+ };
22008
+ ConnectionsController_find: {
22009
+ parameters: {
22010
+ query?: never;
22011
+ header?: never;
22012
+ path: {
22013
+ /** @description Unique identifier for the Connection. */
22014
+ id: string;
22015
+ };
22016
+ cookie?: never;
22017
+ };
22018
+ requestBody?: never;
22019
+ responses: {
22020
+ /** @description OK */
22021
+ 200: {
22022
+ headers: {
22023
+ [name: string]: unknown;
22024
+ };
22025
+ content: {
22026
+ "application/json": components["schemas"]["Connection"];
22027
+ };
22028
+ };
22029
+ /** @description Forbidden */
22030
+ 403: {
22031
+ headers: {
22032
+ [name: string]: unknown;
22033
+ };
22034
+ content: {
22035
+ "application/json": {
22036
+ /**
22037
+ * @description A human-readable description of the error.
22038
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22039
+ */
22040
+ message: string;
22041
+ };
22042
+ };
22043
+ };
22044
+ /** @description Not Found */
22045
+ 404: {
22046
+ headers: {
22047
+ [name: string]: unknown;
22048
+ };
22049
+ content: {
22050
+ "application/json": {
22051
+ /**
22052
+ * @description A human-readable description of the error.
22053
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22054
+ */
22055
+ message: string;
22056
+ };
22057
+ };
22058
+ };
22059
+ };
22060
+ };
22061
+ ConnectionsController_delete: {
22062
+ parameters: {
22063
+ query?: never;
22064
+ header?: never;
22065
+ path: {
22066
+ /** @description Unique identifier for the Connection. */
22067
+ id: string;
22068
+ };
22069
+ cookie?: never;
22070
+ };
22071
+ requestBody?: never;
22072
+ responses: {
22073
+ /** @description OK */
22074
+ 200: {
22075
+ headers: {
22076
+ [name: string]: unknown;
22077
+ };
22078
+ content?: never;
22079
+ };
22080
+ /** @description No Content */
22081
+ 204: {
22082
+ headers: {
22083
+ [name: string]: unknown;
22084
+ };
22085
+ content?: never;
22086
+ };
22087
+ /** @description Forbidden */
22088
+ 403: {
22089
+ headers: {
22090
+ [name: string]: unknown;
22091
+ };
22092
+ content: {
22093
+ "application/json": {
22094
+ /**
22095
+ * @description A human-readable description of the error.
22096
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22097
+ */
22098
+ message: string;
22099
+ };
22100
+ };
22101
+ };
22102
+ /** @description Not Found */
22103
+ 404: {
22104
+ headers: {
22105
+ [name: string]: unknown;
22106
+ };
22107
+ content: {
22108
+ "application/json": {
22109
+ /**
22110
+ * @description A human-readable description of the error.
22111
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22112
+ */
22113
+ message: string;
22114
+ };
22115
+ };
22116
+ };
22117
+ };
22118
+ };
22119
+ DataIntegrationsController_upsertApiKey: {
22120
+ parameters: {
22121
+ query?: never;
22122
+ header?: never;
22123
+ path: {
22124
+ /** @description The identifier of the integration. */
22125
+ slug: string;
22126
+ };
22127
+ cookie?: never;
22128
+ };
22129
+ requestBody: {
22130
+ content: {
22131
+ "application/json": {
22132
+ /**
22133
+ * @description A [User](/reference/authkit/user) identifier.
22134
+ * @example user_01EHZNVPK3SFK441A1RGBFSHRT
22135
+ */
22136
+ user_id: string;
22137
+ /**
22138
+ * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
22139
+ * @example org_01EHZNVPK3SFK441A1RGBFSHRT
22140
+ */
22141
+ organization_id?: string;
22142
+ /**
22143
+ * @description The API key secret to store for this integration.
22144
+ * @example sk-1234567890abcdef
22145
+ */
22146
+ secret: string;
22147
+ };
22148
+ };
22149
+ };
22150
+ responses: {
22151
+ /** @description The resulting connected account after the upsert. */
22152
+ 200: {
22153
+ headers: {
22154
+ [name: string]: unknown;
22155
+ };
22156
+ content: {
22157
+ /**
22158
+ * @example {
22159
+ * "object": "connected_account",
22160
+ * "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
22161
+ * "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
22162
+ * "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
22163
+ * "scopes": [],
22164
+ * "auth_method": "api_key",
22165
+ * "api_key_last_4": "cdef",
22166
+ * "state": "connected",
22167
+ * "created_at": "2024-01-16T14:20:00.000Z",
22168
+ * "updated_at": "2024-01-16T14:20:00.000Z"
22169
+ * }
22170
+ */
22171
+ "application/json": components["schemas"]["ConnectedAccount"];
22172
+ };
22173
+ };
22174
+ /** @description Bad Request */
22175
+ 400: {
21298
22176
  headers: {
21299
22177
  [name: string]: unknown;
21300
22178
  };
@@ -21308,28 +22186,12 @@ export interface operations {
21308
22186
  };
21309
22187
  };
21310
22188
  };
21311
- };
21312
- };
21313
- ConnectionsController_find: {
21314
- parameters: {
21315
- query?: never;
21316
- header?: never;
21317
- path: {
21318
- /** @description Unique identifier for the Connection. */
21319
- id: string;
21320
- };
21321
- cookie?: never;
21322
- };
21323
- requestBody?: never;
21324
- responses: {
21325
- /** @description OK */
21326
- 200: {
22189
+ /** @description Unauthorized */
22190
+ 401: {
21327
22191
  headers: {
21328
22192
  [name: string]: unknown;
21329
22193
  };
21330
- content: {
21331
- "application/json": components["schemas"]["Connection"];
21332
- };
22194
+ content?: never;
21333
22195
  };
21334
22196
  /** @description Forbidden */
21335
22197
  403: {
@@ -21346,7 +22208,7 @@ export interface operations {
21346
22208
  };
21347
22209
  };
21348
22210
  };
21349
- /** @description Not Found */
22211
+ /** @description Data integration not found for the given provider slug. */
21350
22212
  404: {
21351
22213
  headers: {
21352
22214
  [name: string]: unknown;
@@ -21361,29 +22223,76 @@ export interface operations {
21361
22223
  };
21362
22224
  };
21363
22225
  };
22226
+ /** @description The matched installation uses a different auth method than this endpoint expects. */
22227
+ 422: {
22228
+ headers: {
22229
+ [name: string]: unknown;
22230
+ };
22231
+ content: {
22232
+ "application/json": components["schemas"]["AuthMethodMismatchError"];
22233
+ };
22234
+ };
21364
22235
  };
21365
22236
  };
21366
- ConnectionsController_delete: {
22237
+ DataIntegrationsController_getDataIntegrationAuthorizeUrl: {
21367
22238
  parameters: {
21368
22239
  query?: never;
21369
22240
  header?: never;
21370
22241
  path: {
21371
- /** @description Unique identifier for the Connection. */
21372
- id: string;
22242
+ /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
22243
+ slug: string;
21373
22244
  };
21374
22245
  cookie?: never;
21375
22246
  };
21376
- requestBody?: never;
22247
+ requestBody: {
22248
+ content: {
22249
+ "application/json": {
22250
+ /**
22251
+ * @description The ID of the user to authorize.
22252
+ * @example user_01EHZNVPK3SFK441A1RGBFSHRT
22253
+ */
22254
+ user_id: string;
22255
+ /**
22256
+ * @description An organization ID to scope the authorization to a specific organization.
22257
+ * @example org_01EHZNVPK3SFK441A1RGBFSHRT
22258
+ */
22259
+ organization_id?: string;
22260
+ /**
22261
+ * Format: uri
22262
+ * @description The URL to redirect the user to after authorization.
22263
+ * @example https://example.com/callback
22264
+ */
22265
+ return_to?: string;
22266
+ };
22267
+ };
22268
+ };
21377
22269
  responses: {
21378
22270
  /** @description OK */
21379
22271
  200: {
21380
22272
  headers: {
21381
22273
  [name: string]: unknown;
21382
22274
  };
21383
- content?: never;
22275
+ content: {
22276
+ "application/json": components["schemas"]["DataIntegrationAuthorizeUrlResponse"];
22277
+ };
21384
22278
  };
21385
- /** @description No Content */
21386
- 204: {
22279
+ /** @description Bad Request */
22280
+ 400: {
22281
+ headers: {
22282
+ [name: string]: unknown;
22283
+ };
22284
+ content: {
22285
+ "application/json": {
22286
+ /**
22287
+ * @description A human-readable description of the error.
22288
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
22289
+ */
22290
+ message: string;
22291
+ };
22292
+ };
22293
+ };
22294
+ /** @description Unauthorized */
22295
+ 401: {
21387
22296
  headers: {
21388
22297
  [name: string]: unknown;
21389
22298
  };
@@ -21421,12 +22330,12 @@ export interface operations {
21421
22330
  };
21422
22331
  };
21423
22332
  };
21424
- DataIntegrationsController_getDataIntegrationAuthorizeUrl: {
22333
+ DataIntegrationsController_vendCredentials: {
21425
22334
  parameters: {
21426
22335
  query?: never;
21427
22336
  header?: never;
21428
22337
  path: {
21429
- /** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
22338
+ /** @description The identifier of the integration. */
21430
22339
  slug: string;
21431
22340
  };
21432
22341
  cookie?: never;
@@ -21435,21 +22344,15 @@ export interface operations {
21435
22344
  content: {
21436
22345
  "application/json": {
21437
22346
  /**
21438
- * @description The ID of the user to authorize.
22347
+ * @description A [User](/reference/authkit/user) identifier.
21439
22348
  * @example user_01EHZNVPK3SFK441A1RGBFSHRT
21440
22349
  */
21441
22350
  user_id: string;
21442
22351
  /**
21443
- * @description An organization ID to scope the authorization to a specific organization.
22352
+ * @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
21444
22353
  * @example org_01EHZNVPK3SFK441A1RGBFSHRT
21445
22354
  */
21446
22355
  organization_id?: string;
21447
- /**
21448
- * Format: uri
21449
- * @description The URL to redirect the user to after authorization.
21450
- * @example https://example.com/callback
21451
- */
21452
- return_to?: string;
21453
22356
  };
21454
22357
  };
21455
22358
  };
@@ -21460,7 +22363,23 @@ export interface operations {
21460
22363
  [name: string]: unknown;
21461
22364
  };
21462
22365
  content: {
21463
- "application/json": components["schemas"]["DataIntegrationAuthorizeUrlResponse"];
22366
+ /**
22367
+ * @example {
22368
+ * "active": true,
22369
+ * "credential": {
22370
+ * "object": "credential",
22371
+ * "auth_method": "oauth",
22372
+ * "value": "gho_16C7e42F292c6912E7710c838347Ae178B4a",
22373
+ * "expires_at": "2025-12-31T23:59:59.000Z",
22374
+ * "scopes": [
22375
+ * "repo",
22376
+ * "user:email"
22377
+ * ],
22378
+ * "missing_scopes": []
22379
+ * }
22380
+ * }
22381
+ */
22382
+ "application/json": components["schemas"]["DataIntegrationCredentialsResponse"];
21464
22383
  };
21465
22384
  };
21466
22385
  /** @description Bad Request */
@@ -21485,22 +22404,7 @@ export interface operations {
21485
22404
  };
21486
22405
  content?: never;
21487
22406
  };
21488
- /** @description Forbidden */
21489
- 403: {
21490
- headers: {
21491
- [name: string]: unknown;
21492
- };
21493
- content: {
21494
- "application/json": {
21495
- /**
21496
- * @description A human-readable description of the error.
21497
- * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
21498
- */
21499
- message: string;
21500
- };
21501
- };
21502
- };
21503
- /** @description Not Found */
22407
+ /** @description Data integration not found for the given provider slug. */
21504
22408
  404: {
21505
22409
  headers: {
21506
22410
  [name: string]: unknown;
@@ -24389,6 +25293,11 @@ export interface operations {
24389
25293
  * @enum {string}
24390
25294
  */
24391
25295
  action: "sign-up" | "sign-in";
25296
+ /**
25297
+ * @description An optional Radar signals ID for the request.
25298
+ * @example 01JBS0GN92GC2RJQS4X9DBPQ2A
25299
+ */
25300
+ signals_id?: string;
24392
25301
  };
24393
25302
  };
24394
25303
  };
@@ -25952,6 +26861,8 @@ export interface operations {
25952
26861
  provider_scopes?: string[];
25953
26862
  /** @description A token representing a user invitation to redeem during authentication. */
25954
26863
  invitation_token?: string;
26864
+ /** @description Maximum allowable elapsed time, in seconds, since the user last actively authenticated. If the last authentication is older than this value, the user is prompted to re-authenticate; a value of `0` forces re-authentication. Only supported when the provider is `authkit`. */
26865
+ max_age?: number;
25955
26866
  /** @description Used to specify which screen to display when the provider is `authkit`. */
25956
26867
  screen_hint?: "sign-up" | "sign-in";
25957
26868
  /** @description A hint to the authorization server about the login identifier the user might use. */
@@ -26064,6 +26975,72 @@ export interface operations {
26064
26975
  };
26065
26976
  };
26066
26977
  };
26978
+ CorsOriginsController_list: {
26979
+ parameters: {
26980
+ query?: {
26981
+ /** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
26982
+ before?: string;
26983
+ /** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
26984
+ after?: string;
26985
+ /** @description Upper limit on the number of objects to return, between `1` and `100`. */
26986
+ limit?: number;
26987
+ /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). */
26988
+ order?: components["schemas"]["PaginationOrder"];
26989
+ };
26990
+ header?: never;
26991
+ path?: never;
26992
+ cookie?: never;
26993
+ };
26994
+ requestBody?: never;
26995
+ responses: {
26996
+ /** @description CORS origins listed successfully. */
26997
+ 200: {
26998
+ headers: {
26999
+ [name: string]: unknown;
27000
+ };
27001
+ content: {
27002
+ "application/json": {
27003
+ /**
27004
+ * @description Indicates this is a list response.
27005
+ * @constant
27006
+ */
27007
+ object?: "list";
27008
+ /** @description Pagination cursors for navigating between pages of results. */
27009
+ list_metadata?: {
27010
+ /**
27011
+ * @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
27012
+ * @example cors_origin_01HXYZ123456789ABCDEFGHIJ
27013
+ */
27014
+ before: string | null;
27015
+ /**
27016
+ * @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
27017
+ * @example cors_origin_01HXYZ987654321KJIHGFEDCBA
27018
+ */
27019
+ after: string | null;
27020
+ };
27021
+ } & {
27022
+ /** @description The list of records for the current page. */
27023
+ data?: components["schemas"]["CorsOriginResponse"][];
27024
+ };
27025
+ };
27026
+ };
27027
+ /** @description Unauthorized */
27028
+ 401: {
27029
+ headers: {
27030
+ [name: string]: unknown;
27031
+ };
27032
+ content: {
27033
+ "application/json": {
27034
+ /**
27035
+ * @description A human-readable description of the error.
27036
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
27037
+ */
27038
+ message: string;
27039
+ };
27040
+ };
27041
+ };
27042
+ };
27043
+ };
26067
27044
  CorsOriginsController_createCorsOrigin: {
26068
27045
  parameters: {
26069
27046
  query?: never;
@@ -28037,6 +29014,77 @@ export interface operations {
28037
29014
  };
28038
29015
  };
28039
29016
  };
29017
+ RedirectUrisController_list: {
29018
+ parameters: {
29019
+ query?: {
29020
+ /** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
29021
+ before?: string;
29022
+ /** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
29023
+ after?: string;
29024
+ /** @description Upper limit on the number of objects to return, between `1` and `100`. */
29025
+ limit?: number;
29026
+ /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). */
29027
+ order?: components["schemas"]["PaginationOrder"];
29028
+ };
29029
+ header?: never;
29030
+ path?: never;
29031
+ cookie?: never;
29032
+ };
29033
+ requestBody?: never;
29034
+ responses: {
29035
+ /** @description Redirect URIs listed successfully. */
29036
+ 200: {
29037
+ headers: {
29038
+ [name: string]: unknown;
29039
+ };
29040
+ content: {
29041
+ "application/json": {
29042
+ /**
29043
+ * @description Indicates this is a list response.
29044
+ * @constant
29045
+ */
29046
+ object?: "list";
29047
+ /** @description Pagination cursors for navigating between pages of results. */
29048
+ list_metadata?: {
29049
+ /**
29050
+ * @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
29051
+ * @example ruri_01HXYZ123456789ABCDEFGHIJ
29052
+ */
29053
+ before: string | null;
29054
+ /**
29055
+ * @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
29056
+ * @example ruri_01HXYZ987654321KJIHGFEDCBA
29057
+ */
29058
+ after: string | null;
29059
+ };
29060
+ } & {
29061
+ /** @description The list of records for the current page. */
29062
+ data?: components["schemas"]["RedirectUri"][];
29063
+ };
29064
+ };
29065
+ };
29066
+ /** @description Unauthorized */
29067
+ 401: {
29068
+ headers: {
29069
+ [name: string]: unknown;
29070
+ };
29071
+ content: {
29072
+ /**
29073
+ * @example {
29074
+ * "message": "Unauthorized"
29075
+ * }
29076
+ */
29077
+ "application/json": {
29078
+ /**
29079
+ * @description A human-readable description of the error.
29080
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
29081
+ */
29082
+ message: string;
29083
+ };
29084
+ };
29085
+ };
29086
+ };
29087
+ };
28040
29088
  RedirectUrisController_create: {
28041
29089
  parameters: {
28042
29090
  query?: never;