@workos/openapi-spec 0.4.0 → 0.6.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.
Files changed (7) hide show
  1. package/README.md +42 -3
  2. package/{open-api-spec.yaml → dist/open-api-spec.yaml} +442 -162
  3. package/dist/operationOverrides.node.json +122 -0
  4. package/dist/policy.d.mts +85 -0
  5. package/dist/policy.mjs +398 -0
  6. package/{types.d.ts → dist/types.d.ts} +401 -127
  7. package/package.json +52 -8
package/{open-api-spec.yaml → dist/open-api-spec.yaml} RENAMED
@@ -69,6 +69,110 @@ paths:
69
69
  summary: Delete an API key
70
70
  tags:
71
71
  - api_keys
72
+ /api_keys/{id}/expire:
73
+ post:
74
+ description: >-
75
+ Expire an API key immediately, schedule a future expiration, or clear a
76
+ scheduled future expiration.
77
+ operationId: ApiKeysController_expire
78
+ parameters:
79
+ - name: id
80
+ required: true
81
+ in: path
82
+ description: The unique ID of the API key.
83
+ schema:
84
+ type: string
85
+ example: api_key_01EHZNVPK3SFK441A1RGBFSHRT
86
+ requestBody:
87
+ required: false
88
+ content:
89
+ application/json:
90
+ schema:
91
+ $ref: '#/components/schemas/ExpireApiKeyDto'
92
+ examples:
93
+ immediateExpiration:
94
+ summary: Expire immediately
95
+ value: {}
96
+ scheduleExpiration:
97
+ summary: Schedule an expiration
98
+ value:
99
+ expires_at: '2030-01-01T00:00:00.000Z'
100
+ clearExpiration:
101
+ summary: Clear a scheduled expiration
102
+ value:
103
+ expires_at: null
104
+ responses:
105
+ '200':
106
+ content:
107
+ application/json:
108
+ schema:
109
+ $ref: '#/components/schemas/ApiKey'
110
+ example:
111
+ object: api_key
112
+ id: api_key_01EHZNVPK3SFK441A1RGBFSHRT
113
+ owner:
114
+ type: organization
115
+ id: org_01EHZNVPK3SFK441A1RGBFSHRT
116
+ name: Production API Key
117
+ obfuscated_value: sk_...3456
118
+ last_used_at: null
119
+ expires_at: '2030-01-01T00:00:00.000Z'
120
+ permissions:
121
+ - posts:read
122
+ - posts:write
123
+ created_at: '2026-01-15T12:00:00.000Z'
124
+ updated_at: '2026-01-15T12:00:00.000Z'
125
+ description: OK
126
+ '404':
127
+ description: Not Found
128
+ content:
129
+ application/json:
130
+ schema:
131
+ type: object
132
+ properties:
133
+ message:
134
+ type: string
135
+ description: A human-readable description of the error.
136
+ example: 'API Key not found: ''api_key_01EHZNVPK3SFK441A1RGBFSHRT''.'
137
+ required:
138
+ - message
139
+ x-inline-with-overrides: true
140
+ '409':
141
+ description: Conflict
142
+ content:
143
+ application/json:
144
+ schema:
145
+ type: object
146
+ properties:
147
+ code:
148
+ type: string
149
+ description: The error code identifying the type of error.
150
+ example: api_key_already_expired
151
+ const: api_key_already_expired
152
+ message:
153
+ type: string
154
+ description: A human-readable description of the error.
155
+ example: API key is already expired
156
+ required:
157
+ - code
158
+ - message
159
+ x-inline-with-overrides: true
160
+ '422':
161
+ description: Unprocessable Entity
162
+ content:
163
+ application/json:
164
+ schema:
165
+ type: object
166
+ properties:
167
+ message:
168
+ type: string
169
+ description: A human-readable description of the error.
170
+ example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
171
+ required:
172
+ - message
173
+ summary: Expire an API key
174
+ tags:
175
+ - api_keys
72
176
  /audit_logs/actions:
73
177
  get:
74
178
  description: Get a list of all Audit Log actions in the current environment.
@@ -1209,7 +1313,7 @@ paths:
1209
1313
  Order the results by the creation time. Supported values are `"asc"`
