Skip to content

Commit 163b388

Browse files
Update OpenAPI spec (2026-03-25) (#3)
Co-authored-by: workos-sdk-automation[bot] <255426317+workos-sdk-automation[bot]@users.noreply.github.com>
1 parent 66abea7 commit 163b388

2 files changed

Lines changed: 314 additions & 22 deletions

File tree

.last-synced-sha

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
de458a3b6d5e3e7c8c02eef4117639c81be1a720
1+
dfd1301aa2bd693e30269829ff052b93ec0862c4

spec/open-api-spec.yaml

Lines changed: 313 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8772,15 +8772,6 @@ paths:
87728772
description: Initiates the single sign-on flow.
87738773
security: []
87748774
parameters:
8775-
- name: code_challenge_method
8776-
required: false
8777-
in: query
8778-
description: >-
8779-
The only valid PKCE code challenge method is `"S256"`. Required when
8780-
specifying a `code_challenge`.
8781-
schema:
8782-
type: string
8783-
example: S256
87848775
- name: provider_scopes
87858776
required: false
87868777
in: query
@@ -8941,15 +8932,6 @@ paths:
89418932
description: >-
89428933
A random string generated by the client that is used to mitigate
89438934
replay attacks.
8944-
- name: code_challenge
8945-
required: false
8946-
in: query
8947-
description: >-
8948-
Code challenge derived from the code verifier used for the PKCE
8949-
flow.
8950-
schema:
8951-
type: string
8952-
example: E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM
89538935
responses:
89548936
'200':
89558937
description: OK
@@ -9763,6 +9745,34 @@ paths:
97639745
required:
97649746
- code
97659747
- message
9748+
- type: object
9749+
properties:
9750+
code:
9751+
type: string
9752+
description: The error code identifying the type of error.
9753+
example: invalid_pending_authentication_token
9754+
const: invalid_pending_authentication_token
9755+
message:
9756+
type: string
9757+
description: A human-readable description of the error.
9758+
example: Request could not be processed.
9759+
required:
9760+
- code
9761+
- message
9762+
- type: object
9763+
properties:
9764+
code:
9765+
type: string
9766+
description: The error code identifying the type of error.
9767+
example: user_mismatch
9768+
const: user_mismatch
9769+
message:
9770+
type: string
9771+
description: A human-readable description of the error.
9772+
example: Request could not be processed.
9773+
required:
9774+
- code
9775+
- message
97669776
- type: object
97679777
properties:
97689778
error:
@@ -9911,6 +9921,20 @@ paths:
99119921
required:
99129922
- error
99139923
- error_description
9924+
- type: object
9925+
properties:
9926+
error:
9927+
type: string
9928+
description: The OAuth error code.
9929+
example: extra_attributes_required
9930+
const: extra_attributes_required
9931+
error_description:
9932+
type: string
9933+
description: A human-readable description of the error.
9934+
example: 'The request failed due to: extra_attributes_required.'
9935+
required:
9936+
- error
9937+
- error_description
99149938
- type: object
99159939
properties:
99169940
error:
@@ -10199,6 +10223,62 @@ paths:
1019910223
required:
1020010224
- code
1020110225
- message
10226+
- type: object
10227+
properties:
10228+
code:
10229+
type: string
10230+
description: The error code identifying the type of error.
10231+
example: passkey_progressive_enrollment
10232+
const: passkey_progressive_enrollment
10233+
message:
10234+
type: string
10235+
description: A human-readable description of the error.
10236+
example: Request could not be processed.
10237+
required:
10238+
- code
10239+
- message
10240+
- type: object
10241+
properties:
10242+
code:
10243+
type: string
10244+
description: The error code identifying the type of error.
10245+
example: radar_challenge
10246+
const: radar_challenge
10247+
message:
10248+
type: string
10249+
description: A human-readable description of the error.
10250+
example: Request could not be processed.
10251+
required:
10252+
- code
10253+
- message
10254+
- type: object
10255+
properties:
10256+
code:
10257+
type: string
10258+
description: The error code identifying the type of error.
10259+
example: radar_sign_up_challenge
10260+
const: radar_sign_up_challenge
10261+
message:
10262+
type: string
10263+
description: A human-readable description of the error.
10264+
example: Request could not be processed.
10265+
required:
10266+
- code
10267+
- message
10268+
- type: object
10269+
properties:
10270+
code:
10271+
type: string
10272+
description: The error code identifying the type of error.
10273+
example: application_consent_required
10274+
const: application_consent_required
10275+
message:
10276+
type: string
10277+
description: A human-readable description of the error.
10278+
example: Request could not be processed.
10279+
required:
10280+
- code
10281+
- message
1020210282
'404':
1020310283
description: Not Found
1020410284
content:
@@ -14642,6 +14722,125 @@ paths:
1464214722
tags:
1464314723
- webhooks
1464414724
/webhook_endpoints/{id}:
14725+
patch:
14726+
operationId: WebhookEndpointsController_update
14727+
summary: Update a Webhook Endpoint
14728+
description: Update the properties of an existing webhook endpoint.
14729+
parameters:
14730+
- name: id
14731+
required: true
14732+
in: path
14733+
description: Unique identifier of the Webhook Endpoint.
14734+
schema:
14735+
type: string
14736+
example: we_0123456789
14737+
requestBody:
14738+
required: true
14739+
content:
14740+
application/json:
14741+
schema:
14742+
$ref: '#/components/schemas/UpdateWebhookEndpointDto'
14743+
responses:
14744+
'200':
14745+
description: Webhook endpoint updated successfully.
14746+
content:
14747+
application/json:
14748+
schema:
14749+
$ref: '#/components/schemas/WebhookEndpointJson'
14750+
'404':
14751+
description: Webhook endpoint not found.
14752+
content:
14753+
application/json:
14754+
schema:
14755+
type: object
14756+
properties:
14757+
code:
14758+
type: string
14759+
description: The error code identifying the type of error.
14760+
example: entity_not_found
14761+
const: entity_not_found
14762+
message:
14763+
type: string
14764+
description: A human-readable description of the error.
14765+
example: Request could not be processed.
14766+
required:
14767+
- code
14768+
- message
14769+
'409':
14770+
description: A Webhook Endpoint with the same endpoint URL already exists.
14771+
content:
14772+
application/json:
14773+
schema:
14774+
type: object
14775+
properties:
14776+
code:
14777+
type: string
14778+
description: The error code identifying the type of error.
14779+
example: duplicate_endpoint
14780+
const: duplicate_endpoint
14781+
message:
14782+
type: string
14783+
description: A human-readable description of the error.
14784+
example: Request could not be processed.
14785+
required:
14786+
- code
14787+
- message
14788+
'422':
14789+
description: Unprocessable Entity
14790+
content:
14791+
application/json:
14792+
schema:
14793+
oneOf:
14794+
- type: object
14795+
properties:
14796+
code:
14797+
type: string
14798+
description: The error code identifying the type of error.
14799+
example: invalid_url
14800+
const: invalid_url
14801+
message:
14802+
type: string
14803+
description: A human-readable description of the error.
14804+
example: Request could not be processed.
14805+
required:
14806+
- code
14807+
- message
14808+
- type: object
14809+
properties:
14810+
code:
14811+
type: string
14812+
description: The error code identifying the type of error.
14813+
example: invalid_request_parameters
14814+
const: invalid_request_parameters
14815+
message:
14816+
type: string
14817+
description: A human-readable description of the error.
14818+
example: Validation failed.
14819+
errors:
14820+
type: array
14821+
items:
14822+
type: object
14823+
properties:
14824+
code:
14825+
type: string
14826+
description: The validation error code.
14827+
example: unknown_event_type
14828+
message:
14829+
type: string
14830+
description: >-
14831+
A human-readable description of the validation
14832+
error.
14833+
example: Invalid enum value.
14834+
required:
14835+
- code
14836+
- message
14837+
description: The list of validation errors.
14838+
required:
14839+
- code
14840+
- message
14841+
- errors
14842+
tags:
14843+
- webhooks
1464514844
delete:
1464614845
operationId: WebhookEndpointsController_delete
1464714846
summary: Delete a Webhook Endpoint
@@ -16449,16 +16648,109 @@ components:
1644916648
description: The HTTPS URL where webhooks will be sent.
1645016649
example: https://example.com/webhooks
1645116650
events:
16651+
type: array
1645216652
description: The events that the Webhook Endpoint is subscribed to.
16653+
items:
16654+
type: string
16655+
enum: &ref_6
16656+
- authentication.email_verification_succeeded
16657+
- authentication.magic_auth_failed
16658+
- authentication.magic_auth_succeeded
16659+
- authentication.mfa_succeeded
16660+
- authentication.oauth_failed
16661+
- authentication.oauth_succeeded
16662+
- authentication.password_failed
16663+
- authentication.password_succeeded
16664+
- authentication.passkey_failed
16665+
- authentication.passkey_succeeded
16666+
- authentication.sso_failed
16667+
- authentication.sso_started
16668+
- authentication.sso_succeeded
16669+
- authentication.sso_timed_out
16670+
- authentication.radar_risk_detected
16671+
- api_key.created
16672+
- api_key.revoked
16673+
- connection.activated
16674+
- connection.deactivated
16675+
- connection.saml_certificate_renewal_required
16676+
- connection.saml_certificate_renewed
16677+
- connection.deleted
16678+
- dsync.activated
16679+
- dsync.deleted
16680+
- dsync.group.created
16681+
- dsync.group.deleted
16682+
- dsync.group.updated
16683+
- dsync.group.user_added
16684+
- dsync.group.user_removed
16685+
- dsync.user.created
16686+
- dsync.user.deleted
16687+
- dsync.user.updated
16688+
- email_verification.created
16689+
- flag.created
16690+
- flag.deleted
16691+
- flag.updated
16692+
- flag.rule_updated
16693+
- invitation.accepted
16694+
- invitation.created
16695+
- invitation.resent
16696+
- invitation.revoked
16697+
- magic_auth.created
16698+
- organization.created
16699+
- organization.deleted
16700+
- organization.updated
16701+
- organization_domain.created
16702+
- organization_domain.deleted
16703+
- organization_domain.updated
16704+
- organization_domain.verified
16705+
- organization_domain.verification_failed
16706+
- password_reset.created
16707+
- password_reset.succeeded
16708+
- user.created
16709+
- user.updated
16710+
- user.deleted
16711+
- organization_membership.created
16712+
- organization_membership.deleted
16713+
- organization_membership.updated
16714+
- role.created
16715+
- role.deleted
16716+
- role.updated
16717+
- organization_role.created
16718+
- organization_role.deleted
16719+
- organization_role.updated
16720+
- permission.created
16721+
- permission.deleted
16722+
- permission.updated
16723+
- session.created
16724+
- session.revoked
1645316725
example:
1645416726
- user.created
1645516727
- dsync.user.created
16456-
type: array
16457-
items:
16458-
type: string
1645916728
required:
1646016729
- endpoint_url
1646116730
- events
16731+
UpdateWebhookEndpointDto:
16732+
type: object
16733+
properties:
16734+
endpoint_url:
16735+
type: string
16736+
description: The HTTPS URL where webhooks will be sent.
16737+
example: https://example.com/webhooks
16738+
status:
16739+
type: string
16740+
enum:
16741+
- enabled
16742+
- disabled
16743+
description: Whether the Webhook Endpoint is enabled or disabled.
16744+
example: enabled
16745+
events:
16746+
type: array
16747+
description: The events that the Webhook Endpoint is subscribed to.
16748+
items:
16749+
type: string
16750+
enum: *ref_6
16751+
example:
16752+
- user.created
16753+
- dsync.user.created
1646216754
WidgetSessionTokenDto:
1646316755
type: object
1646416756
properties:

0 commit comments

Comments
 (0)