@workos/openapi-spec 0.67.0 → 0.69.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 +579 -76
- package/dist/policy.mjs +10 -0
- package/dist/types.d.ts +428 -53
- package/package.json +5 -5
package/dist/types.d.ts
CHANGED
|
@@ -3605,7 +3605,6 @@ export interface components {
|
|
|
3605
3605
|
expires_at?: string | null;
|
|
3606
3606
|
};
|
|
3607
3607
|
/**
|
|
3608
|
-
* @default desc
|
|
3609
3608
|
* @example desc
|
|
3610
3609
|
* @enum {string}
|
|
3611
3610
|
*/
|
|
@@ -4527,19 +4526,19 @@ export interface components {
|
|
|
4527
4526
|
name: string;
|
|
4528
4527
|
/**
|
|
4529
4528
|
* Format: uri
|
|
4530
|
-
* @description The provider's OAuth authorization endpoint. Required for OAuth providers; omit for `api_key` providers.
|
|
4529
|
+
* @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
4530
|
* @example https://provider.example.com/oauth/authorize
|
|
4532
4531
|
*/
|
|
4533
4532
|
authorization_url?: string;
|
|
4534
4533
|
/**
|
|
4535
4534
|
* Format: uri
|
|
4536
|
-
* @description The provider's OAuth token endpoint. Required for OAuth providers; omit for `api_key` providers.
|
|
4535
|
+
* @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
4536
|
* @example https://provider.example.com/oauth/token
|
|
4538
4537
|
*/
|
|
4539
4538
|
token_url?: string;
|
|
4540
4539
|
/**
|
|
4541
4540
|
* Format: uri
|
|
4542
|
-
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
4541
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint. Must be a static URL, like the other endpoints.
|
|
4543
4542
|
* @example https://provider.example.com/oauth/token
|
|
4544
4543
|
*/
|
|
4545
4544
|
refresh_token_url?: string | null;
|
|
@@ -4639,19 +4638,19 @@ export interface components {
|
|
|
4639
4638
|
name?: string;
|
|
4640
4639
|
/**
|
|
4641
4640
|
* Format: uri
|
|
4642
|
-
* @description The provider's OAuth authorization endpoint.
|
|
4641
|
+
* @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
4642
|
* @example https://provider.example.com/oauth/authorize
|
|
4644
4643
|
*/
|
|
4645
4644
|
authorization_url?: string;
|
|
4646
4645
|
/**
|
|
4647
4646
|
* Format: uri
|
|
4648
|
-
* @description The provider's OAuth token endpoint.
|
|
4647
|
+
* @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
4648
|
* @example https://provider.example.com/oauth/token
|
|
4650
4649
|
*/
|
|
4651
4650
|
token_url?: string;
|
|
4652
4651
|
/**
|
|
4653
4652
|
* Format: uri
|
|
4654
|
-
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
4653
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint. Must be a static URL, like the other endpoints.
|
|
4655
4654
|
* @example https://provider.example.com/oauth/token
|
|
4656
4655
|
*/
|
|
4657
4656
|
refresh_token_url?: string | null;
|
|
@@ -5239,7 +5238,7 @@ export interface components {
|
|
|
5239
5238
|
* "dsync.user.created"
|
|
5240
5239
|
* ]
|
|
5241
5240
|
*/
|
|
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")[];
|
|
5241
|
+
events: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "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
5242
|
};
|
|
5244
5243
|
UpdateWebhookEndpointDto: {
|
|
5245
5244
|
/**
|
|
@@ -5260,7 +5259,7 @@ export interface components {
|
|
|
5260
5259
|
* "dsync.user.created"
|
|
5261
5260
|
* ]
|
|
5262
5261
|
*/
|
|
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")[];
|
|
5262
|
+
events?: ("agent.blueprint.created" | "agent.blueprint.deleted" | "agent.blueprint.updated" | "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
5263
|
};
|
|
5265
5264
|
WidgetSessionTokenDto: {
|
|
5266
5265
|
/**
|
|
@@ -8195,6 +8194,246 @@ export interface components {
|
|
|
8195
8194
|
* @constant
|
|
8196
8195
|
*/
|
|
8197
8196
|
object: "event";
|
|
8197
|
+
} | {
|
|
8198
|
+
/**
|
|
8199
|
+
* @description Unique identifier for the event.
|
|
8200
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8201
|
+
*/
|
|
8202
|
+
id: string;
|
|
8203
|
+
/** @constant */
|
|
8204
|
+
event: "agent.blueprint.created";
|
|
8205
|
+
/** @description The event payload. */
|
|
8206
|
+
data: {
|
|
8207
|
+
/**
|
|
8208
|
+
* @description Distinguishes the agent blueprint object.
|
|
8209
|
+
* @constant
|
|
8210
|
+
*/
|
|
8211
|
+
object: "agent_blueprint";
|
|
8212
|
+
/**
|
|
8213
|
+
* @description Unique identifier of the agent blueprint.
|
|
8214
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8215
|
+
*/
|
|
8216
|
+
id: string;
|
|
8217
|
+
/**
|
|
8218
|
+
* @description Human-readable name of the agent blueprint.
|
|
8219
|
+
* @example Prospecting Agent
|
|
8220
|
+
*/
|
|
8221
|
+
name: string;
|
|
8222
|
+
/**
|
|
8223
|
+
* @description Human-readable description of the agent blueprint.
|
|
8224
|
+
* @example Finds and qualifies sales prospects.
|
|
8225
|
+
*/
|
|
8226
|
+
description: string | null;
|
|
8227
|
+
/**
|
|
8228
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
|
|
8229
|
+
* @example [
|
|
8230
|
+
* "crm:read",
|
|
8231
|
+
* "email:send"
|
|
8232
|
+
* ]
|
|
8233
|
+
*/
|
|
8234
|
+
permissions: string[];
|
|
8235
|
+
/** @description Who may mint sessions from this blueprint. */
|
|
8236
|
+
invocable_by: {
|
|
8237
|
+
/**
|
|
8238
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint.
|
|
8239
|
+
* @example [
|
|
8240
|
+
* "manager"
|
|
8241
|
+
* ]
|
|
8242
|
+
*/
|
|
8243
|
+
role_slugs: string[];
|
|
8244
|
+
/**
|
|
8245
|
+
* @description Organizations in which autonomous sessions may be minted from this blueprint.
|
|
8246
|
+
* @example [
|
|
8247
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
8248
|
+
* ]
|
|
8249
|
+
*/
|
|
8250
|
+
organization_ids: string[];
|
|
8251
|
+
};
|
|
8252
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
8253
|
+
session_settings: {
|
|
8254
|
+
/**
|
|
8255
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this.
|
|
8256
|
+
* @example 3600
|
|
8257
|
+
*/
|
|
8258
|
+
max_age_seconds: number;
|
|
8259
|
+
/**
|
|
8260
|
+
* @description Lifetime of each minted access token in seconds.
|
|
8261
|
+
* @example 300
|
|
8262
|
+
*/
|
|
8263
|
+
access_token_ttl_seconds: number;
|
|
8264
|
+
/**
|
|
8265
|
+
* @description Lifetime of each rotated refresh token in seconds.
|
|
8266
|
+
* @example 3600
|
|
8267
|
+
*/
|
|
8268
|
+
refresh_token_ttl_seconds: number;
|
|
8269
|
+
};
|
|
8270
|
+
/**
|
|
8271
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8272
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8273
|
+
*/
|
|
8274
|
+
created_at: string;
|
|
8275
|
+
/**
|
|
8276
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8277
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8278
|
+
*/
|
|
8279
|
+
updated_at: string;
|
|
8280
|
+
};
|
|
8281
|
+
/**
|
|
8282
|
+
* Format: date-time
|
|
8283
|
+
* @description An ISO 8601 timestamp.
|
|
8284
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8285
|
+
*/
|
|
8286
|
+
created_at: string;
|
|
8287
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8288
|
+
/**
|
|
8289
|
+
* @description Distinguishes the Event object.
|
|
8290
|
+
* @constant
|
|
8291
|
+
*/
|
|
8292
|
+
object: "event";
|
|
8293
|
+
} | {
|
|
8294
|
+
/**
|
|
8295
|
+
* @description Unique identifier for the event.
|
|
8296
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8297
|
+
*/
|
|
8298
|
+
id: string;
|
|
8299
|
+
/** @constant */
|
|
8300
|
+
event: "agent.blueprint.deleted";
|
|
8301
|
+
/** @description The event payload. */
|
|
8302
|
+
data: {
|
|
8303
|
+
/**
|
|
8304
|
+
* @description Distinguishes the agent blueprint object.
|
|
8305
|
+
* @constant
|
|
8306
|
+
*/
|
|
8307
|
+
object: "agent_blueprint";
|
|
8308
|
+
/**
|
|
8309
|
+
* @description Unique identifier of the agent blueprint.
|
|
8310
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8311
|
+
*/
|
|
8312
|
+
id: string;
|
|
8313
|
+
/**
|
|
8314
|
+
* @description Human-readable name of the agent blueprint.
|
|
8315
|
+
* @example Prospecting Agent
|
|
8316
|
+
*/
|
|
8317
|
+
name: string;
|
|
8318
|
+
/**
|
|
8319
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8320
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8321
|
+
*/
|
|
8322
|
+
created_at: string;
|
|
8323
|
+
/**
|
|
8324
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8325
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8326
|
+
*/
|
|
8327
|
+
updated_at: string;
|
|
8328
|
+
};
|
|
8329
|
+
/**
|
|
8330
|
+
* Format: date-time
|
|
8331
|
+
* @description An ISO 8601 timestamp.
|
|
8332
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8333
|
+
*/
|
|
8334
|
+
created_at: string;
|
|
8335
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8336
|
+
/**
|
|
8337
|
+
* @description Distinguishes the Event object.
|
|
8338
|
+
* @constant
|
|
8339
|
+
*/
|
|
8340
|
+
object: "event";
|
|
8341
|
+
} | {
|
|
8342
|
+
/**
|
|
8343
|
+
* @description Unique identifier for the event.
|
|
8344
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
8345
|
+
*/
|
|
8346
|
+
id: string;
|
|
8347
|
+
/** @constant */
|
|
8348
|
+
event: "agent.blueprint.updated";
|
|
8349
|
+
/** @description The event payload. */
|
|
8350
|
+
data: {
|
|
8351
|
+
/**
|
|
8352
|
+
* @description Distinguishes the agent blueprint object.
|
|
8353
|
+
* @constant
|
|
8354
|
+
*/
|
|
8355
|
+
object: "agent_blueprint";
|
|
8356
|
+
/**
|
|
8357
|
+
* @description Unique identifier of the agent blueprint.
|
|
8358
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
8359
|
+
*/
|
|
8360
|
+
id: string;
|
|
8361
|
+
/**
|
|
8362
|
+
* @description Human-readable name of the agent blueprint.
|
|
8363
|
+
* @example Prospecting Agent
|
|
8364
|
+
*/
|
|
8365
|
+
name: string;
|
|
8366
|
+
/**
|
|
8367
|
+
* @description Human-readable description of the agent blueprint.
|
|
8368
|
+
* @example Finds and qualifies sales prospects.
|
|
8369
|
+
*/
|
|
8370
|
+
description: string | null;
|
|
8371
|
+
/**
|
|
8372
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
|
|
8373
|
+
* @example [
|
|
8374
|
+
* "crm:read",
|
|
8375
|
+
* "email:send"
|
|
8376
|
+
* ]
|
|
8377
|
+
*/
|
|
8378
|
+
permissions: string[];
|
|
8379
|
+
/** @description Who may mint sessions from this blueprint. */
|
|
8380
|
+
invocable_by: {
|
|
8381
|
+
/**
|
|
8382
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint.
|
|
8383
|
+
* @example [
|
|
8384
|
+
* "manager"
|
|
8385
|
+
* ]
|
|
8386
|
+
*/
|
|
8387
|
+
role_slugs: string[];
|
|
8388
|
+
/**
|
|
8389
|
+
* @description Organizations in which autonomous sessions may be minted from this blueprint.
|
|
8390
|
+
* @example [
|
|
8391
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
8392
|
+
* ]
|
|
8393
|
+
*/
|
|
8394
|
+
organization_ids: string[];
|
|
8395
|
+
};
|
|
8396
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
8397
|
+
session_settings: {
|
|
8398
|
+
/**
|
|
8399
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this.
|
|
8400
|
+
* @example 3600
|
|
8401
|
+
*/
|
|
8402
|
+
max_age_seconds: number;
|
|
8403
|
+
/**
|
|
8404
|
+
* @description Lifetime of each minted access token in seconds.
|
|
8405
|
+
* @example 300
|
|
8406
|
+
*/
|
|
8407
|
+
access_token_ttl_seconds: number;
|
|
8408
|
+
/**
|
|
8409
|
+
* @description Lifetime of each rotated refresh token in seconds.
|
|
8410
|
+
* @example 3600
|
|
8411
|
+
*/
|
|
8412
|
+
refresh_token_ttl_seconds: number;
|
|
8413
|
+
};
|
|
8414
|
+
/**
|
|
8415
|
+
* @description The timestamp when the agent blueprint was created.
|
|
8416
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8417
|
+
*/
|
|
8418
|
+
created_at: string;
|
|
8419
|
+
/**
|
|
8420
|
+
* @description The timestamp when the agent blueprint was last updated.
|
|
8421
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8422
|
+
*/
|
|
8423
|
+
updated_at: string;
|
|
8424
|
+
};
|
|
8425
|
+
/**
|
|
8426
|
+
* Format: date-time
|
|
8427
|
+
* @description An ISO 8601 timestamp.
|
|
8428
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
8429
|
+
*/
|
|
8430
|
+
created_at: string;
|
|
8431
|
+
context?: components["schemas"]["EventContextDto"];
|
|
8432
|
+
/**
|
|
8433
|
+
* @description Distinguishes the Event object.
|
|
8434
|
+
* @constant
|
|
8435
|
+
*/
|
|
8436
|
+
object: "event";
|
|
8198
8437
|
} | {
|
|
8199
8438
|
/**
|
|
8200
8439
|
* @description Unique identifier for the event.
|
|
@@ -13962,6 +14201,142 @@ export interface components {
|
|
|
13962
14201
|
* @constant
|
|
13963
14202
|
*/
|
|
13964
14203
|
object: "event";
|
|
14204
|
+
} | {
|
|
14205
|
+
/**
|
|
14206
|
+
* @description Unique identifier for the event.
|
|
14207
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14208
|
+
*/
|
|
14209
|
+
id: string;
|
|
14210
|
+
/** @constant */
|
|
14211
|
+
event: "resource_export.completed";
|
|
14212
|
+
/** @description The event payload. */
|
|
14213
|
+
data: {
|
|
14214
|
+
/**
|
|
14215
|
+
* @description The ID of the resource export.
|
|
14216
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14217
|
+
*/
|
|
14218
|
+
id: string;
|
|
14219
|
+
/**
|
|
14220
|
+
* @description The type of resource being exported.
|
|
14221
|
+
* @example users
|
|
14222
|
+
* @enum {string}
|
|
14223
|
+
*/
|
|
14224
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14225
|
+
};
|
|
14226
|
+
/**
|
|
14227
|
+
* Format: date-time
|
|
14228
|
+
* @description An ISO 8601 timestamp.
|
|
14229
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14230
|
+
*/
|
|
14231
|
+
created_at: string;
|
|
14232
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14233
|
+
/**
|
|
14234
|
+
* @description Distinguishes the Event object.
|
|
14235
|
+
* @constant
|
|
14236
|
+
*/
|
|
14237
|
+
object: "event";
|
|
14238
|
+
} | {
|
|
14239
|
+
/**
|
|
14240
|
+
* @description Unique identifier for the event.
|
|
14241
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14242
|
+
*/
|
|
14243
|
+
id: string;
|
|
14244
|
+
/** @constant */
|
|
14245
|
+
event: "resource_export.created";
|
|
14246
|
+
/** @description The event payload. */
|
|
14247
|
+
data: {
|
|
14248
|
+
/**
|
|
14249
|
+
* @description The ID of the resource export.
|
|
14250
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14251
|
+
*/
|
|
14252
|
+
id: string;
|
|
14253
|
+
/**
|
|
14254
|
+
* @description The type of resource being exported.
|
|
14255
|
+
* @example users
|
|
14256
|
+
* @enum {string}
|
|
14257
|
+
*/
|
|
14258
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14259
|
+
};
|
|
14260
|
+
/**
|
|
14261
|
+
* Format: date-time
|
|
14262
|
+
* @description An ISO 8601 timestamp.
|
|
14263
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14264
|
+
*/
|
|
14265
|
+
created_at: string;
|
|
14266
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14267
|
+
/**
|
|
14268
|
+
* @description Distinguishes the Event object.
|
|
14269
|
+
* @constant
|
|
14270
|
+
*/
|
|
14271
|
+
object: "event";
|
|
14272
|
+
} | {
|
|
14273
|
+
/**
|
|
14274
|
+
* @description Unique identifier for the event.
|
|
14275
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14276
|
+
*/
|
|
14277
|
+
id: string;
|
|
14278
|
+
/** @constant */
|
|
14279
|
+
event: "resource_export.downloaded";
|
|
14280
|
+
/** @description The event payload. */
|
|
14281
|
+
data: {
|
|
14282
|
+
/**
|
|
14283
|
+
* @description The ID of the resource export.
|
|
14284
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14285
|
+
*/
|
|
14286
|
+
id: string;
|
|
14287
|
+
/**
|
|
14288
|
+
* @description The type of resource being exported.
|
|
14289
|
+
* @example users
|
|
14290
|
+
* @enum {string}
|
|
14291
|
+
*/
|
|
14292
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14293
|
+
};
|
|
14294
|
+
/**
|
|
14295
|
+
* Format: date-time
|
|
14296
|
+
* @description An ISO 8601 timestamp.
|
|
14297
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14298
|
+
*/
|
|
14299
|
+
created_at: string;
|
|
14300
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14301
|
+
/**
|
|
14302
|
+
* @description Distinguishes the Event object.
|
|
14303
|
+
* @constant
|
|
14304
|
+
*/
|
|
14305
|
+
object: "event";
|
|
14306
|
+
} | {
|
|
14307
|
+
/**
|
|
14308
|
+
* @description Unique identifier for the event.
|
|
14309
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14310
|
+
*/
|
|
14311
|
+
id: string;
|
|
14312
|
+
/** @constant */
|
|
14313
|
+
event: "resource_export.failed";
|
|
14314
|
+
/** @description The event payload. */
|
|
14315
|
+
data: {
|
|
14316
|
+
/**
|
|
14317
|
+
* @description The ID of the resource export.
|
|
14318
|
+
* @example resource_export_01HWZBQZY2M3AMQW166Q22K88F
|
|
14319
|
+
*/
|
|
14320
|
+
id: string;
|
|
14321
|
+
/**
|
|
14322
|
+
* @description The type of resource being exported.
|
|
14323
|
+
* @example users
|
|
14324
|
+
* @enum {string}
|
|
14325
|
+
*/
|
|
14326
|
+
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
14327
|
+
};
|
|
14328
|
+
/**
|
|
14329
|
+
* Format: date-time
|
|
14330
|
+
* @description An ISO 8601 timestamp.
|
|
14331
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
14332
|
+
*/
|
|
14333
|
+
created_at: string;
|
|
14334
|
+
context?: components["schemas"]["EventContextDto"];
|
|
14335
|
+
/**
|
|
14336
|
+
* @description Distinguishes the Event object.
|
|
14337
|
+
* @constant
|
|
14338
|
+
*/
|
|
14339
|
+
object: "event";
|
|
13965
14340
|
} | {
|
|
13966
14341
|
/**
|
|
13967
14342
|
* @description Unique identifier for the event.
|
|
@@ -15775,7 +16150,7 @@ export interface components {
|
|
|
15775
16150
|
*/
|
|
15776
16151
|
scopes: string[] | null;
|
|
15777
16152
|
/**
|
|
15778
|
-
* @description The OAuth redirect URI to register with the provider when configuring the custom application.
|
|
16153
|
+
* @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
16154
|
* @example https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
|
|
15780
16155
|
*/
|
|
15781
16156
|
redirect_uri: string;
|
|
@@ -15786,7 +16161,7 @@ export interface components {
|
|
|
15786
16161
|
* ]
|
|
15787
16162
|
*/
|
|
15788
16163
|
auth_methods: ("oauth" | "api_key" | "client_credentials")[];
|
|
15789
|
-
/** @description The integration-level OAuth app credentials. `null` for `api_key` integrations, which hold no
|
|
16164
|
+
/** @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
16165
|
credentials: {
|
|
15791
16166
|
/**
|
|
15792
16167
|
* @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 +16486,7 @@ export interface components {
|
|
|
16111
16486
|
*/
|
|
16112
16487
|
scopes: string[];
|
|
16113
16488
|
/**
|
|
16114
|
-
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
16489
|
+
* @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
16490
|
* @example []
|
|
16116
16491
|
*/
|
|
16117
16492
|
missing_scopes: string[];
|
|
@@ -18208,7 +18583,7 @@ export interface operations {
|
|
|
18208
18583
|
after?: string;
|
|
18209
18584
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
18210
18585
|
limit?: number;
|
|
18211
|
-
/** @description Order the results by the creation time. */
|
|
18586
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
18212
18587
|
order?: components["schemas"]["PaginationOrder"];
|
|
18213
18588
|
};
|
|
18214
18589
|
header?: never;
|
|
@@ -18289,7 +18664,7 @@ export interface operations {
|
|
|
18289
18664
|
after?: string;
|
|
18290
18665
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
18291
18666
|
limit?: number;
|
|
18292
|
-
/** @description Order the results by the creation time. */
|
|
18667
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
18293
18668
|
order?: components["schemas"]["PaginationOrder"];
|
|
18294
18669
|
};
|
|
18295
18670
|
header?: never;
|
|
@@ -19132,7 +19507,7 @@ export interface operations {
|
|
|
19132
19507
|
after?: string;
|
|
19133
19508
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19134
19509
|
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). */
|
|
19510
|
+
/** @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
19511
|
order?: components["schemas"]["PaginationOrder"];
|
|
19137
19512
|
};
|
|
19138
19513
|
header?: never;
|
|
@@ -19608,7 +19983,7 @@ export interface operations {
|
|
|
19608
19983
|
after?: string;
|
|
19609
19984
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19610
19985
|
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). */
|
|
19986
|
+
/** @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
19987
|
order?: components["schemas"]["PaginationOrder"];
|
|
19613
19988
|
/** @description The permission slug to filter by. Only child resources where the organization membership has this permission are returned. */
|
|
19614
19989
|
permission_slug: string;
|
|
@@ -19714,7 +20089,7 @@ export interface operations {
|
|
|
19714
20089
|
after?: string;
|
|
19715
20090
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19716
20091
|
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). */
|
|
20092
|
+
/** @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
20093
|
order?: components["schemas"]["PaginationOrder"];
|
|
19719
20094
|
};
|
|
19720
20095
|
header?: never;
|
|
@@ -19793,7 +20168,7 @@ export interface operations {
|
|
|
19793
20168
|
after?: string;
|
|
19794
20169
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19795
20170
|
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). */
|
|
20171
|
+
/** @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
20172
|
order?: components["schemas"]["PaginationOrder"];
|
|
19798
20173
|
};
|
|
19799
20174
|
header?: never;
|
|
@@ -19874,7 +20249,7 @@ export interface operations {
|
|
|
19874
20249
|
after?: string;
|
|
19875
20250
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19876
20251
|
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). */
|
|
20252
|
+
/** @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
20253
|
order?: components["schemas"]["PaginationOrder"];
|
|
19879
20254
|
/** @description Filter assignments by the ID of the resource. */
|
|
19880
20255
|
resource_id?: string;
|
|
@@ -21435,7 +21810,7 @@ export interface operations {
|
|
|
21435
21810
|
after?: string;
|
|
21436
21811
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21437
21812
|
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). */
|
|
21813
|
+
/** @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
21814
|
order?: components["schemas"]["PaginationOrder"];
|
|
21440
21815
|
/** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
|
|
21441
21816
|
permission_slug: string;
|
|
@@ -21541,7 +21916,7 @@ export interface operations {
|
|
|
21541
21916
|
after?: string;
|
|
21542
21917
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21543
21918
|
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). */
|
|
21919
|
+
/** @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
21920
|
order?: components["schemas"]["PaginationOrder"];
|
|
21546
21921
|
/** @description Filter assignments by the slug of the role. */
|
|
21547
21922
|
role_slug?: string;
|
|
@@ -21609,7 +21984,7 @@ export interface operations {
|
|
|
21609
21984
|
after?: string;
|
|
21610
21985
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21611
21986
|
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). */
|
|
21987
|
+
/** @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
21988
|
order?: components["schemas"]["PaginationOrder"];
|
|
21614
21989
|
};
|
|
21615
21990
|
header?: never;
|
|
@@ -21957,7 +22332,7 @@ export interface operations {
|
|
|
21957
22332
|
after?: string;
|
|
21958
22333
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
21959
22334
|
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). */
|
|
22335
|
+
/** @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
22336
|
order?: components["schemas"]["PaginationOrder"];
|
|
21962
22337
|
/** @description Filter resources by organization ID. */
|
|
21963
22338
|
organization_id?: string;
|
|
@@ -22577,7 +22952,7 @@ export interface operations {
|
|
|
22577
22952
|
after?: string;
|
|
22578
22953
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
22579
22954
|
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). */
|
|
22955
|
+
/** @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
22956
|
order?: components["schemas"]["PaginationOrder"];
|
|
22582
22957
|
/** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
|
|
22583
22958
|
permission_slug: string;
|
|
@@ -22679,7 +23054,7 @@ export interface operations {
|
|
|
22679
23054
|
after?: string;
|
|
22680
23055
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
22681
23056
|
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). */
|
|
23057
|
+
/** @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
23058
|
order?: components["schemas"]["PaginationOrder"];
|
|
22684
23059
|
/** @description Filter assignments by the slug of the role. */
|
|
22685
23060
|
role_slug?: string;
|
|
@@ -23522,7 +23897,7 @@ export interface operations {
|
|
|
23522
23897
|
after?: string;
|
|
23523
23898
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
23524
23899
|
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). */
|
|
23900
|
+
/** @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
23901
|
order?: components["schemas"]["PaginationOrder"];
|
|
23527
23902
|
/** @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
23903
|
registration_types?: ("dynamic" | "authenticated")[];
|
|
@@ -23920,7 +24295,7 @@ export interface operations {
|
|
|
23920
24295
|
after?: string;
|
|
23921
24296
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
23922
24297
|
limit?: number;
|
|
23923
|
-
/** @description Order the results by the creation time. */
|
|
24298
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
23924
24299
|
order?: components["schemas"]["PaginationOrder"];
|
|
23925
24300
|
/** @description Filter Connections by their type. */
|
|
23926
24301
|
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";
|
|
@@ -24098,7 +24473,7 @@ export interface operations {
|
|
|
24098
24473
|
after?: string;
|
|
24099
24474
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
24100
24475
|
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). */
|
|
24476
|
+
/** @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
24477
|
order?: components["schemas"]["PaginationOrder"];
|
|
24103
24478
|
};
|
|
24104
24479
|
header?: never;
|
|
@@ -24672,7 +25047,7 @@ export interface operations {
|
|
|
24672
25047
|
/**
|
|
24673
25048
|
* @description Provider-specific configuration values collected for this installation, keyed by the provider's config field descriptors.
|
|
24674
25049
|
* @example {
|
|
24675
|
-
* "
|
|
25050
|
+
* "salesforce_host": "acme.my.salesforce.com"
|
|
24676
25051
|
* }
|
|
24677
25052
|
*/
|
|
24678
25053
|
config?: {
|
|
@@ -24966,7 +25341,7 @@ export interface operations {
|
|
|
24966
25341
|
after?: string;
|
|
24967
25342
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
24968
25343
|
limit?: number;
|
|
24969
|
-
/** @description Order the results by the creation time. */
|
|
25344
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
24970
25345
|
order?: components["schemas"]["PaginationOrder"];
|
|
24971
25346
|
/** @description Filter Directories by their associated organization. */
|
|
24972
25347
|
organization_id?: string;
|
|
@@ -25131,7 +25506,7 @@ export interface operations {
|
|
|
25131
25506
|
after?: string;
|
|
25132
25507
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25133
25508
|
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). */
|
|
25509
|
+
/** @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
25510
|
order?: components["schemas"]["PaginationOrder"];
|
|
25136
25511
|
/** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
|
|
25137
25512
|
directory?: string;
|
|
@@ -25262,7 +25637,7 @@ export interface operations {
|
|
|
25262
25637
|
after?: string;
|
|
25263
25638
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25264
25639
|
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). */
|
|
25640
|
+
/** @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
25641
|
order?: components["schemas"]["PaginationOrder"];
|
|
25267
25642
|
/** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
|
|
25268
25643
|
directory?: string;
|
|
@@ -25405,7 +25780,7 @@ export interface operations {
|
|
|
25405
25780
|
after?: string;
|
|
25406
25781
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25407
25782
|
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). */
|
|
25783
|
+
/** @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
25784
|
order?: components["schemas"]["PaginationOrder"];
|
|
25410
25785
|
/** @description Filter events by one or more event types (e.g. `dsync.user.created`). */
|
|
25411
25786
|
events: string[];
|
|
@@ -25485,7 +25860,7 @@ export interface operations {
|
|
|
25485
25860
|
after?: string;
|
|
25486
25861
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
25487
25862
|
limit?: number;
|
|
25488
|
-
/** @description Order the results by the creation time. */
|
|
25863
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
25489
25864
|
order?: components["schemas"]["PaginationOrder"];
|
|
25490
25865
|
};
|
|
25491
25866
|
header?: never;
|
|
@@ -26196,7 +26571,7 @@ export interface operations {
|
|
|
26196
26571
|
after?: string;
|
|
26197
26572
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26198
26573
|
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). */
|
|
26574
|
+
/** @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
26575
|
order?: components["schemas"]["PaginationOrder"];
|
|
26201
26576
|
/** @description The domains of an Organization. Any Organization with a matching domain will be returned. */
|
|
26202
26577
|
domains?: string[];
|
|
@@ -26770,7 +27145,7 @@ export interface operations {
|
|
|
26770
27145
|
after?: string;
|
|
26771
27146
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
26772
27147
|
limit?: number;
|
|
26773
|
-
/** @description Order the results by the creation time. */
|
|
27148
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
26774
27149
|
order?: components["schemas"]["PaginationOrder"];
|
|
26775
27150
|
};
|
|
26776
27151
|
header?: never;
|
|
@@ -27013,7 +27388,7 @@ export interface operations {
|
|
|
27013
27388
|
after?: string;
|
|
27014
27389
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27015
27390
|
limit?: number;
|
|
27016
|
-
/** @description Order the results by the creation time. */
|
|
27391
|
+
/** @description Order the results by the creation time. Defaults to `desc`. */
|
|
27017
27392
|
order?: components["schemas"]["PaginationOrder"];
|
|
27018
27393
|
};
|
|
27019
27394
|
header?: never;
|
|
@@ -27060,7 +27435,7 @@ export interface operations {
|
|
|
27060
27435
|
after?: string;
|
|
27061
27436
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27062
27437
|
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). */
|
|
27438
|
+
/** @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
27439
|
order?: components["schemas"]["PaginationOrder"];
|
|
27065
27440
|
/** @description Search groups by name or by group ID. */
|
|
27066
27441
|
search?: string;
|
|
@@ -27420,7 +27795,7 @@ export interface operations {
|
|
|
27420
27795
|
after?: string;
|
|
27421
27796
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27422
27797
|
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). */
|
|
27798
|
+
/** @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
27799
|
order?: components["schemas"]["PaginationOrder"];
|
|
27425
27800
|
};
|
|
27426
27801
|
header?: never;
|
|
@@ -27634,7 +28009,7 @@ export interface operations {
|
|
|
27634
28009
|
after?: string;
|
|
27635
28010
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
27636
28011
|
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). */
|
|
28012
|
+
/** @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
28013
|
order?: components["schemas"]["PaginationOrder"];
|
|
27639
28014
|
};
|
|
27640
28015
|
header?: never;
|
|
@@ -30189,7 +30564,7 @@ export interface operations {
|
|
|
30189
30564
|
after?: string;
|
|
30190
30565
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
30191
30566
|
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). */
|
|
30567
|
+
/** @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
30568
|
order?: components["schemas"]["PaginationOrder"];
|
|
30194
30569
|
};
|
|
30195
30570
|
header?: never;
|
|
@@ -30361,7 +30736,7 @@ export interface operations {
|
|
|
30361
30736
|
after?: string;
|
|
30362
30737
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
30363
30738
|
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). */
|
|
30739
|
+
/** @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
30740
|
order?: components["schemas"]["PaginationOrder"];
|
|
30366
30741
|
/** @description The ID of the [organization](/reference/organization) that the recipient will join. */
|
|
30367
30742
|
organization_id?: string;
|
|
@@ -31279,7 +31654,7 @@ export interface operations {
|
|
|
31279
31654
|
after?: string;
|
|
31280
31655
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
31281
31656
|
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). */
|
|
31657
|
+
/** @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
31658
|
order?: components["schemas"]["PaginationOrder"];
|
|
31284
31659
|
/** @description The ID of the [organization](/reference/organization) which the user belongs to. */
|
|
31285
31660
|
organization_id?: string;
|
|
@@ -31969,7 +32344,7 @@ export interface operations {
|
|
|
31969
32344
|
after?: string;
|
|
31970
32345
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
31971
32346
|
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). */
|
|
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). Defaults to `normal`. */
|
|
31973
32348
|
order?: components["schemas"]["PaginationOrder"];
|
|
31974
32349
|
};
|
|
31975
32350
|
header?: never;
|
|
@@ -32344,7 +32719,7 @@ export interface operations {
|
|
|
32344
32719
|
after?: string;
|
|
32345
32720
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
32346
32721
|
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). */
|
|
32722
|
+
/** @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
32723
|
order?: components["schemas"]["PaginationOrder"];
|
|
32349
32724
|
};
|
|
32350
32725
|
header?: never;
|
|
@@ -32673,7 +33048,7 @@ export interface operations {
|
|
|
32673
33048
|
after?: string;
|
|
32674
33049
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
32675
33050
|
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). */
|
|
33051
|
+
/** @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
33052
|
order?: components["schemas"]["PaginationOrder"];
|
|
32678
33053
|
/**
|
|
32679
33054
|
* @deprecated
|
|
@@ -33900,7 +34275,7 @@ export interface operations {
|
|
|
33900
34275
|
after?: string;
|
|
33901
34276
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
33902
34277
|
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). */
|
|
34278
|
+
/** @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
34279
|
order?: components["schemas"]["PaginationOrder"];
|
|
33905
34280
|
};
|
|
33906
34281
|
header?: never;
|
|
@@ -34070,7 +34445,7 @@ export interface operations {
|
|
|
34070
34445
|
after?: string;
|
|
34071
34446
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34072
34447
|
limit?: number;
|
|
34073
|
-
/** @description Order the results by the creation time. */
|
|
34448
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
34074
34449
|
order?: components["schemas"]["PaginationOrder"];
|
|
34075
34450
|
/** @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
34451
|
organization_id?: string;
|
|
@@ -34204,7 +34579,7 @@ export interface operations {
|
|
|
34204
34579
|
after?: string;
|
|
34205
34580
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34206
34581
|
limit?: number;
|
|
34207
|
-
/** @description Order the results by the creation time. */
|
|
34582
|
+
/** @description Order the results by the creation time. Defaults to `desc`. */
|
|
34208
34583
|
order?: components["schemas"]["PaginationOrder"];
|
|
34209
34584
|
};
|
|
34210
34585
|
header?: never;
|
|
@@ -34251,7 +34626,7 @@ export interface operations {
|
|
|
34251
34626
|
after?: string;
|
|
34252
34627
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34253
34628
|
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). */
|
|
34629
|
+
/** @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
34630
|
order?: components["schemas"]["PaginationOrder"];
|
|
34256
34631
|
};
|
|
34257
34632
|
header?: never;
|
|
@@ -34635,7 +35010,7 @@ export interface operations {
|
|
|
34635
35010
|
after?: string;
|
|
34636
35011
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
34637
35012
|
limit?: number;
|
|
34638
|
-
/** @description Order the results by the creation time. */
|
|
35013
|
+
/** @description Order the results by the creation time. Defaults to `normal`. */
|
|
34639
35014
|
order?: components["schemas"]["PaginationOrder"];
|
|
34640
35015
|
};
|
|
34641
35016
|
header?: never;
|
|
@@ -35077,7 +35452,7 @@ export interface operations {
|
|
|
35077
35452
|
after?: string;
|
|
35078
35453
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
35079
35454
|
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). */
|
|
35455
|
+
/** @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
35456
|
order?: components["schemas"]["PaginationOrder"];
|
|
35082
35457
|
/** @description Filter waitlist entries by their state. */
|
|
35083
35458
|
state?: "pending" | "approved" | "denied";
|
|
@@ -35723,7 +36098,7 @@ export interface operations {
|
|
|
35723
36098
|
after?: string;
|
|
35724
36099
|
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
35725
36100
|
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). */
|
|
36101
|
+
/** @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
36102
|
order?: components["schemas"]["PaginationOrder"];
|
|
35728
36103
|
};
|
|
35729
36104
|
header?: never;
|