@workos/openapi-spec 0.10.0 → 0.12.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 +224 -1
- package/dist/types.d.ts +143 -4
- package/package.json +7 -6
package/dist/open-api-spec.yaml
CHANGED
|
@@ -6978,6 +6978,14 @@ paths:
|
|
|
6978
6978
|
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
6979
6979
|
required:
|
|
6980
6980
|
- message
|
|
6981
|
+
'422':
|
|
6982
|
+
description: >-
|
|
6983
|
+
The matched installation uses a different auth method than this
|
|
6984
|
+
endpoint expects.
|
|
6985
|
+
content:
|
|
6986
|
+
application/json:
|
|
6987
|
+
schema:
|
|
6988
|
+
$ref: '#/components/schemas/AuthMethodMismatchError'
|
|
6981
6989
|
summary: Get an access token for a connected account
|
|
6982
6990
|
tags:
|
|
6983
6991
|
- pipes
|
|
@@ -7404,6 +7412,24 @@ paths:
|
|
|
7404
7412
|
schema:
|
|
7405
7413
|
example: directory_group_01E64QTDNS0EGJ0FMCVY9BWGZT
|
|
7406
7414
|
type: string
|
|
7415
|
+
- name: idp_id
|
|
7416
|
+
required: false
|
|
7417
|
+
in: query
|
|
7418
|
+
description: >-
|
|
7419
|
+
Filter Directory Users by the identity provider's unique identifier
|
|
7420
|
+
(`idp_id`). Requires the `directory` parameter to also be provided.
|
|
7421
|
+
schema:
|
|
7422
|
+
example: '2836'
|
|
7423
|
+
type: string
|
|
7424
|
+
- name: email
|
|
7425
|
+
required: false
|
|
7426
|
+
in: query
|
|
7427
|
+
description: >-
|
|
7428
|
+
Filter Directory Users by their primary email address. Requires the
|
|
7429
|
+
`directory` parameter to also be provided.
|
|
7430
|
+
schema:
|
|
7431
|
+
example: jane.doe@example.com
|
|
7432
|
+
type: string
|
|
7407
7433
|
responses:
|
|
7408
7434
|
'200':
|
|
7409
7435
|
description: OK
|
|
@@ -11710,6 +11736,14 @@ paths:
|
|
|
11710
11736
|
The email address of the user that must
|
|
11711
11737
|
authenticate via SSO.
|
|
11712
11738
|
example: user@example.com
|
|
11739
|
+
pending_authentication_token:
|
|
11740
|
+
type: string
|
|
11741
|
+
description: >-
|
|
11742
|
+
A token that links the subsequent SSO
|
|
11743
|
+
authentication back to the pending
|
|
11744
|
+
authentication so the authorization session
|
|
11745
|
+
can be completed.
|
|
11746
|
+
example: pat_01FVYZ...
|
|
11713
11747
|
required:
|
|
11714
11748
|
- connection_ids
|
|
11715
11749
|
- email
|
|
@@ -13482,6 +13516,13 @@ paths:
|
|
|
13482
13516
|
description: >-
|
|
13483
13517
|
The primary role assigned to the user within the
|
|
13484
13518
|
organization.
|
|
13519
|
+
roles:
|
|
13520
|
+
type: array
|
|
13521
|
+
items:
|
|
13522
|
+
$ref: '#/components/schemas/SlimRole'
|
|
13523
|
+
description: >-
|
|
13524
|
+
The list of roles assigned to the user within the
|
|
13525
|
+
organization.
|
|
13485
13526
|
user:
|
|
13486
13527
|
$ref: '#/components/schemas/UserlandUser'
|
|
13487
13528
|
description: >-
|
|
@@ -13497,6 +13538,7 @@ paths:
|
|
|
13497
13538
|
- created_at
|
|
13498
13539
|
- updated_at
|
|
13499
13540
|
- role
|
|
13541
|
+
- roles
|
|
13500
13542
|
- user
|
|
13501
13543
|
x-inline-with-overrides: true
|
|
13502
13544
|
'400':
|
|
@@ -13897,6 +13939,13 @@ paths:
|
|
|
13897
13939
|
description: >-
|
|
13898
13940
|
The primary role assigned to the user within the
|
|
13899
13941
|
organization.
|
|
13942
|
+
roles:
|
|
13943
|
+
type: array
|
|
13944
|
+
items:
|
|
13945
|
+
$ref: '#/components/schemas/SlimRole'
|
|
13946
|
+
description: >-
|
|
13947
|
+
The list of roles assigned to the user within the
|
|
13948
|
+
organization.
|
|
13900
13949
|
user:
|
|
13901
13950
|
$ref: '#/components/schemas/UserlandUser'
|
|
13902
13951
|
description: >-
|
|
@@ -13912,6 +13961,7 @@ paths:
|
|
|
13912
13961
|
- created_at
|
|
13913
13962
|
- updated_at
|
|
13914
13963
|
- role
|
|
13964
|
+
- roles
|
|
13915
13965
|
- user
|
|
13916
13966
|
x-inline-with-overrides: true
|
|
13917
13967
|
'400':
|
|
@@ -20050,6 +20100,7 @@ components:
|
|
|
20050
20100
|
- pipes.connected_account.disconnected
|
|
20051
20101
|
- pipes.connected_account.reauthorization_needed
|
|
20052
20102
|
- session.created
|
|
20103
|
+
- session.reauthenticated
|
|
20053
20104
|
- session.revoked
|
|
20054
20105
|
- waitlist_user.approved
|
|
20055
20106
|
- waitlist_user.created
|
|
@@ -20978,7 +21029,10 @@ components:
|
|
|
20978
21029
|
- pending
|
|
20979
21030
|
- ready
|
|
20980
21031
|
- error
|
|
20981
|
-
|
|
21032
|
+
- expired
|
|
21033
|
+
description: >-
|
|
21034
|
+
The state of the export. Possible values: pending, ready, error,
|
|
21035
|
+
expired.
|
|
20982
21036
|
example: ready
|
|
20983
21037
|
url:
|
|
20984
21038
|
type:
|
|
@@ -30467,6 +30521,150 @@ components:
|
|
|
30467
30521
|
- data
|
|
30468
30522
|
- created_at
|
|
30469
30523
|
- object
|
|
30524
|
+
- type: object
|
|
30525
|
+
properties:
|
|
30526
|
+
id:
|
|
30527
|
+
type: string
|
|
30528
|
+
description: Unique identifier for the event.
|
|
30529
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30530
|
+
event:
|
|
30531
|
+
type: string
|
|
30532
|
+
const: session.reauthenticated
|
|
30533
|
+
data:
|
|
30534
|
+
type: object
|
|
30535
|
+
properties:
|
|
30536
|
+
object:
|
|
30537
|
+
type: string
|
|
30538
|
+
description: Distinguishes the session object.
|
|
30539
|
+
const: session
|
|
30540
|
+
id:
|
|
30541
|
+
type: string
|
|
30542
|
+
description: The unique ID of the session.
|
|
30543
|
+
example: session_01H93ZY4F80QPBEZ1R5B2SHQG8
|
|
30544
|
+
impersonator:
|
|
30545
|
+
type: object
|
|
30546
|
+
properties:
|
|
30547
|
+
email:
|
|
30548
|
+
type: string
|
|
30549
|
+
description: >-
|
|
30550
|
+
The email address of the WorkOS Dashboard user who
|
|
30551
|
+
is impersonating the user.
|
|
30552
|
+
example: admin@foocorp.com
|
|
30553
|
+
reason:
|
|
30554
|
+
type:
|
|
30555
|
+
- string
|
|
30556
|
+
- 'null'
|
|
30557
|
+
description: >-
|
|
30558
|
+
The justification the impersonator gave for
|
|
30559
|
+
impersonating the user.
|
|
30560
|
+
example: Investigating an issue with the customer's account.
|
|
30561
|
+
required:
|
|
30562
|
+
- email
|
|
30563
|
+
- reason
|
|
30564
|
+
description: >-
|
|
30565
|
+
Information about the impersonator if this session was
|
|
30566
|
+
created via impersonation.
|
|
30567
|
+
ip_address:
|
|
30568
|
+
type:
|
|
30569
|
+
- string
|
|
30570
|
+
- 'null'
|
|
30571
|
+
description: The IP address from which the session was created.
|
|
30572
|
+
example: 198.51.100.42
|
|
30573
|
+
organization_id:
|
|
30574
|
+
type: string
|
|
30575
|
+
description: >-
|
|
30576
|
+
The ID of the organization this session is associated
|
|
30577
|
+
with.
|
|
30578
|
+
example: org_01H945H0YD4F97JN9MATX7BYAG
|
|
30579
|
+
user_agent:
|
|
30580
|
+
type:
|
|
30581
|
+
- string
|
|
30582
|
+
- 'null'
|
|
30583
|
+
description: >-
|
|
30584
|
+
The user agent string from the device that created the
|
|
30585
|
+
session.
|
|
30586
|
+
example: >-
|
|
30587
|
+
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
|
|
30588
|
+
AppleWebKit/537.36
|
|
30589
|
+
user_id:
|
|
30590
|
+
type: string
|
|
30591
|
+
description: The ID of the user this session belongs to.
|
|
30592
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
30593
|
+
auth_method:
|
|
30594
|
+
type: string
|
|
30595
|
+
enum:
|
|
30596
|
+
- cross_app_auth
|
|
30597
|
+
- external_auth
|
|
30598
|
+
- impersonation
|
|
30599
|
+
- magic_code
|
|
30600
|
+
- migrated_session
|
|
30601
|
+
- oauth
|
|
30602
|
+
- passkey
|
|
30603
|
+
- password
|
|
30604
|
+
- sso
|
|
30605
|
+
- unknown
|
|
30606
|
+
description: The authentication method used to create this session.
|
|
30607
|
+
example: sso
|
|
30608
|
+
status:
|
|
30609
|
+
type: string
|
|
30610
|
+
enum:
|
|
30611
|
+
- active
|
|
30612
|
+
- expired
|
|
30613
|
+
- revoked
|
|
30614
|
+
description: The current status of the session.
|
|
30615
|
+
example: active
|
|
30616
|
+
expires_at:
|
|
30617
|
+
format: date-time
|
|
30618
|
+
type: string
|
|
30619
|
+
description: The timestamp when the session expires.
|
|
30620
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30621
|
+
ended_at:
|
|
30622
|
+
format: date-time
|
|
30623
|
+
type:
|
|
30624
|
+
- string
|
|
30625
|
+
- 'null'
|
|
30626
|
+
description: The timestamp when the session ended.
|
|
30627
|
+
example: null
|
|
30628
|
+
created_at:
|
|
30629
|
+
format: date-time
|
|
30630
|
+
type: string
|
|
30631
|
+
description: An ISO 8601 timestamp.
|
|
30632
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30633
|
+
updated_at:
|
|
30634
|
+
format: date-time
|
|
30635
|
+
type: string
|
|
30636
|
+
description: An ISO 8601 timestamp.
|
|
30637
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30638
|
+
required:
|
|
30639
|
+
- object
|
|
30640
|
+
- id
|
|
30641
|
+
- ip_address
|
|
30642
|
+
- user_agent
|
|
30643
|
+
- user_id
|
|
30644
|
+
- auth_method
|
|
30645
|
+
- status
|
|
30646
|
+
- expires_at
|
|
30647
|
+
- ended_at
|
|
30648
|
+
- created_at
|
|
30649
|
+
- updated_at
|
|
30650
|
+
description: The event payload.
|
|
30651
|
+
created_at:
|
|
30652
|
+
format: date-time
|
|
30653
|
+
type: string
|
|
30654
|
+
description: An ISO 8601 timestamp.
|
|
30655
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30656
|
+
context:
|
|
30657
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
30658
|
+
object:
|
|
30659
|
+
type: string
|
|
30660
|
+
description: Distinguishes the Event object.
|
|
30661
|
+
const: event
|
|
30662
|
+
required:
|
|
30663
|
+
- id
|
|
30664
|
+
- event
|
|
30665
|
+
- data
|
|
30666
|
+
- created_at
|
|
30667
|
+
- object
|
|
30470
30668
|
- type: object
|
|
30471
30669
|
properties:
|
|
30472
30670
|
id:
|
|
@@ -32338,6 +32536,25 @@ components:
|
|
|
32338
32536
|
required:
|
|
32339
32537
|
- active
|
|
32340
32538
|
- error
|
|
32539
|
+
AuthMethodMismatchError:
|
|
32540
|
+
type: object
|
|
32541
|
+
properties:
|
|
32542
|
+
code:
|
|
32543
|
+
type: string
|
|
32544
|
+
description: >-
|
|
32545
|
+
Error code indicating the endpoint does not match the installation
|
|
32546
|
+
auth method.
|
|
32547
|
+
example: auth_method_mismatch
|
|
32548
|
+
const: auth_method_mismatch
|
|
32549
|
+
message:
|
|
32550
|
+
type: string
|
|
32551
|
+
description: A human-readable explanation of the mismatch.
|
|
32552
|
+
example: >-
|
|
32553
|
+
This installation uses oauth authentication. Use the POST
|
|
32554
|
+
/:slug/token endpoint instead.
|
|
32555
|
+
required:
|
|
32556
|
+
- code
|
|
32557
|
+
- message
|
|
32341
32558
|
ConnectedAccount:
|
|
32342
32559
|
type: object
|
|
32343
32560
|
properties:
|
|
@@ -33090,6 +33307,11 @@ components:
|
|
|
33090
33307
|
role:
|
|
33091
33308
|
$ref: '#/components/schemas/SlimRole'
|
|
33092
33309
|
description: The primary role assigned to the user within the organization.
|
|
33310
|
+
roles:
|
|
33311
|
+
type: array
|
|
33312
|
+
items:
|
|
33313
|
+
$ref: '#/components/schemas/SlimRole'
|
|
33314
|
+
description: The list of roles assigned to the user within the organization.
|
|
33093
33315
|
user:
|
|
33094
33316
|
$ref: '#/components/schemas/UserlandUser'
|
|
33095
33317
|
description: The user that belongs to the organization through this membership.
|
|
@@ -33103,6 +33325,7 @@ components:
|
|
|
33103
33325
|
- created_at
|
|
33104
33326
|
- updated_at
|
|
33105
33327
|
- role
|
|
33328
|
+
- roles
|
|
33106
33329
|
- user
|
|
33107
33330
|
UserlandUserOrganizationMembershipList:
|
|
33108
33331
|
type: object
|
package/dist/types.d.ts
CHANGED
|
@@ -4350,7 +4350,7 @@ export interface components {
|
|
|
4350
4350
|
* "dsync.user.created"
|
|
4351
4351
|
* ]
|
|
4352
4352
|
*/
|
|
4353
|
-
events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4353
|
+
events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4354
4354
|
};
|
|
4355
4355
|
UpdateWebhookEndpointDto: {
|
|
4356
4356
|
/**
|
|
@@ -4371,7 +4371,7 @@ export interface components {
|
|
|
4371
4371
|
* "dsync.user.created"
|
|
4372
4372
|
* ]
|
|
4373
4373
|
*/
|
|
4374
|
-
events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4374
|
+
events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4375
4375
|
};
|
|
4376
4376
|
WidgetSessionTokenDto: {
|
|
4377
4377
|
/**
|
|
@@ -5097,11 +5097,11 @@ export interface components {
|
|
|
5097
5097
|
*/
|
|
5098
5098
|
id: string;
|
|
5099
5099
|
/**
|
|
5100
|
-
* @description The state of the export. Possible values: pending, ready, error.
|
|
5100
|
+
* @description The state of the export. Possible values: pending, ready, error, expired.
|
|
5101
5101
|
* @example ready
|
|
5102
5102
|
* @enum {string}
|
|
5103
5103
|
*/
|
|
5104
|
-
state: "pending" | "ready" | "error";
|
|
5104
|
+
state: "pending" | "ready" | "error" | "expired";
|
|
5105
5105
|
/**
|
|
5106
5106
|
* @description A URL to the CSV file. Only defined when the Audit Log Export is ready.
|
|
5107
5107
|
* @example https://exports.audit-logs.com/audit-log-exports/export.csv
|
|
@@ -12450,6 +12450,108 @@ export interface components {
|
|
|
12450
12450
|
* @constant
|
|
12451
12451
|
*/
|
|
12452
12452
|
object: "event";
|
|
12453
|
+
} | {
|
|
12454
|
+
/**
|
|
12455
|
+
* @description Unique identifier for the event.
|
|
12456
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
12457
|
+
*/
|
|
12458
|
+
id: string;
|
|
12459
|
+
/** @constant */
|
|
12460
|
+
event: "session.reauthenticated";
|
|
12461
|
+
/** @description The event payload. */
|
|
12462
|
+
data: {
|
|
12463
|
+
/**
|
|
12464
|
+
* @description Distinguishes the session object.
|
|
12465
|
+
* @constant
|
|
12466
|
+
*/
|
|
12467
|
+
object: "session";
|
|
12468
|
+
/**
|
|
12469
|
+
* @description The unique ID of the session.
|
|
12470
|
+
* @example session_01H93ZY4F80QPBEZ1R5B2SHQG8
|
|
12471
|
+
*/
|
|
12472
|
+
id: string;
|
|
12473
|
+
/** @description Information about the impersonator if this session was created via impersonation. */
|
|
12474
|
+
impersonator?: {
|
|
12475
|
+
/**
|
|
12476
|
+
* @description The email address of the WorkOS Dashboard user who is impersonating the user.
|
|
12477
|
+
* @example admin@foocorp.com
|
|
12478
|
+
*/
|
|
12479
|
+
email: string;
|
|
12480
|
+
/**
|
|
12481
|
+
* @description The justification the impersonator gave for impersonating the user.
|
|
12482
|
+
* @example Investigating an issue with the customer's account.
|
|
12483
|
+
*/
|
|
12484
|
+
reason: string | null;
|
|
12485
|
+
};
|
|
12486
|
+
/**
|
|
12487
|
+
* @description The IP address from which the session was created.
|
|
12488
|
+
* @example 198.51.100.42
|
|
12489
|
+
*/
|
|
12490
|
+
ip_address: string | null;
|
|
12491
|
+
/**
|
|
12492
|
+
* @description The ID of the organization this session is associated with.
|
|
12493
|
+
* @example org_01H945H0YD4F97JN9MATX7BYAG
|
|
12494
|
+
*/
|
|
12495
|
+
organization_id?: string;
|
|
12496
|
+
/**
|
|
12497
|
+
* @description The user agent string from the device that created the session.
|
|
12498
|
+
* @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
|
|
12499
|
+
*/
|
|
12500
|
+
user_agent: string | null;
|
|
12501
|
+
/**
|
|
12502
|
+
* @description The ID of the user this session belongs to.
|
|
12503
|
+
* @example user_01E4ZCR3C56J083X43JQXF3JK5
|
|
12504
|
+
*/
|
|
12505
|
+
user_id: string;
|
|
12506
|
+
/**
|
|
12507
|
+
* @description The authentication method used to create this session.
|
|
12508
|
+
* @example sso
|
|
12509
|
+
* @enum {string}
|
|
12510
|
+
*/
|
|
12511
|
+
auth_method: "cross_app_auth" | "external_auth" | "impersonation" | "magic_code" | "migrated_session" | "oauth" | "passkey" | "password" | "sso" | "unknown";
|
|
12512
|
+
/**
|
|
12513
|
+
* @description The current status of the session.
|
|
12514
|
+
* @example active
|
|
12515
|
+
* @enum {string}
|
|
12516
|
+
*/
|
|
12517
|
+
status: "active" | "expired" | "revoked";
|
|
12518
|
+
/**
|
|
12519
|
+
* Format: date-time
|
|
12520
|
+
* @description The timestamp when the session expires.
|
|
12521
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12522
|
+
*/
|
|
12523
|
+
expires_at: string;
|
|
12524
|
+
/**
|
|
12525
|
+
* Format: date-time
|
|
12526
|
+
* @description The timestamp when the session ended.
|
|
12527
|
+
* @example null
|
|
12528
|
+
*/
|
|
12529
|
+
ended_at: string | null;
|
|
12530
|
+
/**
|
|
12531
|
+
* Format: date-time
|
|
12532
|
+
* @description An ISO 8601 timestamp.
|
|
12533
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12534
|
+
*/
|
|
12535
|
+
created_at: string;
|
|
12536
|
+
/**
|
|
12537
|
+
* Format: date-time
|
|
12538
|
+
* @description An ISO 8601 timestamp.
|
|
12539
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12540
|
+
*/
|
|
12541
|
+
updated_at: string;
|
|
12542
|
+
};
|
|
12543
|
+
/**
|
|
12544
|
+
* Format: date-time
|
|
12545
|
+
* @description An ISO 8601 timestamp.
|
|
12546
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12547
|
+
*/
|
|
12548
|
+
created_at: string;
|
|
12549
|
+
context?: components["schemas"]["EventContextDto"];
|
|
12550
|
+
/**
|
|
12551
|
+
* @description Distinguishes the Event object.
|
|
12552
|
+
* @constant
|
|
12553
|
+
*/
|
|
12554
|
+
object: "event";
|
|
12453
12555
|
} | {
|
|
12454
12556
|
/**
|
|
12455
12557
|
* @description Unique identifier for the event.
|
|
@@ -13882,6 +13984,19 @@ export interface components {
|
|
|
13882
13984
|
*/
|
|
13883
13985
|
error: "needs_reauthorization" | "not_installed";
|
|
13884
13986
|
};
|
|
13987
|
+
AuthMethodMismatchError: {
|
|
13988
|
+
/**
|
|
13989
|
+
* @description Error code indicating the endpoint does not match the installation auth method.
|
|
13990
|
+
* @example auth_method_mismatch
|
|
13991
|
+
* @constant
|
|
13992
|
+
*/
|
|
13993
|
+
code: "auth_method_mismatch";
|
|
13994
|
+
/**
|
|
13995
|
+
* @description A human-readable explanation of the mismatch.
|
|
13996
|
+
* @example This installation uses oauth authentication. Use the POST /:slug/token endpoint instead.
|
|
13997
|
+
*/
|
|
13998
|
+
message: string;
|
|
13999
|
+
};
|
|
13885
14000
|
ConnectedAccount: {
|
|
13886
14001
|
/**
|
|
13887
14002
|
* @description Distinguishes the connected account object.
|
|
@@ -14434,6 +14549,8 @@ export interface components {
|
|
|
14434
14549
|
updated_at: string;
|
|
14435
14550
|
/** @description The primary role assigned to the user within the organization. */
|
|
14436
14551
|
role: components["schemas"]["SlimRole"];
|
|
14552
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
14553
|
+
roles: components["schemas"]["SlimRole"][];
|
|
14437
14554
|
/** @description The user that belongs to the organization through this membership. */
|
|
14438
14555
|
user: components["schemas"]["UserlandUser"];
|
|
14439
14556
|
};
|
|
@@ -21395,6 +21512,15 @@ export interface operations {
|
|
|
21395
21512
|
};
|
|
21396
21513
|
};
|
|
21397
21514
|
};
|
|
21515
|
+
/** @description The matched installation uses a different auth method than this endpoint expects. */
|
|
21516
|
+
422: {
|
|
21517
|
+
headers: {
|
|
21518
|
+
[name: string]: unknown;
|
|
21519
|
+
};
|
|
21520
|
+
content: {
|
|
21521
|
+
"application/json": components["schemas"]["AuthMethodMismatchError"];
|
|
21522
|
+
};
|
|
21523
|
+
};
|
|
21398
21524
|
};
|
|
21399
21525
|
};
|
|
21400
21526
|
DirectoriesController_list: {
|
|
@@ -21708,6 +21834,10 @@ export interface operations {
|
|
|
21708
21834
|
directory?: string;
|
|
21709
21835
|
/** @description Unique identifier of the WorkOS Directory Group. This value can be obtained from the WorkOS API. */
|
|
21710
21836
|
group?: string;
|
|
21837
|
+
/** @description Filter Directory Users by the identity provider's unique identifier (`idp_id`). Requires the `directory` parameter to also be provided. */
|
|
21838
|
+
idp_id?: string;
|
|
21839
|
+
/** @description Filter Directory Users by their primary email address. Requires the `directory` parameter to also be provided. */
|
|
21840
|
+
email?: string;
|
|
21711
21841
|
};
|
|
21712
21842
|
header?: never;
|
|
21713
21843
|
path?: never;
|
|
@@ -25530,6 +25660,11 @@ export interface operations {
|
|
|
25530
25660
|
* @example user@example.com
|
|
25531
25661
|
*/
|
|
25532
25662
|
email: string;
|
|
25663
|
+
/**
|
|
25664
|
+
* @description A token that links the subsequent SSO authentication back to the pending authentication so the authorization session can be completed.
|
|
25665
|
+
* @example pat_01FVYZ...
|
|
25666
|
+
*/
|
|
25667
|
+
pending_authentication_token?: string;
|
|
25533
25668
|
}));
|
|
25534
25669
|
};
|
|
25535
25670
|
};
|
|
@@ -27000,6 +27135,8 @@ export interface operations {
|
|
|
27000
27135
|
updated_at: string;
|
|
27001
27136
|
/** @description The primary role assigned to the user within the organization. */
|
|
27002
27137
|
role: components["schemas"]["SlimRole"];
|
|
27138
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
27139
|
+
roles: components["schemas"]["SlimRole"][];
|
|
27003
27140
|
/** @description The user that belongs to the organization through this membership. */
|
|
27004
27141
|
user: components["schemas"]["UserlandUser"];
|
|
27005
27142
|
};
|
|
@@ -27363,6 +27500,8 @@ export interface operations {
|
|
|
27363
27500
|
updated_at: string;
|
|
27364
27501
|
/** @description The primary role assigned to the user within the organization. */
|
|
27365
27502
|
role: components["schemas"]["SlimRole"];
|
|
27503
|
+
/** @description The list of roles assigned to the user within the organization. */
|
|
27504
|
+
roles: components["schemas"]["SlimRole"][];
|
|
27366
27505
|
/** @description The user that belongs to the organization through this membership. */
|
|
27367
27506
|
user: components["schemas"]["UserlandUser"];
|
|
27368
27507
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.12.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,11 +30,12 @@
|
|
|
30
30
|
"./package.json": "./package.json"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@workos/oagen": "^0.
|
|
33
|
+
"@workos/oagen": "^0.23.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"generate:services": "node scripts/generate-services.mjs",
|
|
37
37
|
"build:policy": "npm run generate:services && tsdown",
|
|
38
|
+
"test": "node --test scripts/__tests__/*.spec.mjs",
|
|
38
39
|
"generate:postman": "tsx scripts/postman/generate.ts",
|
|
39
40
|
"generate:postman:local": "tsx scripts/postman/generate.ts --local",
|
|
40
41
|
"sdk:resolve": "npx oagen resolve --spec spec/open-api-spec.yaml",
|
|
@@ -54,16 +55,16 @@
|
|
|
54
55
|
"prepare": "husky"
|
|
55
56
|
},
|
|
56
57
|
"overrides": {
|
|
57
|
-
"js-yaml": "^4.
|
|
58
|
+
"js-yaml": "^4.1.1",
|
|
58
59
|
"lodash": "^4.17.23"
|
|
59
60
|
},
|
|
60
61
|
"devDependencies": {
|
|
61
62
|
"@types/js-yaml": "^4.0.9",
|
|
62
|
-
"@types/node": "^
|
|
63
|
-
"@workos/oagen-emitters": "^0.
|
|
63
|
+
"@types/node": "^26.0.0",
|
|
64
|
+
"@workos/oagen-emitters": "^0.19.0",
|
|
64
65
|
"diff2html": "^3.4.56",
|
|
65
66
|
"husky": "^9.1.7",
|
|
66
|
-
"js-yaml": "^4.
|
|
67
|
+
"js-yaml": "^4.1.1",
|
|
67
68
|
"openapi-to-postmanv2": "^6.1.0",
|
|
68
69
|
"tsdown": "^0.22.3",
|
|
69
70
|
"tsx": "^4.22.4",
|