1210
1314
  (ascending), `"desc"` (descending), and `"normal"` (descending with
1211
1315
  reversed cursor semantics where `before` fetches older records and
1212
- `after` fetches newer records). Defaults to descending.
1316
+ `after` fetches newer records).
1213
1317
  schema:
1214
1318
  $ref: '#/components/schemas/PaginationOrder'
1215
1319
  - name: permission_slug
@@ -1396,7 +1500,7 @@ paths:
1396
1500
  Order the results by the creation time. Supported values are `"asc"`
1397
1501
  (ascending), `"desc"` (descending), and `"normal"` (descending with
1398
1502
  reversed cursor semantics where `before` fetches older records and
1399
- `after` fetches newer records). Defaults to descending.
1503
+ `after` fetches newer records).
1400
1504
  schema:
1401
1505
  $ref: '#/components/schemas/PaginationOrder'
1402
1506
  responses:
@@ -1520,7 +1624,7 @@ paths:
1520
1624
  Order the results by the creation time. Supported values are `"asc"`
1521
1625
  (ascending), `"desc"` (descending), and `"normal"` (descending with
1522
1626
  reversed cursor semantics where `before` fetches older records and
1523
- `after` fetches newer records). Defaults to descending.
1627
+ `after` fetches newer records).
1524
1628
  schema:
1525
1629
  $ref: '#/components/schemas/PaginationOrder'
1526
1630
  responses:
@@ -1632,7 +1736,7 @@ paths:
1632
1736
  Order the results by the creation time. Supported values are `"asc"`
1633
1737
  (ascending), `"desc"` (descending), and `"normal"` (descending with
1634
1738
  reversed cursor semantics where `before` fetches older records and
1635
- `after` fetches newer records). Defaults to descending.
1739
+ `after` fetches newer records).
1636
1740
  schema:
1637
1741
  $ref: '#/components/schemas/PaginationOrder'
1638
1742
  - name: resource_id
@@ -3326,7 +3430,7 @@ paths:
3326
3430
  Order the results by the creation time. Supported values are `"asc"`
3327
3431
  (ascending), `"desc"` (descending), and `"normal"` (descending with
3328
3432
  reversed cursor semantics where `before` fetches older records and
3329
- `after` fetches newer records). Defaults to descending.
3433
+ `after` fetches newer records).
3330
3434
  schema:
3331
3435
  $ref: '#/components/schemas/PaginationOrder'
3332
3436
  - name: permission_slug
@@ -3492,7 +3596,7 @@ paths:
3492
3596
  Order the results by the creation time. Supported values are `"asc"`
3493
3597
  (ascending), `"desc"` (descending), and `"normal"` (descending with
3494
3598
  reversed cursor semantics where `before` fetches older records and
3495
- `after` fetches newer records). Defaults to descending.
3599
+ `after` fetches newer records).
3496
3600
  schema:
3497
3601
  $ref: '#/components/schemas/PaginationOrder'
3498
3602
  - name: role_slug
@@ -3586,7 +3690,7 @@ paths:
3586
3690
  Order the results by the creation time. Supported values are `"asc"`
3587
3691
  (ascending), `"desc"` (descending), and `"normal"` (descending with
3588
3692
  reversed cursor semantics where `before` fetches older records and
3589
- `after` fetches newer records). Defaults to descending.
3693
+ `after` fetches newer records).
3590
3694
  schema:
3591
3695
  $ref: '#/components/schemas/PaginationOrder'
3592
3696
  responses:
@@ -3960,7 +4064,7 @@ paths:
3960
4064
  Order the results by the creation time. Supported values are `"asc"`
3961
4065
  (ascending), `"desc"` (descending), and `"normal"` (descending with
3962
4066
  reversed cursor semantics where `before` fetches older records and
3963
- `after` fetches newer records). Defaults to descending.
4067
+ `after` fetches newer records).
3964
4068
  schema:
3965
4069
  $ref: '#/components/schemas/PaginationOrder'
3966
4070
  - name: organization_id
@@ -4646,7 +4750,7 @@ paths:
4646
4750
  Order the results by the creation time. Supported values are `"asc"`
4647
4751
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4648
4752
  reversed cursor semantics where `before` fetches older records and
4649
- `after` fetches newer records). Defaults to descending.
4753
+ `after` fetches newer records).
4650
4754
  schema:
4651
4755
  $ref: '#/components/schemas/PaginationOrder'
4652
4756
  - name: permission_slug
