@workos/openapi-spec 0.9.0 → 0.11.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 +197 -1
- package/dist/services.d.mts +7 -1
- package/dist/services.mjs +1001 -1
- package/dist/types.d.ts +121 -4
- package/package.json +7 -6
package/dist/open-api-spec.yaml
CHANGED
|
@@ -7404,6 +7404,24 @@ paths:
|
|
|
7404
7404
|
schema:
|
|
7405
7405
|
example: directory_group_01E64QTDNS0EGJ0FMCVY9BWGZT
|
|
7406
7406
|
type: string
|
|
7407
|
+
- name: idp_id
|
|
7408
|
+
required: false
|
|
7409
|
+
in: query
|
|
7410
|
+
description: >-
|
|
7411
|
+
Filter Directory Users by the identity provider's unique identifier
|
|
7412
|
+
(`idp_id`). Requires the `directory` parameter to also be provided.
|
|
7413
|
+
schema:
|
|
7414
|
+
example: '2836'
|
|
7415
|
+
type: string
|
|
7416
|
+
- name: email
|
|
7417
|
+
required: false
|
|
7418
|
+
in: query
|
|
7419
|
+
description: >-
|
|
7420
|
+
Filter Directory Users by their primary email address. Requires the
|
|
7421
|
+
`directory` parameter to also be provided.
|
|
7422
|
+
schema:
|
|
7423
|
+
example: jane.doe@example.com
|
|
7424
|
+
type: string
|
|
7407
7425
|
responses:
|
|
7408
7426
|
'200':
|
|
7409
7427
|
description: OK
|
|
@@ -11710,6 +11728,14 @@ paths:
|
|
|
11710
11728
|
The email address of the user that must
|
|
11711
11729
|
authenticate via SSO.
|
|
11712
11730
|
example: user@example.com
|
|
11731
|
+
pending_authentication_token:
|
|
11732
|
+
type: string
|
|
11733
|
+
description: >-
|
|
11734
|
+
A token that links the subsequent SSO
|
|
11735
|
+
authentication back to the pending
|
|
11736
|
+
authentication so the authorization session
|
|
11737
|
+
can be completed.
|
|
11738
|
+
example: pat_01FVYZ...
|
|
11713
11739
|
required:
|
|
11714
11740
|
- connection_ids
|
|
11715
11741
|
- email
|
|
@@ -13482,6 +13508,13 @@ paths:
|
|
|
13482
13508
|
description: >-
|
|
13483
13509
|
The primary role assigned to the user within the
|
|
13484
13510
|
organization.
|
|
13511
|
+
roles:
|
|
13512
|
+
type: array
|
|
13513
|
+
items:
|
|
13514
|
+
$ref: '#/components/schemas/SlimRole'
|
|
13515
|
+
description: >-
|
|
13516
|
+
The list of roles assigned to the user within the
|
|
13517
|
+
organization.
|
|
13485
13518
|
user:
|
|
13486
13519
|
$ref: '#/components/schemas/UserlandUser'
|
|
13487
13520
|
description: >-
|
|
@@ -13497,6 +13530,7 @@ paths:
|
|
|
13497
13530
|
- created_at
|
|
13498
13531
|
- updated_at
|
|
13499
13532
|
- role
|
|
13533
|
+
- roles
|
|
13500
13534
|
- user
|
|
13501
13535
|
x-inline-with-overrides: true
|
|
13502
13536
|
'400':
|
|
@@ -13897,6 +13931,13 @@ paths:
|
|
|
13897
13931
|
description: >-
|
|
13898
13932
|
The primary role assigned to the user within the
|
|
13899
13933
|
organization.
|
|
13934
|
+
roles:
|
|
13935
|
+
type: array
|
|
13936
|
+
items:
|
|
13937
|
+
$ref: '#/components/schemas/SlimRole'
|
|
13938
|
+
description: >-
|
|
13939
|
+
The list of roles assigned to the user within the
|
|
13940
|
+
organization.
|
|
13900
13941
|
user:
|
|
13901
13942
|
$ref: '#/components/schemas/UserlandUser'
|
|
13902
13943
|
description: >-
|
|
@@ -13912,6 +13953,7 @@ paths:
|
|
|
13912
13953
|
- created_at
|
|
13913
13954
|
- updated_at
|
|
13914
13955
|
- role
|
|
13956
|
+
- roles
|
|
13915
13957
|
- user
|
|
13916
13958
|
x-inline-with-overrides: true
|
|
13917
13959
|
'400':
|
|
@@ -20050,6 +20092,7 @@ components:
|
|
|
20050
20092
|
- pipes.connected_account.disconnected
|
|
20051
20093
|
- pipes.connected_account.reauthorization_needed
|
|
20052
20094
|
- session.created
|
|
20095
|
+
- session.reauthenticated
|
|
20053
20096
|
- session.revoked
|
|
20054
20097
|
- waitlist_user.approved
|
|
20055
20098
|
- waitlist_user.created
|
|
@@ -20978,7 +21021,10 @@ components:
|
|
|
20978
21021
|
- pending
|
|
20979
21022
|
- ready
|
|
20980
21023
|
- error
|
|
20981
|
-
|
|
21024
|
+
- expired
|
|
21025
|
+
description: >-
|
|
21026
|
+
The state of the export. Possible values: pending, ready, error,
|
|
21027
|
+
expired.
|
|
20982
21028
|
example: ready
|
|
20983
21029
|
url:
|
|
20984
21030
|
type:
|
|
@@ -30467,6 +30513,150 @@ components:
|
|
|
30467
30513
|
- data
|
|
30468
30514
|
- created_at
|
|
30469
30515
|
- object
|
|
30516
|
+
- type: object
|
|
30517
|
+
properties:
|
|
30518
|
+
id:
|
|
30519
|
+
type: string
|
|
30520
|
+
description: Unique identifier for the event.
|
|
30521
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30522
|
+
event:
|
|
30523
|
+
type: string
|
|
30524
|
+
const: session.reauthenticated
|
|
30525
|
+
data:
|
|
30526
|
+
type: object
|
|
30527
|
+
properties:
|
|
30528
|
+
object:
|
|
30529
|
+
type: string
|
|
30530
|
+
description: Distinguishes the session object.
|
|
30531
|
+
const: session
|
|
30532
|
+
id:
|
|
30533
|
+
type: string
|
|
30534
|
+
description: The unique ID of the session.
|
|
30535
|
+
example: session_01H93ZY4F80QPBEZ1R5B2SHQG8
|
|
30536
|
+
impersonator:
|
|
30537
|
+
type: object
|
|
30538
|
+
properties:
|
|
30539
|
+
email:
|
|
30540
|
+
type: string
|
|
30541
|
+
description: >-
|
|
30542
|
+
The email address of the WorkOS Dashboard user who
|
|
30543
|
+
is impersonating the user.
|
|
30544
|
+
example: admin@foocorp.com
|
|
30545
|
+
reason:
|
|
30546
|
+
type:
|
|
30547
|
+
- string
|
|
30548
|
+
- 'null'
|
|
30549
|
+
description: >-
|
|
30550
|
+
The justification the impersonator gave for
|
|
30551
|
+
impersonating the user.
|
|
30552
|
+
example: Investigating an issue with the customer's account.
|
|
30553
|
+
required:
|
|
30554
|
+
- email
|
|
30555
|
+
- reason
|
|
30556
|
+
description: >-
|
|
30557
|
+
Information about the impersonator if this session was
|
|
30558
|
+
created via impersonation.
|
|
30559
|
+
ip_address:
|
|
30560
|
+
type:
|
|
30561
|
+
- string
|
|
30562
|
+
- 'null'
|
|
30563
|
+
description: The IP address from which the session was created.
|
|
30564
|
+
example: 198.51.100.42
|
|
30565
|
+
organization_id:
|
|
30566
|
+
type: string
|
|
30567
|
+
description: >-
|
|
30568
|
+
The ID of the organization this session is associated
|
|
30569
|
+
with.
|
|
30570
|
+
example: org_01H945H0YD4F97JN9MATX7BYAG
|
|
30571
|
+
user_agent:
|
|
30572
|
+
type:
|
|
30573
|
+
- string
|
|
30574
|
+
- 'null'
|
|
30575
|
+
description: >-
|
|
30576
|
+
The user agent string from the device that created the
|
|
30577
|
+
session.
|
|
30578
|
+
example: >-
|
|
30579
|
+
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
|
|
30580
|
+
AppleWebKit/537.36
|
|
30581
|
+
user_id:
|
|
30582
|
+
type: string
|
|
30583
|
+
description: The ID of the user this session belongs to.
|
|
30584
|
+
example: user_01E4ZCR3C56J083X43JQXF3JK5
|
|
30585
|
+
auth_method:
|
|
30586
|
+
type: string
|
|
30587
|
+
enum:
|
|
30588
|
+
- cross_app_auth
|
|
30589
|
+
- external_auth
|
|
30590
|
+
- impersonation
|
|
30591
|
+
- magic_code
|
|
30592
|
+
- migrated_session
|
|
30593
|
+
- oauth
|
|
30594
|
+
- passkey
|
|
30595
|
+
- password
|
|
30596
|
+
- sso
|
|
30597
|
+
- unknown
|
|
30598
|
+
description: The authentication method used to create this session.
|
|
30599
|
+
example: sso
|
|
30600
|
+
status:
|
|
30601
|
+
type: string
|
|
30602
|
+
enum:
|
|
30603
|
+
- active
|
|
30604
|
+
- expired
|
|
30605
|
+
- revoked
|
|
30606
|
+
description: The current status of the session.
|
|
30607
|
+
example: active
|
|
30608
|
+
expires_at:
|
|
30609
|
+
format: date-time
|
|
30610
|
+
type: string
|
|
30611
|
+
description: The timestamp when the session expires.
|
|
30612
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30613
|
+
ended_at:
|
|
30614
|
+
format: date-time
|
|
30615
|
+
type:
|
|
30616
|
+
- string
|
|
30617
|
+
- 'null'
|
|
30618
|
+
description: The timestamp when the session ended.
|
|
30619
|
+
example: null
|
|
30620
|
+
created_at:
|
|
30621
|
+
format: date-time
|
|
30622
|
+
type: string
|
|
30623
|
+
description: An ISO 8601 timestamp.
|
|
30624
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30625
|
+
updated_at:
|
|
30626
|
+
format: date-time
|
|
30627
|
+
type: string
|
|
30628
|
+
description: An ISO 8601 timestamp.
|
|
30629
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30630
|
+
required:
|
|
30631
|
+
- object
|
|
30632
|
+
- id
|
|
30633
|
+
- ip_address
|
|
30634
|
+
- user_agent
|
|
30635
|
+
- user_id
|
|
30636
|
+
- auth_method
|
|
30637
|
+
- status
|
|
30638
|
+
- expires_at
|
|
30639
|
+
- ended_at
|
|
30640
|
+
- created_at
|
|
30641
|
+
- updated_at
|
|
30642
|
+
description: The event payload.
|
|
30643
|
+
created_at:
|
|
30644
|
+
format: date-time
|
|
30645
|
+
type: string
|
|
30646
|
+
description: An ISO 8601 timestamp.
|
|
30647
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30648
|
+
context:
|
|
30649
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
30650
|
+
object:
|
|
30651
|
+
type: string
|
|
30652
|
+
description: Distinguishes the Event object.
|
|
30653
|
+
const: event
|
|
30654
|
+
required:
|
|
30655
|
+
- id
|
|
30656
|
+
- event
|
|
30657
|
+
- data
|
|
30658
|
+
- created_at
|
|
30659
|
+
- object
|
|
30470
30660
|
- type: object
|
|
30471
30661
|
properties:
|
|
30472
30662
|
id:
|
|
@@ -33090,6 +33280,11 @@ components:
|
|
|
33090
33280
|
role:
|
|
33091
33281
|
$ref: '#/components/schemas/SlimRole'
|
|
33092
33282
|
description: The primary role assigned to the user within the organization.
|
|
33283
|
+
roles:
|
|
33284
|
+
type: array
|
|
33285
|
+
items:
|
|
33286
|
+
$ref: '#/components/schemas/SlimRole'
|
|
33287
|
+
description: The list of roles assigned to the user within the organization.
|
|
33093
33288
|
user:
|
|
33094
33289
|
$ref: '#/components/schemas/UserlandUser'
|
|
33095
33290
|
description: The user that belongs to the organization through this membership.
|
|
@@ -33103,6 +33298,7 @@ components:
|
|
|
33103
33298
|
- created_at
|
|
33104
33299
|
- updated_at
|
|
33105
33300
|
- role
|
|
33301
|
+
- roles
|
|
33106
33302
|
- user
|
|
33107
33303
|
UserlandUserOrganizationMembershipList:
|
|
33108
33304
|
type: object
|
package/dist/services.d.mts
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
//#region src/policy/services.generated.d.ts
|
|
2
2
|
declare const services: readonly ["AdminPortal", "ApiKeys", "AuditLogs", "Authorization", "ClientApi", "Connect", "DirectorySync", "Events", "FeatureFlags", "Groups", "MultiFactorAuth", "OrganizationDomains", "OrganizationMembership", "Organizations", "Pipes", "PipesProvider", "Radar", "SSO", "UserManagement", "Vault", "Webhooks", "Widgets"];
|
|
3
3
|
type ServiceName = (typeof services)[number];
|
|
4
|
+
interface ServiceEndpoint {
|
|
5
|
+
method: string;
|
|
6
|
+
path: string;
|
|
7
|
+
name?: string;
|
|
8
|
+
}
|
|
9
|
+
declare const serviceEndpoints: Record<string, ServiceEndpoint[]>;
|
|
4
10
|
//#endregion
|
|
5
|
-
export { ServiceName, services };
|
|
11
|
+
export { ServiceEndpoint, ServiceName, serviceEndpoints, services };
|