@workos/openapi-spec 0.14.0 → 0.16.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.
- package/dist/open-api-spec.yaml +1830 -608
- package/dist/policy.mjs +15 -0
- package/dist/services.d.mts +1 -1
- package/dist/services.mjs +30 -0
- package/dist/types.d.ts +1292 -259
- package/package.json +3 -3
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
|
-
|
|
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
|
-
|
|
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.
|
|
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.
|
|
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: "
|
|
7271
|
+
event: "agent.registration.claim.attempt.created";
|
|
7057
7272
|
/** @description The event payload. */
|
|
7058
7273
|
data: {
|
|
7059
7274
|
/**
|
|
7060
|
-
* @description Distinguishes the
|
|
7275
|
+
* @description Distinguishes the agent registration claim attempt object.
|
|
7061
7276
|
* @constant
|
|
7062
7277
|
*/
|
|
7063
|
-
object: "
|
|
7278
|
+
object: "agent_registration_claim_attempt";
|
|
7064
7279
|
/**
|
|
7065
|
-
* @description Unique identifier of the
|
|
7066
|
-
* @example
|
|
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
|
|
7105
|
-
* @example
|
|
7285
|
+
* @description The ID of the agent registration.
|
|
7286
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
7106
7287
|
*/
|
|
7107
|
-
|
|
7288
|
+
agent_registration_id: string;
|
|
7108
7289
|
/**
|
|
7109
|
-
* @description The
|
|
7110
|
-
* @example
|
|
7290
|
+
* @description The ID of the agent registration claim.
|
|
7291
|
+
* @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
7111
7292
|
*/
|
|
7112
|
-
|
|
7293
|
+
agent_registration_claim_id: string;
|
|
7113
7294
|
/**
|
|
7114
|
-
*
|
|
7115
|
-
* @
|
|
7116
|
-
* @example null
|
|
7295
|
+
* @description The login hint for the claim attempt.
|
|
7296
|
+
* @example jane@example.com
|
|
7117
7297
|
*/
|
|
7118
|
-
|
|
7298
|
+
login_hint: string;
|
|
7119
7299
|
/**
|
|
7120
|
-
* @description The
|
|
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
|
-
|
|
7303
|
+
expires_at: string;
|
|
7127
7304
|
/**
|
|
7128
|
-
* @description The timestamp when the
|
|
7129
|
-
* @example
|
|
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
|
|
7134
|
-
* @example
|
|
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: "
|
|
7334
|
+
event: "agent.registration.claim.completed";
|
|
7158
7335
|
/** @description The event payload. */
|
|
7159
7336
|
data: {
|
|
7160
7337
|
/**
|
|
7161
|
-
* @description Distinguishes the
|
|
7338
|
+
* @description Distinguishes the agent registration claim object.
|
|
7162
7339
|
* @constant
|
|
7163
7340
|
*/
|
|
7164
|
-
object: "
|
|
7341
|
+
object: "agent_registration_claim";
|
|
7165
7342
|
/**
|
|
7166
|
-
* @description Unique identifier of the
|
|
7167
|
-
* @example
|
|
7343
|
+
* @description Unique identifier of the agent registration claim.
|
|
7344
|
+
* @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
7168
7345
|
*/
|
|
7169
7346
|
id: string;
|
|
7170
|
-
/**
|
|
7171
|
-
|
|
7172
|
-
|
|
7173
|
-
|
|
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.
|
|
@@ -12528,108 +13123,6 @@ export interface components {
|
|
|
12528
13123
|
* @constant
|
|
12529
13124
|
*/
|
|
12530
13125
|
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
13126
|
} | {
|
|
12634
13127
|
/**
|
|
12635
13128
|
* @description Unique identifier for the event.
|
|
@@ -14073,7 +14566,88 @@ export interface components {
|
|
|
14073
14566
|
* @description A human-readable explanation of the mismatch.
|
|
14074
14567
|
* @example This installation uses oauth authentication. Use the POST /:slug/token endpoint instead.
|
|
14075
14568
|
*/
|
|
14076
|
-
message: string;
|
|
14569
|
+
message: string;
|
|
14570
|
+
};
|
|
14571
|
+
DataIntegrationCredentialsResponse: {
|
|
14572
|
+
/**
|
|
14573
|
+
* @description Indicates credentials are available.
|
|
14574
|
+
* @constant
|
|
14575
|
+
*/
|
|
14576
|
+
active: true;
|
|
14577
|
+
/** @description The credential object containing the vended secret. */
|
|
14578
|
+
credential: {
|
|
14579
|
+
/**
|
|
14580
|
+
* @description Distinguishes the credential object.
|
|
14581
|
+
* @constant
|
|
14582
|
+
*/
|
|
14583
|
+
object: "credential";
|
|
14584
|
+
/**
|
|
14585
|
+
* @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
|
|
14586
|
+
* @constant
|
|
14587
|
+
*/
|
|
14588
|
+
auth_method: "oauth";
|
|
14589
|
+
/**
|
|
14590
|
+
* @description The OAuth access token.
|
|
14591
|
+
* @example gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
14592
|
+
*/
|
|
14593
|
+
value: string;
|
|
14594
|
+
/**
|
|
14595
|
+
* @description The ISO-8601 formatted timestamp indicating when the credential expires.
|
|
14596
|
+
* @example 2025-12-31T23:59:59.000Z
|
|
14597
|
+
*/
|
|
14598
|
+
expires_at: string | null;
|
|
14599
|
+
/**
|
|
14600
|
+
* @description The scopes granted to the access token.
|
|
14601
|
+
* @example [
|
|
14602
|
+
* "repo",
|
|
14603
|
+
* "user:email"
|
|
14604
|
+
* ]
|
|
14605
|
+
*/
|
|
14606
|
+
scopes: string[];
|
|
14607
|
+
/**
|
|
14608
|
+
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
14609
|
+
* @example []
|
|
14610
|
+
*/
|
|
14611
|
+
missing_scopes: string[];
|
|
14612
|
+
};
|
|
14613
|
+
} | {
|
|
14614
|
+
/**
|
|
14615
|
+
* @description Indicates credentials are available.
|
|
14616
|
+
* @constant
|
|
14617
|
+
*/
|
|
14618
|
+
active: true;
|
|
14619
|
+
/** @description The credential object containing the vended secret. */
|
|
14620
|
+
credential: {
|
|
14621
|
+
/**
|
|
14622
|
+
* @description Distinguishes the credential object.
|
|
14623
|
+
* @constant
|
|
14624
|
+
*/
|
|
14625
|
+
object: "credential";
|
|
14626
|
+
/**
|
|
14627
|
+
* @description The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully.
|
|
14628
|
+
* @constant
|
|
14629
|
+
*/
|
|
14630
|
+
auth_method: "api_key";
|
|
14631
|
+
/**
|
|
14632
|
+
* @description The API key secret.
|
|
14633
|
+
* @example sk-1234567890abcdef
|
|
14634
|
+
*/
|
|
14635
|
+
value: string;
|
|
14636
|
+
};
|
|
14637
|
+
} | {
|
|
14638
|
+
/**
|
|
14639
|
+
* @description Indicates credentials are not available.
|
|
14640
|
+
* @constant
|
|
14641
|
+
*/
|
|
14642
|
+
active: false;
|
|
14643
|
+
/**
|
|
14644
|
+
* @description The reason credentials are unavailable. Additional values may be added in the future; handle unknown values gracefully.
|
|
14645
|
+
* - `"not_installed"`: The user does not have the integration installed.
|
|
14646
|
+
* - `"needs_reauthorization"`: The user needs to reauthorize the integration.
|
|
14647
|
+
* @example not_installed
|
|
14648
|
+
* @enum {string}
|
|
14649
|
+
*/
|
|
14650
|
+
error: "not_installed" | "needs_reauthorization";
|
|
14077
14651
|
};
|
|
14078
14652
|
ConnectedAccount: {
|
|
14079
14653
|
/**
|
|
@@ -15369,6 +15943,106 @@ export interface components {
|
|
|
15369
15943
|
}
|
|
15370
15944
|
export type $defs = Record<string, never>;
|
|
15371
15945
|
export interface operations {
|
|
15946
|
+
AgentAdminController_validateCredential: {
|
|
15947
|
+
parameters: {
|
|
15948
|
+
query?: never;
|
|
15949
|
+
header?: never;
|
|
15950
|
+
path?: never;
|
|
15951
|
+
cookie?: never;
|
|
15952
|
+
};
|
|
15953
|
+
requestBody: {
|
|
15954
|
+
content: {
|
|
15955
|
+
"application/json": {
|
|
15956
|
+
/**
|
|
15957
|
+
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
15958
|
+
* @example access_token
|
|
15959
|
+
* @enum {string}
|
|
15960
|
+
*/
|
|
15961
|
+
type: "api_key" | "access_token";
|
|
15962
|
+
/**
|
|
15963
|
+
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
15964
|
+
* @example sk_agent_example_1234567890
|
|
15965
|
+
*/
|
|
15966
|
+
credential: string;
|
|
15967
|
+
/**
|
|
15968
|
+
* @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.
|
|
15969
|
+
* @example https://api.example.com
|
|
15970
|
+
*/
|
|
15971
|
+
audience?: string;
|
|
15972
|
+
};
|
|
15973
|
+
};
|
|
15974
|
+
};
|
|
15975
|
+
responses: {
|
|
15976
|
+
/** @description OK */
|
|
15977
|
+
200: {
|
|
15978
|
+
headers: {
|
|
15979
|
+
[name: string]: unknown;
|
|
15980
|
+
};
|
|
15981
|
+
content: {
|
|
15982
|
+
"application/json": components["schemas"]["AgentCredentialValidation"];
|
|
15983
|
+
};
|
|
15984
|
+
};
|
|
15985
|
+
/** @description Bad Request */
|
|
15986
|
+
400: {
|
|
15987
|
+
headers: {
|
|
15988
|
+
[name: string]: unknown;
|
|
15989
|
+
};
|
|
15990
|
+
content: {
|
|
15991
|
+
"application/json": {
|
|
15992
|
+
/**
|
|
15993
|
+
* @description The error code identifying the type of error.
|
|
15994
|
+
* @example invalid_request
|
|
15995
|
+
* @constant
|
|
15996
|
+
*/
|
|
15997
|
+
code: "invalid_request";
|
|
15998
|
+
/**
|
|
15999
|
+
* @description A human-readable description of the error.
|
|
16000
|
+
* @example Request could not be processed.
|
|
16001
|
+
*/
|
|
16002
|
+
message: string;
|
|
16003
|
+
};
|
|
16004
|
+
};
|
|
16005
|
+
};
|
|
16006
|
+
};
|
|
16007
|
+
};
|
|
16008
|
+
AgentAdminController_getRegistration: {
|
|
16009
|
+
parameters: {
|
|
16010
|
+
query?: never;
|
|
16011
|
+
header?: never;
|
|
16012
|
+
path: {
|
|
16013
|
+
/** @description The unique ID of the agent registration. */
|
|
16014
|
+
id: string;
|
|
16015
|
+
};
|
|
16016
|
+
cookie?: never;
|
|
16017
|
+
};
|
|
16018
|
+
requestBody?: never;
|
|
16019
|
+
responses: {
|
|
16020
|
+
/** @description OK */
|
|
16021
|
+
200: {
|
|
16022
|
+
headers: {
|
|
16023
|
+
[name: string]: unknown;
|
|
16024
|
+
};
|
|
16025
|
+
content: {
|
|
16026
|
+
"application/json": components["schemas"]["AgentRegistration"];
|
|
16027
|
+
};
|
|
16028
|
+
};
|
|
16029
|
+
/** @description Not Found */
|
|
16030
|
+
404: {
|
|
16031
|
+
headers: {
|
|
16032
|
+
[name: string]: unknown;
|
|
16033
|
+
};
|
|
16034
|
+
content: {
|
|
16035
|
+
"application/json": {
|
|
16036
|
+
/**
|
|
16037
|
+
* @description A human-readable description of the error.
|
|
16038
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16039
|
+
*/
|
|
16040
|
+
message: string;
|
|
16041
|
+
};
|
|
16042
|
+
};
|
|
16043
|
+
};
|
|
16044
|
+
};
|
|
16045
|
+
};
|
|
15372
16046
|
ApiKeysController_validateApiKey: {
|
|
15373
16047
|
parameters: {
|
|
15374
16048
|
query?: never;
|
|
@@ -17306,6 +17980,10 @@ export interface operations {
|
|
|
17306
17980
|
* "external_id": "project-ext-456",
|
|
17307
17981
|
* "resource_type_slug": "project"
|
|
17308
17982
|
* },
|
|
17983
|
+
* "source": {
|
|
17984
|
+
* "type": "direct",
|
|
17985
|
+
* "group_role_assignment_id": null
|
|
17986
|
+
* },
|
|
17309
17987
|
* "created_at": "2026-01-15T12:00:00.000Z",
|
|
17310
17988
|
* "updated_at": "2026-01-15T12:00:00.000Z"
|
|
17311
17989
|
* }
|
|
@@ -20858,6 +21536,8 @@ export interface operations {
|
|
|
20858
21536
|
limit?: number;
|
|
20859
21537
|
/** @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
21538
|
order?: components["schemas"]["PaginationOrder"];
|
|
21539
|
+
/** @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. */
|
|
21540
|
+
registration_types?: ("dynamic" | "authenticated")[];
|
|
20861
21541
|
/** @description Filter Connect Applications by organization ID. */
|
|
20862
21542
|
organization_id?: string;
|
|
20863
21543
|
};
|
|
@@ -21293,8 +21973,191 @@ export interface operations {
|
|
|
21293
21973
|
};
|
|
21294
21974
|
};
|
|
21295
21975
|
};
|
|
21296
|
-
/** @description Unprocessable Entity */
|
|
21297
|
-
422: {
|
|
21976
|
+
/** @description Unprocessable Entity */
|
|
21977
|
+
422: {
|
|
21978
|
+
headers: {
|
|
21979
|
+
[name: string]: unknown;
|
|
21980
|
+
};
|
|
21981
|
+
content: {
|
|
21982
|
+
"application/json": {
|
|
21983
|
+
/**
|
|
21984
|
+
* @description A human-readable description of the error.
|
|
21985
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
21986
|
+
*/
|
|
21987
|
+
message: string;
|
|
21988
|
+
};
|
|
21989
|
+
};
|
|
21990
|
+
};
|
|
21991
|
+
};
|
|
21992
|
+
};
|
|
21993
|
+
ConnectionsController_find: {
|
|
21994
|
+
parameters: {
|
|
21995
|
+
query?: never;
|
|
21996
|
+
header?: never;
|
|
21997
|
+
path: {
|
|
21998
|
+
/** @description Unique identifier for the Connection. */
|
|
21999
|
+
id: string;
|
|
22000
|
+
};
|
|
22001
|
+
cookie?: never;
|
|
22002
|
+
};
|
|
22003
|
+
requestBody?: never;
|
|
22004
|
+
responses: {
|
|
22005
|
+
/** @description OK */
|
|
22006
|
+
200: {
|
|
22007
|
+
headers: {
|
|
22008
|
+
[name: string]: unknown;
|
|
22009
|
+
};
|
|
22010
|
+
content: {
|
|
22011
|
+
"application/json": components["schemas"]["Connection"];
|
|
22012
|
+
};
|
|
22013
|
+
};
|
|
22014
|
+
/** @description Forbidden */
|
|
22015
|
+
403: {
|
|
22016
|
+
headers: {
|
|
22017
|
+
[name: string]: unknown;
|
|
22018
|
+
};
|
|
22019
|
+
content: {
|
|
22020
|
+
"application/json": {
|
|
22021
|
+
/**
|
|
22022
|
+
* @description A human-readable description of the error.
|
|
22023
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22024
|
+
*/
|
|
22025
|
+
message: string;
|
|
22026
|
+
};
|
|
22027
|
+
};
|
|
22028
|
+
};
|
|
22029
|
+
/** @description Not Found */
|
|
22030
|
+
404: {
|
|
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
|
+
};
|
|
22045
|
+
};
|
|
22046
|
+
ConnectionsController_delete: {
|
|
22047
|
+
parameters: {
|
|
22048
|
+
query?: never;
|
|
22049
|
+
header?: never;
|
|
22050
|
+
path: {
|
|
22051
|
+
/** @description Unique identifier for the Connection. */
|
|
22052
|
+
id: string;
|
|
22053
|
+
};
|
|
22054
|
+
cookie?: never;
|
|
22055
|
+
};
|
|
22056
|
+
requestBody?: never;
|
|
22057
|
+
responses: {
|
|
22058
|
+
/** @description OK */
|
|
22059
|
+
200: {
|
|
22060
|
+
headers: {
|
|
22061
|
+
[name: string]: unknown;
|
|
22062
|
+
};
|
|
22063
|
+
content?: never;
|
|
22064
|
+
};
|
|
22065
|
+
/** @description No Content */
|
|
22066
|
+
204: {
|
|
22067
|
+
headers: {
|
|
22068
|
+
[name: string]: unknown;
|
|
22069
|
+
};
|
|
22070
|
+
content?: never;
|
|
22071
|
+
};
|
|
22072
|
+
/** @description Forbidden */
|
|
22073
|
+
403: {
|
|
22074
|
+
headers: {
|
|
22075
|
+
[name: string]: unknown;
|
|
22076
|
+
};
|
|
22077
|
+
content: {
|
|
22078
|
+
"application/json": {
|
|
22079
|
+
/**
|
|
22080
|
+
* @description A human-readable description of the error.
|
|
22081
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22082
|
+
*/
|
|
22083
|
+
message: string;
|
|
22084
|
+
};
|
|
22085
|
+
};
|
|
22086
|
+
};
|
|
22087
|
+
/** @description Not Found */
|
|
22088
|
+
404: {
|
|
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
|
+
};
|
|
22103
|
+
};
|
|
22104
|
+
DataIntegrationsController_upsertApiKey: {
|
|
22105
|
+
parameters: {
|
|
22106
|
+
query?: never;
|
|
22107
|
+
header?: never;
|
|
22108
|
+
path: {
|
|
22109
|
+
/** @description The identifier of the integration. */
|
|
22110
|
+
slug: string;
|
|
22111
|
+
};
|
|
22112
|
+
cookie?: never;
|
|
22113
|
+
};
|
|
22114
|
+
requestBody: {
|
|
22115
|
+
content: {
|
|
22116
|
+
"application/json": {
|
|
22117
|
+
/**
|
|
22118
|
+
* @description A [User](/reference/authkit/user) identifier.
|
|
22119
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
22120
|
+
*/
|
|
22121
|
+
user_id: string;
|
|
22122
|
+
/**
|
|
22123
|
+
* @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
|
|
22124
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
22125
|
+
*/
|
|
22126
|
+
organization_id?: string;
|
|
22127
|
+
/**
|
|
22128
|
+
* @description The API key secret to store for this integration.
|
|
22129
|
+
* @example sk-1234567890abcdef
|
|
22130
|
+
*/
|
|
22131
|
+
secret: string;
|
|
22132
|
+
};
|
|
22133
|
+
};
|
|
22134
|
+
};
|
|
22135
|
+
responses: {
|
|
22136
|
+
/** @description The resulting connected account after the upsert. */
|
|
22137
|
+
200: {
|
|
22138
|
+
headers: {
|
|
22139
|
+
[name: string]: unknown;
|
|
22140
|
+
};
|
|
22141
|
+
content: {
|
|
22142
|
+
/**
|
|
22143
|
+
* @example {
|
|
22144
|
+
* "object": "connected_account",
|
|
22145
|
+
* "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
22146
|
+
* "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
22147
|
+
* "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
22148
|
+
* "scopes": [],
|
|
22149
|
+
* "auth_method": "api_key",
|
|
22150
|
+
* "api_key_last_4": "cdef",
|
|
22151
|
+
* "state": "connected",
|
|
22152
|
+
* "created_at": "2024-01-16T14:20:00.000Z",
|
|
22153
|
+
* "updated_at": "2024-01-16T14:20:00.000Z"
|
|
22154
|
+
* }
|
|
22155
|
+
*/
|
|
22156
|
+
"application/json": components["schemas"]["ConnectedAccount"];
|
|
22157
|
+
};
|
|
22158
|
+
};
|
|
22159
|
+
/** @description Bad Request */
|
|
22160
|
+
400: {
|
|
21298
22161
|
headers: {
|
|
21299
22162
|
[name: string]: unknown;
|
|
21300
22163
|
};
|
|
@@ -21308,28 +22171,12 @@ export interface operations {
|
|
|
21308
22171
|
};
|
|
21309
22172
|
};
|
|
21310
22173
|
};
|
|
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: {
|
|
22174
|
+
/** @description Unauthorized */
|
|
22175
|
+
401: {
|
|
21327
22176
|
headers: {
|
|
21328
22177
|
[name: string]: unknown;
|
|
21329
22178
|
};
|
|
21330
|
-
content
|
|
21331
|
-
"application/json": components["schemas"]["Connection"];
|
|
21332
|
-
};
|
|
22179
|
+
content?: never;
|
|
21333
22180
|
};
|
|
21334
22181
|
/** @description Forbidden */
|
|
21335
22182
|
403: {
|
|
@@ -21346,7 +22193,7 @@ export interface operations {
|
|
|
21346
22193
|
};
|
|
21347
22194
|
};
|
|
21348
22195
|
};
|
|
21349
|
-
/** @description
|
|
22196
|
+
/** @description Data integration not found for the given provider slug. */
|
|
21350
22197
|
404: {
|
|
21351
22198
|
headers: {
|
|
21352
22199
|
[name: string]: unknown;
|
|
@@ -21361,29 +22208,76 @@ export interface operations {
|
|
|
21361
22208
|
};
|
|
21362
22209
|
};
|
|
21363
22210
|
};
|
|
22211
|
+
/** @description The matched installation uses a different auth method than this endpoint expects. */
|
|
22212
|
+
422: {
|
|
22213
|
+
headers: {
|
|
22214
|
+
[name: string]: unknown;
|
|
22215
|
+
};
|
|
22216
|
+
content: {
|
|
22217
|
+
"application/json": components["schemas"]["AuthMethodMismatchError"];
|
|
22218
|
+
};
|
|
22219
|
+
};
|
|
21364
22220
|
};
|
|
21365
22221
|
};
|
|
21366
|
-
|
|
22222
|
+
DataIntegrationsController_getDataIntegrationAuthorizeUrl: {
|
|
21367
22223
|
parameters: {
|
|
21368
22224
|
query?: never;
|
|
21369
22225
|
header?: never;
|
|
21370
22226
|
path: {
|
|
21371
|
-
/** @description
|
|
21372
|
-
|
|
22227
|
+
/** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
22228
|
+
slug: string;
|
|
21373
22229
|
};
|
|
21374
22230
|
cookie?: never;
|
|
21375
22231
|
};
|
|
21376
|
-
requestBody
|
|
22232
|
+
requestBody: {
|
|
22233
|
+
content: {
|
|
22234
|
+
"application/json": {
|
|
22235
|
+
/**
|
|
22236
|
+
* @description The ID of the user to authorize.
|
|
22237
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
22238
|
+
*/
|
|
22239
|
+
user_id: string;
|
|
22240
|
+
/**
|
|
22241
|
+
* @description An organization ID to scope the authorization to a specific organization.
|
|
22242
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
22243
|
+
*/
|
|
22244
|
+
organization_id?: string;
|
|
22245
|
+
/**
|
|
22246
|
+
* Format: uri
|
|
22247
|
+
* @description The URL to redirect the user to after authorization.
|
|
22248
|
+
* @example https://example.com/callback
|
|
22249
|
+
*/
|
|
22250
|
+
return_to?: string;
|
|
22251
|
+
};
|
|
22252
|
+
};
|
|
22253
|
+
};
|
|
21377
22254
|
responses: {
|
|
21378
22255
|
/** @description OK */
|
|
21379
22256
|
200: {
|
|
21380
22257
|
headers: {
|
|
21381
22258
|
[name: string]: unknown;
|
|
21382
22259
|
};
|
|
21383
|
-
content
|
|
22260
|
+
content: {
|
|
22261
|
+
"application/json": components["schemas"]["DataIntegrationAuthorizeUrlResponse"];
|
|
22262
|
+
};
|
|
21384
22263
|
};
|
|
21385
|
-
/** @description
|
|
21386
|
-
|
|
22264
|
+
/** @description Bad Request */
|
|
22265
|
+
400: {
|
|
22266
|
+
headers: {
|
|
22267
|
+
[name: string]: unknown;
|
|
22268
|
+
};
|
|
22269
|
+
content: {
|
|
22270
|
+
"application/json": {
|
|
22271
|
+
/**
|
|
22272
|
+
* @description A human-readable description of the error.
|
|
22273
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22274
|
+
*/
|
|
22275
|
+
message: string;
|
|
22276
|
+
};
|
|
22277
|
+
};
|
|
22278
|
+
};
|
|
22279
|
+
/** @description Unauthorized */
|
|
22280
|
+
401: {
|
|
21387
22281
|
headers: {
|
|
21388
22282
|
[name: string]: unknown;
|
|
21389
22283
|
};
|
|
@@ -21421,12 +22315,12 @@ export interface operations {
|
|
|
21421
22315
|
};
|
|
21422
22316
|
};
|
|
21423
22317
|
};
|
|
21424
|
-
|
|
22318
|
+
DataIntegrationsController_vendCredentials: {
|
|
21425
22319
|
parameters: {
|
|
21426
22320
|
query?: never;
|
|
21427
22321
|
header?: never;
|
|
21428
22322
|
path: {
|
|
21429
|
-
/** @description The
|
|
22323
|
+
/** @description The identifier of the integration. */
|
|
21430
22324
|
slug: string;
|
|
21431
22325
|
};
|
|
21432
22326
|
cookie?: never;
|
|
@@ -21435,21 +22329,15 @@ export interface operations {
|
|
|
21435
22329
|
content: {
|
|
21436
22330
|
"application/json": {
|
|
21437
22331
|
/**
|
|
21438
|
-
* @description
|
|
22332
|
+
* @description A [User](/reference/authkit/user) identifier.
|
|
21439
22333
|
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
21440
22334
|
*/
|
|
21441
22335
|
user_id: string;
|
|
21442
22336
|
/**
|
|
21443
|
-
* @description An organization
|
|
22337
|
+
* @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
|
|
21444
22338
|
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
21445
22339
|
*/
|
|
21446
22340
|
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
22341
|
};
|
|
21454
22342
|
};
|
|
21455
22343
|
};
|
|
@@ -21460,7 +22348,23 @@ export interface operations {
|
|
|
21460
22348
|
[name: string]: unknown;
|
|
21461
22349
|
};
|
|
21462
22350
|
content: {
|
|
21463
|
-
|
|
22351
|
+
/**
|
|
22352
|
+
* @example {
|
|
22353
|
+
* "active": true,
|
|
22354
|
+
* "credential": {
|
|
22355
|
+
* "object": "credential",
|
|
22356
|
+
* "auth_method": "oauth",
|
|
22357
|
+
* "value": "gho_16C7e42F292c6912E7710c838347Ae178B4a",
|
|
22358
|
+
* "expires_at": "2025-12-31T23:59:59.000Z",
|
|
22359
|
+
* "scopes": [
|
|
22360
|
+
* "repo",
|
|
22361
|
+
* "user:email"
|
|
22362
|
+
* ],
|
|
22363
|
+
* "missing_scopes": []
|
|
22364
|
+
* }
|
|
22365
|
+
* }
|
|
22366
|
+
*/
|
|
22367
|
+
"application/json": components["schemas"]["DataIntegrationCredentialsResponse"];
|
|
21464
22368
|
};
|
|
21465
22369
|
};
|
|
21466
22370
|
/** @description Bad Request */
|
|
@@ -21485,22 +22389,7 @@ export interface operations {
|
|
|
21485
22389
|
};
|
|
21486
22390
|
content?: never;
|
|
21487
22391
|
};
|
|
21488
|
-
/** @description
|
|
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 */
|
|
22392
|
+
/** @description Data integration not found for the given provider slug. */
|
|
21504
22393
|
404: {
|
|
21505
22394
|
headers: {
|
|
21506
22395
|
[name: string]: unknown;
|
|
@@ -24389,6 +25278,11 @@ export interface operations {
|
|
|
24389
25278
|
* @enum {string}
|
|
24390
25279
|
*/
|
|
24391
25280
|
action: "sign-up" | "sign-in";
|
|
25281
|
+
/**
|
|
25282
|
+
* @description An optional Radar signals ID for the request.
|
|
25283
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
25284
|
+
*/
|
|
25285
|
+
signals_id?: string;
|
|
24392
25286
|
};
|
|
24393
25287
|
};
|
|
24394
25288
|
};
|
|
@@ -25952,6 +26846,8 @@ export interface operations {
|
|
|
25952
26846
|
provider_scopes?: string[];
|
|
25953
26847
|
/** @description A token representing a user invitation to redeem during authentication. */
|
|
25954
26848
|
invitation_token?: string;
|
|
26849
|
+
/** @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`. */
|
|
26850
|
+
max_age?: number;
|
|
25955
26851
|
/** @description Used to specify which screen to display when the provider is `authkit`. */
|
|
25956
26852
|
screen_hint?: "sign-up" | "sign-in";
|
|
25957
26853
|
/** @description A hint to the authorization server about the login identifier the user might use. */
|
|
@@ -26064,6 +26960,72 @@ export interface operations {
|
|
|
26064
26960
|
};
|
|
26065
26961
|
};
|
|
26066
26962
|
};
|
|
26963
|
+
CorsOriginsController_list: {
|
|
26964
|
+
parameters: {
|
|
26965
|
+
query?: {
|
|
26966
|
+
/** @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"`. */
|
|
26967
|
+
before?: string;
|
|
26968
|
+
/** @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"`. */
|
|
26969
|
+
after?: string;
|
|
26970
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26971
|
+
limit?: number;
|
|
26972
|
+
/** @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). */
|
|
26973
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
26974
|
+
};
|
|
26975
|
+
header?: never;
|
|
26976
|
+
path?: never;
|
|
26977
|
+
cookie?: never;
|
|
26978
|
+
};
|
|
26979
|
+
requestBody?: never;
|
|
26980
|
+
responses: {
|
|
26981
|
+
/** @description CORS origins listed successfully. */
|
|
26982
|
+
200: {
|
|
26983
|
+
headers: {
|
|
26984
|
+
[name: string]: unknown;
|
|
26985
|
+
};
|
|
26986
|
+
content: {
|
|
26987
|
+
"application/json": {
|
|
26988
|
+
/**
|
|
26989
|
+
* @description Indicates this is a list response.
|
|
26990
|
+
* @constant
|
|
26991
|
+
*/
|
|
26992
|
+
object?: "list";
|
|
26993
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
26994
|
+
list_metadata?: {
|
|
26995
|
+
/**
|
|
26996
|
+
* @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.
|
|
26997
|
+
* @example cors_origin_01HXYZ123456789ABCDEFGHIJ
|
|
26998
|
+
*/
|
|
26999
|
+
before: string | null;
|
|
27000
|
+
/**
|
|
27001
|
+
* @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.
|
|
27002
|
+
* @example cors_origin_01HXYZ987654321KJIHGFEDCBA
|
|
27003
|
+
*/
|
|
27004
|
+
after: string | null;
|
|
27005
|
+
};
|
|
27006
|
+
} & {
|
|
27007
|
+
/** @description The list of records for the current page. */
|
|
27008
|
+
data?: components["schemas"]["CorsOriginResponse"][];
|
|
27009
|
+
};
|
|
27010
|
+
};
|
|
27011
|
+
};
|
|
27012
|
+
/** @description Unauthorized */
|
|
27013
|
+
401: {
|
|
27014
|
+
headers: {
|
|
27015
|
+
[name: string]: unknown;
|
|
27016
|
+
};
|
|
27017
|
+
content: {
|
|
27018
|
+
"application/json": {
|
|
27019
|
+
/**
|
|
27020
|
+
* @description A human-readable description of the error.
|
|
27021
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
27022
|
+
*/
|
|
27023
|
+
message: string;
|
|
27024
|
+
};
|
|
27025
|
+
};
|
|
27026
|
+
};
|
|
27027
|
+
};
|
|
27028
|
+
};
|
|
26067
27029
|
CorsOriginsController_createCorsOrigin: {
|
|
26068
27030
|
parameters: {
|
|
26069
27031
|
query?: never;
|
|
@@ -28037,6 +28999,77 @@ export interface operations {
|
|
|
28037
28999
|
};
|
|
28038
29000
|
};
|
|
28039
29001
|
};
|
|
29002
|
+
RedirectUrisController_list: {
|
|
29003
|
+
parameters: {
|
|
29004
|
+
query?: {
|
|
29005
|
+
/** @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"`. */
|
|
29006
|
+
before?: string;
|
|
29007
|
+
/** @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"`. */
|
|
29008
|
+
after?: string;
|
|
29009
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
29010
|
+
limit?: number;
|
|
29011
|
+
/** @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). */
|
|
29012
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
29013
|
+
};
|
|
29014
|
+
header?: never;
|
|
29015
|
+
path?: never;
|
|
29016
|
+
cookie?: never;
|
|
29017
|
+
};
|
|
29018
|
+
requestBody?: never;
|
|
29019
|
+
responses: {
|
|
29020
|
+
/** @description Redirect URIs listed successfully. */
|
|
29021
|
+
200: {
|
|
29022
|
+
headers: {
|
|
29023
|
+
[name: string]: unknown;
|
|
29024
|
+
};
|
|
29025
|
+
content: {
|
|
29026
|
+
"application/json": {
|
|
29027
|
+
/**
|
|
29028
|
+
* @description Indicates this is a list response.
|
|
29029
|
+
* @constant
|
|
29030
|
+
*/
|
|
29031
|
+
object?: "list";
|
|
29032
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
29033
|
+
list_metadata?: {
|
|
29034
|
+
/**
|
|
29035
|
+
* @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.
|
|
29036
|
+
* @example ruri_01HXYZ123456789ABCDEFGHIJ
|
|
29037
|
+
*/
|
|
29038
|
+
before: string | null;
|
|
29039
|
+
/**
|
|
29040
|
+
* @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.
|
|
29041
|
+
* @example ruri_01HXYZ987654321KJIHGFEDCBA
|
|
29042
|
+
*/
|
|
29043
|
+
after: string | null;
|
|
29044
|
+
};
|
|
29045
|
+
} & {
|
|
29046
|
+
/** @description The list of records for the current page. */
|
|
29047
|
+
data?: components["schemas"]["RedirectUri"][];
|
|
29048
|
+
};
|
|
29049
|
+
};
|
|
29050
|
+
};
|
|
29051
|
+
/** @description Unauthorized */
|
|
29052
|
+
401: {
|
|
29053
|
+
headers: {
|
|
29054
|
+
[name: string]: unknown;
|
|
29055
|
+
};
|
|
29056
|
+
content: {
|
|
29057
|
+
/**
|
|
29058
|
+
* @example {
|
|
29059
|
+
* "message": "Unauthorized"
|
|
29060
|
+
* }
|
|
29061
|
+
*/
|
|
29062
|
+
"application/json": {
|
|
29063
|
+
/**
|
|
29064
|
+
* @description A human-readable description of the error.
|
|
29065
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29066
|
+
*/
|
|
29067
|
+
message: string;
|
|
29068
|
+
};
|
|
29069
|
+
};
|
|
29070
|
+
};
|
|
29071
|
+
};
|
|
29072
|
+
};
|
|
28040
29073
|
RedirectUrisController_create: {
|
|
28041
29074
|
parameters: {
|
|
28042
29075
|
query?: never;
|