@@ -4796,7 +4900,7 @@ paths:
4796
4900
  Order the results by the creation time. Supported values are `"asc"`
4797
4901
  (ascending), `"desc"` (descending), and `"normal"` (descending with
4798
4902
  reversed cursor semantics where `before` fetches older records and
4799
- `after` fetches newer records). Defaults to descending.
4903
+ `after` fetches newer records).
4800
4904
  schema:
4801
4905
  $ref: '#/components/schemas/PaginationOrder'
4802
4906
  - name: role_slug
@@ -5592,7 +5696,7 @@ paths:
5592
5696
  Order the results by the creation time. Supported values are `"asc"`
5593
5697
  (ascending), `"desc"` (descending), and `"normal"` (descending with
5594
5698
  reversed cursor semantics where `before` fetches older records and
5595
- `after` fetches newer records). Defaults to descending.
5699
+ `after` fetches newer records).
5596
5700
  schema:
5597
5701
  $ref: '#/components/schemas/PaginationOrder'
5598
5702
  - name: organization_id
@@ -6606,7 +6710,7 @@ paths:
6606
6710
  Order the results by the creation time. Supported values are `"asc"`
6607
6711
  (ascending), `"desc"` (descending), and `"normal"` (descending with
6608
6712
  reversed cursor semantics where `before` fetches older records and
6609
- `after` fetches newer records). Defaults to descending.
6713
+ `after` fetches newer records).
6610
6714
  schema:
6611
6715
  $ref: '#/components/schemas/PaginationOrder'
6612
6716
  - name: directory
@@ -6774,7 +6878,7 @@ paths:
6774
6878
  Order the results by the creation time. Supported values are `"asc"`
6775
6879
  (ascending), `"desc"` (descending), and `"normal"` (descending with
6776
6880
  reversed cursor semantics where `before` fetches older records and
6777
- `after` fetches newer records). Defaults to descending.
6881
+ `after` fetches newer records).
6778
6882
  schema:
6779
6883
  $ref: '#/components/schemas/PaginationOrder'
6780
6884
  - name: directory
@@ -6947,7 +7051,7 @@ paths:
6947
7051
  Order the results by the creation time. Supported values are `"asc"`
6948
7052
  (ascending), `"desc"` (descending), and `"normal"` (descending with
6949
7053
  reversed cursor semantics where `before` fetches older records and
6950
- `after` fetches newer records). Defaults to descending.
7054
+ `after` fetches newer records).
6951
7055
  schema:
6952
7056
  $ref: '#/components/schemas/PaginationOrder'
6953
7057
  - name: events
@@ -7833,7 +7937,7 @@ paths:
7833
7937
  Order the results by the creation time. Supported values are `"asc"`
7834
7938
  (ascending), `"desc"` (descending), and `"normal"` (descending with
7835
7939
  reversed cursor semantics where `before` fetches older records and
7836
- `after` fetches newer records). Defaults to descending.
7940
+ `after` fetches newer records).
7837
7941
  schema:
7838
7942
  $ref: '#/components/schemas/PaginationOrder'
7839
7943
  - name: domains
@@ -8718,7 +8822,7 @@ paths:
8718
8822
  Order the results by the creation time. Supported values are `"asc"`
8719
8823
  (ascending), `"desc"` (descending), and `"normal"` (descending with
8720
8824
  reversed cursor semantics where `before` fetches older records and
8721
- `after` fetches newer records). Defaults to descending.
8825
+ `after` fetches newer records).
8722
8826
  schema:
8723
8827
  $ref: '#/components/schemas/PaginationOrder'
8724
8828
  responses:
@@ -9115,7 +9219,7 @@ paths:
9115
9219
  Order the results by the creation time. Supported values are `"asc"`
9116
9220
  (ascending), `"desc"` (descending), and `"normal"` (descending with
9117
9221
  reversed cursor semantics where `before` fetches older records and
9118
- `after` fetches newer records). Defaults to descending.
9222
+ `after` fetches newer records).
9119
9223
  schema:
9120
9224
  $ref: '#/components/schemas/PaginationOrder'
9121
9225
  responses:
@@ -11569,7 +11673,7 @@ paths:
11569
11673
  Order the results by the creation time. Supported values are `"asc"`
