@workos/openapi-spec 0.68.0 → 0.70.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 +3365 -394
- package/dist/policy.mjs +10 -0
- package/dist/services.mjs +55 -0
- package/dist/types.d.ts +2788 -198
- package/package.json +7 -7
package/dist/types.d.ts
CHANGED
|
@@ -1042,13 +1042,149 @@ export interface paths {
|
|
|
1042
1042
|
*/
|
|
1043
1043
|
get: operations["ConnectionsController_list"];
|
|
1044
1044
|
put?: never;
|
|
1045
|
+
/**
|
|
1046
|
+
* Create a Connection
|
|
1047
|
+
* @description Creates a new connection for an organization. Provide `saml_options` or `oidc_options` to configure the identity provider. When `external_id` matches an existing connection in the organization, that connection is returned instead of creating a duplicate.
|
|
1048
|
+
*/
|
|
1049
|
+
post: operations["ConnectionsController_create"];
|
|
1050
|
+
delete?: never;
|
|
1051
|
+
options?: never;
|
|
1052
|
+
head?: never;
|
|
1053
|
+
patch?: never;
|
|
1054
|
+
trace?: never;
|
|
1055
|
+
};
|
|
1056
|
+
"/connections/{connectionId}/saml_idp_signing_certs": {
|
|
1057
|
+
parameters: {
|
|
1058
|
+
query?: never;
|
|
1059
|
+
header?: never;
|
|
1060
|
+
path?: never;
|
|
1061
|
+
cookie?: never;
|
|
1062
|
+
};
|
|
1063
|
+
/**
|
|
1064
|
+
* List IdP signing certificates
|
|
1065
|
+
* @description Lists every Identity Provider signing certificate on the connection, including expired ones, oldest first.
|
|
1066
|
+
*/
|
|
1067
|
+
get: operations["SamlIdpSigningCertificatesController_list"];
|
|
1068
|
+
put?: never;
|
|
1069
|
+
/**
|
|
1070
|
+
* Create an IdP signing certificate
|
|
1071
|
+
* @description Adds an Identity Provider signing certificate to the connection, so SAML responses signed with its key can be verified. Use this to import a new certificate ahead of an Identity Provider rotation — the existing certificates keep working until they are deleted or expire.
|
|
1072
|
+
*/
|
|
1073
|
+
post: operations["SamlIdpSigningCertificatesController_create"];
|
|
1074
|
+
delete?: never;
|
|
1075
|
+
options?: never;
|
|
1076
|
+
head?: never;
|
|
1077
|
+
patch?: never;
|
|
1078
|
+
trace?: never;
|
|
1079
|
+
};
|
|
1080
|
+
"/connections/{connectionId}/saml_idp_signing_certs/{certificateId}": {
|
|
1081
|
+
parameters: {
|
|
1082
|
+
query?: never;
|
|
1083
|
+
header?: never;
|
|
1084
|
+
path?: never;
|
|
1085
|
+
cookie?: never;
|
|
1086
|
+
};
|
|
1087
|
+
get?: never;
|
|
1088
|
+
put?: never;
|
|
1045
1089
|
post?: never;
|
|
1090
|
+
/**
|
|
1091
|
+
* Delete an IdP signing certificate
|
|
1092
|
+
* @description Removes an Identity Provider signing certificate from the connection. The last remaining certificate cannot be deleted. A certificate still published in the Identity Provider metadata may be restored by a metadata refresh.
|
|
1093
|
+
*/
|
|
1094
|
+
delete: operations["SamlIdpSigningCertificatesController_delete"];
|
|
1095
|
+
options?: never;
|
|
1096
|
+
head?: never;
|
|
1097
|
+
patch?: never;
|
|
1098
|
+
trace?: never;
|
|
1099
|
+
};
|
|
1100
|
+
"/connections/{connectionId}/saml_sp_encryption_certs": {
|
|
1101
|
+
parameters: {
|
|
1102
|
+
query?: never;
|
|
1103
|
+
header?: never;
|
|
1104
|
+
path?: never;
|
|
1105
|
+
cookie?: never;
|
|
1106
|
+
};
|
|
1107
|
+
/**
|
|
1108
|
+
* List SP encryption certificates
|
|
1109
|
+
* @description Lists the public certificates the Identity Provider can use to encrypt SAML responses sent to WorkOS, including expired ones, oldest first.
|
|
1110
|
+
*/
|
|
1111
|
+
get: operations["SamlSpEncryptionCertificatesController_list"];
|
|
1112
|
+
put?: never;
|
|
1113
|
+
/**
|
|
1114
|
+
* Create an SP encryption certificate
|
|
1115
|
+
* @description Generates a new encryption key pair for the connection and returns its public certificate. WorkOS holds the private key, so the request takes no body — to bring your own key pairs, provide `saml_options.sp_encryption_key_pairs` when creating the connection instead. Creating a certificate appends rather than replaces: every active private key is tried when decrypting, which lets a rotation overlap the old and new certificates.
|
|
1116
|
+
*/
|
|
1117
|
+
post: operations["SamlSpEncryptionCertificatesController_create"];
|
|
1046
1118
|
delete?: never;
|
|
1047
1119
|
options?: never;
|
|
1048
1120
|
head?: never;
|
|
1049
1121
|
patch?: never;
|
|
1050
1122
|
trace?: never;
|
|
1051
1123
|
};
|
|
1124
|
+
"/connections/{connectionId}/saml_sp_encryption_certs/{certificateId}": {
|
|
1125
|
+
parameters: {
|
|
1126
|
+
query?: never;
|
|
1127
|
+
header?: never;
|
|
1128
|
+
path?: never;
|
|
1129
|
+
cookie?: never;
|
|
1130
|
+
};
|
|
1131
|
+
get?: never;
|
|
1132
|
+
put?: never;
|
|
1133
|
+
post?: never;
|
|
1134
|
+
/**
|
|
1135
|
+
* Delete an SP encryption certificate
|
|
1136
|
+
* @description Removes an encryption key pair from the connection. SAML responses encrypted with its certificate can no longer be decrypted, so remove the certificate from the Identity Provider first when rotating.
|
|
1137
|
+
*/
|
|
1138
|
+
delete: operations["SamlSpEncryptionCertificatesController_delete"];
|
|
1139
|
+
options?: never;
|
|
1140
|
+
head?: never;
|
|
1141
|
+
patch?: never;
|
|
1142
|
+
trace?: never;
|
|
1143
|
+
};
|
|
1144
|
+
"/connections/{connectionId}/saml_sp_signing_cert": {
|
|
1145
|
+
parameters: {
|
|
1146
|
+
query?: never;
|
|
1147
|
+
header?: never;
|
|
1148
|
+
path?: never;
|
|
1149
|
+
cookie?: never;
|
|
1150
|
+
};
|
|
1151
|
+
/**
|
|
1152
|
+
* Get the SP signing certificate
|
|
1153
|
+
* @description Returns the public certificate the Identity Provider can use to verify the signature of SAML requests sent by WorkOS. Responds with `404` when the connection has no request signing key pair.
|
|
1154
|
+
*/
|
|
1155
|
+
get: operations["SamlSpSigningCertificatesController_get"];
|
|
1156
|
+
put?: never;
|
|
1157
|
+
/**
|
|
1158
|
+
* Create an SP signing certificate
|
|
1159
|
+
* @description Generates a new request signing key pair for the connection and returns its public certificate. WorkOS holds the private key, so the request takes no body — to bring your own key pair, provide `saml_options.sp_signing_key_pair` when creating the connection instead. A connection signs with one key pair at a time: delete the existing certificate before creating its replacement.
|
|
1160
|
+
*/
|
|
1161
|
+
post: operations["SamlSpSigningCertificatesController_create"];
|
|
1162
|
+
delete?: never;
|
|
1163
|
+
options?: never;
|
|
1164
|
+
head?: never;
|
|
1165
|
+
patch?: never;
|
|
1166
|
+
trace?: never;
|
|
1167
|
+
};
|
|
1168
|
+
"/connections/{connectionId}/saml_sp_signing_cert/{certificateId}": {
|
|
1169
|
+
parameters: {
|
|
1170
|
+
query?: never;
|
|
1171
|
+
header?: never;
|
|
1172
|
+
path?: never;
|
|
1173
|
+
cookie?: never;
|
|
1174
|
+
};
|
|
1175
|
+
get?: never;
|
|
1176
|
+
put?: never;
|
|
1177
|
+
post?: never;
|
|
1178
|
+
/**
|
|
1179
|
+
* Delete the SP signing certificate
|
|
1180
|
+
* @description Removes the request signing key pair from the connection, after which SAML requests are sent unsigned. Delete the certificate before creating its replacement when rotating.
|
|
1181
|
+
*/
|
|
1182
|
+
delete: operations["SamlSpSigningCertificatesController_delete"];
|
|
1183
|
+
options?: never;
|
|
1184
|
+
head?: never;
|
|
1185
|
+
patch?: never;
|
|
1186
|
+
trace?: never;
|
|
1187
|
+
};
|
|
1052
1188
|
"/connections/{id}": {
|
|
1053
1189
|
parameters: {
|
|
1054
1190
|
query?: never;
|
|
@@ -1070,7 +1206,11 @@ export interface paths {
|
|
|
1070
1206
|
delete: operations["ConnectionsController_delete"];
|
|
1071
1207
|
options?: never;
|
|
1072
1208
|
head?: never;
|
|
1073
|
-
|
|
1209
|
+
/**
|
|
1210
|
+
* Update a Connection
|
|
1211
|
+
* @description Updates an existing connection. Only the provided fields are changed; fields that accept `null` are reset to their default behavior.
|
|
1212
|
+
*/
|
|
1213
|
+
patch: operations["ConnectionsController_patch"];
|
|
1074
1214
|
trace?: never;
|
|
1075
1215
|
};
|
|
1076
1216
|
"/data-integrations": {
|
|
@@ -3147,7 +3287,7 @@ export interface paths {
|
|
|
3147
3287
|
post?: never;
|
|
3148
3288
|
/**
|
|
3149
3289
|
* Delete a waitlist entry
|
|
3150
|
-
* @description
|
|
3290
|
+
* @description Remove the entry from the waitlist. Its email address can join again unless a user with that email now exists in the environment. Deleting the entry does not revoke an invitation created by approving it — [revoke that invitation](/reference/authkit/invitation/revoke) separately to withdraw access.
|
|
3151
3291
|
*/
|
|
3152
3292
|
delete: operations["WaitlistEntriesController_delete"];
|
|
3153
3293
|
options?: never;
|
|
@@ -3166,7 +3306,11 @@ export interface paths {
|
|
|
3166
3306
|
put?: never;
|
|
3167
3307
|
/**
|
|
3168
3308
|
* Approve a waitlist entry
|
|
3169
|
-
* @description Approve a waitlist entry and send the
|
|
3309
|
+
* @description Approve a waitlist entry, create an invitation for its email address, and send the invitation email. Approving a denied entry reverses the denial. The approval is saved even when the invitation steps fail, so instead of retrying the approval, recover based on the outcome:
|
|
3310
|
+
*
|
|
3311
|
+
* - `200` — the entry is approved. If invitation creation failed, no invitation exists yet; [send](/reference/authkit/invitation/send) one.
|
|
3312
|
+
* - `422` with code `invitation_email_not_sent` — the entry is approved and an invitation exists, but its email was not sent; [resend](/reference/authkit/invitation/resend) it.
|
|
3313
|
+
* - `422` with code `invalid_state` — the entry was already approved.
|
|
3170
3314
|
*/
|
|
3171
3315
|
post: operations["WaitlistEntriesController_approve"];
|
|
3172
3316
|
delete?: never;
|
|
@@ -3186,7 +3330,7 @@ export interface paths {
|
|
|
3186
3330
|
put?: never;
|
|
3187
3331
|
/**
|
|
3188
3332
|
* Deny a waitlist entry
|
|
3189
|
-
* @description Deny a pending waitlist entry. A denial can be reversed by approving the entry.
|
|
3333
|
+
* @description Deny a pending waitlist entry. Denying an entry that is not pending fails with the code `invalid_state`. A denial can be reversed by approving the entry.
|
|
3190
3334
|
*/
|
|
3191
3335
|
post: operations["WaitlistEntriesController_deny"];
|
|
3192
3336
|
delete?: never;
|
|
@@ -3204,7 +3348,7 @@ export interface paths {
|
|
|
3204
3348
|
};
|
|
3205
3349
|
/**
|
|
3206
3350
|
* List waitlists
|
|
3207
|
-
* @description Get a list of the waitlists in the environment.
|
|
3351
|
+
* @description Get a list of the waitlists in the environment. All waitlists are returned in a single response — this endpoint is not paginated, so the `list_metadata` cursors are always `null`.
|
|
3208
3352
|
*/
|
|
3209
3353
|
get: operations["WaitlistsController_list"];
|
|
3210
3354
|
put?: never;
|
|
@@ -3250,7 +3394,7 @@ export interface paths {
|
|
|
3250
3394
|
put?: never;
|
|
3251
3395
|
/**
|
|
3252
3396
|
* Create a waitlist entry
|
|
3253
|
-
* @description Add an email address to the waitlist.
|
|
3397
|
+
* @description Add an email address to the waitlist. Email addresses are normalized and unique per environment: a request for an email address already on the waitlist returns the existing entry unchanged (still with status `201`) and does not send another confirmation email. If a user with the email address already exists in the environment, the request fails with the code `user_already_exists`.
|
|
3254
3398
|
*/
|
|
3255
3399
|
post: operations["WaitlistsController_createEntry"];
|
|
3256
3400
|
delete?: never;
|
|
@@ -3605,7 +3749,6 @@ export interface components {
|
|
|
3605
3749
|
expires_at?: string | null;
|
|
3606
3750
|
};
|
|
3607
3751
|
/**
|
|
3608
|
-
* @default desc
|
|
3609
3752
|
* @example desc
|
|
3610
3753
|
* @enum {string}
|
|
3611
3754
|
*/
|
|
@@ -4298,6 +4441,334 @@ export interface components {
|
|
|
4298
4441
|
*/
|
|
4299
4442
|
parent_resource_type_slug: string;
|
|
4300
4443
|
});
|
|
4444
|
+
CreateConnectionKeyPairDto: {
|
|
4445
|
+
/**
|
|
4446
|
+
* @description The PEM-encoded private key.
|
|
4447
|
+
* @example -----BEGIN PRIVATE KEY-----
|
|
4448
|
+
* MIIE...
|
|
4449
|
+
* -----END PRIVATE KEY-----
|
|
4450
|
+
*/
|
|
4451
|
+
key: string;
|
|
4452
|
+
/**
|
|
4453
|
+
* @description The PEM-encoded X.509 certificate for the key.
|
|
4454
|
+
* @example -----BEGIN CERTIFICATE-----
|
|
4455
|
+
* MIIC...
|
|
4456
|
+
* -----END CERTIFICATE-----
|
|
4457
|
+
*/
|
|
4458
|
+
cert: string;
|
|
4459
|
+
};
|
|
4460
|
+
CreateConnectionSamlOptionsDto: {
|
|
4461
|
+
/**
|
|
4462
|
+
* Format: uri
|
|
4463
|
+
* @description The Identity Provider metadata URL. When provided, the IdP fields and signing certificates are imported from the metadata document. Mutually exclusive with the manual IdP fields.
|
|
4464
|
+
* @example https://idp.example.com/metadata.xml
|
|
4465
|
+
*/
|
|
4466
|
+
idp_metadata_url?: string;
|
|
4467
|
+
/**
|
|
4468
|
+
* Format: uri
|
|
4469
|
+
* @description A custom Assertion Consumer Service (ACS) URL override. When omitted, the standard WorkOS-generated ACS URL is used.
|
|
4470
|
+
* @example https://example.auth0.com/login/callback?connection=123
|
|
4471
|
+
*/
|
|
4472
|
+
acs_url?: string;
|
|
4473
|
+
/**
|
|
4474
|
+
* @description A custom Service Provider Entity ID (audience) override. When omitted, the connection external key is used.
|
|
4475
|
+
* @example https://example.auth0.com/login/callback?connection=123
|
|
4476
|
+
*/
|
|
4477
|
+
sp_entity_id?: string;
|
|
4478
|
+
/**
|
|
4479
|
+
* @description The Identity Provider Entity ID.
|
|
4480
|
+
* @example https://idp.example.com/entity
|
|
4481
|
+
*/
|
|
4482
|
+
idp_entity_id?: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* Format: uri
|
|
4485
|
+
* @description The Identity Provider SSO URL. Required when configuring the connection with manual IdP fields.
|
|
4486
|
+
* @example https://idp.example.com/sso
|
|
4487
|
+
*/
|
|
4488
|
+
idp_sso_url?: string;
|
|
4489
|
+
/**
|
|
4490
|
+
* @description The X.509 certificates used to verify signed SAML responses from the Identity Provider. Required when configuring the connection with manual IdP fields.
|
|
4491
|
+
* @example [
|
|
4492
|
+
* "-----BEGIN CERTIFICATE-----\nMIIC...\n-----END CERTIFICATE-----"
|
|
4493
|
+
* ]
|
|
4494
|
+
*/
|
|
4495
|
+
idp_signing_certs?: string[];
|
|
4496
|
+
/** @description The customer-owned key pair used to sign SAML requests sent to the Identity Provider. When omitted, WorkOS generates and manages the signing key pair. */
|
|
4497
|
+
sp_signing_key_pair?: components["schemas"]["CreateConnectionKeyPairDto"];
|
|
4498
|
+
/** @description The customer-owned key pairs used to decrypt encrypted SAML responses from the Identity Provider. When omitted, WorkOS generates and manages the encryption key pair. */
|
|
4499
|
+
sp_encryption_key_pairs?: components["schemas"]["CreateConnectionKeyPairDto"][];
|
|
4500
|
+
};
|
|
4501
|
+
CreateConnectionOidcOptionsDto: {
|
|
4502
|
+
/**
|
|
4503
|
+
* Format: uri
|
|
4504
|
+
* @description The OIDC discovery endpoint.
|
|
4505
|
+
* @example https://idp.example.com/.well-known/openid-configuration
|
|
4506
|
+
*/
|
|
4507
|
+
discovery_endpoint: string;
|
|
4508
|
+
/**
|
|
4509
|
+
* @description The OIDC client ID.
|
|
4510
|
+
* @example client_123
|
|
4511
|
+
*/
|
|
4512
|
+
client_id: string;
|
|
4513
|
+
/**
|
|
4514
|
+
* @description The OIDC client secret. Required for `client_secret_basic` and `client_secret_post`, and rejected for `private_key_jwt`, which authenticates with a key pair instead. This value is write-only and is never returned.
|
|
4515
|
+
* @example secret_xyz
|
|
4516
|
+
*/
|
|
4517
|
+
client_secret?: string;
|
|
4518
|
+
/**
|
|
4519
|
+
* Format: uri
|
|
4520
|
+
* @description A custom OAuth callback URL override. When omitted, the standard WorkOS-generated redirect URI is used.
|
|
4521
|
+
* @example https://auth.workos.com/sso/oidc/conn_externalkey/callback
|
|
4522
|
+
*/
|
|
4523
|
+
redirect_uri?: string;
|
|
4524
|
+
/**
|
|
4525
|
+
* @description Whether PKCE is enabled for the connection.
|
|
4526
|
+
* @default true
|
|
4527
|
+
* @example true
|
|
4528
|
+
*/
|
|
4529
|
+
pkce: boolean;
|
|
4530
|
+
/**
|
|
4531
|
+
* @description The token-endpoint client authentication method.
|
|
4532
|
+
* @default client_secret_basic
|
|
4533
|
+
* @example client_secret_basic
|
|
4534
|
+
* @enum {string}
|
|
4535
|
+
*/
|
|
4536
|
+
token_authentication_method: "client_secret_post" | "client_secret_basic" | "private_key_jwt";
|
|
4537
|
+
/** @description A key pair for WorkOS to sign `private_key_jwt` client assertions with. Only accepted when `token_authentication_method` is `private_key_jwt`; when omitted, WorkOS generates one and returns its certificate in `oidc_options.jwt_signing_certs`. */
|
|
4538
|
+
jwt_signing_key_pair?: components["schemas"]["CreateConnectionKeyPairDto"];
|
|
4539
|
+
/**
|
|
4540
|
+
* @description The ID-token signing algorithm.
|
|
4541
|
+
* @example RS256
|
|
4542
|
+
* @enum {string}
|
|
4543
|
+
*/
|
|
4544
|
+
id_token_signature_algorithm?: "ES256" | "ES384" | "ES512" | "EdDSA" | "HS256" | "HS384" | "HS512" | "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512";
|
|
4545
|
+
/**
|
|
4546
|
+
* @description Whether to fetch additional profile attributes from the userinfo endpoint.
|
|
4547
|
+
* @example false
|
|
4548
|
+
*/
|
|
4549
|
+
fetch_user_info?: boolean;
|
|
4550
|
+
};
|
|
4551
|
+
CreateConnectionStandardAttributesDto: {
|
|
4552
|
+
/**
|
|
4553
|
+
* @description The IdP attribute or claim the profile's `idp_id` is mapped from. When omitted, the default for the connection type is used.
|
|
4554
|
+
* @example sub
|
|
4555
|
+
*/
|
|
4556
|
+
idp_id?: string;
|
|
4557
|
+
/**
|
|
4558
|
+
* @description The IdP attribute or claim the profile's `email` is mapped from. When omitted, the default for the connection type is used.
|
|
4559
|
+
* @example email
|
|
4560
|
+
*/
|
|
4561
|
+
email?: string;
|
|
4562
|
+
/**
|
|
4563
|
+
* @description The IdP attribute or claim the profile's `first_name` is mapped from. When omitted, the default for the connection type is used.
|
|
4564
|
+
* @example given_name
|
|
4565
|
+
*/
|
|
4566
|
+
first_name?: string;
|
|
4567
|
+
/**
|
|
4568
|
+
* @description The IdP attribute or claim the profile's `last_name` is mapped from. When omitted, the default for the connection type is used.
|
|
4569
|
+
* @example family_name
|
|
4570
|
+
*/
|
|
4571
|
+
last_name?: string;
|
|
4572
|
+
/**
|
|
4573
|
+
* @description The IdP attribute or claim the profile's `groups` are mapped from. `null` leaves the mapping unset.
|
|
4574
|
+
* @example memberOf
|
|
4575
|
+
*/
|
|
4576
|
+
groups?: string | null;
|
|
4577
|
+
/**
|
|
4578
|
+
* @description The IdP attribute or claim the profile's `name` is mapped from. `null` leaves the mapping unset.
|
|
4579
|
+
* @example displayName
|
|
4580
|
+
*/
|
|
4581
|
+
name?: string | null;
|
|
4582
|
+
};
|
|
4583
|
+
CreateConnectionAttributeMapsDto: {
|
|
4584
|
+
/** @description How IdP attributes or claims map onto the standard WorkOS profile fields. Provided fields override the defaults for the connection type. */
|
|
4585
|
+
standard_attributes?: components["schemas"]["CreateConnectionStandardAttributesDto"];
|
|
4586
|
+
/**
|
|
4587
|
+
* @description How IdP attributes or claims map onto custom attributes, keyed by custom attribute name. Custom attributes must already be defined in the WorkOS dashboard.
|
|
4588
|
+
* @example {
|
|
4589
|
+
* "company": "company_claim"
|
|
4590
|
+
* }
|
|
4591
|
+
*/
|
|
4592
|
+
custom_attributes?: {
|
|
4593
|
+
[key: string]: string;
|
|
4594
|
+
};
|
|
4595
|
+
};
|
|
4596
|
+
CreateConnectionDto: {
|
|
4597
|
+
/**
|
|
4598
|
+
* @description Unique identifier for the Organization in which the Connection resides.
|
|
4599
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
4600
|
+
*/
|
|
4601
|
+
organization_id: string;
|
|
4602
|
+
/**
|
|
4603
|
+
* @description A human-readable name for the Connection. This will most commonly be the organization's name.
|
|
4604
|
+
* @example Foo Corp
|
|
4605
|
+
*/
|
|
4606
|
+
name?: string;
|
|
4607
|
+
/**
|
|
4608
|
+
* @description The customer-owned identifier for the Connection.
|
|
4609
|
+
* @example acme-legacy-conn-42
|
|
4610
|
+
*/
|
|
4611
|
+
external_id?: string;
|
|
4612
|
+
/**
|
|
4613
|
+
* @description The type of the Connection. Only SAML and OIDC connection types may be created. When omitted, the type is inferred from the provided options.
|
|
4614
|
+
* @example OktaSAML
|
|
4615
|
+
*/
|
|
4616
|
+
connection_type?: string;
|
|
4617
|
+
/** @description How IdP attributes or claims map onto WorkOS profile fields. Provided fields override the defaults for the connection type. */
|
|
4618
|
+
attribute_maps?: components["schemas"]["CreateConnectionAttributeMapsDto"];
|
|
4619
|
+
} & ({
|
|
4620
|
+
/** @description Protocol configuration for SAML connections. Mutually exclusive with `oidc_options`. */
|
|
4621
|
+
saml_options: components["schemas"]["CreateConnectionSamlOptionsDto"];
|
|
4622
|
+
} | {
|
|
4623
|
+
/** @description Protocol configuration for OIDC connections. Mutually exclusive with `saml_options`. */
|
|
4624
|
+
oidc_options: components["schemas"]["CreateConnectionOidcOptionsDto"];
|
|
4625
|
+
});
|
|
4626
|
+
PatchConnectionSamlOptionsDto: {
|
|
4627
|
+
/**
|
|
4628
|
+
* Format: uri
|
|
4629
|
+
* @description The Identity Provider metadata URL. When provided, the IdP fields and signing certificates are re-imported from the metadata document, replacing the current set. Mutually exclusive with the manual IdP fields. Set to `null` to stop tracking a metadata URL.
|
|
4630
|
+
* @example https://idp.example.com/metadata.xml
|
|
4631
|
+
*/
|
|
4632
|
+
idp_metadata_url?: string | null;
|
|
4633
|
+
/**
|
|
4634
|
+
* Format: uri
|
|
4635
|
+
* @description A custom Assertion Consumer Service (ACS) URL override. Set to `null` to revert to the standard WorkOS-generated ACS URL.
|
|
4636
|
+
* @example https://example.auth0.com/login/callback?connection=123
|
|
4637
|
+
*/
|
|
4638
|
+
acs_url?: string | null;
|
|
4639
|
+
/**
|
|
4640
|
+
* @description A custom Service Provider Entity ID (audience) override. Set to `null` to revert to the connection external key.
|
|
4641
|
+
* @example https://example.auth0.com/login/callback?connection=123
|
|
4642
|
+
*/
|
|
4643
|
+
sp_entity_id?: string | null;
|
|
4644
|
+
/**
|
|
4645
|
+
* @description The Identity Provider Entity ID.
|
|
4646
|
+
* @example https://idp.example.com/entity
|
|
4647
|
+
*/
|
|
4648
|
+
idp_entity_id?: string;
|
|
4649
|
+
/**
|
|
4650
|
+
* Format: uri
|
|
4651
|
+
* @description The Identity Provider SSO URL.
|
|
4652
|
+
* @example https://idp.example.com/sso
|
|
4653
|
+
*/
|
|
4654
|
+
idp_sso_url?: string;
|
|
4655
|
+
};
|
|
4656
|
+
PatchConnectionOidcOptionsDto: {
|
|
4657
|
+
/**
|
|
4658
|
+
* Format: uri
|
|
4659
|
+
* @description The OIDC discovery endpoint.
|
|
4660
|
+
* @example https://idp.example.com/.well-known/openid-configuration
|
|
4661
|
+
*/
|
|
4662
|
+
discovery_endpoint?: string;
|
|
4663
|
+
/**
|
|
4664
|
+
* @description The OIDC client ID.
|
|
4665
|
+
* @example client_123
|
|
4666
|
+
*/
|
|
4667
|
+
client_id?: string;
|
|
4668
|
+
/**
|
|
4669
|
+
* @description The OIDC client secret. Required when moving the connection to `client_secret_basic` or `client_secret_post`, and rejected for `private_key_jwt`, which authenticates with a key pair instead. This value is write-only and is never returned.
|
|
4670
|
+
* @example secret_xyz
|
|
4671
|
+
*/
|
|
4672
|
+
client_secret?: string;
|
|
4673
|
+
/**
|
|
4674
|
+
* Format: uri
|
|
4675
|
+
* @description A custom OAuth callback URL override. Set to `null` to revert to the standard WorkOS-generated redirect URI.
|
|
4676
|
+
* @example https://auth.workos.com/sso/oidc/conn_externalkey/callback
|
|
4677
|
+
*/
|
|
4678
|
+
redirect_uri?: string | null;
|
|
4679
|
+
/**
|
|
4680
|
+
* @description Whether PKCE is enabled for the connection.
|
|
4681
|
+
* @example true
|
|
4682
|
+
*/
|
|
4683
|
+
pkce?: boolean;
|
|
4684
|
+
/**
|
|
4685
|
+
* @description The token-endpoint client authentication method. Moving to `private_key_jwt` generates a signing key pair if the connection has none; its certificate is returned in `oidc_options.jwt_signing_certs` and must be registered at the Identity Provider.
|
|
4686
|
+
* @example client_secret_basic
|
|
4687
|
+
* @enum {string}
|
|
4688
|
+
*/
|
|
4689
|
+
token_authentication_method?: "client_secret_post" | "client_secret_basic" | "private_key_jwt";
|
|
4690
|
+
/**
|
|
4691
|
+
* @description The ID-token signing algorithm.
|
|
4692
|
+
* @example RS256
|
|
4693
|
+
* @enum {string}
|
|
4694
|
+
*/
|
|
4695
|
+
id_token_signature_algorithm?: "ES256" | "ES384" | "ES512" | "EdDSA" | "HS256" | "HS384" | "HS512" | "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512";
|
|
4696
|
+
/**
|
|
4697
|
+
* @description Whether to fetch additional profile attributes from the userinfo endpoint.
|
|
4698
|
+
* @example false
|
|
4699
|
+
*/
|
|
4700
|
+
fetch_user_info?: boolean;
|
|
4701
|
+
};
|
|
4702
|
+
PatchConnectionStandardAttributesDto: {
|
|
4703
|
+
/**
|
|
4704
|
+
* @description The IdP attribute or claim the profile's `idp_id` is mapped from.
|
|
4705
|
+
* @example sub
|
|
4706
|
+
*/
|
|
4707
|
+
idp_id?: string;
|
|
4708
|
+
/**
|
|
4709
|
+
* @description The IdP attribute or claim the profile's `email` is mapped from.
|
|
4710
|
+
* @example email
|
|
4711
|
+
*/
|
|
4712
|
+
email?: string;
|
|
4713
|
+
/**
|
|
4714
|
+
* @description The IdP attribute or claim the profile's `first_name` is mapped from.
|
|
4715
|
+
* @example given_name
|
|
4716
|
+
*/
|
|
4717
|
+
first_name?: string;
|
|
4718
|
+
/**
|
|
4719
|
+
* @description The IdP attribute or claim the profile's `last_name` is mapped from.
|
|
4720
|
+
* @example family_name
|
|
4721
|
+
*/
|
|
4722
|
+
last_name?: string;
|
|
4723
|
+
/**
|
|
4724
|
+
* @description The IdP attribute or claim the profile's `groups` are mapped from. Set to `null` to unset the mapping.
|
|
4725
|
+
* @example memberOf
|
|
4726
|
+
*/
|
|
4727
|
+
groups?: string | null;
|
|
4728
|
+
/**
|
|
4729
|
+
* @description The IdP attribute or claim the profile's `name` is mapped from. Set to `null` to unset the mapping.
|
|
4730
|
+
* @example displayName
|
|
4731
|
+
*/
|
|
4732
|
+
name?: string | null;
|
|
4733
|
+
};
|
|
4734
|
+
PatchConnectionAttributeMapsDto: {
|
|
4735
|
+
/** @description How IdP attributes or claims map onto the standard WorkOS profile fields. Only the provided fields are updated. */
|
|
4736
|
+
standard_attributes?: components["schemas"]["PatchConnectionStandardAttributesDto"];
|
|
4737
|
+
/**
|
|
4738
|
+
* @description How IdP attributes or claims map onto custom attributes, keyed by custom attribute name. Custom attributes must already be defined in the WorkOS dashboard. Only the provided keys are updated; a `null` value unsets that mapping.
|
|
4739
|
+
* @example {
|
|
4740
|
+
* "company": "company_claim"
|
|
4741
|
+
* }
|
|
4742
|
+
*/
|
|
4743
|
+
custom_attributes?: {
|
|
4744
|
+
[key: string]: string | null;
|
|
4745
|
+
};
|
|
4746
|
+
};
|
|
4747
|
+
PatchConnectionDto: {
|
|
4748
|
+
/**
|
|
4749
|
+
* @description A human-readable name for the Connection.
|
|
4750
|
+
* @example Foo Corp
|
|
4751
|
+
*/
|
|
4752
|
+
name?: string;
|
|
4753
|
+
/**
|
|
4754
|
+
* @description The customer-owned identifier for the Connection. Set to `null` to stop tracking one.
|
|
4755
|
+
* @example acme-legacy-conn-42
|
|
4756
|
+
*/
|
|
4757
|
+
external_id?: string | null;
|
|
4758
|
+
/**
|
|
4759
|
+
* @description The type of the Connection. Immutable after creation — it may be sent, but only with the Connection current type.
|
|
4760
|
+
* @example OktaSAML
|
|
4761
|
+
*/
|
|
4762
|
+
connection_type?: string;
|
|
4763
|
+
/** @description How IdP attributes or claims map onto WorkOS profile fields. Only the provided fields are updated. */
|
|
4764
|
+
attribute_maps?: components["schemas"]["PatchConnectionAttributeMapsDto"];
|
|
4765
|
+
} & (Record<string, never> | {
|
|
4766
|
+
/** @description Protocol configuration for SAML connections. Only the provided fields are updated. Mutually exclusive with `oidc_options`. */
|
|
4767
|
+
saml_options: components["schemas"]["PatchConnectionSamlOptionsDto"];
|
|
4768
|
+
} | {
|
|
4769
|
+
/** @description Protocol configuration for OIDC connections. Only the provided fields are updated. Mutually exclusive with `saml_options`. */
|
|
4770
|
+
oidc_options: components["schemas"]["PatchConnectionOidcOptionsDto"];
|
|
4771
|
+
});
|
|
4301
4772
|
CreateCorsOriginDto: {
|
|
4302
4773
|
/**
|
|
4303
4774
|
* @description The origin URL to allow for CORS requests.
|
|
@@ -4527,19 +4998,19 @@ export interface components {
|
|
|
4527
4998
|
name: string;
|
|
4528
4999
|
/**
|
|
4529
5000
|
* Format: uri
|
|
4530
|
-
* @description The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers.
|
|
5001
|
+
* @description The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers. Must be a static URL: `${config.…}` placeholders are resolved against a provider's declared config fields, which custom providers cannot declare.
|
|
4531
5002
|
* @example https://provider.example.com/oauth/authorize
|
|
4532
5003
|
*/
|
|
4533
5004
|
authorization_url?: string;
|
|
4534
5005
|
/**
|
|
4535
5006
|
* Format: uri
|
|
4536
|
-
* @description The provider's OAuth token endpoint. Required for OAuth providers; omit for `api_key` providers.
|
|
5007
|
+
* @description The provider's OAuth token endpoint. Required for OAuth and `client_credentials` providers; omit for `api_key` providers. Must be a static URL: `${config.…}` placeholders are resolved against a provider's declared config fields, which custom providers cannot declare.
|
|
4537
5008
|
* @example https://provider.example.com/oauth/token
|
|
4538
5009
|
*/
|
|
4539
5010
|
token_url?: string;
|
|
4540
5011
|
/**
|
|
4541
5012
|
* Format: uri
|
|
4542
|
-
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
5013
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint. Must be a static URL, like the other endpoints.
|
|
4543
5014
|
* @example https://provider.example.com/oauth/token
|
|
4544
5015
|
*/
|
|
4545
5016
|
refresh_token_url?: string | null;
|
|
@@ -4639,19 +5110,19 @@ export interface components {
|
|
|
4639
5110
|
name?: string;
|
|
4640
5111
|
/**
|
|
4641
5112
|
* Format: uri
|
|
4642
|
-
* @description The provider's OAuth authorization endpoint.
|
|
5113
|
+
* @description The provider's OAuth authorization endpoint. Must be a static URL: `${config.…}` placeholders are resolved against a provider's declared config fields, which custom providers cannot declare.
|
|
4643
5114
|
* @example https://provider.example.com/oauth/authorize
|
|
4644
5115
|
*/
|
|
4645
5116
|
authorization_url?: string;
|
|
4646
5117
|
/**
|
|
4647
5118
|
* Format: uri
|
|
4648
|
-
* @description The provider's OAuth token endpoint.
|
|
5119
|
+
* @description The provider's OAuth token endpoint. Must be a static URL: `${config.…}` placeholders are resolved against a provider's declared config fields, which custom providers cannot declare.
|
|
4649
5120
|
* @example https://provider.example.com/oauth/token
|
|
4650
5121
|
*/
|
|
4651
5122
|
token_url?: string;
|
|
4652
5123
|
/**
|
|
4653
5124
|
* Format: uri
|
|
4654
|
-
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
5125
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint. Must be a static URL, like the other endpoints.
|
|
4655
5126
|
* @example https://provider.example.com/oauth/token
|
|
4656
5127
|
*/
|
|
4657
5128
|
refresh_token_url?: string | null;
|
|
@@ -4825,6 +5296,13 @@ export interface components {
|
|
|
4825
5296
|
*/
|
|
4826
5297
|
uri: string;
|
|
4827
5298
|
};
|
|
5299
|
+
CreateSamlIdpSigningCertificateDto: {
|
|
5300
|
+
/**
|
|
5301
|
+
* @description The PEM-encoded X.509 certificate.
|
|
5302
|
+
* @example -----BEGIN CERTIFICATE-----MIIC...-----END CERTIFICATE-----
|
|
5303
|
+
*/
|
|
5304
|
+
value: string;
|
|
5305
|
+
};
|
|
4828
5306
|
CreateTeamDto: {
|
|
4829
5307
|
/**
|
|
4830
5308
|
* Format: email
|
|
@@ -5211,7 +5689,7 @@ export interface components {
|
|
|
5211
5689
|
*/
|
|
5212
5690
|
email: string;
|
|
5213
5691
|
/**
|
|
5214
|
-
* @description Object containing additional key/value pairs collected with the waitlist entry. Values are user-provided — treat them as untrusted input when rendering or exporting.
|
|
5692
|
+
* @description Object containing additional key/value pairs collected with the waitlist entry. Supports up to 50 string pairs, with keys up to 40 characters and values up to 600 characters. Values are user-provided — treat them as untrusted input when rendering or exporting.
|
|
5215
5693
|
* @example {
|
|
5216
5694
|
* "company": "Example Corp"
|
|
5217
5695
|
* }
|
|
@@ -5239,7 +5717,7 @@ export interface components {
|
|
|
5239
5717
|
* "dsync.user.created"
|
|
5240
5718
|
* ]
|
|
5241
5719
|
*/
|
|
5242
|
-
events: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "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" | "radar.challenge_created" | "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")[];
|
|
5720
|
+
events: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "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" | "radar.challenge_created" | "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")[];
|
|
5243
5721
|
};
|
|
5244
5722
|
UpdateWebhookEndpointDto: {
|
|
5245
5723
|
/**
|
|
@@ -5260,7 +5738,7 @@ export interface components {
|
|
|
5260
5738
|
* "dsync.user.created"
|
|
5261
5739
|
* ]
|
|
5262
5740
|
*/
|
|
5263
|
-
events?: ("agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "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" | "radar.challenge_created" | "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")[];
|
|
5741
|
+
events?: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "agent.instance.created" | "agent.instance.deleted" | "agent.instance.session.created" | "agent.instance.session.revoked" | "agent.registration.created" | "agent.registration.claim.attempt.created" | "agent.registration.claim.completed" | "agent.registration.credential.issued" | "agent.registration.deleted" | "agent.registration.refreshed" | "agent.registration.expired" | "agent.registration.organization.switched" | "agent.registration.revoked" | "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" | "radar.challenge_created" | "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")[];
|
|
5264
5742
|
};
|
|
5265
5743
|
WidgetSessionTokenDto: {
|
|
5266
5744
|
/**
|
|
@@ -8202,47 +8680,128 @@ export interface components {
|
|
|
8202
8680
|
*/
|
|
8203
8681
|
id: string;
|
|
8204
8682
|
/** @constant */
|
|
8205
|
-
event: "agent.
|
|
8683
|
+
event: "agent.blueprint.created";
|
|
8206
8684
|
/** @description The event payload. */
|
|
8207
8685
|
data: {
|
|
8208
8686
|
/**
|
|
8209
|
-
* @description Distinguishes the agent
|
|
8687
|
+
* @description Distinguishes the agent blueprint object.
|
|
8210
8688
|
* @constant
|
|
8211
8689
|
*/
|
|
8212
|
-
object: "
|
|
8690
|
+
object: "agent_blueprint";
|
|
8213
8691
|
/**
|
|
8214
|
-
* @description Unique identifier of the agent
|
|
8215
|
-
* @example
|
|
8692
|
+
* @description Unique identifier of the agent blueprint.
|
|
8693
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8216
8694
|
*/
|
|
8217
8695
|
id: string;
|
|
8218
8696
|
/**
|
|
8219
|
-
* @description
|
|
8220
|
-
* @example
|
|
8697
|
+
* @description Human-readable name of the agent blueprint.
|
|
8698
|
+
* @example Prospecting Agent
|
|
8221
8699
|
*/
|
|
8222
|
-
|
|
8700
|
+
name: string;
|
|
8223
8701
|
/**
|
|
8224
|
-
* @description
|
|
8225
|
-
* @example
|
|
8702
|
+
* @description Human-readable description of the agent blueprint.
|
|
8703
|
+
* @example Finds and qualifies sales prospects.
|
|
8226
8704
|
*/
|
|
8227
|
-
|
|
8705
|
+
description: string | null;
|
|
8228
8706
|
/**
|
|
8229
|
-
* @description
|
|
8230
|
-
* @example
|
|
8707
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
|
|
8708
|
+
* @example [
|
|
8709
|
+
* "crm:read",
|
|
8710
|
+
* "email:send"
|
|
8711
|
+
* ]
|
|
8231
8712
|
*/
|
|
8232
|
-
|
|
8713
|
+
permissions: string[];
|
|
8714
|
+
/** @description Who may mint sessions from this blueprint. */
|
|
8715
|
+
invocable_by: {
|
|
8716
|
+
/**
|
|
8717
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint.
|
|
8718
|
+
* @example [
|
|
8719
|
+
* "manager"
|
|
8720
|
+
* ]
|
|
8721
|
+
*/
|
|
8722
|
+
role_slugs: string[];
|
|
8723
|
+
/**
|
|
8724
|
+
* @description Organizations in which autonomous sessions may be minted from this blueprint.
|
|
8725
|
+
* @example [
|
|
8726
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
8727
|
+
* ]
|
|
8728
|
+
*/
|
|
8729
|
+
organization_ids: string[];
|
|
8730
|
+
};
|
|
8731
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
8732
|
+
session_settings: {
|
|
8733
|
+
/**
|
|
8734
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this.
|
|
8735
|
+
* @example 3600
|
|
8736
|
+
*/
|
|
8737
|
+
max_age_seconds: number;
|
|
8738
|
+
/**
|
|
8739
|
+
* @description Lifetime of each minted access token in seconds.
|
|
8740
|
+
* @example 300
|
|
8741
|
+
*/
|
|
8742
|
+
access_token_ttl_seconds: number;
|
|
8743
|
+
/**
|
|
8744
|
+
* @description Lifetime of each rotated refresh token in seconds.
|
|
8745
|
+
* @example 3600
|
|
8746
|
+
*/
|
|
8747
|
+
refresh_token_ttl_seconds: number;
|
|
8748
|
+
};
|
|
8233
8749
|
/**
|
|
8234
|
-
* @description The timestamp when the
|
|
8235
|
-
* @example
|
|
8750
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8751
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8236
8752
|
*/
|
|
8237
|
-
|
|
8753
|
+
created_at: string;
|
|
8238
8754
|
/**
|
|
8239
|
-
* @description The timestamp when the
|
|
8240
|
-
* @example
|
|
8755
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8756
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8757
|
+
*/
|
|
8758
|
+
updated_at: string;
|
|
8759
|
+
};
|
|
8760
|
+
/**
|
|
8761
|
+
* Format: date-time
|
|
8762
|
+
* @description An ISO 8601 timestamp.
|
|
8763
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8764
|
+
*/
|
|
8765
|
+
created_at: string;
|
|
8766
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8767
|
+
/**
|
|
8768
|
+
* @description Distinguishes the Event object.
|
|
8769
|
+
* @constant
|
|
8770
|
+
*/
|
|
8771
|
+
object: "event";
|
|
8772
|
+
} | {
|
|
8773
|
+
/**
|
|
8774
|
+
* @description Unique identifier for the event.
|
|
8775
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8776
|
+
*/
|
|
8777
|
+
id: string;
|
|
8778
|
+
/** @constant */
|
|
8779
|
+
event: "agent.blueprint.deleted";
|
|
8780
|
+
/** @description The event payload. */
|
|
8781
|
+
data: {
|
|
8782
|
+
/**
|
|
8783
|
+
* @description Distinguishes the agent blueprint object.
|
|
8784
|
+
* @constant
|
|
8785
|
+
*/
|
|
8786
|
+
object: "agent_blueprint";
|
|
8787
|
+
/**
|
|
8788
|
+
* @description Unique identifier of the agent blueprint.
|
|
8789
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8790
|
+
*/
|
|
8791
|
+
id: string;
|
|
8792
|
+
/**
|
|
8793
|
+
* @description Human-readable name of the agent blueprint.
|
|
8794
|
+
* @example Prospecting Agent
|
|
8795
|
+
*/
|
|
8796
|
+
name: string;
|
|
8797
|
+
/**
|
|
8798
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8799
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8241
8800
|
*/
|
|
8242
8801
|
created_at: string;
|
|
8243
8802
|
/**
|
|
8244
|
-
* @description The timestamp when the
|
|
8245
|
-
* @example
|
|
8803
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8804
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8246
8805
|
*/
|
|
8247
8806
|
updated_at: string;
|
|
8248
8807
|
};
|
|
@@ -8265,55 +8824,143 @@ export interface components {
|
|
|
8265
8824
|
*/
|
|
8266
8825
|
id: string;
|
|
8267
8826
|
/** @constant */
|
|
8268
|
-
event: "agent.
|
|
8827
|
+
event: "agent.blueprint.updated";
|
|
8269
8828
|
/** @description The event payload. */
|
|
8270
8829
|
data: {
|
|
8271
8830
|
/**
|
|
8272
|
-
* @description Distinguishes the agent
|
|
8831
|
+
* @description Distinguishes the agent blueprint object.
|
|
8273
8832
|
* @constant
|
|
8274
8833
|
*/
|
|
8275
|
-
object: "
|
|
8834
|
+
object: "agent_blueprint";
|
|
8276
8835
|
/**
|
|
8277
|
-
* @description Unique identifier of the agent
|
|
8278
|
-
* @example
|
|
8836
|
+
* @description Unique identifier of the agent blueprint.
|
|
8837
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8279
8838
|
*/
|
|
8280
8839
|
id: string;
|
|
8281
8840
|
/**
|
|
8282
|
-
* @description
|
|
8283
|
-
* @example
|
|
8841
|
+
* @description Human-readable name of the agent blueprint.
|
|
8842
|
+
* @example Prospecting Agent
|
|
8284
8843
|
*/
|
|
8285
|
-
|
|
8844
|
+
name: string;
|
|
8286
8845
|
/**
|
|
8287
|
-
* @description
|
|
8288
|
-
* @example
|
|
8846
|
+
* @description Human-readable description of the agent blueprint.
|
|
8847
|
+
* @example Finds and qualifies sales prospects.
|
|
8289
8848
|
*/
|
|
8290
|
-
|
|
8291
|
-
/**
|
|
8292
|
-
|
|
8849
|
+
description: string | null;
|
|
8850
|
+
/**
|
|
8851
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
|
|
8852
|
+
* @example [
|
|
8853
|
+
* "crm:read",
|
|
8854
|
+
* "email:send"
|
|
8855
|
+
* ]
|
|
8856
|
+
*/
|
|
8857
|
+
permissions: string[];
|
|
8858
|
+
/** @description Who may mint sessions from this blueprint. */
|
|
8859
|
+
invocable_by: {
|
|
8293
8860
|
/**
|
|
8294
|
-
* @description
|
|
8295
|
-
* @example
|
|
8861
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint.
|
|
8862
|
+
* @example [
|
|
8863
|
+
* "manager"
|
|
8864
|
+
* ]
|
|
8296
8865
|
*/
|
|
8297
|
-
|
|
8866
|
+
role_slugs: string[];
|
|
8298
8867
|
/**
|
|
8299
|
-
* @description
|
|
8300
|
-
* @example
|
|
8868
|
+
* @description Organizations in which autonomous sessions may be minted from this blueprint.
|
|
8869
|
+
* @example [
|
|
8870
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
8871
|
+
* ]
|
|
8301
8872
|
*/
|
|
8302
|
-
|
|
8873
|
+
organization_ids: string[];
|
|
8874
|
+
};
|
|
8875
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
8876
|
+
session_settings: {
|
|
8877
|
+
/**
|
|
8878
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this.
|
|
8879
|
+
* @example 3600
|
|
8880
|
+
*/
|
|
8881
|
+
max_age_seconds: number;
|
|
8882
|
+
/**
|
|
8883
|
+
* @description Lifetime of each minted access token in seconds.
|
|
8884
|
+
* @example 300
|
|
8885
|
+
*/
|
|
8886
|
+
access_token_ttl_seconds: number;
|
|
8887
|
+
/**
|
|
8888
|
+
* @description Lifetime of each rotated refresh token in seconds.
|
|
8889
|
+
* @example 3600
|
|
8890
|
+
*/
|
|
8891
|
+
refresh_token_ttl_seconds: number;
|
|
8303
8892
|
};
|
|
8304
8893
|
/**
|
|
8305
|
-
* @description The timestamp when the
|
|
8306
|
-
* @example
|
|
8894
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8895
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8307
8896
|
*/
|
|
8308
|
-
|
|
8897
|
+
created_at: string;
|
|
8309
8898
|
/**
|
|
8310
|
-
* @description The timestamp when the
|
|
8311
|
-
* @example
|
|
8899
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8900
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8901
|
+
*/
|
|
8902
|
+
updated_at: string;
|
|
8903
|
+
};
|
|
8904
|
+
/**
|
|
8905
|
+
* Format: date-time
|
|
8906
|
+
* @description An ISO 8601 timestamp.
|
|
8907
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8908
|
+
*/
|
|
8909
|
+
created_at: string;
|
|
8910
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8911
|
+
/**
|
|
8912
|
+
* @description Distinguishes the Event object.
|
|
8913
|
+
* @constant
|
|
8914
|
+
*/
|
|
8915
|
+
object: "event";
|
|
8916
|
+
} | {
|
|
8917
|
+
/**
|
|
8918
|
+
* @description Unique identifier for the event.
|
|
8919
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8920
|
+
*/
|
|
8921
|
+
id: string;
|
|
8922
|
+
/** @constant */
|
|
8923
|
+
event: "agent.instance.created";
|
|
8924
|
+
/** @description The event payload. */
|
|
8925
|
+
data: {
|
|
8926
|
+
/**
|
|
8927
|
+
* @description Distinguishes the agent instance object.
|
|
8928
|
+
* @constant
|
|
8929
|
+
*/
|
|
8930
|
+
object: "agent_instance";
|
|
8931
|
+
/**
|
|
8932
|
+
* @description Unique identifier of the agent instance.
|
|
8933
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8934
|
+
*/
|
|
8935
|
+
id: string;
|
|
8936
|
+
/**
|
|
8937
|
+
* @description The agent blueprint this instance was minted from.
|
|
8938
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8939
|
+
*/
|
|
8940
|
+
agent_blueprint_id: string;
|
|
8941
|
+
/**
|
|
8942
|
+
* @description The organization the instance acts within.
|
|
8943
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8944
|
+
*/
|
|
8945
|
+
organization_id: string;
|
|
8946
|
+
/**
|
|
8947
|
+
* @description The organization membership the instance acts on behalf of; `null` for an autonomous instance.
|
|
8948
|
+
* @example om_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8949
|
+
*/
|
|
8950
|
+
organization_membership_id: string | null;
|
|
8951
|
+
/**
|
|
8952
|
+
* @description Whether the instance acts on behalf of a user (`delegated`) or as itself within an organization (`autonomous`).
|
|
8953
|
+
* @enum {string}
|
|
8954
|
+
*/
|
|
8955
|
+
type: "delegated" | "autonomous";
|
|
8956
|
+
/**
|
|
8957
|
+
* @description The timestamp when the agent instance was created.
|
|
8958
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8312
8959
|
*/
|
|
8313
8960
|
created_at: string;
|
|
8314
8961
|
/**
|
|
8315
|
-
* @description The timestamp when the
|
|
8316
|
-
* @example
|
|
8962
|
+
* @description The timestamp when the agent instance was last updated.
|
|
8963
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8317
8964
|
*/
|
|
8318
8965
|
updated_at: string;
|
|
8319
8966
|
};
|
|
@@ -8336,70 +8983,119 @@ export interface components {
|
|
|
8336
8983
|
*/
|
|
8337
8984
|
id: string;
|
|
8338
8985
|
/** @constant */
|
|
8339
|
-
event: "agent.
|
|
8986
|
+
event: "agent.instance.deleted";
|
|
8340
8987
|
/** @description The event payload. */
|
|
8341
8988
|
data: {
|
|
8342
8989
|
/**
|
|
8343
|
-
* @description Distinguishes the agent
|
|
8990
|
+
* @description Distinguishes the agent instance object.
|
|
8344
8991
|
* @constant
|
|
8345
8992
|
*/
|
|
8346
|
-
object: "
|
|
8993
|
+
object: "agent_instance";
|
|
8347
8994
|
/**
|
|
8348
|
-
* @description Unique identifier of the agent
|
|
8349
|
-
* @example
|
|
8995
|
+
* @description Unique identifier of the agent instance.
|
|
8996
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8350
8997
|
*/
|
|
8351
8998
|
id: string;
|
|
8352
|
-
/** @description The agent identity for this registration. */
|
|
8353
|
-
agent_identity: {
|
|
8354
|
-
/**
|
|
8355
|
-
* @description Distinguishes the agent identity object.
|
|
8356
|
-
* @constant
|
|
8357
|
-
*/
|
|
8358
|
-
object: "agent_identity";
|
|
8359
|
-
/**
|
|
8360
|
-
* @description Unique identifier of the agent identity.
|
|
8361
|
-
* @example agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8362
|
-
*/
|
|
8363
|
-
id: string;
|
|
8364
|
-
/**
|
|
8365
|
-
* @description The ID of the userland user bound to this agent identity.
|
|
8366
|
-
* @example null
|
|
8367
|
-
*/
|
|
8368
|
-
userland_user_id: string | ("null" | null);
|
|
8369
|
-
};
|
|
8370
8999
|
/**
|
|
8371
|
-
* @description The
|
|
9000
|
+
* @description The agent blueprint this instance was minted from.
|
|
9001
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9002
|
+
*/
|
|
9003
|
+
agent_blueprint_id: string;
|
|
9004
|
+
/**
|
|
9005
|
+
* @description The organization the instance acts within.
|
|
8372
9006
|
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8373
9007
|
*/
|
|
8374
9008
|
organization_id: string;
|
|
8375
9009
|
/**
|
|
8376
|
-
* @description The
|
|
8377
|
-
* @example
|
|
8378
|
-
* @enum {string}
|
|
9010
|
+
* @description The organization membership the instance acts on behalf of; `null` for an autonomous instance.
|
|
9011
|
+
* @example om_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8379
9012
|
*/
|
|
8380
|
-
|
|
9013
|
+
organization_membership_id: string | null;
|
|
8381
9014
|
/**
|
|
8382
|
-
* @description
|
|
8383
|
-
* @example anonymous
|
|
9015
|
+
* @description Whether the instance acts on behalf of a user (`delegated`) or as itself within an organization (`autonomous`).
|
|
8384
9016
|
* @enum {string}
|
|
8385
9017
|
*/
|
|
8386
|
-
|
|
9018
|
+
type: "delegated" | "autonomous";
|
|
8387
9019
|
/**
|
|
8388
|
-
* @description The
|
|
8389
|
-
* @example
|
|
8390
|
-
* @enum {string}
|
|
9020
|
+
* @description The timestamp when the agent instance was created.
|
|
9021
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8391
9022
|
*/
|
|
8392
|
-
|
|
9023
|
+
created_at: string;
|
|
8393
9024
|
/**
|
|
8394
|
-
* @description The timestamp when the
|
|
8395
|
-
* @example
|
|
9025
|
+
* @description The timestamp when the agent instance was last updated.
|
|
9026
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9027
|
+
*/
|
|
9028
|
+
updated_at: string;
|
|
9029
|
+
};
|
|
9030
|
+
/**
|
|
9031
|
+
* Format: date-time
|
|
9032
|
+
* @description An ISO 8601 timestamp.
|
|
9033
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9034
|
+
*/
|
|
9035
|
+
created_at: string;
|
|
9036
|
+
context?: components["schemas"]["EventContextDto"];
|
|
9037
|
+
/**
|
|
9038
|
+
* @description Distinguishes the Event object.
|
|
9039
|
+
* @constant
|
|
9040
|
+
*/
|
|
9041
|
+
object: "event";
|
|
9042
|
+
} | {
|
|
9043
|
+
/**
|
|
9044
|
+
* @description Unique identifier for the event.
|
|
9045
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
9046
|
+
*/
|
|
9047
|
+
id: string;
|
|
9048
|
+
/** @constant */
|
|
9049
|
+
event: "agent.instance.session.created";
|
|
9050
|
+
/** @description The event payload. */
|
|
9051
|
+
data: {
|
|
9052
|
+
/**
|
|
9053
|
+
* @description Distinguishes the agent instance session object.
|
|
9054
|
+
* @constant
|
|
9055
|
+
*/
|
|
9056
|
+
object: "agent_instance_session";
|
|
9057
|
+
/**
|
|
9058
|
+
* @description Unique identifier of the agent instance session.
|
|
9059
|
+
* @example agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9060
|
+
*/
|
|
9061
|
+
id: string;
|
|
9062
|
+
/**
|
|
9063
|
+
* @description The agent instance the session belongs to.
|
|
9064
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9065
|
+
*/
|
|
9066
|
+
agent_instance_id: string;
|
|
9067
|
+
/**
|
|
9068
|
+
* @description The organization the owning agent instance belongs to.
|
|
9069
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9070
|
+
*/
|
|
9071
|
+
organization_id: string;
|
|
9072
|
+
/**
|
|
9073
|
+
* @description Timestamp when the session expires.
|
|
9074
|
+
* @example 2026-01-15T13:00:00.000Z
|
|
9075
|
+
*/
|
|
9076
|
+
expires_at: string;
|
|
9077
|
+
/**
|
|
9078
|
+
* @description Timestamp when the session was revoked; `null` if it has not been revoked.
|
|
9079
|
+
* @example null
|
|
9080
|
+
*/
|
|
9081
|
+
revoked_at: string | null;
|
|
9082
|
+
/**
|
|
9083
|
+
* @description The timestamp when the session was created.
|
|
9084
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8396
9085
|
*/
|
|
8397
9086
|
created_at: string;
|
|
8398
9087
|
/**
|
|
8399
|
-
* @description The timestamp when the
|
|
8400
|
-
* @example
|
|
9088
|
+
* @description The timestamp when the session was last updated.
|
|
9089
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8401
9090
|
*/
|
|
8402
9091
|
updated_at: string;
|
|
9092
|
+
/**
|
|
9093
|
+
* @description The permissions granted to the session at mint time.
|
|
9094
|
+
* @example [
|
|
9095
|
+
* "crm:read"
|
|
9096
|
+
* ]
|
|
9097
|
+
*/
|
|
9098
|
+
permission_slugs: string[];
|
|
8403
9099
|
};
|
|
8404
9100
|
/**
|
|
8405
9101
|
* Format: date-time
|
|
@@ -8420,61 +9116,342 @@ export interface components {
|
|
|
8420
9116
|
*/
|
|
8421
9117
|
id: string;
|
|
8422
9118
|
/** @constant */
|
|
8423
|
-
event: "agent.
|
|
9119
|
+
event: "agent.instance.session.revoked";
|
|
8424
9120
|
/** @description The event payload. */
|
|
8425
9121
|
data: {
|
|
8426
9122
|
/**
|
|
8427
|
-
* @description Distinguishes the agent
|
|
9123
|
+
* @description Distinguishes the agent instance session object.
|
|
8428
9124
|
* @constant
|
|
8429
9125
|
*/
|
|
8430
|
-
object: "
|
|
9126
|
+
object: "agent_instance_session";
|
|
8431
9127
|
/**
|
|
8432
|
-
* @description Unique identifier of the agent
|
|
8433
|
-
* @example
|
|
9128
|
+
* @description Unique identifier of the agent instance session.
|
|
9129
|
+
* @example agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8434
9130
|
*/
|
|
8435
9131
|
id: string;
|
|
8436
9132
|
/**
|
|
8437
|
-
* @description The
|
|
8438
|
-
* @example
|
|
9133
|
+
* @description The agent instance the session belongs to.
|
|
9134
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8439
9135
|
*/
|
|
8440
|
-
|
|
8441
|
-
/** @description Details of the issued credential. */
|
|
8442
|
-
detail: {
|
|
8443
|
-
/**
|
|
8444
|
-
* @description The kind of credential issued.
|
|
8445
|
-
* @constant
|
|
8446
|
-
*/
|
|
8447
|
-
kind: "api_key";
|
|
8448
|
-
/**
|
|
8449
|
-
* @description The ID of the issued API key.
|
|
8450
|
-
* @example api_key_01HWDP91J37GZW2FT9GCEX8YWV
|
|
8451
|
-
*/
|
|
8452
|
-
api_key_id: string;
|
|
8453
|
-
} | {
|
|
8454
|
-
/**
|
|
8455
|
-
* @description The kind of credential issued.
|
|
8456
|
-
* @constant
|
|
8457
|
-
*/
|
|
8458
|
-
kind: "access_token";
|
|
8459
|
-
/**
|
|
8460
|
-
* @description The JWT ID of the issued access token.
|
|
8461
|
-
* @example jti_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8462
|
-
*/
|
|
8463
|
-
jti: string;
|
|
8464
|
-
/**
|
|
8465
|
-
* @description The timestamp when the access token expires.
|
|
8466
|
-
* @example 2024-01-15T11:30:00.000Z
|
|
8467
|
-
*/
|
|
8468
|
-
expires_at: string | ("null" | null);
|
|
8469
|
-
};
|
|
9136
|
+
agent_instance_id: string;
|
|
8470
9137
|
/**
|
|
8471
|
-
* @description The
|
|
8472
|
-
* @example
|
|
9138
|
+
* @description The organization the owning agent instance belongs to.
|
|
9139
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9140
|
+
*/
|
|
9141
|
+
organization_id: string;
|
|
9142
|
+
/**
|
|
9143
|
+
* @description Timestamp when the session expires.
|
|
9144
|
+
* @example 2026-01-15T13:00:00.000Z
|
|
9145
|
+
*/
|
|
9146
|
+
expires_at: string;
|
|
9147
|
+
/**
|
|
9148
|
+
* @description Timestamp when the session was revoked; `null` if it has not been revoked.
|
|
9149
|
+
* @example null
|
|
9150
|
+
*/
|
|
9151
|
+
revoked_at: string | null;
|
|
9152
|
+
/**
|
|
9153
|
+
* @description The timestamp when the session was created.
|
|
9154
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8473
9155
|
*/
|
|
8474
9156
|
created_at: string;
|
|
8475
9157
|
/**
|
|
8476
|
-
* @description The timestamp when the
|
|
8477
|
-
* @example
|
|
9158
|
+
* @description The timestamp when the session was last updated.
|
|
9159
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9160
|
+
*/
|
|
9161
|
+
updated_at: string;
|
|
9162
|
+
};
|
|
9163
|
+
/**
|
|
9164
|
+
* Format: date-time
|
|
9165
|
+
* @description An ISO 8601 timestamp.
|
|
9166
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9167
|
+
*/
|
|
9168
|
+
created_at: string;
|
|
9169
|
+
context?: components["schemas"]["EventContextDto"];
|
|
9170
|
+
/**
|
|
9171
|
+
* @description Distinguishes the Event object.
|
|
9172
|
+
* @constant
|
|
9173
|
+
*/
|
|
9174
|
+
object: "event";
|
|
9175
|
+
} | {
|
|
9176
|
+
/**
|
|
9177
|
+
* @description Unique identifier for the event.
|
|
9178
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
9179
|
+
*/
|
|
9180
|
+
id: string;
|
|
9181
|
+
/** @constant */
|
|
9182
|
+
event: "agent.registration.claim.attempt.created";
|
|
9183
|
+
/** @description The event payload. */
|
|
9184
|
+
data: {
|
|
9185
|
+
/**
|
|
9186
|
+
* @description Distinguishes the agent registration claim attempt object.
|
|
9187
|
+
* @constant
|
|
9188
|
+
*/
|
|
9189
|
+
object: "agent_registration_claim_attempt";
|
|
9190
|
+
/**
|
|
9191
|
+
* @description Unique identifier of the agent registration claim attempt.
|
|
9192
|
+
* @example agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9193
|
+
*/
|
|
9194
|
+
id: string;
|
|
9195
|
+
/**
|
|
9196
|
+
* @description The ID of the agent registration.
|
|
9197
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9198
|
+
*/
|
|
9199
|
+
agent_registration_id: string;
|
|
9200
|
+
/**
|
|
9201
|
+
* @description The ID of the agent registration claim.
|
|
9202
|
+
* @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9203
|
+
*/
|
|
9204
|
+
agent_registration_claim_id: string;
|
|
9205
|
+
/**
|
|
9206
|
+
* @description The login hint for the claim attempt.
|
|
9207
|
+
* @example jane@example.com
|
|
9208
|
+
*/
|
|
9209
|
+
login_hint: string;
|
|
9210
|
+
/**
|
|
9211
|
+
* @description The timestamp when the claim attempt expires.
|
|
9212
|
+
* @example 2024-01-15T10:35:00.000Z
|
|
9213
|
+
*/
|
|
9214
|
+
expires_at: string;
|
|
9215
|
+
/**
|
|
9216
|
+
* @description The timestamp when the claim attempt was created.
|
|
9217
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
9218
|
+
*/
|
|
9219
|
+
created_at: string;
|
|
9220
|
+
/**
|
|
9221
|
+
* @description The timestamp when the claim attempt was last updated.
|
|
9222
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
9223
|
+
*/
|
|
9224
|
+
updated_at: string;
|
|
9225
|
+
};
|
|
9226
|
+
/**
|
|
9227
|
+
* Format: date-time
|
|
9228
|
+
* @description An ISO 8601 timestamp.
|
|
9229
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9230
|
+
*/
|
|
9231
|
+
created_at: string;
|
|
9232
|
+
context?: components["schemas"]["EventContextDto"];
|
|
9233
|
+
/**
|
|
9234
|
+
* @description Distinguishes the Event object.
|
|
9235
|
+
* @constant
|
|
9236
|
+
*/
|
|
9237
|
+
object: "event";
|
|
9238
|
+
} | {
|
|
9239
|
+
/**
|
|
9240
|
+
* @description Unique identifier for the event.
|
|
9241
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
9242
|
+
*/
|
|
9243
|
+
id: string;
|
|
9244
|
+
/** @constant */
|
|
9245
|
+
event: "agent.registration.claim.completed";
|
|
9246
|
+
/** @description The event payload. */
|
|
9247
|
+
data: {
|
|
9248
|
+
/**
|
|
9249
|
+
* @description Distinguishes the agent registration claim object.
|
|
9250
|
+
* @constant
|
|
9251
|
+
*/
|
|
9252
|
+
object: "agent_registration_claim";
|
|
9253
|
+
/**
|
|
9254
|
+
* @description Unique identifier of the agent registration claim.
|
|
9255
|
+
* @example agent_reg_claim_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9256
|
+
*/
|
|
9257
|
+
id: string;
|
|
9258
|
+
/**
|
|
9259
|
+
* @description The ID of the agent registration.
|
|
9260
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9261
|
+
*/
|
|
9262
|
+
agent_registration_id: string;
|
|
9263
|
+
/**
|
|
9264
|
+
* @description The ID of the claim attempt that completed the claim.
|
|
9265
|
+
* @example agent_reg_claim_attempt_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9266
|
+
*/
|
|
9267
|
+
completed_by_attempt_id: string;
|
|
9268
|
+
/** @description The user who completed the claim. */
|
|
9269
|
+
claimed_by: {
|
|
9270
|
+
/**
|
|
9271
|
+
* @description The ID of the user who completed the claim.
|
|
9272
|
+
* @example user_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9273
|
+
*/
|
|
9274
|
+
user_id: string;
|
|
9275
|
+
/**
|
|
9276
|
+
* @description The ID of the organization the claiming user belongs to.
|
|
9277
|
+
* @example null
|
|
9278
|
+
*/
|
|
9279
|
+
organization_id: string | ("null" | null);
|
|
9280
|
+
};
|
|
9281
|
+
/**
|
|
9282
|
+
* @description The timestamp when the claim was completed.
|
|
9283
|
+
* @example 2024-01-15T10:32:00.000Z
|
|
9284
|
+
*/
|
|
9285
|
+
completed_at: string;
|
|
9286
|
+
/**
|
|
9287
|
+
* @description The timestamp when the claim was created.
|
|
9288
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
9289
|
+
*/
|
|
9290
|
+
created_at: string;
|
|
9291
|
+
/**
|
|
9292
|
+
* @description The timestamp when the claim was last updated.
|
|
9293
|
+
* @example 2024-01-15T10:32:00.000Z
|
|
9294
|
+
*/
|
|
9295
|
+
updated_at: string;
|
|
9296
|
+
};
|
|
9297
|
+
/**
|
|
9298
|
+
* Format: date-time
|
|
9299
|
+
* @description An ISO 8601 timestamp.
|
|
9300
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9301
|
+
*/
|
|
9302
|
+
created_at: string;
|
|
9303
|
+
context?: components["schemas"]["EventContextDto"];
|
|
9304
|
+
/**
|
|
9305
|
+
* @description Distinguishes the Event object.
|
|
9306
|
+
* @constant
|
|
9307
|
+
*/
|
|
9308
|
+
object: "event";
|
|
9309
|
+
} | {
|
|
9310
|
+
/**
|
|
9311
|
+
* @description Unique identifier for the event.
|
|
9312
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
9313
|
+
*/
|
|
9314
|
+
id: string;
|
|
9315
|
+
/** @constant */
|
|
9316
|
+
event: "agent.registration.created";
|
|
9317
|
+
/** @description The event payload. */
|
|
9318
|
+
data: {
|
|
9319
|
+
/**
|
|
9320
|
+
* @description Distinguishes the agent registration object.
|
|
9321
|
+
* @constant
|
|
9322
|
+
*/
|
|
9323
|
+
object: "agent_registration";
|
|
9324
|
+
/**
|
|
9325
|
+
* @description Unique identifier of the agent registration.
|
|
9326
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9327
|
+
*/
|
|
9328
|
+
id: string;
|
|
9329
|
+
/** @description The agent identity for this registration. */
|
|
9330
|
+
agent_identity: {
|
|
9331
|
+
/**
|
|
9332
|
+
* @description Distinguishes the agent identity object.
|
|
9333
|
+
* @constant
|
|
9334
|
+
*/
|
|
9335
|
+
object: "agent_identity";
|
|
9336
|
+
/**
|
|
9337
|
+
* @description Unique identifier of the agent identity.
|
|
9338
|
+
* @example agent_identity_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9339
|
+
*/
|
|
9340
|
+
id: string;
|
|
9341
|
+
/**
|
|
9342
|
+
* @description The ID of the userland user bound to this agent identity.
|
|
9343
|
+
* @example null
|
|
9344
|
+
*/
|
|
9345
|
+
userland_user_id: string | ("null" | null);
|
|
9346
|
+
};
|
|
9347
|
+
/**
|
|
9348
|
+
* @description The ID of the organization the registration belongs to.
|
|
9349
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9350
|
+
*/
|
|
9351
|
+
organization_id: string;
|
|
9352
|
+
/**
|
|
9353
|
+
* @description The current status of the registration.
|
|
9354
|
+
* @example unverified
|
|
9355
|
+
* @enum {string}
|
|
9356
|
+
*/
|
|
9357
|
+
status: "unverified" | "verified" | "expired" | "revoked";
|
|
9358
|
+
/**
|
|
9359
|
+
* @description The kind of the registration.
|
|
9360
|
+
* @example anonymous
|
|
9361
|
+
* @enum {string}
|
|
9362
|
+
*/
|
|
9363
|
+
kind: "anonymous" | "service_auth" | "identity_assertion";
|
|
9364
|
+
/**
|
|
9365
|
+
* @description The authentication method of the registration.
|
|
9366
|
+
* @example anonymous
|
|
9367
|
+
* @enum {string}
|
|
9368
|
+
*/
|
|
9369
|
+
method: "anonymous" | "service_auth" | "id_jag";
|
|
9370
|
+
/**
|
|
9371
|
+
* @description The timestamp when the registration was created.
|
|
9372
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
9373
|
+
*/
|
|
9374
|
+
created_at: string;
|
|
9375
|
+
/**
|
|
9376
|
+
* @description The timestamp when the registration was last updated.
|
|
9377
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
9378
|
+
*/
|
|
9379
|
+
updated_at: string;
|
|
9380
|
+
};
|
|
9381
|
+
/**
|
|
9382
|
+
* Format: date-time
|
|
9383
|
+
* @description An ISO 8601 timestamp.
|
|
9384
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
9385
|
+
*/
|
|
9386
|
+
created_at: string;
|
|
9387
|
+
context?: components["schemas"]["EventContextDto"];
|
|
9388
|
+
/**
|
|
9389
|
+
* @description Distinguishes the Event object.
|
|
9390
|
+
* @constant
|
|
9391
|
+
*/
|
|
9392
|
+
object: "event";
|
|
9393
|
+
} | {
|
|
9394
|
+
/**
|
|
9395
|
+
* @description Unique identifier for the event.
|
|
9396
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
9397
|
+
*/
|
|
9398
|
+
id: string;
|
|
9399
|
+
/** @constant */
|
|
9400
|
+
event: "agent.registration.credential.issued";
|
|
9401
|
+
/** @description The event payload. */
|
|
9402
|
+
data: {
|
|
9403
|
+
/**
|
|
9404
|
+
* @description Distinguishes the agent registration credential object.
|
|
9405
|
+
* @constant
|
|
9406
|
+
*/
|
|
9407
|
+
object: "agent_registration_credential";
|
|
9408
|
+
/**
|
|
9409
|
+
* @description Unique identifier of the agent registration credential.
|
|
9410
|
+
* @example agent_reg_credential_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9411
|
+
*/
|
|
9412
|
+
id: string;
|
|
9413
|
+
/**
|
|
9414
|
+
* @description The ID of the agent registration.
|
|
9415
|
+
* @example agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9416
|
+
*/
|
|
9417
|
+
agent_registration_id: string;
|
|
9418
|
+
/** @description Details of the issued credential. */
|
|
9419
|
+
detail: {
|
|
9420
|
+
/**
|
|
9421
|
+
* @description The kind of credential issued.
|
|
9422
|
+
* @constant
|
|
9423
|
+
*/
|
|
9424
|
+
kind: "api_key";
|
|
9425
|
+
/**
|
|
9426
|
+
* @description The ID of the issued API key.
|
|
9427
|
+
* @example api_key_01HWDP91J37GZW2FT9GCEX8YWV
|
|
9428
|
+
*/
|
|
9429
|
+
api_key_id: string;
|
|
9430
|
+
} | {
|
|
9431
|
+
/**
|
|
9432
|
+
* @description The kind of credential issued.
|
|
9433
|
+
* @constant
|
|
9434
|
+
*/
|
|
9435
|
+
kind: "access_token";
|
|
9436
|
+
/**
|
|
9437
|
+
* @description The JWT ID of the issued access token.
|
|
9438
|
+
* @example jti_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
9439
|
+
*/
|
|
9440
|
+
jti: string;
|
|
9441
|
+
/**
|
|
9442
|
+
* @description The timestamp when the access token expires.
|
|
9443
|
+
* @example 2024-01-15T11:30:00.000Z
|
|
9444
|
+
*/
|
|
9445
|
+
expires_at: string | ("null" | null);
|
|
9446
|
+
};
|
|
9447
|
+
/**
|
|
9448
|
+
* @description The timestamp when the credential was issued.
|
|
9449
|
+
* @example 2024-01-15T10:33:00.000Z
|
|
9450
|
+
*/
|
|
9451
|
+
created_at: string;
|
|
9452
|
+
/**
|
|
9453
|
+
* @description The timestamp when the credential was last updated.
|
|
9454
|
+
* @example 2024-01-15T10:33:00.000Z
|
|
8478
9455
|
*/
|
|
8479
9456
|
updated_at: string;
|
|
8480
9457
|
};
|
|
@@ -13962,6 +14939,142 @@ export interface components {
|
|
|
13962
14939
|
* @constant
|
|
13963
14940
|
*/
|
|
13964
14941
|
object: "event";
|
|
14942
|
+
} | {
|
|
14943
|
+
/**
|
|
14944
|
+
* @description Unique identifier for the event.
|
|
14945
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14946
|
+
*/
|
|
14947
|
+
id: string;
|
|
14948
|
+
/** @constant */
|
|
14949
|
+
event: "resource_export.completed";
|
|
14950
|
+
/** @description The event payload. */
|
|
14951
|
+
data: {
|
|
14952
|
+
/**
|
|
14953
|
+
* @description The ID of the resource export.
|
|
14954
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14955
|
+
*/
|
|
14956
|
+
id: string;
|
|
14957
|
+
/**
|
|
14958
|
+
* @description The type of resource being exported.
|
|
14959
|
+
* @example users
|
|
14960
|
+
* @enum {string}
|
|
14961
|
+
*/
|
|
14962
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14963
|
+
};
|
|
14964
|
+
/**
|
|
14965
|
+
* Format: date-time
|
|
14966
|
+
* @description An ISO 8601 timestamp.
|
|
14967
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14968
|
+
*/
|
|
14969
|
+
created_at: string;
|
|
14970
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14971
|
+
/**
|
|
14972
|
+
* @description Distinguishes the Event object.
|
|
14973
|
+
* @constant
|
|
14974
|
+
*/
|
|
14975
|
+
object: "event";
|
|
14976
|
+
} | {
|
|
14977
|
+
/**
|
|
14978
|
+
* @description Unique identifier for the event.
|
|
14979
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14980
|
+
*/
|
|
14981
|
+
id: string;
|
|
14982
|
+
/** @constant */
|
|
14983
|
+
event: "resource_export.created";
|
|
14984
|
+
/** @description The event payload. */
|
|
14985
|
+
data: {
|
|
14986
|
+
/**
|
|
14987
|
+
* @description The ID of the resource export.
|
|
14988
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14989
|
+
*/
|
|
14990
|
+
id: string;
|
|
14991
|
+
/**
|
|
14992
|
+
* @description The type of resource being exported.
|
|
14993
|
+
* @example users
|
|
14994
|
+
* @enum {string}
|
|
14995
|
+
*/
|
|
14996
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14997
|
+
};
|
|
14998
|
+
/**
|
|
14999
|
+
* Format: date-time
|
|
15000
|
+
* @description An ISO 8601 timestamp.
|
|
15001
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15002
|
+
*/
|
|
15003
|
+
created_at: string;
|
|
15004
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15005
|
+
/**
|
|
15006
|
+
* @description Distinguishes the Event object.
|
|
15007
|
+
* @constant
|
|
15008
|
+
*/
|
|
15009
|
+
object: "event";
|
|
15010
|
+
} | {
|
|
15011
|
+
/**
|
|
15012
|
+
* @description Unique identifier for the event.
|
|
15013
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15014
|
+
*/
|
|
15015
|
+
id: string;
|
|
15016
|
+
/** @constant */
|
|
15017
|
+
event: "resource_export.downloaded";
|
|
15018
|
+
/** @description The event payload. */
|
|
15019
|
+
data: {
|
|
15020
|
+
/**
|
|
15021
|
+
* @description The ID of the resource export.
|
|
15022
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
15023
|
+
*/
|
|
15024
|
+
id: string;
|
|
15025
|
+
/**
|
|
15026
|
+
* @description The type of resource being exported.
|
|
15027
|
+
* @example users
|
|
15028
|
+
* @enum {string}
|
|
15029
|
+
*/
|
|
15030
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15031
|
+
};
|
|
15032
|
+
/**
|
|
15033
|
+
* Format: date-time
|
|
15034
|
+
* @description An ISO 8601 timestamp.
|
|
15035
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15036
|
+
*/
|
|
15037
|
+
created_at: string;
|
|
15038
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15039
|
+
/**
|
|
15040
|
+
* @description Distinguishes the Event object.
|
|
15041
|
+
* @constant
|
|
15042
|
+
*/
|
|
15043
|
+
object: "event";
|
|
15044
|
+
} | {
|
|
15045
|
+
/**
|
|
15046
|
+
* @description Unique identifier for the event.
|
|
15047
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
15048
|
+
*/
|
|
15049
|
+
id: string;
|
|
15050
|
+
/** @constant */
|
|
15051
|
+
event: "resource_export.failed";
|
|
15052
|
+
/** @description The event payload. */
|
|
15053
|
+
data: {
|
|
15054
|
+
/**
|
|
15055
|
+
* @description The ID of the resource export.
|
|
15056
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
15057
|
+
*/
|
|
15058
|
+
id: string;
|
|
15059
|
+
/**
|
|
15060
|
+
* @description The type of resource being exported.
|
|
15061
|
+
* @example users
|
|
15062
|
+
* @enum {string}
|
|
15063
|
+
*/
|
|
15064
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15065
|
+
};
|
|
15066
|
+
/**
|
|
15067
|
+
* Format: date-time
|
|
15068
|
+
* @description An ISO 8601 timestamp.
|
|
15069
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15070
|
+
*/
|
|
15071
|
+
created_at: string;
|
|
15072
|
+
context?: components["schemas"]["EventContextDto"];
|
|
15073
|
+
/**
|
|
15074
|
+
* @description Distinguishes the Event object.
|
|
15075
|
+
* @constant
|
|
15076
|
+
*/
|
|
15077
|
+
object: "event";
|
|
13965
15078
|
} | {
|
|
13966
15079
|
/**
|
|
13967
15080
|
* @description Unique identifier for the event.
|
|
@@ -15775,7 +16888,7 @@ export interface components {
|
|
|
15775
16888
|
*/
|
|
15776
16889
|
scopes: string[] | null;
|
|
15777
16890
|
/**
|
|
15778
|
-
* @description The OAuth redirect URI to register with the provider when configuring the custom application.
|
|
16891
|
+
* @description The OAuth redirect URI to register with the provider when configuring the custom application. Empty for `api_key` and `client_credentials` integrations, which run no authorization redirect.
|
|
15779
16892
|
* @example https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
|
|
15780
16893
|
*/
|
|
15781
16894
|
redirect_uri: string;
|
|
@@ -15786,7 +16899,7 @@ export interface components {
|
|
|
15786
16899
|
* ]
|
|
15787
16900
|
*/
|
|
15788
16901
|
auth_methods: ("oauth" | "api_key" | "client_credentials")[];
|
|
15789
|
-
/** @description The integration-level OAuth app credentials. `null` for `api_key` integrations, which hold no
|
|
16902
|
+
/** @description The integration-level OAuth app credentials. `null` for `api_key` and `client_credentials` integrations, which hold no integration-level credentials (secrets are installed per-tenant). */
|
|
15790
16903
|
credentials: {
|
|
15791
16904
|
/**
|
|
15792
16905
|
* @description The credentials type. `custom` uses your own OAuth app credentials; `organization` has each organization supply its own credentials (so `client_id`/`redacted_client_secret` are null on the integration itself).
|
|
@@ -16111,7 +17224,7 @@ export interface components {
|
|
|
16111
17224
|
*/
|
|
16112
17225
|
scopes: string[];
|
|
16113
17226
|
/**
|
|
16114
|
-
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
17227
|
+
* @description If the integration has requested scopes that aren't present on the access token, they're listed here. The scopes granted to a client-credentials token are governed by the connected organization's client application, so the integration's configured scopes are requests or defaults rather than guarantees.
|
|
16115
17228
|
* @example []
|
|
16116
17229
|
*/
|
|
16117
17230
|
missing_scopes: string[];
|
|
@@ -16553,6 +17666,129 @@ export interface components {
|
|
|
16553
17666
|
*/
|
|
16554
17667
|
updated_at: string;
|
|
16555
17668
|
};
|
|
17669
|
+
SamlIdpSigningCertificate: {
|
|
17670
|
+
/**
|
|
17671
|
+
* @description Distinguishes the SAML Identity Provider signing certificate object.
|
|
17672
|
+
* @constant
|
|
17673
|
+
*/
|
|
17674
|
+
object: "saml_idp_signing_certificate";
|
|
17675
|
+
/**
|
|
17676
|
+
* @description Unique identifier for the Identity Provider signing certificate.
|
|
17677
|
+
* @example saml_x509_cert_01E4ZCR3C56J083X43JQXF3JK5
|
|
17678
|
+
*/
|
|
17679
|
+
id: string;
|
|
17680
|
+
/**
|
|
17681
|
+
* @description The PEM-encoded public X.509 certificate.
|
|
17682
|
+
* @example -----BEGIN CERTIFICATE-----MIIC...-----END CERTIFICATE-----
|
|
17683
|
+
*/
|
|
17684
|
+
value: string;
|
|
17685
|
+
/**
|
|
17686
|
+
* Format: date-time
|
|
17687
|
+
* @description When the certificate becomes valid.
|
|
17688
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17689
|
+
*/
|
|
17690
|
+
not_before: string | null;
|
|
17691
|
+
/**
|
|
17692
|
+
* Format: date-time
|
|
17693
|
+
* @description When the certificate expires.
|
|
17694
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17695
|
+
*/
|
|
17696
|
+
not_after: string | null;
|
|
17697
|
+
/**
|
|
17698
|
+
* Format: date-time
|
|
17699
|
+
* @description An ISO 8601 timestamp.
|
|
17700
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17701
|
+
*/
|
|
17702
|
+
created_at: string;
|
|
17703
|
+
};
|
|
17704
|
+
SamlIdpSigningCertificateList: {
|
|
17705
|
+
/**
|
|
17706
|
+
* @example list
|
|
17707
|
+
* @constant
|
|
17708
|
+
*/
|
|
17709
|
+
object: "list";
|
|
17710
|
+
/** @description Every Identity Provider signing certificate on the Connection, including expired ones, oldest first. */
|
|
17711
|
+
data: components["schemas"]["SamlIdpSigningCertificate"][];
|
|
17712
|
+
};
|
|
17713
|
+
SamlSpEncryptionCertificate: {
|
|
17714
|
+
/**
|
|
17715
|
+
* @description Distinguishes the SAML Service Provider encryption certificate object.
|
|
17716
|
+
* @constant
|
|
17717
|
+
*/
|
|
17718
|
+
object: "saml_sp_encryption_certificate";
|
|
17719
|
+
/**
|
|
17720
|
+
* @description Unique identifier for the Service Provider encryption key pair. WorkOS holds the corresponding private key, which is never exposed.
|
|
17721
|
+
* @example saml_enc_key_pair_01E4ZCR3C56J083X43JQXF3JK5
|
|
17722
|
+
*/
|
|
17723
|
+
id: string;
|
|
17724
|
+
/**
|
|
17725
|
+
* @description The PEM-encoded public X.509 certificate.
|
|
17726
|
+
* @example -----BEGIN CERTIFICATE-----MIIC...-----END CERTIFICATE-----
|
|
17727
|
+
*/
|
|
17728
|
+
value: string;
|
|
17729
|
+
/**
|
|
17730
|
+
* Format: date-time
|
|
17731
|
+
* @description When the certificate becomes valid.
|
|
17732
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17733
|
+
*/
|
|
17734
|
+
not_before: string | null;
|
|
17735
|
+
/**
|
|
17736
|
+
* Format: date-time
|
|
17737
|
+
* @description When the certificate expires.
|
|
17738
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17739
|
+
*/
|
|
17740
|
+
not_after: string | null;
|
|
17741
|
+
/**
|
|
17742
|
+
* Format: date-time
|
|
17743
|
+
* @description An ISO 8601 timestamp.
|
|
17744
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17745
|
+
*/
|
|
17746
|
+
created_at: string;
|
|
17747
|
+
};
|
|
17748
|
+
SamlSpEncryptionCertificateList: {
|
|
17749
|
+
/**
|
|
17750
|
+
* @example list
|
|
17751
|
+
* @constant
|
|
17752
|
+
*/
|
|
17753
|
+
object: "list";
|
|
17754
|
+
/** @description Every Service Provider encryption certificate on the Connection, including expired ones. */
|
|
17755
|
+
data: components["schemas"]["SamlSpEncryptionCertificate"][];
|
|
17756
|
+
};
|
|
17757
|
+
SamlSpSigningCertificate: {
|
|
17758
|
+
/**
|
|
17759
|
+
* @description Distinguishes the SAML Service Provider signing certificate object.
|
|
17760
|
+
* @constant
|
|
17761
|
+
*/
|
|
17762
|
+
object: "saml_sp_signing_certificate";
|
|
17763
|
+
/**
|
|
17764
|
+
* @description Unique identifier for the Service Provider signing key pair. WorkOS holds the corresponding private key, which is never exposed.
|
|
17765
|
+
* @example saml_party_trust_01E4ZCR3C56J083X43JQXF3JK5
|
|
17766
|
+
*/
|
|
17767
|
+
id: string;
|
|
17768
|
+
/**
|
|
17769
|
+
* @description The PEM-encoded public X.509 certificate.
|
|
17770
|
+
* @example -----BEGIN CERTIFICATE-----MIIC...-----END CERTIFICATE-----
|
|
17771
|
+
*/
|
|
17772
|
+
value: string;
|
|
17773
|
+
/**
|
|
17774
|
+
* Format: date-time
|
|
17775
|
+
* @description When the certificate becomes valid.
|
|
17776
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17777
|
+
*/
|
|
17778
|
+
not_before: string | null;
|
|
17779
|
+
/**
|
|
17780
|
+
* Format: date-time
|
|
17781
|
+
* @description When the certificate expires.
|
|
17782
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17783
|
+
*/
|
|
17784
|
+
not_after: string | null;
|
|
17785
|
+
/**
|
|
17786
|
+
* Format: date-time
|
|
17787
|
+
* @description An ISO 8601 timestamp.
|
|
17788
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
17789
|
+
*/
|
|
17790
|
+
created_at: string;
|
|
17791
|
+
};
|
|
16556
17792
|
Team: {
|
|
16557
17793
|
/**
|
|
16558
17794
|
* @description Distinguishes the team object.
|
|
@@ -18208,7 +19444,7 @@ export interface operations {
|
|
|
18208
19444
|
after?: string;
|
|
18209
19445
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
18210
19446
|
limit?: number;
|
|
18211
|
-
/** @description Order the results by the creation time. */
|
|
19447
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
18212
19448
|
order?: components["schemas"]["PaginationOrder"];
|
|
18213
19449
|
};
|
|
18214
19450
|
header?: never;
|
|
@@ -18289,7 +19525,7 @@ export interface operations {
|
|
|
18289
19525
|
after?: string;
|
|
18290
19526
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
18291
19527
|
limit?: number;
|
|
18292
|
-
/** @description Order the results by the creation time. */
|
|
19528
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
18293
19529
|
order?: components["schemas"]["PaginationOrder"];
|
|
18294
19530
|
};
|
|
18295
19531
|
header?: never;
|
|
@@ -19132,7 +20368,7 @@ export interface operations {
|
|
|
19132
20368
|
after?: string;
|
|
19133
20369
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19134
20370
|
limit?: number;
|
|
19135
|
-
/** @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). */
|
|
20371
|
+
/** @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). Defaults to `normal`. */
|
|
19136
20372
|
order?: components["schemas"]["PaginationOrder"];
|
|
19137
20373
|
};
|
|
19138
20374
|
header?: never;
|
|
@@ -19608,7 +20844,7 @@ export interface operations {
|
|
|
19608
20844
|
after?: string;
|
|
19609
20845
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19610
20846
|
limit?: number;
|
|
19611
|
-
/** @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). */
|
|
20847
|
+
/** @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). Defaults to `normal`. */
|
|
19612
20848
|
order?: components["schemas"]["PaginationOrder"];
|
|
19613
20849
|
/** @description The permission slug to filter by. Only child resources where the organization membership has this permission are returned. */
|
|
19614
20850
|
permission_slug: string;
|
|
@@ -19714,7 +20950,7 @@ export interface operations {
|
|
|
19714
20950
|
after?: string;
|
|
19715
20951
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19716
20952
|
limit?: number;
|
|
19717
|
-
/** @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). */
|
|
20953
|
+
/** @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). Defaults to `normal`. */
|
|
19718
20954
|
order?: components["schemas"]["PaginationOrder"];
|
|
19719
20955
|
};
|
|
19720
20956
|
header?: never;
|
|
@@ -19793,7 +21029,7 @@ export interface operations {
|
|
|
19793
21029
|
after?: string;
|
|
19794
21030
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19795
21031
|
limit?: number;
|
|
19796
|
-
/** @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). */
|
|
21032
|
+
/** @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). Defaults to `normal`. */
|
|
19797
21033
|
order?: components["schemas"]["PaginationOrder"];
|
|
19798
21034
|
};
|
|
19799
21035
|
header?: never;
|
|
@@ -19874,7 +21110,7 @@ export interface operations {
|
|
|
19874
21110
|
after?: string;
|
|
19875
21111
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19876
21112
|
limit?: number;
|
|
19877
|
-
/** @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). */
|
|
21113
|
+
/** @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). Defaults to `normal`. */
|
|
19878
21114
|
order?: components["schemas"]["PaginationOrder"];
|
|
19879
21115
|
/** @description Filter assignments by the ID of the resource. */
|
|
19880
21116
|
resource_id?: string;
|
|
@@ -21435,7 +22671,7 @@ export interface operations {
|
|
|
21435
22671
|
after?: string;
|
|
21436
22672
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21437
22673
|
limit?: number;
|
|
21438
|
-
/** @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). */
|
|
22674
|
+
/** @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). Defaults to `normal`. */
|
|
21439
22675
|
order?: components["schemas"]["PaginationOrder"];
|
|
21440
22676
|
/** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
|
|
21441
22677
|
permission_slug: string;
|
|
@@ -21541,7 +22777,7 @@ export interface operations {
|
|
|
21541
22777
|
after?: string;
|
|
21542
22778
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21543
22779
|
limit?: number;
|
|
21544
|
-
/** @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). */
|
|
22780
|
+
/** @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). Defaults to `normal`. */
|
|
21545
22781
|
order?: components["schemas"]["PaginationOrder"];
|
|
21546
22782
|
/** @description Filter assignments by the slug of the role. */
|
|
21547
22783
|
role_slug?: string;
|
|
@@ -21609,7 +22845,7 @@ export interface operations {
|
|
|
21609
22845
|
after?: string;
|
|
21610
22846
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21611
22847
|
limit?: number;
|
|
21612
|
-
/** @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). */
|
|
22848
|
+
/** @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). Defaults to `normal`. */
|
|
21613
22849
|
order?: components["schemas"]["PaginationOrder"];
|
|
21614
22850
|
};
|
|
21615
22851
|
header?: never;
|
|
@@ -21957,7 +23193,7 @@ export interface operations {
|
|
|
21957
23193
|
after?: string;
|
|
21958
23194
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21959
23195
|
limit?: number;
|
|
21960
|
-
/** @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). */
|
|
23196
|
+
/** @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). Defaults to `normal`. */
|
|
21961
23197
|
order?: components["schemas"]["PaginationOrder"];
|
|
21962
23198
|
/** @description Filter resources by organization ID. */
|
|
21963
23199
|
organization_id?: string;
|
|
@@ -22577,7 +23813,7 @@ export interface operations {
|
|
|
22577
23813
|
after?: string;
|
|
22578
23814
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
22579
23815
|
limit?: number;
|
|
22580
|
-
/** @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). */
|
|
23816
|
+
/** @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). Defaults to `normal`. */
|
|
22581
23817
|
order?: components["schemas"]["PaginationOrder"];
|
|
22582
23818
|
/** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
|
|
22583
23819
|
permission_slug: string;
|
|
@@ -22679,7 +23915,7 @@ export interface operations {
|
|
|
22679
23915
|
after?: string;
|
|
22680
23916
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
22681
23917
|
limit?: number;
|
|
22682
|
-
/** @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). */
|
|
23918
|
+
/** @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). Defaults to `normal`. */
|
|
22683
23919
|
order?: components["schemas"]["PaginationOrder"];
|
|
22684
23920
|
/** @description Filter assignments by the slug of the role. */
|
|
22685
23921
|
role_slug?: string;
|
|
@@ -23522,7 +24758,7 @@ export interface operations {
|
|
|
23522
24758
|
after?: string;
|
|
23523
24759
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
23524
24760
|
limit?: number;
|
|
23525
|
-
/** @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). */
|
|
24761
|
+
/** @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). Defaults to `normal`. */
|
|
23526
24762
|
order?: components["schemas"]["PaginationOrder"];
|
|
23527
24763
|
/** @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. */
|
|
23528
24764
|
registration_types?: ("dynamic" | "authenticated")[];
|
|
@@ -23920,7 +25156,7 @@ export interface operations {
|
|
|
23920
25156
|
after?: string;
|
|
23921
25157
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
23922
25158
|
limit?: number;
|
|
23923
|
-
/** @description Order the results by the creation time. */
|
|
25159
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
23924
25160
|
order?: components["schemas"]["PaginationOrder"];
|
|
23925
25161
|
/** @description Filter Connections by their type. */
|
|
23926
25162
|
connection_type?: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "CloudflareSAML" | "ClassLinkSAML" | "CleverOIDC" | "CyberArkSAML" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
|
|
@@ -23978,20 +25214,1117 @@ export interface operations {
|
|
|
23978
25214
|
};
|
|
23979
25215
|
};
|
|
23980
25216
|
};
|
|
23981
|
-
|
|
25217
|
+
ConnectionsController_create: {
|
|
23982
25218
|
parameters: {
|
|
23983
25219
|
query?: never;
|
|
23984
25220
|
header?: never;
|
|
23985
|
-
path
|
|
23986
|
-
/** @description Unique identifier for the Connection. */
|
|
23987
|
-
id: string;
|
|
23988
|
-
};
|
|
25221
|
+
path?: never;
|
|
23989
25222
|
cookie?: never;
|
|
23990
25223
|
};
|
|
23991
|
-
requestBody
|
|
25224
|
+
requestBody: {
|
|
25225
|
+
content: {
|
|
25226
|
+
"application/json": components["schemas"]["CreateConnectionDto"];
|
|
25227
|
+
};
|
|
25228
|
+
};
|
|
23992
25229
|
responses: {
|
|
23993
|
-
/** @description
|
|
23994
|
-
|
|
25230
|
+
/** @description Created */
|
|
25231
|
+
201: {
|
|
25232
|
+
headers: {
|
|
25233
|
+
[name: string]: unknown;
|
|
25234
|
+
};
|
|
25235
|
+
content: {
|
|
25236
|
+
"application/json": components["schemas"]["Connection"];
|
|
25237
|
+
};
|
|
25238
|
+
};
|
|
25239
|
+
/** @description Bad Request */
|
|
25240
|
+
400: {
|
|
25241
|
+
headers: {
|
|
25242
|
+
[name: string]: unknown;
|
|
25243
|
+
};
|
|
25244
|
+
content: {
|
|
25245
|
+
"application/json": {
|
|
25246
|
+
/**
|
|
25247
|
+
* @description The error code identifying the type of error.
|
|
25248
|
+
* @example external_id_already_in_use
|
|
25249
|
+
* @constant
|
|
25250
|
+
*/
|
|
25251
|
+
code: "external_id_already_in_use";
|
|
25252
|
+
/**
|
|
25253
|
+
* @description A human-readable description of the error.
|
|
25254
|
+
* @example Request could not be processed.
|
|
25255
|
+
*/
|
|
25256
|
+
message: string;
|
|
25257
|
+
} | {
|
|
25258
|
+
/**
|
|
25259
|
+
* @description The error code identifying the type of error.
|
|
25260
|
+
* @example connection_type_not_supported
|
|
25261
|
+
* @constant
|
|
25262
|
+
*/
|
|
25263
|
+
code: "connection_type_not_supported";
|
|
25264
|
+
/**
|
|
25265
|
+
* @description A human-readable description of the error.
|
|
25266
|
+
* @example Request could not be processed.
|
|
25267
|
+
*/
|
|
25268
|
+
message: string;
|
|
25269
|
+
} | {
|
|
25270
|
+
/**
|
|
25271
|
+
* @description The error code identifying the type of error.
|
|
25272
|
+
* @example connection_type_or_options_required
|
|
25273
|
+
* @constant
|
|
25274
|
+
*/
|
|
25275
|
+
code: "connection_type_or_options_required";
|
|
25276
|
+
/**
|
|
25277
|
+
* @description A human-readable description of the error.
|
|
25278
|
+
* @example Request could not be processed.
|
|
25279
|
+
*/
|
|
25280
|
+
message: string;
|
|
25281
|
+
} | {
|
|
25282
|
+
/**
|
|
25283
|
+
* @description The error code identifying the type of error.
|
|
25284
|
+
* @example connection_type_conflicts_with_options
|
|
25285
|
+
* @constant
|
|
25286
|
+
*/
|
|
25287
|
+
code: "connection_type_conflicts_with_options";
|
|
25288
|
+
/**
|
|
25289
|
+
* @description A human-readable description of the error.
|
|
25290
|
+
* @example Request could not be processed.
|
|
25291
|
+
*/
|
|
25292
|
+
message: string;
|
|
25293
|
+
} | {
|
|
25294
|
+
/**
|
|
25295
|
+
* @description The error code identifying the type of error.
|
|
25296
|
+
* @example both_saml_and_oidc_options_provided
|
|
25297
|
+
* @constant
|
|
25298
|
+
*/
|
|
25299
|
+
code: "both_saml_and_oidc_options_provided";
|
|
25300
|
+
/**
|
|
25301
|
+
* @description A human-readable description of the error.
|
|
25302
|
+
* @example Request could not be processed.
|
|
25303
|
+
*/
|
|
25304
|
+
message: string;
|
|
25305
|
+
} | {
|
|
25306
|
+
/**
|
|
25307
|
+
* @description The error code identifying the type of error.
|
|
25308
|
+
* @example ambiguous_saml_options
|
|
25309
|
+
* @constant
|
|
25310
|
+
*/
|
|
25311
|
+
code: "ambiguous_saml_options";
|
|
25312
|
+
/**
|
|
25313
|
+
* @description A human-readable description of the error.
|
|
25314
|
+
* @example Request could not be processed.
|
|
25315
|
+
*/
|
|
25316
|
+
message: string;
|
|
25317
|
+
} | {
|
|
25318
|
+
/**
|
|
25319
|
+
* @description The error code identifying the type of error.
|
|
25320
|
+
* @example incomplete_saml_options
|
|
25321
|
+
* @constant
|
|
25322
|
+
*/
|
|
25323
|
+
code: "incomplete_saml_options";
|
|
25324
|
+
/**
|
|
25325
|
+
* @description A human-readable description of the error.
|
|
25326
|
+
* @example Request could not be processed.
|
|
25327
|
+
*/
|
|
25328
|
+
message: string;
|
|
25329
|
+
} | {
|
|
25330
|
+
/**
|
|
25331
|
+
* @description The error code identifying the type of error.
|
|
25332
|
+
* @example saml_options_required
|
|
25333
|
+
* @constant
|
|
25334
|
+
*/
|
|
25335
|
+
code: "saml_options_required";
|
|
25336
|
+
/**
|
|
25337
|
+
* @description A human-readable description of the error.
|
|
25338
|
+
* @example Request could not be processed.
|
|
25339
|
+
*/
|
|
25340
|
+
message: string;
|
|
25341
|
+
} | {
|
|
25342
|
+
/**
|
|
25343
|
+
* @description The error code identifying the type of error.
|
|
25344
|
+
* @example oidc_options_required
|
|
25345
|
+
* @constant
|
|
25346
|
+
*/
|
|
25347
|
+
code: "oidc_options_required";
|
|
25348
|
+
/**
|
|
25349
|
+
* @description A human-readable description of the error.
|
|
25350
|
+
* @example Request could not be processed.
|
|
25351
|
+
*/
|
|
25352
|
+
message: string;
|
|
25353
|
+
} | {
|
|
25354
|
+
/**
|
|
25355
|
+
* @description The error code identifying the type of error.
|
|
25356
|
+
* @example invalid_certificate
|
|
25357
|
+
* @constant
|
|
25358
|
+
*/
|
|
25359
|
+
code: "invalid_certificate";
|
|
25360
|
+
/**
|
|
25361
|
+
* @description A human-readable description of the error.
|
|
25362
|
+
* @example Request could not be processed.
|
|
25363
|
+
*/
|
|
25364
|
+
message: string;
|
|
25365
|
+
} | {
|
|
25366
|
+
/**
|
|
25367
|
+
* @description The error code identifying the type of error.
|
|
25368
|
+
* @example client_secret_required
|
|
25369
|
+
* @constant
|
|
25370
|
+
*/
|
|
25371
|
+
code: "client_secret_required";
|
|
25372
|
+
/**
|
|
25373
|
+
* @description A human-readable description of the error.
|
|
25374
|
+
* @example Request could not be processed.
|
|
25375
|
+
*/
|
|
25376
|
+
message: string;
|
|
25377
|
+
} | {
|
|
25378
|
+
/**
|
|
25379
|
+
* @description The error code identifying the type of error.
|
|
25380
|
+
* @example client_secret_not_accepted
|
|
25381
|
+
* @constant
|
|
25382
|
+
*/
|
|
25383
|
+
code: "client_secret_not_accepted";
|
|
25384
|
+
/**
|
|
25385
|
+
* @description A human-readable description of the error.
|
|
25386
|
+
* @example Request could not be processed.
|
|
25387
|
+
*/
|
|
25388
|
+
message: string;
|
|
25389
|
+
} | {
|
|
25390
|
+
/**
|
|
25391
|
+
* @description The error code identifying the type of error.
|
|
25392
|
+
* @example key_pair_not_accepted
|
|
25393
|
+
* @constant
|
|
25394
|
+
*/
|
|
25395
|
+
code: "key_pair_not_accepted";
|
|
25396
|
+
/**
|
|
25397
|
+
* @description A human-readable description of the error.
|
|
25398
|
+
* @example Request could not be processed.
|
|
25399
|
+
*/
|
|
25400
|
+
message: string;
|
|
25401
|
+
} | {
|
|
25402
|
+
/**
|
|
25403
|
+
* @description The error code identifying the type of error.
|
|
25404
|
+
* @example discovery_endpoint_must_use_https
|
|
25405
|
+
* @constant
|
|
25406
|
+
*/
|
|
25407
|
+
code: "discovery_endpoint_must_use_https";
|
|
25408
|
+
/**
|
|
25409
|
+
* @description A human-readable description of the error.
|
|
25410
|
+
* @example Request could not be processed.
|
|
25411
|
+
*/
|
|
25412
|
+
message: string;
|
|
25413
|
+
} | {
|
|
25414
|
+
/**
|
|
25415
|
+
* @description The error code identifying the type of error.
|
|
25416
|
+
* @example token_authentication_method_not_supported
|
|
25417
|
+
* @constant
|
|
25418
|
+
*/
|
|
25419
|
+
code: "token_authentication_method_not_supported";
|
|
25420
|
+
/**
|
|
25421
|
+
* @description A human-readable description of the error.
|
|
25422
|
+
* @example Request could not be processed.
|
|
25423
|
+
*/
|
|
25424
|
+
message: string;
|
|
25425
|
+
};
|
|
25426
|
+
};
|
|
25427
|
+
};
|
|
25428
|
+
/** @description Forbidden */
|
|
25429
|
+
403: {
|
|
25430
|
+
headers: {
|
|
25431
|
+
[name: string]: unknown;
|
|
25432
|
+
};
|
|
25433
|
+
content: {
|
|
25434
|
+
"application/json": {
|
|
25435
|
+
/**
|
|
25436
|
+
* @description A human-readable description of the error.
|
|
25437
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25438
|
+
*/
|
|
25439
|
+
message: string;
|
|
25440
|
+
};
|
|
25441
|
+
};
|
|
25442
|
+
};
|
|
25443
|
+
/** @description Not Found */
|
|
25444
|
+
404: {
|
|
25445
|
+
headers: {
|
|
25446
|
+
[name: string]: unknown;
|
|
25447
|
+
};
|
|
25448
|
+
content: {
|
|
25449
|
+
"application/json": {
|
|
25450
|
+
/**
|
|
25451
|
+
* @description A human-readable description of the error.
|
|
25452
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25453
|
+
*/
|
|
25454
|
+
message: string;
|
|
25455
|
+
};
|
|
25456
|
+
};
|
|
25457
|
+
};
|
|
25458
|
+
409: {
|
|
25459
|
+
headers: {
|
|
25460
|
+
[name: string]: unknown;
|
|
25461
|
+
};
|
|
25462
|
+
content: {
|
|
25463
|
+
"application/json": {
|
|
25464
|
+
/**
|
|
25465
|
+
* @description The error code identifying the type of error.
|
|
25466
|
+
* @example connection_deletion_in_progress
|
|
25467
|
+
* @constant
|
|
25468
|
+
*/
|
|
25469
|
+
code: "connection_deletion_in_progress";
|
|
25470
|
+
/**
|
|
25471
|
+
* @description A human-readable description of the error.
|
|
25472
|
+
* @example Request could not be processed.
|
|
25473
|
+
*/
|
|
25474
|
+
message: string;
|
|
25475
|
+
};
|
|
25476
|
+
};
|
|
25477
|
+
};
|
|
25478
|
+
/** @description Unprocessable Entity */
|
|
25479
|
+
422: {
|
|
25480
|
+
headers: {
|
|
25481
|
+
[name: string]: unknown;
|
|
25482
|
+
};
|
|
25483
|
+
content: {
|
|
25484
|
+
"application/json": {
|
|
25485
|
+
/**
|
|
25486
|
+
* @description A human-readable description of the error.
|
|
25487
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25488
|
+
*/
|
|
25489
|
+
message: string;
|
|
25490
|
+
} | {
|
|
25491
|
+
/**
|
|
25492
|
+
* @description The error code identifying the type of error.
|
|
25493
|
+
* @example idp_metadata_fetch_failed
|
|
25494
|
+
* @constant
|
|
25495
|
+
*/
|
|
25496
|
+
code: "idp_metadata_fetch_failed";
|
|
25497
|
+
/**
|
|
25498
|
+
* @description A human-readable description of the error.
|
|
25499
|
+
* @example Request could not be processed.
|
|
25500
|
+
*/
|
|
25501
|
+
message: string;
|
|
25502
|
+
} | {
|
|
25503
|
+
/**
|
|
25504
|
+
* @description The error code identifying the type of error.
|
|
25505
|
+
* @example connection_could_not_be_verified
|
|
25506
|
+
* @constant
|
|
25507
|
+
*/
|
|
25508
|
+
code: "connection_could_not_be_verified";
|
|
25509
|
+
/**
|
|
25510
|
+
* @description A human-readable description of the error.
|
|
25511
|
+
* @example Request could not be processed.
|
|
25512
|
+
*/
|
|
25513
|
+
message: string;
|
|
25514
|
+
} | {
|
|
25515
|
+
/**
|
|
25516
|
+
* @description The error code identifying the type of error.
|
|
25517
|
+
* @example invalid_idp_sso_url
|
|
25518
|
+
* @constant
|
|
25519
|
+
*/
|
|
25520
|
+
code: "invalid_idp_sso_url";
|
|
25521
|
+
/**
|
|
25522
|
+
* @description A human-readable description of the error.
|
|
25523
|
+
* @example Request could not be processed.
|
|
25524
|
+
*/
|
|
25525
|
+
message: string;
|
|
25526
|
+
};
|
|
25527
|
+
};
|
|
25528
|
+
};
|
|
25529
|
+
};
|
|
25530
|
+
};
|
|
25531
|
+
SamlIdpSigningCertificatesController_list: {
|
|
25532
|
+
parameters: {
|
|
25533
|
+
query?: never;
|
|
25534
|
+
header?: never;
|
|
25535
|
+
path: {
|
|
25536
|
+
/** @description Unique identifier for the Connection. */
|
|
25537
|
+
connectionId: string;
|
|
25538
|
+
};
|
|
25539
|
+
cookie?: never;
|
|
25540
|
+
};
|
|
25541
|
+
requestBody?: never;
|
|
25542
|
+
responses: {
|
|
25543
|
+
/** @description OK */
|
|
25544
|
+
200: {
|
|
25545
|
+
headers: {
|
|
25546
|
+
[name: string]: unknown;
|
|
25547
|
+
};
|
|
25548
|
+
content: {
|
|
25549
|
+
"application/json": components["schemas"]["SamlIdpSigningCertificateList"];
|
|
25550
|
+
};
|
|
25551
|
+
};
|
|
25552
|
+
/** @description Bad Request */
|
|
25553
|
+
400: {
|
|
25554
|
+
headers: {
|
|
25555
|
+
[name: string]: unknown;
|
|
25556
|
+
};
|
|
25557
|
+
content: {
|
|
25558
|
+
"application/json": {
|
|
25559
|
+
/**
|
|
25560
|
+
* @description The error code identifying the type of error.
|
|
25561
|
+
* @example connection_is_not_saml
|
|
25562
|
+
* @constant
|
|
25563
|
+
*/
|
|
25564
|
+
code: "connection_is_not_saml";
|
|
25565
|
+
/**
|
|
25566
|
+
* @description A human-readable description of the error.
|
|
25567
|
+
* @example Request could not be processed.
|
|
25568
|
+
*/
|
|
25569
|
+
message: string;
|
|
25570
|
+
};
|
|
25571
|
+
};
|
|
25572
|
+
};
|
|
25573
|
+
/** @description Forbidden */
|
|
25574
|
+
403: {
|
|
25575
|
+
headers: {
|
|
25576
|
+
[name: string]: unknown;
|
|
25577
|
+
};
|
|
25578
|
+
content: {
|
|
25579
|
+
"application/json": {
|
|
25580
|
+
/**
|
|
25581
|
+
* @description A human-readable description of the error.
|
|
25582
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25583
|
+
*/
|
|
25584
|
+
message: string;
|
|
25585
|
+
};
|
|
25586
|
+
};
|
|
25587
|
+
};
|
|
25588
|
+
/** @description Not Found */
|
|
25589
|
+
404: {
|
|
25590
|
+
headers: {
|
|
25591
|
+
[name: string]: unknown;
|
|
25592
|
+
};
|
|
25593
|
+
content: {
|
|
25594
|
+
"application/json": {
|
|
25595
|
+
/**
|
|
25596
|
+
* @description A human-readable description of the error.
|
|
25597
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25598
|
+
*/
|
|
25599
|
+
message: string;
|
|
25600
|
+
};
|
|
25601
|
+
};
|
|
25602
|
+
};
|
|
25603
|
+
};
|
|
25604
|
+
};
|
|
25605
|
+
SamlIdpSigningCertificatesController_create: {
|
|
25606
|
+
parameters: {
|
|
25607
|
+
query?: never;
|
|
25608
|
+
header?: never;
|
|
25609
|
+
path: {
|
|
25610
|
+
/** @description Unique identifier for the Connection. */
|
|
25611
|
+
connectionId: string;
|
|
25612
|
+
};
|
|
25613
|
+
cookie?: never;
|
|
25614
|
+
};
|
|
25615
|
+
requestBody: {
|
|
25616
|
+
content: {
|
|
25617
|
+
"application/json": components["schemas"]["CreateSamlIdpSigningCertificateDto"];
|
|
25618
|
+
};
|
|
25619
|
+
};
|
|
25620
|
+
responses: {
|
|
25621
|
+
/** @description Created */
|
|
25622
|
+
201: {
|
|
25623
|
+
headers: {
|
|
25624
|
+
[name: string]: unknown;
|
|
25625
|
+
};
|
|
25626
|
+
content: {
|
|
25627
|
+
"application/json": components["schemas"]["SamlIdpSigningCertificate"];
|
|
25628
|
+
};
|
|
25629
|
+
};
|
|
25630
|
+
/** @description Bad Request */
|
|
25631
|
+
400: {
|
|
25632
|
+
headers: {
|
|
25633
|
+
[name: string]: unknown;
|
|
25634
|
+
};
|
|
25635
|
+
content: {
|
|
25636
|
+
"application/json": {
|
|
25637
|
+
/**
|
|
25638
|
+
* @description The error code identifying the type of error.
|
|
25639
|
+
* @example connection_is_not_saml
|
|
25640
|
+
* @constant
|
|
25641
|
+
*/
|
|
25642
|
+
code: "connection_is_not_saml";
|
|
25643
|
+
/**
|
|
25644
|
+
* @description A human-readable description of the error.
|
|
25645
|
+
* @example Request could not be processed.
|
|
25646
|
+
*/
|
|
25647
|
+
message: string;
|
|
25648
|
+
} | {
|
|
25649
|
+
/**
|
|
25650
|
+
* @description The error code identifying the type of error.
|
|
25651
|
+
* @example invalid_certificate
|
|
25652
|
+
* @constant
|
|
25653
|
+
*/
|
|
25654
|
+
code: "invalid_certificate";
|
|
25655
|
+
/**
|
|
25656
|
+
* @description A human-readable description of the error.
|
|
25657
|
+
* @example Request could not be processed.
|
|
25658
|
+
*/
|
|
25659
|
+
message: string;
|
|
25660
|
+
} | {
|
|
25661
|
+
/**
|
|
25662
|
+
* @description The error code identifying the type of error.
|
|
25663
|
+
* @example certificate_expired
|
|
25664
|
+
* @constant
|
|
25665
|
+
*/
|
|
25666
|
+
code: "certificate_expired";
|
|
25667
|
+
/**
|
|
25668
|
+
* @description A human-readable description of the error.
|
|
25669
|
+
* @example Request could not be processed.
|
|
25670
|
+
*/
|
|
25671
|
+
message: string;
|
|
25672
|
+
};
|
|
25673
|
+
};
|
|
25674
|
+
};
|
|
25675
|
+
/** @description Forbidden */
|
|
25676
|
+
403: {
|
|
25677
|
+
headers: {
|
|
25678
|
+
[name: string]: unknown;
|
|
25679
|
+
};
|
|
25680
|
+
content: {
|
|
25681
|
+
"application/json": {
|
|
25682
|
+
/**
|
|
25683
|
+
* @description A human-readable description of the error.
|
|
25684
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25685
|
+
*/
|
|
25686
|
+
message: string;
|
|
25687
|
+
};
|
|
25688
|
+
};
|
|
25689
|
+
};
|
|
25690
|
+
/** @description Not Found */
|
|
25691
|
+
404: {
|
|
25692
|
+
headers: {
|
|
25693
|
+
[name: string]: unknown;
|
|
25694
|
+
};
|
|
25695
|
+
content: {
|
|
25696
|
+
"application/json": {
|
|
25697
|
+
/**
|
|
25698
|
+
* @description A human-readable description of the error.
|
|
25699
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25700
|
+
*/
|
|
25701
|
+
message: string;
|
|
25702
|
+
};
|
|
25703
|
+
};
|
|
25704
|
+
};
|
|
25705
|
+
/** @description Unprocessable Entity */
|
|
25706
|
+
422: {
|
|
25707
|
+
headers: {
|
|
25708
|
+
[name: string]: unknown;
|
|
25709
|
+
};
|
|
25710
|
+
content: {
|
|
25711
|
+
"application/json": {
|
|
25712
|
+
/**
|
|
25713
|
+
* @description A human-readable description of the error.
|
|
25714
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25715
|
+
*/
|
|
25716
|
+
message: string;
|
|
25717
|
+
};
|
|
25718
|
+
};
|
|
25719
|
+
};
|
|
25720
|
+
};
|
|
25721
|
+
};
|
|
25722
|
+
SamlIdpSigningCertificatesController_delete: {
|
|
25723
|
+
parameters: {
|
|
25724
|
+
query?: never;
|
|
25725
|
+
header?: never;
|
|
25726
|
+
path: {
|
|
25727
|
+
/** @description Unique identifier for the Connection. */
|
|
25728
|
+
connectionId: string;
|
|
25729
|
+
/** @description Unique identifier for the Identity Provider signing certificate. */
|
|
25730
|
+
certificateId: string;
|
|
25731
|
+
};
|
|
25732
|
+
cookie?: never;
|
|
25733
|
+
};
|
|
25734
|
+
requestBody?: never;
|
|
25735
|
+
responses: {
|
|
25736
|
+
/** @description No Content */
|
|
25737
|
+
204: {
|
|
25738
|
+
headers: {
|
|
25739
|
+
[name: string]: unknown;
|
|
25740
|
+
};
|
|
25741
|
+
content?: never;
|
|
25742
|
+
};
|
|
25743
|
+
/** @description Bad Request */
|
|
25744
|
+
400: {
|
|
25745
|
+
headers: {
|
|
25746
|
+
[name: string]: unknown;
|
|
25747
|
+
};
|
|
25748
|
+
content: {
|
|
25749
|
+
"application/json": {
|
|
25750
|
+
/**
|
|
25751
|
+
* @description The error code identifying the type of error.
|
|
25752
|
+
* @example cannot_delete_last_certificate
|
|
25753
|
+
* @constant
|
|
25754
|
+
*/
|
|
25755
|
+
code: "cannot_delete_last_certificate";
|
|
25756
|
+
/**
|
|
25757
|
+
* @description A human-readable description of the error.
|
|
25758
|
+
* @example Request could not be processed.
|
|
25759
|
+
*/
|
|
25760
|
+
message: string;
|
|
25761
|
+
};
|
|
25762
|
+
};
|
|
25763
|
+
};
|
|
25764
|
+
/** @description Forbidden */
|
|
25765
|
+
403: {
|
|
25766
|
+
headers: {
|
|
25767
|
+
[name: string]: unknown;
|
|
25768
|
+
};
|
|
25769
|
+
content: {
|
|
25770
|
+
"application/json": {
|
|
25771
|
+
/**
|
|
25772
|
+
* @description A human-readable description of the error.
|
|
25773
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25774
|
+
*/
|
|
25775
|
+
message: string;
|
|
25776
|
+
};
|
|
25777
|
+
};
|
|
25778
|
+
};
|
|
25779
|
+
/** @description Not Found */
|
|
25780
|
+
404: {
|
|
25781
|
+
headers: {
|
|
25782
|
+
[name: string]: unknown;
|
|
25783
|
+
};
|
|
25784
|
+
content: {
|
|
25785
|
+
"application/json": {
|
|
25786
|
+
/**
|
|
25787
|
+
* @description A human-readable description of the error.
|
|
25788
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25789
|
+
*/
|
|
25790
|
+
message: string;
|
|
25791
|
+
};
|
|
25792
|
+
};
|
|
25793
|
+
};
|
|
25794
|
+
};
|
|
25795
|
+
};
|
|
25796
|
+
SamlSpEncryptionCertificatesController_list: {
|
|
25797
|
+
parameters: {
|
|
25798
|
+
query?: never;
|
|
25799
|
+
header?: never;
|
|
25800
|
+
path: {
|
|
25801
|
+
/** @description Unique identifier for the Connection. */
|
|
25802
|
+
connectionId: string;
|
|
25803
|
+
};
|
|
25804
|
+
cookie?: never;
|
|
25805
|
+
};
|
|
25806
|
+
requestBody?: never;
|
|
25807
|
+
responses: {
|
|
25808
|
+
/** @description OK */
|
|
25809
|
+
200: {
|
|
25810
|
+
headers: {
|
|
25811
|
+
[name: string]: unknown;
|
|
25812
|
+
};
|
|
25813
|
+
content: {
|
|
25814
|
+
"application/json": components["schemas"]["SamlSpEncryptionCertificateList"];
|
|
25815
|
+
};
|
|
25816
|
+
};
|
|
25817
|
+
/** @description Bad Request */
|
|
25818
|
+
400: {
|
|
25819
|
+
headers: {
|
|
25820
|
+
[name: string]: unknown;
|
|
25821
|
+
};
|
|
25822
|
+
content: {
|
|
25823
|
+
"application/json": {
|
|
25824
|
+
/**
|
|
25825
|
+
* @description The error code identifying the type of error.
|
|
25826
|
+
* @example connection_is_not_saml
|
|
25827
|
+
* @constant
|
|
25828
|
+
*/
|
|
25829
|
+
code: "connection_is_not_saml";
|
|
25830
|
+
/**
|
|
25831
|
+
* @description A human-readable description of the error.
|
|
25832
|
+
* @example Request could not be processed.
|
|
25833
|
+
*/
|
|
25834
|
+
message: string;
|
|
25835
|
+
};
|
|
25836
|
+
};
|
|
25837
|
+
};
|
|
25838
|
+
/** @description Forbidden */
|
|
25839
|
+
403: {
|
|
25840
|
+
headers: {
|
|
25841
|
+
[name: string]: unknown;
|
|
25842
|
+
};
|
|
25843
|
+
content: {
|
|
25844
|
+
"application/json": {
|
|
25845
|
+
/**
|
|
25846
|
+
* @description A human-readable description of the error.
|
|
25847
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25848
|
+
*/
|
|
25849
|
+
message: string;
|
|
25850
|
+
};
|
|
25851
|
+
};
|
|
25852
|
+
};
|
|
25853
|
+
/** @description Not Found */
|
|
25854
|
+
404: {
|
|
25855
|
+
headers: {
|
|
25856
|
+
[name: string]: unknown;
|
|
25857
|
+
};
|
|
25858
|
+
content: {
|
|
25859
|
+
"application/json": {
|
|
25860
|
+
/**
|
|
25861
|
+
* @description A human-readable description of the error.
|
|
25862
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25863
|
+
*/
|
|
25864
|
+
message: string;
|
|
25865
|
+
};
|
|
25866
|
+
};
|
|
25867
|
+
};
|
|
25868
|
+
};
|
|
25869
|
+
};
|
|
25870
|
+
SamlSpEncryptionCertificatesController_create: {
|
|
25871
|
+
parameters: {
|
|
25872
|
+
query?: never;
|
|
25873
|
+
header?: never;
|
|
25874
|
+
path: {
|
|
25875
|
+
/** @description Unique identifier for the Connection. */
|
|
25876
|
+
connectionId: string;
|
|
25877
|
+
};
|
|
25878
|
+
cookie?: never;
|
|
25879
|
+
};
|
|
25880
|
+
requestBody?: never;
|
|
25881
|
+
responses: {
|
|
25882
|
+
/** @description Created */
|
|
25883
|
+
201: {
|
|
25884
|
+
headers: {
|
|
25885
|
+
[name: string]: unknown;
|
|
25886
|
+
};
|
|
25887
|
+
content: {
|
|
25888
|
+
"application/json": components["schemas"]["SamlSpEncryptionCertificate"];
|
|
25889
|
+
};
|
|
25890
|
+
};
|
|
25891
|
+
/** @description Bad Request */
|
|
25892
|
+
400: {
|
|
25893
|
+
headers: {
|
|
25894
|
+
[name: string]: unknown;
|
|
25895
|
+
};
|
|
25896
|
+
content: {
|
|
25897
|
+
"application/json": {
|
|
25898
|
+
/**
|
|
25899
|
+
* @description The error code identifying the type of error.
|
|
25900
|
+
* @example connection_is_not_saml
|
|
25901
|
+
* @constant
|
|
25902
|
+
*/
|
|
25903
|
+
code: "connection_is_not_saml";
|
|
25904
|
+
/**
|
|
25905
|
+
* @description A human-readable description of the error.
|
|
25906
|
+
* @example Request could not be processed.
|
|
25907
|
+
*/
|
|
25908
|
+
message: string;
|
|
25909
|
+
} | {
|
|
25910
|
+
/**
|
|
25911
|
+
* @description The error code identifying the type of error.
|
|
25912
|
+
* @example key_pair_not_accepted
|
|
25913
|
+
* @constant
|
|
25914
|
+
*/
|
|
25915
|
+
code: "key_pair_not_accepted";
|
|
25916
|
+
/**
|
|
25917
|
+
* @description A human-readable description of the error.
|
|
25918
|
+
* @example Request could not be processed.
|
|
25919
|
+
*/
|
|
25920
|
+
message: string;
|
|
25921
|
+
};
|
|
25922
|
+
};
|
|
25923
|
+
};
|
|
25924
|
+
/** @description Forbidden */
|
|
25925
|
+
403: {
|
|
25926
|
+
headers: {
|
|
25927
|
+
[name: string]: unknown;
|
|
25928
|
+
};
|
|
25929
|
+
content: {
|
|
25930
|
+
"application/json": {
|
|
25931
|
+
/**
|
|
25932
|
+
* @description A human-readable description of the error.
|
|
25933
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25934
|
+
*/
|
|
25935
|
+
message: string;
|
|
25936
|
+
};
|
|
25937
|
+
};
|
|
25938
|
+
};
|
|
25939
|
+
/** @description Not Found */
|
|
25940
|
+
404: {
|
|
25941
|
+
headers: {
|
|
25942
|
+
[name: string]: unknown;
|
|
25943
|
+
};
|
|
25944
|
+
content: {
|
|
25945
|
+
"application/json": {
|
|
25946
|
+
/**
|
|
25947
|
+
* @description A human-readable description of the error.
|
|
25948
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
25949
|
+
*/
|
|
25950
|
+
message: string;
|
|
25951
|
+
};
|
|
25952
|
+
};
|
|
25953
|
+
};
|
|
25954
|
+
409: {
|
|
25955
|
+
headers: {
|
|
25956
|
+
[name: string]: unknown;
|
|
25957
|
+
};
|
|
25958
|
+
content: {
|
|
25959
|
+
"application/json": {
|
|
25960
|
+
/**
|
|
25961
|
+
* @description The error code identifying the type of error.
|
|
25962
|
+
* @example too_many_sp_encryption_certs
|
|
25963
|
+
* @constant
|
|
25964
|
+
*/
|
|
25965
|
+
code: "too_many_sp_encryption_certs";
|
|
25966
|
+
/**
|
|
25967
|
+
* @description A human-readable description of the error.
|
|
25968
|
+
* @example Request could not be processed.
|
|
25969
|
+
*/
|
|
25970
|
+
message: string;
|
|
25971
|
+
};
|
|
25972
|
+
};
|
|
25973
|
+
};
|
|
25974
|
+
503: {
|
|
25975
|
+
headers: {
|
|
25976
|
+
[name: string]: unknown;
|
|
25977
|
+
};
|
|
25978
|
+
content: {
|
|
25979
|
+
"application/json": {
|
|
25980
|
+
/**
|
|
25981
|
+
* @description The error code identifying the type of error.
|
|
25982
|
+
* @example concurrent_request
|
|
25983
|
+
* @constant
|
|
25984
|
+
*/
|
|
25985
|
+
code: "concurrent_request";
|
|
25986
|
+
/**
|
|
25987
|
+
* @description A human-readable description of the error.
|
|
25988
|
+
* @example Request could not be processed.
|
|
25989
|
+
*/
|
|
25990
|
+
message: string;
|
|
25991
|
+
};
|
|
25992
|
+
};
|
|
25993
|
+
};
|
|
25994
|
+
};
|
|
25995
|
+
};
|
|
25996
|
+
SamlSpEncryptionCertificatesController_delete: {
|
|
25997
|
+
parameters: {
|
|
25998
|
+
query?: never;
|
|
25999
|
+
header?: never;
|
|
26000
|
+
path: {
|
|
26001
|
+
/** @description Unique identifier for the Connection. */
|
|
26002
|
+
connectionId: string;
|
|
26003
|
+
/** @description Unique identifier for the Service Provider encryption key pair. WorkOS holds the corresponding private key, which is never exposed. */
|
|
26004
|
+
certificateId: string;
|
|
26005
|
+
};
|
|
26006
|
+
cookie?: never;
|
|
26007
|
+
};
|
|
26008
|
+
requestBody?: never;
|
|
26009
|
+
responses: {
|
|
26010
|
+
/** @description No Content */
|
|
26011
|
+
204: {
|
|
26012
|
+
headers: {
|
|
26013
|
+
[name: string]: unknown;
|
|
26014
|
+
};
|
|
26015
|
+
content?: never;
|
|
26016
|
+
};
|
|
26017
|
+
/** @description Forbidden */
|
|
26018
|
+
403: {
|
|
26019
|
+
headers: {
|
|
26020
|
+
[name: string]: unknown;
|
|
26021
|
+
};
|
|
26022
|
+
content: {
|
|
26023
|
+
"application/json": {
|
|
26024
|
+
/**
|
|
26025
|
+
* @description A human-readable description of the error.
|
|
26026
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26027
|
+
*/
|
|
26028
|
+
message: string;
|
|
26029
|
+
};
|
|
26030
|
+
};
|
|
26031
|
+
};
|
|
26032
|
+
/** @description Not Found */
|
|
26033
|
+
404: {
|
|
26034
|
+
headers: {
|
|
26035
|
+
[name: string]: unknown;
|
|
26036
|
+
};
|
|
26037
|
+
content: {
|
|
26038
|
+
"application/json": {
|
|
26039
|
+
/**
|
|
26040
|
+
* @description A human-readable description of the error.
|
|
26041
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26042
|
+
*/
|
|
26043
|
+
message: string;
|
|
26044
|
+
};
|
|
26045
|
+
};
|
|
26046
|
+
};
|
|
26047
|
+
};
|
|
26048
|
+
};
|
|
26049
|
+
SamlSpSigningCertificatesController_get: {
|
|
26050
|
+
parameters: {
|
|
26051
|
+
query?: never;
|
|
26052
|
+
header?: never;
|
|
26053
|
+
path: {
|
|
26054
|
+
/** @description Unique identifier for the Connection. */
|
|
26055
|
+
connectionId: string;
|
|
26056
|
+
};
|
|
26057
|
+
cookie?: never;
|
|
26058
|
+
};
|
|
26059
|
+
requestBody?: never;
|
|
26060
|
+
responses: {
|
|
26061
|
+
/** @description OK */
|
|
26062
|
+
200: {
|
|
26063
|
+
headers: {
|
|
26064
|
+
[name: string]: unknown;
|
|
26065
|
+
};
|
|
26066
|
+
content: {
|
|
26067
|
+
"application/json": components["schemas"]["SamlSpSigningCertificate"];
|
|
26068
|
+
};
|
|
26069
|
+
};
|
|
26070
|
+
/** @description Bad Request */
|
|
26071
|
+
400: {
|
|
26072
|
+
headers: {
|
|
26073
|
+
[name: string]: unknown;
|
|
26074
|
+
};
|
|
26075
|
+
content: {
|
|
26076
|
+
"application/json": {
|
|
26077
|
+
/**
|
|
26078
|
+
* @description The error code identifying the type of error.
|
|
26079
|
+
* @example connection_is_not_saml
|
|
26080
|
+
* @constant
|
|
26081
|
+
*/
|
|
26082
|
+
code: "connection_is_not_saml";
|
|
26083
|
+
/**
|
|
26084
|
+
* @description A human-readable description of the error.
|
|
26085
|
+
* @example Request could not be processed.
|
|
26086
|
+
*/
|
|
26087
|
+
message: string;
|
|
26088
|
+
};
|
|
26089
|
+
};
|
|
26090
|
+
};
|
|
26091
|
+
/** @description Forbidden */
|
|
26092
|
+
403: {
|
|
26093
|
+
headers: {
|
|
26094
|
+
[name: string]: unknown;
|
|
26095
|
+
};
|
|
26096
|
+
content: {
|
|
26097
|
+
"application/json": {
|
|
26098
|
+
/**
|
|
26099
|
+
* @description A human-readable description of the error.
|
|
26100
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26101
|
+
*/
|
|
26102
|
+
message: string;
|
|
26103
|
+
};
|
|
26104
|
+
};
|
|
26105
|
+
};
|
|
26106
|
+
/** @description Not Found */
|
|
26107
|
+
404: {
|
|
26108
|
+
headers: {
|
|
26109
|
+
[name: string]: unknown;
|
|
26110
|
+
};
|
|
26111
|
+
content: {
|
|
26112
|
+
"application/json": {
|
|
26113
|
+
/**
|
|
26114
|
+
* @description A human-readable description of the error.
|
|
26115
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26116
|
+
*/
|
|
26117
|
+
message: string;
|
|
26118
|
+
};
|
|
26119
|
+
};
|
|
26120
|
+
};
|
|
26121
|
+
};
|
|
26122
|
+
};
|
|
26123
|
+
SamlSpSigningCertificatesController_create: {
|
|
26124
|
+
parameters: {
|
|
26125
|
+
query?: never;
|
|
26126
|
+
header?: never;
|
|
26127
|
+
path: {
|
|
26128
|
+
/** @description Unique identifier for the Connection. */
|
|
26129
|
+
connectionId: string;
|
|
26130
|
+
};
|
|
26131
|
+
cookie?: never;
|
|
26132
|
+
};
|
|
26133
|
+
requestBody?: never;
|
|
26134
|
+
responses: {
|
|
26135
|
+
/** @description Created */
|
|
26136
|
+
201: {
|
|
26137
|
+
headers: {
|
|
26138
|
+
[name: string]: unknown;
|
|
26139
|
+
};
|
|
26140
|
+
content: {
|
|
26141
|
+
"application/json": components["schemas"]["SamlSpSigningCertificate"];
|
|
26142
|
+
};
|
|
26143
|
+
};
|
|
26144
|
+
/** @description Bad Request */
|
|
26145
|
+
400: {
|
|
26146
|
+
headers: {
|
|
26147
|
+
[name: string]: unknown;
|
|
26148
|
+
};
|
|
26149
|
+
content: {
|
|
26150
|
+
"application/json": {
|
|
26151
|
+
/**
|
|
26152
|
+
* @description The error code identifying the type of error.
|
|
26153
|
+
* @example connection_is_not_saml
|
|
26154
|
+
* @constant
|
|
26155
|
+
*/
|
|
26156
|
+
code: "connection_is_not_saml";
|
|
26157
|
+
/**
|
|
26158
|
+
* @description A human-readable description of the error.
|
|
26159
|
+
* @example Request could not be processed.
|
|
26160
|
+
*/
|
|
26161
|
+
message: string;
|
|
26162
|
+
} | {
|
|
26163
|
+
/**
|
|
26164
|
+
* @description The error code identifying the type of error.
|
|
26165
|
+
* @example key_pair_not_accepted
|
|
26166
|
+
* @constant
|
|
26167
|
+
*/
|
|
26168
|
+
code: "key_pair_not_accepted";
|
|
26169
|
+
/**
|
|
26170
|
+
* @description A human-readable description of the error.
|
|
26171
|
+
* @example Request could not be processed.
|
|
26172
|
+
*/
|
|
26173
|
+
message: string;
|
|
26174
|
+
} | {
|
|
26175
|
+
/**
|
|
26176
|
+
* @description The error code identifying the type of error.
|
|
26177
|
+
* @example connection_type_not_supported
|
|
26178
|
+
* @constant
|
|
26179
|
+
*/
|
|
26180
|
+
code: "connection_type_not_supported";
|
|
26181
|
+
/**
|
|
26182
|
+
* @description A human-readable description of the error.
|
|
26183
|
+
* @example Request could not be processed.
|
|
26184
|
+
*/
|
|
26185
|
+
message: string;
|
|
26186
|
+
};
|
|
26187
|
+
};
|
|
26188
|
+
};
|
|
26189
|
+
/** @description Forbidden */
|
|
26190
|
+
403: {
|
|
26191
|
+
headers: {
|
|
26192
|
+
[name: string]: unknown;
|
|
26193
|
+
};
|
|
26194
|
+
content: {
|
|
26195
|
+
"application/json": {
|
|
26196
|
+
/**
|
|
26197
|
+
* @description A human-readable description of the error.
|
|
26198
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26199
|
+
*/
|
|
26200
|
+
message: string;
|
|
26201
|
+
};
|
|
26202
|
+
};
|
|
26203
|
+
};
|
|
26204
|
+
/** @description Not Found */
|
|
26205
|
+
404: {
|
|
26206
|
+
headers: {
|
|
26207
|
+
[name: string]: unknown;
|
|
26208
|
+
};
|
|
26209
|
+
content: {
|
|
26210
|
+
"application/json": {
|
|
26211
|
+
/**
|
|
26212
|
+
* @description A human-readable description of the error.
|
|
26213
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26214
|
+
*/
|
|
26215
|
+
message: string;
|
|
26216
|
+
};
|
|
26217
|
+
};
|
|
26218
|
+
};
|
|
26219
|
+
409: {
|
|
26220
|
+
headers: {
|
|
26221
|
+
[name: string]: unknown;
|
|
26222
|
+
};
|
|
26223
|
+
content: {
|
|
26224
|
+
"application/json": {
|
|
26225
|
+
/**
|
|
26226
|
+
* @description The error code identifying the type of error.
|
|
26227
|
+
* @example sp_signing_cert_already_exists
|
|
26228
|
+
* @constant
|
|
26229
|
+
*/
|
|
26230
|
+
code: "sp_signing_cert_already_exists";
|
|
26231
|
+
/**
|
|
26232
|
+
* @description A human-readable description of the error.
|
|
26233
|
+
* @example Request could not be processed.
|
|
26234
|
+
*/
|
|
26235
|
+
message: string;
|
|
26236
|
+
};
|
|
26237
|
+
};
|
|
26238
|
+
};
|
|
26239
|
+
503: {
|
|
26240
|
+
headers: {
|
|
26241
|
+
[name: string]: unknown;
|
|
26242
|
+
};
|
|
26243
|
+
content: {
|
|
26244
|
+
"application/json": {
|
|
26245
|
+
/**
|
|
26246
|
+
* @description The error code identifying the type of error.
|
|
26247
|
+
* @example concurrent_request
|
|
26248
|
+
* @constant
|
|
26249
|
+
*/
|
|
26250
|
+
code: "concurrent_request";
|
|
26251
|
+
/**
|
|
26252
|
+
* @description A human-readable description of the error.
|
|
26253
|
+
* @example Request could not be processed.
|
|
26254
|
+
*/
|
|
26255
|
+
message: string;
|
|
26256
|
+
};
|
|
26257
|
+
};
|
|
26258
|
+
};
|
|
26259
|
+
};
|
|
26260
|
+
};
|
|
26261
|
+
SamlSpSigningCertificatesController_delete: {
|
|
26262
|
+
parameters: {
|
|
26263
|
+
query?: never;
|
|
26264
|
+
header?: never;
|
|
26265
|
+
path: {
|
|
26266
|
+
/** @description Unique identifier for the Connection. */
|
|
26267
|
+
connectionId: string;
|
|
26268
|
+
/** @description Unique identifier for the Service Provider signing key pair. WorkOS holds the corresponding private key, which is never exposed. */
|
|
26269
|
+
certificateId: string;
|
|
26270
|
+
};
|
|
26271
|
+
cookie?: never;
|
|
26272
|
+
};
|
|
26273
|
+
requestBody?: never;
|
|
26274
|
+
responses: {
|
|
26275
|
+
/** @description No Content */
|
|
26276
|
+
204: {
|
|
26277
|
+
headers: {
|
|
26278
|
+
[name: string]: unknown;
|
|
26279
|
+
};
|
|
26280
|
+
content?: never;
|
|
26281
|
+
};
|
|
26282
|
+
/** @description Forbidden */
|
|
26283
|
+
403: {
|
|
26284
|
+
headers: {
|
|
26285
|
+
[name: string]: unknown;
|
|
26286
|
+
};
|
|
26287
|
+
content: {
|
|
26288
|
+
"application/json": {
|
|
26289
|
+
/**
|
|
26290
|
+
* @description A human-readable description of the error.
|
|
26291
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26292
|
+
*/
|
|
26293
|
+
message: string;
|
|
26294
|
+
};
|
|
26295
|
+
};
|
|
26296
|
+
};
|
|
26297
|
+
/** @description Not Found */
|
|
26298
|
+
404: {
|
|
26299
|
+
headers: {
|
|
26300
|
+
[name: string]: unknown;
|
|
26301
|
+
};
|
|
26302
|
+
content: {
|
|
26303
|
+
"application/json": {
|
|
26304
|
+
/**
|
|
26305
|
+
* @description A human-readable description of the error.
|
|
26306
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26307
|
+
*/
|
|
26308
|
+
message: string;
|
|
26309
|
+
};
|
|
26310
|
+
};
|
|
26311
|
+
};
|
|
26312
|
+
};
|
|
26313
|
+
};
|
|
26314
|
+
ConnectionsController_find: {
|
|
26315
|
+
parameters: {
|
|
26316
|
+
query?: never;
|
|
26317
|
+
header?: never;
|
|
26318
|
+
path: {
|
|
26319
|
+
/** @description Unique identifier for the Connection. */
|
|
26320
|
+
id: string;
|
|
26321
|
+
};
|
|
26322
|
+
cookie?: never;
|
|
26323
|
+
};
|
|
26324
|
+
requestBody?: never;
|
|
26325
|
+
responses: {
|
|
26326
|
+
/** @description OK */
|
|
26327
|
+
200: {
|
|
23995
26328
|
headers: {
|
|
23996
26329
|
[name: string]: unknown;
|
|
23997
26330
|
};
|
|
@@ -24089,6 +26422,263 @@ export interface operations {
|
|
|
24089
26422
|
};
|
|
24090
26423
|
};
|
|
24091
26424
|
};
|
|
26425
|
+
ConnectionsController_patch: {
|
|
26426
|
+
parameters: {
|
|
26427
|
+
query?: never;
|
|
26428
|
+
header?: never;
|
|
26429
|
+
path: {
|
|
26430
|
+
/** @description Unique identifier for the Connection. */
|
|
26431
|
+
id: string;
|
|
26432
|
+
};
|
|
26433
|
+
cookie?: never;
|
|
26434
|
+
};
|
|
26435
|
+
requestBody: {
|
|
26436
|
+
content: {
|
|
26437
|
+
"application/json": components["schemas"]["PatchConnectionDto"];
|
|
26438
|
+
};
|
|
26439
|
+
};
|
|
26440
|
+
responses: {
|
|
26441
|
+
/** @description OK */
|
|
26442
|
+
200: {
|
|
26443
|
+
headers: {
|
|
26444
|
+
[name: string]: unknown;
|
|
26445
|
+
};
|
|
26446
|
+
content: {
|
|
26447
|
+
"application/json": components["schemas"]["Connection"];
|
|
26448
|
+
};
|
|
26449
|
+
};
|
|
26450
|
+
/** @description Bad Request */
|
|
26451
|
+
400: {
|
|
26452
|
+
headers: {
|
|
26453
|
+
[name: string]: unknown;
|
|
26454
|
+
};
|
|
26455
|
+
content: {
|
|
26456
|
+
"application/json": {
|
|
26457
|
+
/**
|
|
26458
|
+
* @description The error code identifying the type of error.
|
|
26459
|
+
* @example external_id_already_in_use
|
|
26460
|
+
* @constant
|
|
26461
|
+
*/
|
|
26462
|
+
code: "external_id_already_in_use";
|
|
26463
|
+
/**
|
|
26464
|
+
* @description A human-readable description of the error.
|
|
26465
|
+
* @example Request could not be processed.
|
|
26466
|
+
*/
|
|
26467
|
+
message: string;
|
|
26468
|
+
} | {
|
|
26469
|
+
/**
|
|
26470
|
+
* @description The error code identifying the type of error.
|
|
26471
|
+
* @example connection_type_not_supported
|
|
26472
|
+
* @constant
|
|
26473
|
+
*/
|
|
26474
|
+
code: "connection_type_not_supported";
|
|
26475
|
+
/**
|
|
26476
|
+
* @description A human-readable description of the error.
|
|
26477
|
+
* @example Request could not be processed.
|
|
26478
|
+
*/
|
|
26479
|
+
message: string;
|
|
26480
|
+
} | {
|
|
26481
|
+
/**
|
|
26482
|
+
* @description The error code identifying the type of error.
|
|
26483
|
+
* @example connection_type_conflicts_with_options
|
|
26484
|
+
* @constant
|
|
26485
|
+
*/
|
|
26486
|
+
code: "connection_type_conflicts_with_options";
|
|
26487
|
+
/**
|
|
26488
|
+
* @description A human-readable description of the error.
|
|
26489
|
+
* @example Request could not be processed.
|
|
26490
|
+
*/
|
|
26491
|
+
message: string;
|
|
26492
|
+
} | {
|
|
26493
|
+
/**
|
|
26494
|
+
* @description The error code identifying the type of error.
|
|
26495
|
+
* @example both_saml_and_oidc_options_provided
|
|
26496
|
+
* @constant
|
|
26497
|
+
*/
|
|
26498
|
+
code: "both_saml_and_oidc_options_provided";
|
|
26499
|
+
/**
|
|
26500
|
+
* @description A human-readable description of the error.
|
|
26501
|
+
* @example Request could not be processed.
|
|
26502
|
+
*/
|
|
26503
|
+
message: string;
|
|
26504
|
+
} | {
|
|
26505
|
+
/**
|
|
26506
|
+
* @description The error code identifying the type of error.
|
|
26507
|
+
* @example ambiguous_saml_options
|
|
26508
|
+
* @constant
|
|
26509
|
+
*/
|
|
26510
|
+
code: "ambiguous_saml_options";
|
|
26511
|
+
/**
|
|
26512
|
+
* @description A human-readable description of the error.
|
|
26513
|
+
* @example Request could not be processed.
|
|
26514
|
+
*/
|
|
26515
|
+
message: string;
|
|
26516
|
+
} | {
|
|
26517
|
+
/**
|
|
26518
|
+
* @description The error code identifying the type of error.
|
|
26519
|
+
* @example token_authentication_method_not_supported
|
|
26520
|
+
* @constant
|
|
26521
|
+
*/
|
|
26522
|
+
code: "token_authentication_method_not_supported";
|
|
26523
|
+
/**
|
|
26524
|
+
* @description A human-readable description of the error.
|
|
26525
|
+
* @example Request could not be processed.
|
|
26526
|
+
*/
|
|
26527
|
+
message: string;
|
|
26528
|
+
} | {
|
|
26529
|
+
/**
|
|
26530
|
+
* @description The error code identifying the type of error.
|
|
26531
|
+
* @example id_token_signature_algorithm_not_supported
|
|
26532
|
+
* @constant
|
|
26533
|
+
*/
|
|
26534
|
+
code: "id_token_signature_algorithm_not_supported";
|
|
26535
|
+
/**
|
|
26536
|
+
* @description A human-readable description of the error.
|
|
26537
|
+
* @example Request could not be processed.
|
|
26538
|
+
*/
|
|
26539
|
+
message: string;
|
|
26540
|
+
} | {
|
|
26541
|
+
/**
|
|
26542
|
+
* @description The error code identifying the type of error.
|
|
26543
|
+
* @example client_secret_required
|
|
26544
|
+
* @constant
|
|
26545
|
+
*/
|
|
26546
|
+
code: "client_secret_required";
|
|
26547
|
+
/**
|
|
26548
|
+
* @description A human-readable description of the error.
|
|
26549
|
+
* @example Request could not be processed.
|
|
26550
|
+
*/
|
|
26551
|
+
message: string;
|
|
26552
|
+
} | {
|
|
26553
|
+
/**
|
|
26554
|
+
* @description The error code identifying the type of error.
|
|
26555
|
+
* @example client_secret_not_accepted
|
|
26556
|
+
* @constant
|
|
26557
|
+
*/
|
|
26558
|
+
code: "client_secret_not_accepted";
|
|
26559
|
+
/**
|
|
26560
|
+
* @description A human-readable description of the error.
|
|
26561
|
+
* @example Request could not be processed.
|
|
26562
|
+
*/
|
|
26563
|
+
message: string;
|
|
26564
|
+
} | {
|
|
26565
|
+
/**
|
|
26566
|
+
* @description The error code identifying the type of error.
|
|
26567
|
+
* @example discovery_endpoint_must_use_https
|
|
26568
|
+
* @constant
|
|
26569
|
+
*/
|
|
26570
|
+
code: "discovery_endpoint_must_use_https";
|
|
26571
|
+
/**
|
|
26572
|
+
* @description A human-readable description of the error.
|
|
26573
|
+
* @example Request could not be processed.
|
|
26574
|
+
*/
|
|
26575
|
+
message: string;
|
|
26576
|
+
};
|
|
26577
|
+
};
|
|
26578
|
+
};
|
|
26579
|
+
/** @description Forbidden */
|
|
26580
|
+
403: {
|
|
26581
|
+
headers: {
|
|
26582
|
+
[name: string]: unknown;
|
|
26583
|
+
};
|
|
26584
|
+
content: {
|
|
26585
|
+
"application/json": {
|
|
26586
|
+
/**
|
|
26587
|
+
* @description A human-readable description of the error.
|
|
26588
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26589
|
+
*/
|
|
26590
|
+
message: string;
|
|
26591
|
+
};
|
|
26592
|
+
};
|
|
26593
|
+
};
|
|
26594
|
+
/** @description Not Found */
|
|
26595
|
+
404: {
|
|
26596
|
+
headers: {
|
|
26597
|
+
[name: string]: unknown;
|
|
26598
|
+
};
|
|
26599
|
+
content: {
|
|
26600
|
+
"application/json": {
|
|
26601
|
+
/**
|
|
26602
|
+
* @description A human-readable description of the error.
|
|
26603
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26604
|
+
*/
|
|
26605
|
+
message: string;
|
|
26606
|
+
};
|
|
26607
|
+
};
|
|
26608
|
+
};
|
|
26609
|
+
409: {
|
|
26610
|
+
headers: {
|
|
26611
|
+
[name: string]: unknown;
|
|
26612
|
+
};
|
|
26613
|
+
content: {
|
|
26614
|
+
"application/json": {
|
|
26615
|
+
/**
|
|
26616
|
+
* @description The error code identifying the type of error.
|
|
26617
|
+
* @example connection_deletion_in_progress
|
|
26618
|
+
* @constant
|
|
26619
|
+
*/
|
|
26620
|
+
code: "connection_deletion_in_progress";
|
|
26621
|
+
/**
|
|
26622
|
+
* @description A human-readable description of the error.
|
|
26623
|
+
* @example Request could not be processed.
|
|
26624
|
+
*/
|
|
26625
|
+
message: string;
|
|
26626
|
+
};
|
|
26627
|
+
};
|
|
26628
|
+
};
|
|
26629
|
+
/** @description Unprocessable Entity */
|
|
26630
|
+
422: {
|
|
26631
|
+
headers: {
|
|
26632
|
+
[name: string]: unknown;
|
|
26633
|
+
};
|
|
26634
|
+
content: {
|
|
26635
|
+
"application/json": {
|
|
26636
|
+
/**
|
|
26637
|
+
* @description A human-readable description of the error.
|
|
26638
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
26639
|
+
*/
|
|
26640
|
+
message: string;
|
|
26641
|
+
} | {
|
|
26642
|
+
/**
|
|
26643
|
+
* @description The error code identifying the type of error.
|
|
26644
|
+
* @example connection_type_not_updatable
|
|
26645
|
+
* @constant
|
|
26646
|
+
*/
|
|
26647
|
+
code: "connection_type_not_updatable";
|
|
26648
|
+
/**
|
|
26649
|
+
* @description A human-readable description of the error.
|
|
26650
|
+
* @example Request could not be processed.
|
|
26651
|
+
*/
|
|
26652
|
+
message: string;
|
|
26653
|
+
} | {
|
|
26654
|
+
/**
|
|
26655
|
+
* @description The error code identifying the type of error.
|
|
26656
|
+
* @example idp_metadata_fetch_failed
|
|
26657
|
+
* @constant
|
|
26658
|
+
*/
|
|
26659
|
+
code: "idp_metadata_fetch_failed";
|
|
26660
|
+
/**
|
|
26661
|
+
* @description A human-readable description of the error.
|
|
26662
|
+
* @example Request could not be processed.
|
|
26663
|
+
*/
|
|
26664
|
+
message: string;
|
|
26665
|
+
} | {
|
|
26666
|
+
/**
|
|
26667
|
+
* @description The error code identifying the type of error.
|
|
26668
|
+
* @example connection_could_not_be_verified
|
|
26669
|
+
* @constant
|
|
26670
|
+
*/
|
|
26671
|
+
code: "connection_could_not_be_verified";
|
|
26672
|
+
/**
|
|
26673
|
+
* @description A human-readable description of the error.
|
|
26674
|
+
* @example Request could not be processed.
|
|
26675
|
+
*/
|
|
26676
|
+
message: string;
|
|
26677
|
+
};
|
|
26678
|
+
};
|
|
26679
|
+
};
|
|
26680
|
+
};
|
|
26681
|
+
};
|
|
24092
26682
|
DataIntegrationsManagementController_listDataIntegrations: {
|
|
24093
26683
|
parameters: {
|
|
24094
26684
|
query?: {
|
|
@@ -24098,7 +26688,7 @@ export interface operations {
|
|
|
24098
26688
|
after?: string;
|
|
24099
26689
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
24100
26690
|
limit?: number;
|
|
24101
|
-
/** @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). */
|
|
26691
|
+
/** @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). Defaults to `normal`. */
|
|
24102
26692
|
order?: components["schemas"]["PaginationOrder"];
|
|
24103
26693
|
};
|
|
24104
26694
|
header?: never;
|
|
@@ -24672,7 +27262,7 @@ export interface operations {
|
|
|
24672
27262
|
/**
|
|
24673
27263
|
* @description Provider-specific configuration values collected for this installation, keyed by the provider's config field descriptors.
|
|
24674
27264
|
* @example {
|
|
24675
|
-
* "
|
|
27265
|
+
* "salesforce_host": "acme.my.salesforce.com"
|
|
24676
27266
|
* }
|
|
24677
27267
|
*/
|
|
24678
27268
|
config?: {
|
|
@@ -24966,7 +27556,7 @@ export interface operations {
|
|
|
24966
27556
|
after?: string;
|
|
24967
27557
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
24968
27558
|
limit?: number;
|
|
24969
|
-
/** @description Order the results by the creation time. */
|
|
27559
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
24970
27560
|
order?: components["schemas"]["PaginationOrder"];
|
|
24971
27561
|
/** @description Filter Directories by their associated organization. */
|
|
24972
27562
|
organization_id?: string;
|
|
@@ -25131,7 +27721,7 @@ export interface operations {
|
|
|
25131
27721
|
after?: string;
|
|
25132
27722
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25133
27723
|
limit?: number;
|
|
25134
|
-
/** @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). */
|
|
27724
|
+
/** @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). Defaults to `normal`. */
|
|
25135
27725
|
order?: components["schemas"]["PaginationOrder"];
|
|
25136
27726
|
/** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
|
|
25137
27727
|
directory?: string;
|
|
@@ -25262,7 +27852,7 @@ export interface operations {
|
|
|
25262
27852
|
after?: string;
|
|
25263
27853
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25264
27854
|
limit?: number;
|
|
25265
|
-
/** @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). */
|
|
27855
|
+
/** @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). Defaults to `normal`. */
|
|
25266
27856
|
order?: components["schemas"]["PaginationOrder"];
|
|
25267
27857
|
/** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
|
|
25268
27858
|
directory?: string;
|
|
@@ -25405,7 +27995,7 @@ export interface operations {
|
|
|
25405
27995
|
after?: string;
|
|
25406
27996
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25407
27997
|
limit?: number;
|
|
25408
|
-
/** @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). */
|
|
27998
|
+
/** @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). Defaults to `normal`. */
|
|
25409
27999
|
order?: components["schemas"]["PaginationOrder"];
|
|
25410
28000
|
/** @description Filter events by one or more event types (e.g. `dsync.user.created`). */
|
|
25411
28001
|
events: string[];
|
|
@@ -25485,7 +28075,7 @@ export interface operations {
|
|
|
25485
28075
|
after?: string;
|
|
25486
28076
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25487
28077
|
limit?: number;
|
|
25488
|
-
/** @description Order the results by the creation time. */
|
|
28078
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
25489
28079
|
order?: components["schemas"]["PaginationOrder"];
|
|
25490
28080
|
};
|
|
25491
28081
|
header?: never;
|
|
@@ -26196,7 +28786,7 @@ export interface operations {
|
|
|
26196
28786
|
after?: string;
|
|
26197
28787
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26198
28788
|
limit?: number;
|
|
26199
|
-
/** @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). */
|
|
28789
|
+
/** @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). Defaults to `normal`. */
|
|
26200
28790
|
order?: components["schemas"]["PaginationOrder"];
|
|
26201
28791
|
/** @description The domains of an Organization. Any Organization with a matching domain will be returned. */
|
|
26202
28792
|
domains?: string[];
|
|
@@ -26770,7 +29360,7 @@ export interface operations {
|
|
|
26770
29360
|
after?: string;
|
|
26771
29361
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26772
29362
|
limit?: number;
|
|
26773
|
-
/** @description Order the results by the creation time. */
|
|
29363
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
26774
29364
|
order?: components["schemas"]["PaginationOrder"];
|
|
26775
29365
|
};
|
|
26776
29366
|
header?: never;
|
|
@@ -27013,7 +29603,7 @@ export interface operations {
|
|
|
27013
29603
|
after?: string;
|
|
27014
29604
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27015
29605
|
limit?: number;
|
|
27016
|
-
/** @description Order the results by the creation time. */
|
|
29606
|
+
/** @description Order the results by the creation time. Defaults to `desc`. */
|
|
27017
29607
|
order?: components["schemas"]["PaginationOrder"];
|
|
27018
29608
|
};
|
|
27019
29609
|
header?: never;
|
|
@@ -27060,7 +29650,7 @@ export interface operations {
|
|
|
27060
29650
|
after?: string;
|
|
27061
29651
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27062
29652
|
limit?: number;
|
|
27063
|
-
/** @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). */
|
|
29653
|
+
/** @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). Defaults to `normal`. */
|
|
27064
29654
|
order?: components["schemas"]["PaginationOrder"];
|
|
27065
29655
|
/** @description Search groups by name or by group ID. */
|
|
27066
29656
|
search?: string;
|
|
@@ -27420,7 +30010,7 @@ export interface operations {
|
|
|
27420
30010
|
after?: string;
|
|
27421
30011
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27422
30012
|
limit?: number;
|
|
27423
|
-
/** @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). */
|
|
30013
|
+
/** @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). Defaults to `normal`. */
|
|
27424
30014
|
order?: components["schemas"]["PaginationOrder"];
|
|
27425
30015
|
};
|
|
27426
30016
|
header?: never;
|
|
@@ -27634,7 +30224,7 @@ export interface operations {
|
|
|
27634
30224
|
after?: string;
|
|
27635
30225
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27636
30226
|
limit?: number;
|
|
27637
|
-
/** @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). */
|
|
30227
|
+
/** @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). Defaults to `normal`. */
|
|
27638
30228
|
order?: components["schemas"]["PaginationOrder"];
|
|
27639
30229
|
};
|
|
27640
30230
|
header?: never;
|
|
@@ -30189,7 +32779,7 @@ export interface operations {
|
|
|
30189
32779
|
after?: string;
|
|
30190
32780
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
30191
32781
|
limit?: number;
|
|
30192
|
-
/** @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). */
|
|
32782
|
+
/** @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). Defaults to `normal`. */
|
|
30193
32783
|
order?: components["schemas"]["PaginationOrder"];
|
|
30194
32784
|
};
|
|
30195
32785
|
header?: never;
|
|
@@ -30361,7 +32951,7 @@ export interface operations {
|
|
|
30361
32951
|
after?: string;
|
|
30362
32952
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
30363
32953
|
limit?: number;
|
|
30364
|
-
/** @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). */
|
|
32954
|
+
/** @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). Defaults to `desc`. */
|
|
30365
32955
|
order?: components["schemas"]["PaginationOrder"];
|
|
30366
32956
|
/** @description The ID of the [organization](/reference/organization) that the recipient will join. */
|
|
30367
32957
|
organization_id?: string;
|
|
@@ -31279,7 +33869,7 @@ export interface operations {
|
|
|
31279
33869
|
after?: string;
|
|
31280
33870
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
31281
33871
|
limit?: number;
|
|
31282
|
-
/** @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). */
|
|
33872
|
+
/** @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). Defaults to `desc`. */
|
|
31283
33873
|
order?: components["schemas"]["PaginationOrder"];
|
|
31284
33874
|
/** @description The ID of the [organization](/reference/organization) which the user belongs to. */
|
|
31285
33875
|
organization_id?: string;
|
|
@@ -31969,7 +34559,7 @@ export interface operations {
|
|
|
31969
34559
|
after?: string;
|
|
31970
34560
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
31971
34561
|
limit?: number;
|
|
31972
|
-
/** @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). */
|
|
34562
|
+
/** @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). Defaults to `normal`. */
|
|
31973
34563
|
order?: components["schemas"]["PaginationOrder"];
|
|
31974
34564
|
};
|
|
31975
34565
|
header?: never;
|
|
@@ -32344,7 +34934,7 @@ export interface operations {
|
|
|
32344
34934
|
after?: string;
|
|
32345
34935
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
32346
34936
|
limit?: number;
|
|
32347
|
-
/** @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). */
|
|
34937
|
+
/** @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). Defaults to `normal`. */
|
|
32348
34938
|
order?: components["schemas"]["PaginationOrder"];
|
|
32349
34939
|
};
|
|
32350
34940
|
header?: never;
|
|
@@ -32673,7 +35263,7 @@ export interface operations {
|
|
|
32673
35263
|
after?: string;
|
|
32674
35264
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
32675
35265
|
limit?: number;
|
|
32676
|
-
/** @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). */
|
|
35266
|
+
/** @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). Defaults to `desc`. */
|
|
32677
35267
|
order?: components["schemas"]["PaginationOrder"];
|
|
32678
35268
|
/**
|
|
32679
35269
|
* @deprecated
|
|
@@ -33900,7 +36490,7 @@ export interface operations {
|
|
|
33900
36490
|
after?: string;
|
|
33901
36491
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
33902
36492
|
limit?: number;
|
|
33903
|
-
/** @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). */
|
|
36493
|
+
/** @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). Defaults to `desc`. */
|
|
33904
36494
|
order?: components["schemas"]["PaginationOrder"];
|
|
33905
36495
|
};
|
|
33906
36496
|
header?: never;
|
|
@@ -34070,7 +36660,7 @@ export interface operations {
|
|
|
34070
36660
|
after?: string;
|
|
34071
36661
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34072
36662
|
limit?: number;
|
|
34073
|
-
/** @description Order the results by the creation time. */
|
|
36663
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
34074
36664
|
order?: components["schemas"]["PaginationOrder"];
|
|
34075
36665
|
/** @description The ID of the organization to filter user API keys by. When provided, only API keys created against that organization membership are returned. */
|
|
34076
36666
|
organization_id?: string;
|
|
@@ -34204,7 +36794,7 @@ export interface operations {
|
|
|
34204
36794
|
after?: string;
|
|
34205
36795
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34206
36796
|
limit?: number;
|
|
34207
|
-
/** @description Order the results by the creation time. */
|
|
36797
|
+
/** @description Order the results by the creation time. Defaults to `desc`. */
|
|
34208
36798
|
order?: components["schemas"]["PaginationOrder"];
|
|
34209
36799
|
};
|
|
34210
36800
|
header?: never;
|
|
@@ -34251,7 +36841,7 @@ export interface operations {
|
|
|
34251
36841
|
after?: string;
|
|
34252
36842
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34253
36843
|
limit?: number;
|
|
34254
|
-
/** @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). */
|
|
36844
|
+
/** @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). Defaults to `normal`. */
|
|
34255
36845
|
order?: components["schemas"]["PaginationOrder"];
|
|
34256
36846
|
};
|
|
34257
36847
|
header?: never;
|
|
@@ -34635,7 +37225,7 @@ export interface operations {
|
|
|
34635
37225
|
after?: string;
|
|
34636
37226
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34637
37227
|
limit?: number;
|
|
34638
|
-
/** @description Order the results by the creation time. */
|
|
37228
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
34639
37229
|
order?: components["schemas"]["PaginationOrder"];
|
|
34640
37230
|
};
|
|
34641
37231
|
header?: never;
|
|
@@ -35035,7 +37625,7 @@ export interface operations {
|
|
|
35035
37625
|
query?: never;
|
|
35036
37626
|
header?: never;
|
|
35037
37627
|
path: {
|
|
35038
|
-
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. */
|
|
37628
|
+
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. The default waitlist is created when its first entry is added, so read requests for `default` return a `404` until then. */
|
|
35039
37629
|
id: string;
|
|
35040
37630
|
};
|
|
35041
37631
|
cookie?: never;
|
|
@@ -35077,7 +37667,7 @@ export interface operations {
|
|
|
35077
37667
|
after?: string;
|
|
35078
37668
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
35079
37669
|
limit?: number;
|
|
35080
|
-
/** @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). */
|
|
37670
|
+
/** @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). Defaults to `normal`. */
|
|
35081
37671
|
order?: components["schemas"]["PaginationOrder"];
|
|
35082
37672
|
/** @description Filter waitlist entries by their state. */
|
|
35083
37673
|
state?: "pending" | "approved" | "denied";
|
|
@@ -35086,7 +37676,7 @@ export interface operations {
|
|
|
35086
37676
|
};
|
|
35087
37677
|
header?: never;
|
|
35088
37678
|
path: {
|
|
35089
|
-
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. */
|
|
37679
|
+
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. The default waitlist is created when its first entry is added, so read requests for `default` return a `404` until then. */
|
|
35090
37680
|
id: string;
|
|
35091
37681
|
};
|
|
35092
37682
|
cookie?: never;
|
|
@@ -35167,7 +37757,7 @@ export interface operations {
|
|
|
35167
37757
|
query?: never;
|
|
35168
37758
|
header?: never;
|
|
35169
37759
|
path: {
|
|
35170
|
-
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. */
|
|
37760
|
+
/** @description The unique ID of the waitlist, or the literal `default` for the environment's default waitlist. Use `default` when adding the first entry — the default waitlist is created automatically. */
|
|
35171
37761
|
id: string;
|
|
35172
37762
|
};
|
|
35173
37763
|
cookie?: never;
|
|
@@ -35723,7 +38313,7 @@ export interface operations {
|
|
|
35723
38313
|
after?: string;
|
|
35724
38314
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
35725
38315
|
limit?: number;
|
|
35726
|
-
/** @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). */
|
|
38316
|
+
/** @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). Defaults to `normal`. */
|
|
35727
38317
|
order?: components["schemas"]["PaginationOrder"];
|
|
35728
38318
|
};
|
|
35729
38319
|
header?: never;
|