11570
11674
  (ascending), `"desc"` (descending), and `"normal"` (descending with
11571
11675
  reversed cursor semantics where `before` fetches older records and
11572
- `after` fetches newer records). Defaults to descending.
11676
+ `after` fetches newer records).
11573
11677
  schema:
11574
11678
  $ref: '#/components/schemas/PaginationOrder'
11575
11679
  - name: organization_id
@@ -12579,7 +12683,7 @@ paths:
12579
12683
  Order the results by the creation time. Supported values are `"asc"`
12580
12684
  (ascending), `"desc"` (descending), and `"normal"` (descending with
12581
12685
  reversed cursor semantics where `before` fetches older records and
12582
- `after` fetches newer records). Defaults to descending.
12686
+ `after` fetches newer records).
12583
12687
  schema:
12584
12688
  $ref: '#/components/schemas/PaginationOrder'
12585
12689
  - name: organization_id
@@ -13450,7 +13554,7 @@ paths:
13450
13554
  Order the results by the creation time. Supported values are `"asc"`
13451
13555
  (ascending), `"desc"` (descending), and `"normal"` (descending with
13452
13556
  reversed cursor semantics where `before` fetches older records and
13453
- `after` fetches newer records). Defaults to descending.
13557
+ `after` fetches newer records).
13454
13558
  schema:
13455
13559
  $ref: '#/components/schemas/PaginationOrder'
13456
13560
  responses:
@@ -13817,15 +13921,15 @@ paths:
13817
13921
  required: true
13818
13922
  in: query
13819
13923
  description: >-
13820
- The ID of the session to revoke. This can be extracted from the
13821
- `sid` claim of the access token.
13924
+ The ID of the session. This can be extracted from the `sid` claim of
13925
+ the access token.
13822
13926
  schema:
13823
13927
  example: session_01H93ZY4F80QPBEZ1R5B2SHQG8
13824
13928
  type: string
13825
13929
  - name: return_to
13826
13930
  required: false
13827
13931
  in: query
13828
- description: The URL to redirect the user to after session revocation.
13932
+ description: The URL to redirect the user to after logout.
13829
13933
  schema:
13830
13934
  example: https://example.com
13831
13935
  type: string
@@ -13941,7 +14045,7 @@ paths:
13941
14045
  Order the results by the creation time. Supported values are `"asc"`
13942
14046
  (ascending), `"desc"` (descending), and `"normal"` (descending with
13943
14047
  reversed cursor semantics where `before` fetches older records and
13944
- `after` fetches newer records). Defaults to descending.
14048
+ `after` fetches newer records).
13945
14049
  schema:
13946
14050
  $ref: '#/components/schemas/PaginationOrder'
13947
14051
  - name: organization
@@ -14576,6 +14680,12 @@ paths:
14576
14680
  - 'null'
14577
14681
  description: The last name of the user.
14578
14682
  example: Davis
14683
+ name:
14684
+ type:
14685
+ - string
14686
+ - 'null'
14687
+ description: The user's full name.
14688
+ example: Marcelina Davis
14579
14689
  profile_picture_url:
14580
14690
  type:
14581
14691
  - string
@@ -15286,7 +15396,7 @@ paths:
15286
15396
  Order the results by the creation time. Supported values are `"asc"`
15287
15397
  (ascending), `"desc"` (descending), and `"normal"` (descending with
15288
15398
  reversed cursor semantics where `before` fetches older records and
15289
- `after` fetches newer records). Defaults to descending.
15399
+ `after` fetches newer records).
15290
15400
  schema:
15291
15401
  $ref: '#/components/schemas/PaginationOrder'
15292
15402
  responses:
@@ -15790,7 +15900,7 @@ paths:
15790
15900
  Order the results by the creation time. Supported values are `"asc"`
15791
15901
  (ascending), `"desc"` (descending), and `"normal"` (descending with
15792
15902
  reversed cursor semantics where `before` fetches older records and
15793
- `after` fetches newer records). Defaults to descending.
15903
+ `after` fetches newer records).
15794
15904
  schema:
15795
15905
  $ref: '#/components/schemas/PaginationOrder'
15796
15906
  responses:
@@ -16619,7 +16729,7 @@ paths:
16619
16729
  Order the results by the creation time. Supported values are `"asc"`
16620
16730
  (ascending), `"desc"` (descending), and `"normal"` (descending with
16621
16731
  reversed cursor semantics where `before` fetches older records and
16622
- `after` fetches newer records). Defaults to descending.
16732
+ `after` fetches newer records).
16623
16733
  schema:
16624
16734
  $ref: '#/components/schemas/PaginationOrder'
16625
16735
  responses:
@@ -17102,6 +17212,10 @@ components:
17102
17212
  type: string
17103
17213
  description: The user's last name.
17104
17214
  example: Davis
17215
+ name:
17216
+ type: string
17217
+ description: The user's full name.
17218
+ example: Marcelina Davis
17105
17219
  metadata:
17106
17220
  type: object
17107
17221
  description: A set of key-value pairs to attach to the user.
@@ -17184,6 +17298,19 @@ components:
17184
17298
  example: sk_example_1234567890abcdef
17185
17299
  required:
17186
17300
  - value
17301
+ ExpireApiKeyDto:
17302
+ type: object
17303
+ properties:
17304
+ expires_at:
17305
+ type:
17306
+ - string
17307
+ - 'null'
17308
+ description: >-
17309
+ When the API key should expire. If omitted or in the past, the key
17310
+ expires immediately. Use null to clear a scheduled future
17311
+ expiration.
17312
+ example: '2030-01-01T00:00:00.000Z'
17313
+ format: date-time
17187
17314
  PaginationOrder:
17188
17315
  type: string
17189
17316
  enum:
@@ -18893,6 +19020,12 @@ components:
18893
19020
  - 'null'
18894
19021
  description: The last name of the user.
18895
19022
  example: Davis
19023
+ name:
19024
+ type:
19025
+ - string
19026
+ - 'null'
19027
+ description: The user's full name.
19028
+ example: Marcelina Davis
18896
19029
  email_verified:
18897
19030
  type:
18898
19031
  - boolean
@@ -19015,6 +19148,10 @@ components:
19015
19148
  type: string
19016
19149
  description: The last name of the user.
19017
19150
  example: Davis
19151
+ name:
19152
+ type: string
19153
+ description: The user's full name.
19154
+ example: Marcelina Davis
19018
19155
  email_verified:
19019
19156
  type: boolean
19020
19157
  description: Whether the user's email has been verified.
@@ -19173,10 +19310,6 @@ components:
19173
19310
  The ID of the session to revoke. This can be extracted from the
19174
19311
  `sid` claim of the access token.
19175
19312
  example: session_01H93ZY4F80QPBEZ1R5B2SHQG8
19176
- return_to:
19177
- type: string
19178
- description: The URL to redirect the user to after session revocation.
19179
- example: https://example.com
19180
19313
  required:
19181
19314
  - session_id
19182
19315
  CreateWebhookEndpointDto:
@@ -19209,6 +19342,7 @@ components:
19209
19342
  - authentication.radar_risk_detected
19210
19343
  - api_key.created
19211
19344
  - api_key.revoked
19345
+ - api_key.updated
19212
19346
  - connection.activated
19213
19347
  - connection.deactivated
19214
19348
  - connection.saml_certificate_renewal_required
@@ -20959,6 +21093,12 @@ components:
20959
21093
  - 'null'
20960
21094
  description: The last name of the user.
20961
21095
  example: Davis
21096
+ name:
21097
+ type:
21098
+ - string
21099
+ - 'null'
21100
+ description: The user's full name.
21101
+ example: Marcelina Davis
20962
21102
  profile_picture_url:
20963
21103
  type:
20964
21104
  - string
@@ -22650,6 +22790,7 @@ components:
22650
22790
  - name
22651
22791
  - obfuscated_value
22652
22792
  - last_used_at
22793
+ - expires_at
22653
22794
  - permissions
22654
22795
  - created_at
22655
22796
  - updated_at
@@ -22773,9 +22914,150 @@ components:
22773
22914
  - name
22774
22915
  - obfuscated_value
22775
22916
  - last_used_at
22917
+ - expires_at
22918
+ - permissions
22919
+ - created_at
22920
+ - updated_at
22921
+ description: The event payload.
22922
+ created_at:
22923
+ format: date-time
22924
+ type: string
22925
+ description: An ISO 8601 timestamp.
22926
+ example: '2026-01-15T12:00:00.000Z'
22927
+ context:
22928
+ $ref: '#/components/schemas/EventContextDto'
22929
+ object:
22930
+ type: string
22931
+ description: Distinguishes the Event object.
22932
+ const: event
22933
+ required:
22934
+ - id
22935
+ - event
22936
+ - data
22937
+ - created_at
22938
+ - object
22939
+ - type: object
22940
+ properties:
22941
+ id:
22942
+ type: string
22943
+ description: Unique identifier for the event.
22944
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
22945
+ event:
22946
+ type: string
22947
+ const: api_key.updated
22948
+ data:
22949
+ type: object
22950
+ properties:
22951
+ object:
22952
+ type: string
22953
+ description: Distinguishes the API key object.
22954
+ const: api_key
22955
+ id:
22956
+ type: string
22957
+ description: Unique identifier of the API key.
22958
+ example: api_key_01EHWNCE74X7JSDV0X3SZ3KJNY
22959
+ owner:
22960
+ oneOf:
22961
+ - type: object
22962
+ properties:
22963
+ type:
22964
+ type: string
22965
+ description: The type of the API key owner.
22966
+ const: organization
22967
+ id:
22968
+ type: string
22969
+ description: The unique identifier of the API key owner.
22970
+ example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
22971
+ required:
22972
+ - type
22973
+ - id
22974
+ - type: object
22975
+ properties:
22976
+ type:
22977
+ type: string
22978
+ description: The type of the API key owner.
22979
+ const: user
22980
+ id:
22981
+ type: string
22982
+ description: >-
22983
+ The unique identifier of the user who owns the
22984
+ API key.
22985
+ example: user_01EHWNCE74X7JSDV0X3SZ3KJNY
22986
+ organization_id:
22987
+ type: string
22988
+ description: >-
22989
+ The unique identifier of the organization the
22990
+ API key belongs to.
22991
+ example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
22992
+ required:
22993
+ - type
22994
+ - id
22995
+ - organization_id
22996
+ description: The owner of the API key.
22997
+ name:
22998
+ type: string
22999
+ description: The name of the API key.
23000
+ example: My API Key
23001
+ obfuscated_value:
23002
+ type: string
23003
+ description: The obfuscated value of the API key.
23004
+ example: sk_test_...1234
23005
+ last_used_at:
23006
+ type:
23007
+ - string
23008
+ - 'null'
23009
+ description: The timestamp when the API key was last used.
23010
+ example: '2026-01-15T12:00:00.000Z'
23011
+ expires_at:
23012
+ type:
23013
+ - string
23014
+ - 'null'
23015
+ format: date-time
23016
+ description: >-
23017
+ Timestamp when the API Key expires. Null means the key
23018
+ does not expire.
23019
+ example: null
23020
+ permissions:
23021
+ type: array
23022
+ items:
23023
+ type: string
23024
+ description: The permissions granted to the API key.
23025
+ example: *ref_17
23026
+ created_at:
23027
+ type: string
23028
+ description: The timestamp when the API key was created.
23029
+ example: '2026-01-15T12:00:00.000Z'
23030
+ updated_at:
23031
+ type: string
23032
+ description: The timestamp when the API key was last updated.
23033
+ example: '2026-01-15T12:00:00.000Z'
23034
+ previous_attributes:
23035
+ type: object
23036
+ properties:
23037
+ expires_at:
23038
+ type:
23039
+ - string
23040
+ - 'null'
23041
+ format: date-time
23042
+ description: >-
23043
+ The previous timestamp when the API Key expired.
23044
+ Null means the key did not expire.
23045
+ example: null
23046
+ required:
23047
+ - expires_at
23048
+ description: Previous API key attributes before the update.
23049
+ required:
23050
+ - object
23051
+ - id
23052
+ - owner
23053
+ - name
23054
+ - obfuscated_value
23055
+ - last_used_at
23056
+ - expires_at
22776
23057
  - permissions
22777
23058
  - created_at
22778
23059
  - updated_at
23060
+ - previous_attributes
22779
23061
  description: The event payload.
22780
23062
  created_at:
22781
23063
  format: date-time
@@ -24901,136 +25183,6 @@ components:
24901
25183
  - data
24902
25184
  - created_at
24903
25185
  - object
24904
- - type: object
24905
- properties:
24906
- id:
24907
- type: string
24908
- description: Unique identifier for the event.
24909
- example: event_01EHZNVPK3SFK441A1RGBFSHRT
24910
- event:
24911
- type: string
24912
- const: dsync.deactivated
24913
- data:
24914
- type: object
24915
- properties:
24916
- object:
24917
- type: string
24918
- description: Distinguishes the directory object.
24919
- const: directory
24920
- id:
24921
- type: string
24922
- description: Unique identifier of the directory.
24923
- example: directory_01EHWNCE74X7JSDV0X3SZ3KJNY
24924
- organization_id:
24925
- type: string
24926
- description: The ID of the organization the directory belongs to.
24927
- example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
24928
- type:
24929
- type: string
24930
- enum:
24931
- - azure scim v2.0
24932
- - bamboohr
24933
- - breathe hr
24934
- - cezanne hr
24935
- - cyberark scim v2.0
24936
- - fourth hr
24937
- - generic scim v2.0
24938
- - gsuite directory
24939
- - gusto
24940
- - hibob
24941
- - jump cloud scim v2.0
24942
- - okta scim v2.0
24943
- - onelogin scim v2.0
24944
- - people hr
24945
- - personio
24946
- - pingfederate scim v2.0
24947
- - rippling scim v2.0
24948
- - rippling
24949
- - sailpoint scim v2.0
24950
- - s3
24951
- - sftp
24952
- - sftp workday
24953
- - workday
24954
- description: The type of the directory.
24955
- example: okta scim v2.0
24956
- state:
24957
- type: string
24958
- enum:
24959
- - active
24960
- - validating
24961
- - invalid_credentials
24962
- - inactive
24963
- - deleting
24964
- description: The current state of the directory.
24965
- example: active
24966
- name:
24967
- type: string
24968
- description: The name of the directory.
24969
- example: Acme Directory
24970
- created_at:
24971
- format: date-time
24972
- type: string
24973
- description: An ISO 8601 timestamp.
24974
- example: '2026-01-15T12:00:00.000Z'
24975
- updated_at:
24976
- format: date-time
24977
- type: string
24978
- description: An ISO 8601 timestamp.
24979
- example: '2026-01-15T12:00:00.000Z'
24980
- external_key:
24981
- type: string
24982
- description: The external key of the directory.
24983
- example: ext_01EHWNCE74X7JSDV0X3SZ3KJNY
24984
- domains:
24985
- type: array
24986
- items:
24987
- type: object
24988
- properties:
24989
- object:
24990
- type: string
24991
- description: Distinguishes the organization domain object.
24992
- const: organization_domain
24993
- id:
24994
- type: string
24995
- description: Unique identifier of the organization domain.
24996
- example: org_domain_01EHWNCE74X7JSDV0X3SZ3KJNY
24997
- domain:
24998
- type: string
24999
- description: The domain value.
25000
- example: acme.com
25001
- required:
25002
- - object
25003
- - id
25004
- - domain
25005
- description: The domains associated with the directory.
25006
- required:
25007
- - object
25008
- - id
25009
- - type
25010
- - state
25011
- - name
25012
- - created_at
25013
- - updated_at
25014
- - external_key
25015
- - domains
25016
- description: The event payload.
25017
- created_at:
25018
- format: date-time
25019
- type: string
25020
- description: An ISO 8601 timestamp.
25021
- example: '2026-01-15T12:00:00.000Z'
25022
- context:
25023
- $ref: '#/components/schemas/EventContextDto'
25024
- object:
25025
- type: string
25026
- description: Distinguishes the Event object.
25027
- const: event
25028
- required:
25029
- - id
25030
- - event
25031
- - data
25032
- - created_at
25033
- - object
25034
25186
  - type: object
25035
25187
  properties:
25036
25188
  id:
@@ -25278,6 +25430,134 @@ components:
25278
25430
  - data
25279
25431
  - created_at
25280
25432
  - object
25433
+ - type: object
25434
+ properties:
25435
+ id:
25436
+ type: string
25437
+ description: Unique identifier for the event.
25438
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
25439
+ event:
25440
+ type: string
25441
+ const: dsync.token.created
25442
+ data:
25443
+ type: object
25444
+ properties:
25445
+ object:
25446
+ type: string
25447
+ description: Distinguishes the directory token object.
25448
+ const: directory_token
25449
+ id:
25450
+ type: string
25451
+ description: Unique identifier of the directory token.
25452
+ example: directory_token_01EHWNCE74X7JSDV0X3SZ3KJNY
25453
+ directory_id:
25454
+ type: string
25455
+ description: The ID of the directory the token authenticates to.
25456
+ example: directory_01EHWNCE74X7JSDV0X3SZ3KJNY
25457
+ organization_id:
25458
+ type: string
25459
+ description: The ID of the organization the directory belongs to.
25460
+ example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
25461
+ token_suffix:
25462
+ type: string
25463
+ description: >-
25464
+ The trailing characters of the bearer token, for
25465
+ identification only. The full token value is never
25466
+ included in events.
25467
+ example: a1b2
25468
+ created_at:
25469
+ format: date-time
25470
+ type: string
25471
+ description: An ISO 8601 timestamp.
25472
+ example: '2026-01-15T12:00:00.000Z'
25473
+ required:
25474
+ - object
25475
+ - id
25476
+ - directory_id
25477
+ - token_suffix
25478
+ - created_at
25479
+ description: The event payload.
25480
+ created_at:
25481
+ format: date-time
25482
+ type: string
25483
+ description: An ISO 8601 timestamp.
25484
+ example: '2026-01-15T12:00:00.000Z'
25485
+ context:
25486
+ $ref: '#/components/schemas/EventContextDto'
25487
+ object:
25488
+ type: string
25489
+ description: Distinguishes the Event object.
25490
+ const: event
25491
+ required:
25492
+ - id
25493
+ - event
25494
+ - data
25495
+ - created_at
25496
+ - object
25497
+ - type: object
25498
+ properties:
25499
+ id:
25500
+ type: string
25501
+ description: Unique identifier for the event.
25502
+ example: event_01EHZNVPK3SFK441A1RGBFSHRT
25503
+ event:
25504
+ type: string
25505
+ const: dsync.token.revoked
25506
+ data:
25507
+ type: object
25508
+ properties:
25509
+ object:
25510
+ type: string
25511
+ description: Distinguishes the directory token object.
25512
+ const: directory_token
25513
+ id:
25514
+ type: string
25515
+ description: Unique identifier of the directory token.
25516
+ example: directory_token_01EHWNCE74X7JSDV0X3SZ3KJNY
25517
+ directory_id:
25518
+ type: string
25519
+ description: The ID of the directory the token authenticates to.
25520
+ example: directory_01EHWNCE74X7JSDV0X3SZ3KJNY
25521
+ organization_id:
25522
+ type: string
25523
+ description: The ID of the organization the directory belongs to.
25524
+ example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
25525
+ token_suffix:
25526
+ type: string
25527
+ description: >-
25528
+ The trailing characters of the bearer token, for
25529
+ identification only. The full token value is never
25530
+ included in events.
25531
+ example: a1b2
25532
+ created_at:
25533
+ format: date-time
25534
+ type: string
25535
+ description: An ISO 8601 timestamp.
25536
+ example: '2026-01-15T12:00:00.000Z'
25537
+ required:
25538
+ - object
25539
+ - id
25540
+ - directory_id
25541
+ - token_suffix
25542
+ - created_at
25543
+ description: The event payload.
25544
+ created_at:
25545
+ format: date-time
25546
+ type: string
25547
+ description: An ISO 8601 timestamp.
25548
+ example: '2026-01-15T12:00:00.000Z'
25549
+ context:
25550
+ $ref: '#/components/schemas/EventContextDto'
25551
+ object:
25552
+ type: string
25553
+ description: Distinguishes the Event object.
25554
+ const: event
25555
+ required:
25556
+ - id
25557
+ - event
25558
+ - data
25559
+ - created_at
25560
+ - object
25281
25561
  - type: object
25282
25562
  properties:
25283
25563
  id:
@@ -31001,6 +31281,7 @@ components:
31001
31281
  - GenericHttps
31002
31282
  - GoogleCloudStorage
31003
31283
  - S3
31284
+ - Snowflake
31004
31285
  - Splunk
31005
31286
  description: The type of the Audit Log Stream destination.
31006
31287
  example: Datadog
@@ -31445,7 +31726,6 @@ components:
31445
31726
  enum:
31446
31727
  - bot_detection
31447
31728
  - brute_force_attack
31448
- - domain_sign_up_rate_limit
31449
31729
  - impossible_travel
31450
31730
  - repeat_sign_up
31451
31731
  - stale_account