@workos/openapi-spec 0.115.0 → 0.117.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 +403 -200
- package/dist/types.d.ts +145 -19
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -3767,7 +3767,7 @@ paths:
|
|
|
3767
3767
|
summary: Check authorization
|
|
3768
3768
|
tags:
|
|
3769
3769
|
- authorization
|
|
3770
|
-
x-mutually-exclusive-body-groups: &
|
|
3770
|
+
x-mutually-exclusive-body-groups: &ref_7
|
|
3771
3771
|
resource_target:
|
|
3772
3772
|
optional: false
|
|
3773
3773
|
variants:
|
|
@@ -4411,7 +4411,7 @@ paths:
|
|
|
4411
4411
|
summary: Assign a role
|
|
4412
4412
|
tags:
|
|
4413
4413
|
- authorization
|
|
4414
|
-
x-mutually-exclusive-body-groups: &
|
|
4414
|
+
x-mutually-exclusive-body-groups: &ref_8
|
|
4415
4415
|
resource_target:
|
|
4416
4416
|
optional: false
|
|
4417
4417
|
variants:
|
|
@@ -4482,7 +4482,7 @@ paths:
|
|
|
4482
4482
|
summary: Remove a role assignment
|
|
4483
4483
|
tags:
|
|
4484
4484
|
- authorization
|
|
4485
|
-
x-mutually-exclusive-body-groups: &
|
|
4485
|
+
x-mutually-exclusive-body-groups: &ref_9
|
|
4486
4486
|
resource_target:
|
|
4487
4487
|
optional: false
|
|
4488
4488
|
variants:
|
|
@@ -6905,7 +6905,7 @@ paths:
|
|
|
6905
6905
|
summary: Create an authorization resource
|
|
6906
6906
|
tags:
|
|
6907
6907
|
- authorization
|
|
6908
|
-
x-mutually-exclusive-body-groups: &
|
|
6908
|
+
x-mutually-exclusive-body-groups: &ref_10
|
|
6909
6909
|
parent_resource:
|
|
6910
6910
|
optional: true
|
|
6911
6911
|
variants:
|
|
@@ -9073,7 +9073,7 @@ paths:
|
|
|
9073
9073
|
tags:
|
|
9074
9074
|
- connections
|
|
9075
9075
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
9076
|
-
x-mutually-exclusive-body-groups: &
|
|
9076
|
+
x-mutually-exclusive-body-groups: &ref_11
|
|
9077
9077
|
protocol_options:
|
|
9078
9078
|
optional: false
|
|
9079
9079
|
variants:
|
|
@@ -10315,7 +10315,7 @@ paths:
|
|
|
10315
10315
|
tags:
|
|
10316
10316
|
- connections
|
|
10317
10317
|
x-feature-flag: connections-api-migrations-capabilities-api
|
|
10318
|
-
x-mutually-exclusive-body-groups: &
|
|
10318
|
+
x-mutually-exclusive-body-groups: &ref_14
|
|
10319
10319
|
protocol_options:
|
|
10320
10320
|
optional: true
|
|
10321
10321
|
variants:
|
|
@@ -11185,18 +11185,37 @@ paths:
|
|
|
11185
11185
|
required:
|
|
11186
11186
|
- message
|
|
11187
11187
|
'404':
|
|
11188
|
-
description:
|
|
11188
|
+
description: >-
|
|
11189
|
+
The data integration or selected connected account was not found
|
|
11190
|
+
(`entity_not_found`).
|
|
11189
11191
|
content:
|
|
11190
11192
|
application/json:
|
|
11191
11193
|
schema:
|
|
11192
|
-
|
|
11193
|
-
|
|
11194
|
-
|
|
11195
|
-
|
|
11196
|
-
|
|
11197
|
-
|
|
11198
|
-
|
|
11199
|
-
|
|
11194
|
+
anyOf:
|
|
11195
|
+
- type: object
|
|
11196
|
+
properties:
|
|
11197
|
+
code:
|
|
11198
|
+
type: string
|
|
11199
|
+
description: The error code identifying the type of error.
|
|
11200
|
+
example: entity_not_found
|
|
11201
|
+
const: entity_not_found
|
|
11202
|
+
message:
|
|
11203
|
+
type: string
|
|
11204
|
+
description: A human-readable description of the error.
|
|
11205
|
+
example: Request could not be processed.
|
|
11206
|
+
required:
|
|
11207
|
+
- code
|
|
11208
|
+
- message
|
|
11209
|
+
- type: object
|
|
11210
|
+
properties:
|
|
11211
|
+
message:
|
|
11212
|
+
type: string
|
|
11213
|
+
description: A human-readable description of the error.
|
|
11214
|
+
example: >-
|
|
11215
|
+
Organization not found:
|
|
11216
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
11217
|
+
required:
|
|
11218
|
+
- message
|
|
11200
11219
|
'409':
|
|
11201
11220
|
description: >-
|
|
11202
11221
|
Several connected accounts match the connection owner for the
|
|
@@ -11238,54 +11257,187 @@ paths:
|
|
|
11238
11257
|
content:
|
|
11239
11258
|
application/json:
|
|
11240
11259
|
schema:
|
|
11241
|
-
|
|
11242
|
-
|
|
11243
|
-
|
|
11244
|
-
|
|
11245
|
-
|
|
11246
|
-
|
|
11247
|
-
|
|
11248
|
-
|
|
11249
|
-
|
|
11250
|
-
|
|
11251
|
-
|
|
11252
|
-
|
|
11253
|
-
|
|
11254
|
-
|
|
11255
|
-
|
|
11256
|
-
|
|
11257
|
-
|
|
11258
|
-
|
|
11259
|
-
|
|
11260
|
-
|
|
11261
|
-
|
|
11262
|
-
|
|
11263
|
-
|
|
11264
|
-
|
|
11265
|
-
|
|
11266
|
-
|
|
11267
|
-
|
|
11268
|
-
|
|
11269
|
-
|
|
11270
|
-
|
|
11271
|
-
|
|
11272
|
-
|
|
11273
|
-
|
|
11274
|
-
|
|
11275
|
-
|
|
11276
|
-
|
|
11277
|
-
|
|
11278
|
-
|
|
11279
|
-
|
|
11280
|
-
|
|
11281
|
-
|
|
11282
|
-
|
|
11283
|
-
|
|
11284
|
-
|
|
11285
|
-
|
|
11286
|
-
|
|
11287
|
-
|
|
11288
|
-
|
|
11260
|
+
oneOf:
|
|
11261
|
+
- type: object
|
|
11262
|
+
properties:
|
|
11263
|
+
user_id:
|
|
11264
|
+
type: string
|
|
11265
|
+
description: >-
|
|
11266
|
+
The ID of the user to authorize. When `connection_owner`
|
|
11267
|
+
is `organization`, this is the user authorizing on
|
|
11268
|
+
behalf of the organization; they must be an active
|
|
11269
|
+
member of the organization and do not become the owner
|
|
11270
|
+
of the resulting connected account.
|
|
11271
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11272
|
+
organization_id:
|
|
11273
|
+
type: string
|
|
11274
|
+
description: >-
|
|
11275
|
+
An organization ID to scope the authorization to a
|
|
11276
|
+
specific organization. Required when `connection_owner`
|
|
11277
|
+
is `organization`.
|
|
11278
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11279
|
+
connection_owner:
|
|
11280
|
+
type: string
|
|
11281
|
+
enum:
|
|
11282
|
+
- user
|
|
11283
|
+
- organization
|
|
11284
|
+
description: >-
|
|
11285
|
+
Who will own the connected account. `user` (the default)
|
|
11286
|
+
connects the user's own account. `organization` connects
|
|
11287
|
+
the organization's shared account and requires
|
|
11288
|
+
`organization_id`.
|
|
11289
|
+
example: user
|
|
11290
|
+
return_to:
|
|
11291
|
+
type: string
|
|
11292
|
+
format: uri
|
|
11293
|
+
description: The URL to redirect the user to after authorization.
|
|
11294
|
+
example: https://example.com/callback
|
|
11295
|
+
config:
|
|
11296
|
+
type: object
|
|
11297
|
+
additionalProperties:
|
|
11298
|
+
type: string
|
|
11299
|
+
description: >-
|
|
11300
|
+
Connect-time config values for the provider-declared
|
|
11301
|
+
`installation`-scope fields (e.g. a Zendesk
|
|
11302
|
+
`subdomain`), keyed by the config field. Only fields the
|
|
11303
|
+
provider declares may be supplied, and required fields
|
|
11304
|
+
must be provided unless already pinned on the
|
|
11305
|
+
integration.
|
|
11306
|
+
example: &ref_1
|
|
11307
|
+
subdomain: acme
|
|
11308
|
+
required:
|
|
11309
|
+
- user_id
|
|
11310
|
+
additionalProperties: false
|
|
11311
|
+
- type: object
|
|
11312
|
+
properties:
|
|
11313
|
+
user_id:
|
|
11314
|
+
type: string
|
|
11315
|
+
description: >-
|
|
11316
|
+
The ID of the user to authorize. When `connection_owner`
|
|
11317
|
+
is `organization`, this is the user authorizing on
|
|
11318
|
+
behalf of the organization; they must be an active
|
|
11319
|
+
member of the organization and do not become the owner
|
|
11320
|
+
of the resulting connected account.
|
|
11321
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11322
|
+
organization_id:
|
|
11323
|
+
type: string
|
|
11324
|
+
description: >-
|
|
11325
|
+
An organization ID to scope the authorization to a
|
|
11326
|
+
specific organization. Required when `connection_owner`
|
|
11327
|
+
is `organization`.
|
|
11328
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11329
|
+
connection_owner:
|
|
11330
|
+
type: string
|
|
11331
|
+
enum:
|
|
11332
|
+
- user
|
|
11333
|
+
- organization
|
|
11334
|
+
description: >-
|
|
11335
|
+
Who will own the connected account. `user` (the default)
|
|
11336
|
+
connects the user's own account. `organization` connects
|
|
11337
|
+
the organization's shared account and requires
|
|
11338
|
+
`organization_id`.
|
|
11339
|
+
example: user
|
|
11340
|
+
return_to:
|
|
11341
|
+
type: string
|
|
11342
|
+
format: uri
|
|
11343
|
+
description: The URL to redirect the user to after authorization.
|
|
11344
|
+
example: https://example.com/callback
|
|
11345
|
+
config:
|
|
11346
|
+
type: object
|
|
11347
|
+
additionalProperties:
|
|
11348
|
+
type: string
|
|
11349
|
+
description: >-
|
|
11350
|
+
Connect-time config values for the provider-declared
|
|
11351
|
+
`installation`-scope fields (e.g. a Zendesk
|
|
11352
|
+
`subdomain`), keyed by the config field. Only fields the
|
|
11353
|
+
provider declares may be supplied, and required fields
|
|
11354
|
+
must be provided unless already pinned on the
|
|
11355
|
+
integration.
|
|
11356
|
+
example: *ref_1
|
|
11357
|
+
connection_intent:
|
|
11358
|
+
type: string
|
|
11359
|
+
description: >-
|
|
11360
|
+
Create another connection. The first connection for an
|
|
11361
|
+
owner shape fills the compatibility slot; later
|
|
11362
|
+
connections are standard. Creating an additional
|
|
11363
|
+
connection is not yet available: until it is, `add`
|
|
11364
|
+
succeeds only when the owner has no connection for this
|
|
11365
|
+
integration and otherwise returns 404
|
|
11366
|
+
`multiple_connections_unavailable`. Omit
|
|
11367
|
+
`connection_intent` to use the compatibility connection,
|
|
11368
|
+
or send `reauthorize` with `connected_account_id` to
|
|
11369
|
+
reauthorize one exact connection.
|
|
11370
|
+
example: add
|
|
11371
|
+
const: add
|
|
11372
|
+
required:
|
|
11373
|
+
- user_id
|
|
11374
|
+
- connection_intent
|
|
11375
|
+
additionalProperties: false
|
|
11376
|
+
- type: object
|
|
11377
|
+
properties:
|
|
11378
|
+
user_id:
|
|
11379
|
+
type: string
|
|
11380
|
+
description: >-
|
|
11381
|
+
The ID of the user to authorize. When `connection_owner`
|
|
11382
|
+
is `organization`, this is the user authorizing on
|
|
11383
|
+
behalf of the organization; they must be an active
|
|
11384
|
+
member of the organization and do not become the owner
|
|
11385
|
+
of the resulting connected account.
|
|
11386
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11387
|
+
organization_id:
|
|
11388
|
+
type: string
|
|
11389
|
+
description: >-
|
|
11390
|
+
An organization ID to scope the authorization to a
|
|
11391
|
+
specific organization. Required when `connection_owner`
|
|
11392
|
+
is `organization`.
|
|
11393
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11394
|
+
connection_owner:
|
|
11395
|
+
type: string
|
|
11396
|
+
enum:
|
|
11397
|
+
- user
|
|
11398
|
+
- organization
|
|
11399
|
+
description: >-
|
|
11400
|
+
Who will own the connected account. `user` (the default)
|
|
11401
|
+
connects the user's own account. `organization` connects
|
|
11402
|
+
the organization's shared account and requires
|
|
11403
|
+
`organization_id`.
|
|
11404
|
+
example: user
|
|
11405
|
+
return_to:
|
|
11406
|
+
type: string
|
|
11407
|
+
format: uri
|
|
11408
|
+
description: The URL to redirect the user to after authorization.
|
|
11409
|
+
example: https://example.com/callback
|
|
11410
|
+
config:
|
|
11411
|
+
type: object
|
|
11412
|
+
additionalProperties:
|
|
11413
|
+
type: string
|
|
11414
|
+
description: >-
|
|
11415
|
+
Connect-time config values for the provider-declared
|
|
11416
|
+
`installation`-scope fields (e.g. a Zendesk
|
|
11417
|
+
`subdomain`), keyed by the config field. Only fields the
|
|
11418
|
+
provider declares may be supplied, and required fields
|
|
11419
|
+
must be provided unless already pinned on the
|
|
11420
|
+
integration.
|
|
11421
|
+
example: *ref_1
|
|
11422
|
+
connection_intent:
|
|
11423
|
+
type: string
|
|
11424
|
+
description: >-
|
|
11425
|
+
Reauthorize exactly the connection named by
|
|
11426
|
+
`connected_account_id`.
|
|
11427
|
+
example: reauthorize
|
|
11428
|
+
const: reauthorize
|
|
11429
|
+
connected_account_id:
|
|
11430
|
+
type: string
|
|
11431
|
+
pattern: ^data_installation_.+$
|
|
11432
|
+
description: >-
|
|
11433
|
+
The exact connected account to reauthorize. Required
|
|
11434
|
+
with `connection_intent: reauthorize`.
|
|
11435
|
+
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11436
|
+
required:
|
|
11437
|
+
- user_id
|
|
11438
|
+
- connection_intent
|
|
11439
|
+
- connected_account_id
|
|
11440
|
+
additionalProperties: false
|
|
11289
11441
|
responses:
|
|
11290
11442
|
'200':
|
|
11291
11443
|
description: OK
|
|
@@ -11322,18 +11474,50 @@ paths:
|
|
|
11322
11474
|
required:
|
|
11323
11475
|
- message
|
|
11324
11476
|
'404':
|
|
11325
|
-
description:
|
|
11477
|
+
description: >-
|
|
11478
|
+
The integration or user was not found (`entity_not_found`);
|
|
11479
|
+
`connected_account_not_found` when `connected_account_id` does not
|
|
11480
|
+
name a connection for this owner and integration; or
|
|
11481
|
+
`multiple_connections_unavailable` when `connection_intent: add`
|
|
11482
|
+
would create an additional connection before that capability is
|
|
11483
|
+
available.
|
|
11326
11484
|
content:
|
|
11327
11485
|
application/json:
|
|
11328
11486
|
schema:
|
|
11329
|
-
|
|
11330
|
-
|
|
11331
|
-
|
|
11332
|
-
|
|
11333
|
-
|
|
11334
|
-
|
|
11335
|
-
|
|
11336
|
-
|
|
11487
|
+
anyOf:
|
|
11488
|
+
- type: object
|
|
11489
|
+
properties:
|
|
11490
|
+
code:
|
|
11491
|
+
type: string
|
|
11492
|
+
enum:
|
|
11493
|
+
- multiple_connections_unavailable
|
|
11494
|
+
- connected_account_not_found
|
|
11495
|
+
- entity_not_found
|
|
11496
|
+
description: The error code identifying the type of error.
|
|
11497
|
+
example: multiple_connections_unavailable
|
|
11498
|
+
message:
|
|
11499
|
+
type: string
|
|
11500
|
+
description: A human-readable description of the error.
|
|
11501
|
+
example: Request could not be processed.
|
|
11502
|
+
required:
|
|
11503
|
+
- code
|
|
11504
|
+
- message
|
|
11505
|
+
- type: object
|
|
11506
|
+
properties:
|
|
11507
|
+
message:
|
|
11508
|
+
type: string
|
|
11509
|
+
description: A human-readable description of the error.
|
|
11510
|
+
example: >-
|
|
11511
|
+
Organization not found:
|
|
11512
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
11513
|
+
required:
|
|
11514
|
+
- message
|
|
11515
|
+
'422':
|
|
11516
|
+
description: The selected connected account does not use OAuth authentication.
|
|
11517
|
+
content:
|
|
11518
|
+
application/json:
|
|
11519
|
+
schema:
|
|
11520
|
+
$ref: '#/components/schemas/AuthMethodMismatchError'
|
|
11337
11521
|
summary: Get authorization URL
|
|
11338
11522
|
tags:
|
|
11339
11523
|
- pipes
|
|
@@ -11605,7 +11789,7 @@ paths:
|
|
|
11605
11789
|
Provider-specific configuration values collected for
|
|
11606
11790
|
this installation, keyed by the provider's config field
|
|
11607
11791
|
descriptors.
|
|
11608
|
-
example: &
|
|
11792
|
+
example: &ref_2
|
|
11609
11793
|
salesforce_host: acme.my.salesforce.com
|
|
11610
11794
|
required:
|
|
11611
11795
|
- user_id
|
|
@@ -11657,7 +11841,7 @@ paths:
|
|
|
11657
11841
|
Provider-specific configuration values collected for
|
|
11658
11842
|
this installation, keyed by the provider's config field
|
|
11659
11843
|
descriptors.
|
|
11660
|
-
example: *
|
|
11844
|
+
example: *ref_2
|
|
11661
11845
|
connection_intent:
|
|
11662
11846
|
type: string
|
|
11663
11847
|
description: >-
|
|
@@ -11724,7 +11908,7 @@ paths:
|
|
|
11724
11908
|
Provider-specific configuration values collected for
|
|
11725
11909
|
this installation, keyed by the provider's config field
|
|
11726
11910
|
descriptors.
|
|
11727
|
-
example: *
|
|
11911
|
+
example: *ref_2
|
|
11728
11912
|
connected_account_id:
|
|
11729
11913
|
type: string
|
|
11730
11914
|
pattern: ^data_installation_.+$
|
|
@@ -11787,18 +11971,37 @@ paths:
|
|
|
11787
11971
|
required:
|
|
11788
11972
|
- message
|
|
11789
11973
|
'404':
|
|
11790
|
-
description:
|
|
11974
|
+
description: >-
|
|
11975
|
+
The data integration or selected connected account was not found
|
|
11976
|
+
(`entity_not_found`).
|
|
11791
11977
|
content:
|
|
11792
11978
|
application/json:
|
|
11793
11979
|
schema:
|
|
11794
|
-
|
|
11795
|
-
|
|
11796
|
-
|
|
11797
|
-
|
|
11798
|
-
|
|
11799
|
-
|
|
11800
|
-
|
|
11801
|
-
|
|
11980
|
+
anyOf:
|
|
11981
|
+
- type: object
|
|
11982
|
+
properties:
|
|
11983
|
+
code:
|
|
11984
|
+
type: string
|
|
11985
|
+
description: The error code identifying the type of error.
|
|
11986
|
+
example: entity_not_found
|
|
11987
|
+
const: entity_not_found
|
|
11988
|
+
message:
|
|
11989
|
+
type: string
|
|
11990
|
+
description: A human-readable description of the error.
|
|
11991
|
+
example: Request could not be processed.
|
|
11992
|
+
required:
|
|
11993
|
+
- code
|
|
11994
|
+
- message
|
|
11995
|
+
- type: object
|
|
11996
|
+
properties:
|
|
11997
|
+
message:
|
|
11998
|
+
type: string
|
|
11999
|
+
description: A human-readable description of the error.
|
|
12000
|
+
example: >-
|
|
12001
|
+
Organization not found:
|
|
12002
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
12003
|
+
required:
|
|
12004
|
+
- message
|
|
11802
12005
|
'409':
|
|
11803
12006
|
description: >-
|
|
11804
12007
|
Several connected accounts match the connection owner for the
|
|
@@ -14383,7 +14586,7 @@ paths:
|
|
|
14383
14586
|
summary: Set Retention
|
|
14384
14587
|
tags:
|
|
14385
14588
|
- audit-logs
|
|
14386
|
-
x-mutually-exclusive-body-groups: &
|
|
14589
|
+
x-mutually-exclusive-body-groups: &ref_6
|
|
14387
14590
|
retention:
|
|
14388
14591
|
optional: false
|
|
14389
14592
|
variants:
|
|
@@ -16142,7 +16345,7 @@ paths:
|
|
|
16142
16345
|
credentialsType: oauth2
|
|
16143
16346
|
createdAt: '2024-01-15T10:30:00.000Z'
|
|
16144
16347
|
updatedAt: '2024-01-15T10:30:00.000Z'
|
|
16145
|
-
connected_account: &
|
|
16348
|
+
connected_account: &ref_3
|
|
16146
16349
|
object: connected_account
|
|
16147
16350
|
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
16148
16351
|
user_id: null
|
|
@@ -16167,7 +16370,7 @@ paths:
|
|
|
16167
16370
|
createdAt: '2024-01-16T14:20:00.000Z'
|
|
16168
16371
|
updatedAt: '2024-01-16T14:20:00.000Z'
|
|
16169
16372
|
connected_accounts:
|
|
16170
|
-
- *
|
|
16373
|
+
- *ref_3
|
|
16171
16374
|
'401':
|
|
16172
16375
|
description: The request is missing a valid API key.
|
|
16173
16376
|
'404':
|
|
@@ -21065,7 +21268,7 @@ paths:
|
|
|
21065
21268
|
summary: Create an organization membership
|
|
21066
21269
|
tags:
|
|
21067
21270
|
- user-management.organization-membership
|
|
21068
|
-
x-mutually-exclusive-body-groups: &
|
|
21271
|
+
x-mutually-exclusive-body-groups: &ref_20
|
|
21069
21272
|
role:
|
|
21070
21273
|
optional: true
|
|
21071
21274
|
variants:
|
|
@@ -21249,7 +21452,7 @@ paths:
|
|
|
21249
21452
|
summary: Update an organization membership
|
|
21250
21453
|
tags:
|
|
21251
21454
|
- user-management.organization-membership
|
|
21252
|
-
x-mutually-exclusive-body-groups: &
|
|
21455
|
+
x-mutually-exclusive-body-groups: &ref_21
|
|
21253
21456
|
role:
|
|
21254
21457
|
optional: true
|
|
21255
21458
|
variants:
|
|
@@ -22569,7 +22772,7 @@ paths:
|
|
|
22569
22772
|
summary: Create a user
|
|
22570
22773
|
tags:
|
|
22571
22774
|
- user-management.users
|
|
22572
|
-
x-mutually-exclusive-body-groups: &
|
|
22775
|
+
x-mutually-exclusive-body-groups: &ref_22
|
|
22573
22776
|
password:
|
|
22574
22777
|
optional: true
|
|
22575
22778
|
variants:
|
|
@@ -22881,7 +23084,7 @@ paths:
|
|
|
22881
23084
|
summary: Update a user
|
|
22882
23085
|
tags:
|
|
22883
23086
|
- user-management.users
|
|
22884
|
-
x-mutually-exclusive-body-groups: &
|
|
23087
|
+
x-mutually-exclusive-body-groups: &ref_26
|
|
22885
23088
|
password:
|
|
22886
23089
|
optional: true
|
|
22887
23090
|
variants:
|
|
@@ -26857,7 +27060,7 @@ components:
|
|
|
26857
27060
|
example: An application for managing user access
|
|
26858
27061
|
scopes:
|
|
26859
27062
|
description: The OAuth scopes granted to the application.
|
|
26860
|
-
example: &
|
|
27063
|
+
example: &ref_4
|
|
26861
27064
|
- openid
|
|
26862
27065
|
- profile
|
|
26863
27066
|
- email
|
|
@@ -26919,7 +27122,7 @@ components:
|
|
|
26919
27122
|
example: An application for managing user access
|
|
26920
27123
|
scopes:
|
|
26921
27124
|
description: The OAuth scopes granted to the application.
|
|
26922
|
-
example: *
|
|
27125
|
+
example: *ref_4
|
|
26923
27126
|
type:
|
|
26924
27127
|
- array
|
|
26925
27128
|
- 'null'
|
|
@@ -26992,7 +27195,7 @@ components:
|
|
|
26992
27195
|
owner: user_01GBTCQ2
|
|
26993
27196
|
maxProperties: 50
|
|
26994
27197
|
additionalProperties: false
|
|
26995
|
-
patternProperties: &
|
|
27198
|
+
patternProperties: &ref_5
|
|
26996
27199
|
^[a-zA-Z0-9_-]{0,40}$:
|
|
26997
27200
|
anyOf:
|
|
26998
27201
|
- type: string
|
|
@@ -27024,7 +27227,7 @@ components:
|
|
|
27024
27227
|
owner: user_01GBTCQ2
|
|
27025
27228
|
maxProperties: 50
|
|
27026
27229
|
additionalProperties: false
|
|
27027
|
-
patternProperties: *
|
|
27230
|
+
patternProperties: *ref_5
|
|
27028
27231
|
required:
|
|
27029
27232
|
- id
|
|
27030
27233
|
- type
|
|
@@ -27071,7 +27274,7 @@ components:
|
|
|
27071
27274
|
owner: user_01GBTCQ2
|
|
27072
27275
|
maxProperties: 50
|
|
27073
27276
|
additionalProperties: false
|
|
27074
|
-
patternProperties: *
|
|
27277
|
+
patternProperties: *ref_5
|
|
27075
27278
|
version:
|
|
27076
27279
|
type: integer
|
|
27077
27280
|
description: What schema version the event is associated with.
|
|
@@ -27153,7 +27356,7 @@ components:
|
|
|
27153
27356
|
- range_start
|
|
27154
27357
|
- range_end
|
|
27155
27358
|
UpdateAuditLogsRetentionDto:
|
|
27156
|
-
x-mutually-exclusive-body-groups: *
|
|
27359
|
+
x-mutually-exclusive-body-groups: *ref_6
|
|
27157
27360
|
oneOf:
|
|
27158
27361
|
- type: object
|
|
27159
27362
|
properties:
|
|
@@ -27338,7 +27541,7 @@ components:
|
|
|
27338
27541
|
x-exclude-from-lint: true
|
|
27339
27542
|
required:
|
|
27340
27543
|
- resource_id
|
|
27341
|
-
x-mutually-exclusive-body-groups: *
|
|
27544
|
+
x-mutually-exclusive-body-groups: *ref_7
|
|
27342
27545
|
CreateGroupRoleAssignmentDto:
|
|
27343
27546
|
type: object
|
|
27344
27547
|
properties:
|
|
@@ -27479,7 +27682,7 @@ components:
|
|
|
27479
27682
|
x-exclude-from-lint: true
|
|
27480
27683
|
required:
|
|
27481
27684
|
- resource_id
|
|
27482
|
-
x-mutually-exclusive-body-groups: *
|
|
27685
|
+
x-mutually-exclusive-body-groups: *ref_8
|
|
27483
27686
|
RemoveRoleDto:
|
|
27484
27687
|
allOf:
|
|
27485
27688
|
- type: object
|
|
@@ -27538,7 +27741,7 @@ components:
|
|
|
27538
27741
|
x-exclude-from-lint: true
|
|
27539
27742
|
required:
|
|
27540
27743
|
- resource_id
|
|
27541
|
-
x-mutually-exclusive-body-groups: *
|
|
27744
|
+
x-mutually-exclusive-body-groups: *ref_9
|
|
27542
27745
|
SetRolePermissionsDto:
|
|
27543
27746
|
type: object
|
|
27544
27747
|
properties:
|
|
@@ -27888,7 +28091,7 @@ components:
|
|
|
27888
28091
|
x-exclude-from-lint: true
|
|
27889
28092
|
required:
|
|
27890
28093
|
- parent_resource_id
|
|
27891
|
-
x-mutually-exclusive-body-groups: *
|
|
28094
|
+
x-mutually-exclusive-body-groups: *ref_10
|
|
27892
28095
|
CreateConnectionKeyPairDto:
|
|
27893
28096
|
type: object
|
|
27894
28097
|
properties:
|
|
@@ -28006,7 +28209,7 @@ components:
|
|
|
28006
28209
|
default: true
|
|
28007
28210
|
token_authentication_method:
|
|
28008
28211
|
type: string
|
|
28009
|
-
enum: &
|
|
28212
|
+
enum: &ref_12
|
|
28010
28213
|
- client_secret_post
|
|
28011
28214
|
- client_secret_basic
|
|
28012
28215
|
- private_key_jwt
|
|
@@ -28022,7 +28225,7 @@ components:
|
|
|
28022
28225
|
$ref: '#/components/schemas/CreateConnectionKeyPairDto'
|
|
28023
28226
|
id_token_signature_algorithm:
|
|
28024
28227
|
type: string
|
|
28025
|
-
enum: &
|
|
28228
|
+
enum: &ref_13
|
|
28026
28229
|
- ES256
|
|
28027
28230
|
- ES384
|
|
28028
28231
|
- ES512
|
|
@@ -28178,7 +28381,7 @@ components:
|
|
|
28178
28381
|
x-exclude-from-lint: true
|
|
28179
28382
|
required:
|
|
28180
28383
|
- saml_options
|
|
28181
|
-
x-mutually-exclusive-body-groups: *
|
|
28384
|
+
x-mutually-exclusive-body-groups: *ref_11
|
|
28182
28385
|
PatchConnectionSamlOptionsDto:
|
|
28183
28386
|
type: object
|
|
28184
28387
|
properties:
|
|
@@ -28254,7 +28457,7 @@ components:
|
|
|
28254
28457
|
example: true
|
|
28255
28458
|
token_authentication_method:
|
|
28256
28459
|
type: string
|
|
28257
|
-
enum: *
|
|
28460
|
+
enum: *ref_12
|
|
28258
28461
|
description: >-
|
|
28259
28462
|
The token-endpoint client authentication method. Moving to
|
|
28260
28463
|
`private_key_jwt` generates a signing key pair if the connection has
|
|
@@ -28264,7 +28467,7 @@ components:
|
|
|
28264
28467
|
example: client_secret_basic
|
|
28265
28468
|
id_token_signature_algorithm:
|
|
28266
28469
|
type: string
|
|
28267
|
-
enum: *
|
|
28470
|
+
enum: *ref_13
|
|
28268
28471
|
description: The ID-token signing algorithm.
|
|
28269
28472
|
example: RS256
|
|
28270
28473
|
fetch_user_info:
|
|
@@ -28408,7 +28611,7 @@ components:
|
|
|
28408
28611
|
x-exclude-from-lint: true
|
|
28409
28612
|
required:
|
|
28410
28613
|
- saml_options
|
|
28411
|
-
x-mutually-exclusive-body-groups: *
|
|
28614
|
+
x-mutually-exclusive-body-groups: *ref_14
|
|
28412
28615
|
CreateCorsOriginDto:
|
|
28413
28616
|
type: object
|
|
28414
28617
|
properties:
|
|
@@ -28590,11 +28793,11 @@ components:
|
|
|
28590
28793
|
type:
|
|
28591
28794
|
- object
|
|
28592
28795
|
- 'null'
|
|
28593
|
-
additionalProperties: &
|
|
28796
|
+
additionalProperties: &ref_15
|
|
28594
28797
|
type: string
|
|
28595
28798
|
maxLength: 600
|
|
28596
28799
|
maxProperties: 50
|
|
28597
|
-
example: &
|
|
28800
|
+
example: &ref_16
|
|
28598
28801
|
tier: diamond
|
|
28599
28802
|
description: >-
|
|
28600
28803
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
@@ -28649,9 +28852,9 @@ components:
|
|
|
28649
28852
|
type:
|
|
28650
28853
|
- object
|
|
28651
28854
|
- 'null'
|
|
28652
|
-
additionalProperties: *
|
|
28855
|
+
additionalProperties: *ref_15
|
|
28653
28856
|
maxProperties: 50
|
|
28654
|
-
example: *
|
|
28857
|
+
example: *ref_16
|
|
28655
28858
|
description: >-
|
|
28656
28859
|
Object containing [metadata](/authkit/metadata) key/value pairs
|
|
28657
28860
|
associated with the Organization.
|
|
@@ -28785,7 +28988,7 @@ components:
|
|
|
28785
28988
|
example: application/x-www-form-urlencoded
|
|
28786
28989
|
authenticate_via:
|
|
28787
28990
|
type: string
|
|
28788
|
-
enum: &
|
|
28991
|
+
enum: &ref_17
|
|
28789
28992
|
- request_body
|
|
28790
28993
|
- basic_auth_header
|
|
28791
28994
|
description: >-
|
|
@@ -28953,7 +29156,7 @@ components:
|
|
|
28953
29156
|
example: application/x-www-form-urlencoded
|
|
28954
29157
|
authenticate_via:
|
|
28955
29158
|
type: string
|
|
28956
|
-
enum: *
|
|
29159
|
+
enum: *ref_17
|
|
28957
29160
|
description: >-
|
|
28958
29161
|
How client credentials are sent when exchanging authorization codes
|
|
28959
29162
|
and refreshing tokens.
|
|
@@ -29019,7 +29222,7 @@ components:
|
|
|
29019
29222
|
format: date-time
|
|
29020
29223
|
scopes:
|
|
29021
29224
|
description: The OAuth scopes granted for this connection.
|
|
29022
|
-
example: &
|
|
29225
|
+
example: &ref_18
|
|
29023
29226
|
- repo
|
|
29024
29227
|
- user:email
|
|
29025
29228
|
type: array
|
|
@@ -29027,7 +29230,7 @@ components:
|
|
|
29027
29230
|
type: string
|
|
29028
29231
|
state:
|
|
29029
29232
|
type: string
|
|
29030
|
-
enum: &
|
|
29233
|
+
enum: &ref_19
|
|
29031
29234
|
- connected
|
|
29032
29235
|
- needs_reauthorization
|
|
29033
29236
|
description: >-
|
|
@@ -29074,13 +29277,13 @@ components:
|
|
|
29074
29277
|
format: date-time
|
|
29075
29278
|
scopes:
|
|
29076
29279
|
description: The OAuth scopes granted for this connection.
|
|
29077
|
-
example: *
|
|
29280
|
+
example: *ref_18
|
|
29078
29281
|
type: array
|
|
29079
29282
|
items:
|
|
29080
29283
|
type: string
|
|
29081
29284
|
state:
|
|
29082
29285
|
type: string
|
|
29083
|
-
enum: *
|
|
29286
|
+
enum: *ref_19
|
|
29084
29287
|
description: >-
|
|
29085
29288
|
Explicitly set the state of the connected account. When omitted, the
|
|
29086
29289
|
state is derived from the token combination provided.
|
|
@@ -29114,13 +29317,13 @@ components:
|
|
|
29114
29317
|
format: date-time
|
|
29115
29318
|
scopes:
|
|
29116
29319
|
description: The OAuth scopes granted for this connection.
|
|
29117
|
-
example: *
|
|
29320
|
+
example: *ref_18
|
|
29118
29321
|
type: array
|
|
29119
29322
|
items:
|
|
29120
29323
|
type: string
|
|
29121
29324
|
state:
|
|
29122
29325
|
type: string
|
|
29123
|
-
enum: *
|
|
29326
|
+
enum: *ref_19
|
|
29124
29327
|
description: >-
|
|
29125
29328
|
Explicitly set the state of the connected account. When omitted, the
|
|
29126
29329
|
state is derived from the token combination provided.
|
|
@@ -29156,13 +29359,13 @@ components:
|
|
|
29156
29359
|
format: date-time
|
|
29157
29360
|
scopes:
|
|
29158
29361
|
description: The OAuth scopes granted for this connection.
|
|
29159
|
-
example: *
|
|
29362
|
+
example: *ref_18
|
|
29160
29363
|
type: array
|
|
29161
29364
|
items:
|
|
29162
29365
|
type: string
|
|
29163
29366
|
state:
|
|
29164
29367
|
type: string
|
|
29165
|
-
enum: *
|
|
29368
|
+
enum: *ref_19
|
|
29166
29369
|
description: >-
|
|
29167
29370
|
Explicitly set the state of the connected account. When omitted, the
|
|
29168
29371
|
state is derived from the token combination provided.
|
|
@@ -29672,9 +29875,9 @@ components:
|
|
|
29672
29875
|
x-exclude-from-lint: true
|
|
29673
29876
|
required:
|
|
29674
29877
|
- role_slug
|
|
29675
|
-
x-mutually-exclusive-body-groups: *ref_19
|
|
29676
|
-
UpdateUserlandUserOrganizationMembershipDto:
|
|
29677
29878
|
x-mutually-exclusive-body-groups: *ref_20
|
|
29879
|
+
UpdateUserlandUserOrganizationMembershipDto:
|
|
29880
|
+
x-mutually-exclusive-body-groups: *ref_21
|
|
29678
29881
|
oneOf:
|
|
29679
29882
|
- type: object
|
|
29680
29883
|
not:
|
|
@@ -29798,9 +30001,9 @@ components:
|
|
|
29798
30001
|
type:
|
|
29799
30002
|
- object
|
|
29800
30003
|
- 'null'
|
|
29801
|
-
additionalProperties: *
|
|
30004
|
+
additionalProperties: *ref_15
|
|
29802
30005
|
maxProperties: 50
|
|
29803
|
-
example: &
|
|
30006
|
+
example: &ref_23
|
|
29804
30007
|
timezone: America/New_York
|
|
29805
30008
|
description: >-
|
|
29806
30009
|
Object containing metadata key/value pairs associated with the
|
|
@@ -29899,7 +30102,7 @@ components:
|
|
|
29899
30102
|
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
29900
30103
|
password_hash_type:
|
|
29901
30104
|
type: string
|
|
29902
|
-
enum: &
|
|
30105
|
+
enum: &ref_24
|
|
29903
30106
|
- bcrypt
|
|
29904
30107
|
- firebase-scrypt
|
|
29905
30108
|
- ssha
|
|
@@ -29914,7 +30117,7 @@ components:
|
|
|
29914
30117
|
example: bcrypt
|
|
29915
30118
|
password_salt_position:
|
|
29916
30119
|
type: string
|
|
29917
|
-
enum: &
|
|
30120
|
+
enum: &ref_25
|
|
29918
30121
|
- prefix
|
|
29919
30122
|
- suffix
|
|
29920
30123
|
description: >-
|
|
@@ -29935,7 +30138,7 @@ components:
|
|
|
29935
30138
|
x-exclude-from-lint: true
|
|
29936
30139
|
required:
|
|
29937
30140
|
- password
|
|
29938
|
-
x-mutually-exclusive-body-groups: *
|
|
30141
|
+
x-mutually-exclusive-body-groups: *ref_22
|
|
29939
30142
|
UpdateUserlandUserDto:
|
|
29940
30143
|
allOf:
|
|
29941
30144
|
- type: object
|
|
@@ -29965,9 +30168,9 @@ components:
|
|
|
29965
30168
|
type:
|
|
29966
30169
|
- object
|
|
29967
30170
|
- 'null'
|
|
29968
|
-
additionalProperties: *
|
|
30171
|
+
additionalProperties: *ref_15
|
|
29969
30172
|
maxProperties: 50
|
|
29970
|
-
example: *
|
|
30173
|
+
example: *ref_23
|
|
29971
30174
|
description: >-
|
|
29972
30175
|
Object containing metadata key/value pairs associated with the
|
|
29973
30176
|
user.
|
|
@@ -30049,7 +30252,7 @@ components:
|
|
|
30049
30252
|
example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
|
|
30050
30253
|
password_hash_type:
|
|
30051
30254
|
type: string
|
|
30052
|
-
enum: *
|
|
30255
|
+
enum: *ref_24
|
|
30053
30256
|
description: >-
|
|
30054
30257
|
The algorithm originally used to hash the password, used
|
|
30055
30258
|
when providing a `password_hash`. Required with
|
|
@@ -30057,7 +30260,7 @@ components:
|
|
|
30057
30260
|
example: bcrypt
|
|
30058
30261
|
password_salt_position:
|
|
30059
30262
|
type: string
|
|
30060
|
-
enum: *
|
|
30263
|
+
enum: *ref_25
|
|
30061
30264
|
description: >-
|
|
30062
30265
|
The position of the salt relative to the password when the
|
|
30063
30266
|
`password_hash` digest was computed: `prefix` for `hash(salt
|
|
@@ -30076,7 +30279,7 @@ components:
|
|
|
30076
30279
|
x-exclude-from-lint: true
|
|
30077
30280
|
required:
|
|
30078
30281
|
- password
|
|
30079
|
-
x-mutually-exclusive-body-groups: *
|
|
30282
|
+
x-mutually-exclusive-body-groups: *ref_26
|
|
30080
30283
|
VerifyEmailAddressDto:
|
|
30081
30284
|
type: object
|
|
30082
30285
|
properties:
|
|
@@ -30185,7 +30388,7 @@ components:
|
|
|
30185
30388
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
30186
30389
|
items:
|
|
30187
30390
|
type: string
|
|
30188
|
-
enum: &
|
|
30391
|
+
enum: &ref_27
|
|
30189
30392
|
- agent.blueprint.created
|
|
30190
30393
|
- agent.blueprint.deleted
|
|
30191
30394
|
- agent.blueprint.updated
|
|
@@ -30316,7 +30519,7 @@ components:
|
|
|
30316
30519
|
description: The events that the Webhook Endpoint is subscribed to.
|
|
30317
30520
|
items:
|
|
30318
30521
|
type: string
|
|
30319
|
-
enum: *
|
|
30522
|
+
enum: *ref_27
|
|
30320
30523
|
example:
|
|
30321
30524
|
- user.created
|
|
30322
30525
|
- dsync.user.created
|
|
@@ -34010,7 +34213,7 @@ components:
|
|
|
34010
34213
|
description: >-
|
|
34011
34214
|
An object containing the custom attribute mapping for the Directory
|
|
34012
34215
|
Provider.
|
|
34013
|
-
example: &
|
|
34216
|
+
example: &ref_34
|
|
34014
34217
|
department: Engineering
|
|
34015
34218
|
job_title: Software Engineer
|
|
34016
34219
|
role:
|
|
@@ -34249,7 +34452,7 @@ components:
|
|
|
34249
34452
|
type: object
|
|
34250
34453
|
additionalProperties: {}
|
|
34251
34454
|
description: The event payload.
|
|
34252
|
-
example: &
|
|
34455
|
+
example: &ref_28
|
|
34253
34456
|
id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
|
|
34254
34457
|
directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
|
|
34255
34458
|
organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
|
|
@@ -34284,11 +34487,11 @@ components:
|
|
|
34284
34487
|
- data
|
|
34285
34488
|
- created_at
|
|
34286
34489
|
description: An event emitted by WorkOS.
|
|
34287
|
-
example: &
|
|
34490
|
+
example: &ref_39
|
|
34288
34491
|
object: event
|
|
34289
34492
|
id: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
34290
34493
|
event: dsync.user.created
|
|
34291
|
-
data: *
|
|
34494
|
+
data: *ref_28
|
|
34292
34495
|
created_at: '2021-06-25T19:07:33.155Z'
|
|
34293
34496
|
context: {}
|
|
34294
34497
|
- oneOf:
|
|
@@ -34488,7 +34691,7 @@ components:
|
|
|
34488
34691
|
description: >-
|
|
34489
34692
|
Permission slugs forming the ceiling on what sessions
|
|
34490
34693
|
minted from this blueprint may do.
|
|
34491
|
-
example: &
|
|
34694
|
+
example: &ref_29
|
|
34492
34695
|
- crm:read
|
|
34493
34696
|
- email:send
|
|
34494
34697
|
invocable_by:
|
|
@@ -34501,7 +34704,7 @@ components:
|
|
|
34501
34704
|
description: >-
|
|
34502
34705
|
Role slugs whose members may mint user-delegated
|
|
34503
34706
|
sessions from this blueprint.
|
|
34504
|
-
example: &
|
|
34707
|
+
example: &ref_30
|
|
34505
34708
|
- manager
|
|
34506
34709
|
organization_ids:
|
|
34507
34710
|
type: array
|
|
@@ -34510,7 +34713,7 @@ components:
|
|
|
34510
34713
|
description: >-
|
|
34511
34714
|
Organizations in which autonomous sessions may be
|
|
34512
34715
|
minted from this blueprint.
|
|
34513
|
-
example: &
|
|
34716
|
+
example: &ref_31
|
|
34514
34717
|
- org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
34515
34718
|
required:
|
|
34516
34719
|
- role_slugs
|
|
@@ -34530,7 +34733,7 @@ components:
|
|
|
34530
34733
|
Instance types that may be minted from this
|
|
34531
34734
|
blueprint: `delegated` (acting for a user) and/or
|
|
34532
34735
|
`autonomous` (acting as the agent itself).
|
|
34533
|
-
example: &
|
|
34736
|
+
example: &ref_32
|
|
34534
34737
|
- delegated
|
|
34535
34738
|
- autonomous
|
|
34536
34739
|
required:
|
|
@@ -34690,7 +34893,7 @@ components:
|
|
|
34690
34893
|
description: >-
|
|
34691
34894
|
Permission slugs forming the ceiling on what sessions
|
|
34692
34895
|
minted from this blueprint may do.
|
|
34693
|
-
example: *
|
|
34896
|
+
example: *ref_29
|
|
34694
34897
|
invocable_by:
|
|
34695
34898
|
type: object
|
|
34696
34899
|
properties:
|
|
@@ -34701,7 +34904,7 @@ components:
|
|
|
34701
34904
|
description: >-
|
|
34702
34905
|
Role slugs whose members may mint user-delegated
|
|
34703
34906
|
sessions from this blueprint.
|
|
34704
|
-
example: *
|
|
34907
|
+
example: *ref_30
|
|
34705
34908
|
organization_ids:
|
|
34706
34909
|
type: array
|
|
34707
34910
|
items:
|
|
@@ -34709,7 +34912,7 @@ components:
|
|
|
34709
34912
|
description: >-
|
|
34710
34913
|
Organizations in which autonomous sessions may be
|
|
34711
34914
|
minted from this blueprint.
|
|
34712
|
-
example: *
|
|
34915
|
+
example: *ref_31
|
|
34713
34916
|
required:
|
|
34714
34917
|
- role_slugs
|
|
34715
34918
|
- organization_ids
|
|
@@ -34728,7 +34931,7 @@ components:
|
|
|
34728
34931
|
Instance types that may be minted from this
|
|
34729
34932
|
blueprint: `delegated` (acting for a user) and/or
|
|
34730
34933
|
`autonomous` (acting as the agent itself).
|
|
34731
|
-
example: *
|
|
34934
|
+
example: *ref_32
|
|
34732
34935
|
required:
|
|
34733
34936
|
- instance_types
|
|
34734
34937
|
description: How sessions may be minted from this blueprint.
|
|
@@ -35764,7 +35967,7 @@ components:
|
|
|
35764
35967
|
items:
|
|
35765
35968
|
type: string
|
|
35766
35969
|
description: The permissions granted to the API key.
|
|
35767
|
-
example: &
|
|
35970
|
+
example: &ref_33
|
|
35768
35971
|
- users:read
|
|
35769
35972
|
- users:write
|
|
35770
35973
|
created_at:
|
|
@@ -35890,7 +36093,7 @@ components:
|
|
|
35890
36093
|
items:
|
|
35891
36094
|
type: string
|
|
35892
36095
|
description: The permissions granted to the API key.
|
|
35893
|
-
example: *
|
|
36096
|
+
example: *ref_33
|
|
35894
36097
|
created_at:
|
|
35895
36098
|
type: string
|
|
35896
36099
|
description: The timestamp when the API key was created.
|
|
@@ -36014,7 +36217,7 @@ components:
|
|
|
36014
36217
|
items:
|
|
36015
36218
|
type: string
|
|
36016
36219
|
description: The permissions granted to the API key.
|
|
36017
|
-
example: *
|
|
36220
|
+
example: *ref_33
|
|
36018
36221
|
created_at:
|
|
36019
36222
|
type: string
|
|
36020
36223
|
description: The timestamp when the API key was created.
|
|
@@ -38881,7 +39084,7 @@ components:
|
|
|
38881
39084
|
description: >-
|
|
38882
39085
|
An object containing the custom attribute mapping for
|
|
38883
39086
|
the Directory Provider.
|
|
38884
|
-
example: *
|
|
39087
|
+
example: *ref_34
|
|
38885
39088
|
role:
|
|
38886
39089
|
$ref: '#/components/schemas/SlimRole'
|
|
38887
39090
|
roles:
|
|
@@ -39071,7 +39274,7 @@ components:
|
|
|
39071
39274
|
description: >-
|
|
39072
39275
|
Labels assigned to the Feature Flag for categorizing and
|
|
39073
39276
|
filtering.
|
|
39074
|
-
example: &
|
|
39277
|
+
example: &ref_35
|
|
39075
39278
|
- reports
|
|
39076
39279
|
enabled:
|
|
39077
39280
|
type: boolean
|
|
@@ -39232,7 +39435,7 @@ components:
|
|
|
39232
39435
|
description: >-
|
|
39233
39436
|
Labels assigned to the Feature Flag for categorizing and
|
|
39234
39437
|
filtering.
|
|
39235
|
-
example: *
|
|
39438
|
+
example: *ref_35
|
|
39236
39439
|
enabled:
|
|
39237
39440
|
type: boolean
|
|
39238
39441
|
description: >-
|
|
@@ -39392,7 +39595,7 @@ components:
|
|
|
39392
39595
|
description: >-
|
|
39393
39596
|
Labels assigned to the Feature Flag for categorizing and
|
|
39394
39597
|
filtering.
|
|
39395
|
-
example: *
|
|
39598
|
+
example: *ref_35
|
|
39396
39599
|
enabled:
|
|
39397
39600
|
type: boolean
|
|
39398
39601
|
description: >-
|
|
@@ -39672,7 +39875,7 @@ components:
|
|
|
39672
39875
|
description: >-
|
|
39673
39876
|
Labels assigned to the Feature Flag for categorizing and
|
|
39674
39877
|
filtering.
|
|
39675
|
-
example: *
|
|
39878
|
+
example: *ref_35
|
|
39676
39879
|
enabled:
|
|
39677
39880
|
type: boolean
|
|
39678
39881
|
description: >-
|
|
@@ -40660,7 +40863,7 @@ components:
|
|
|
40660
40863
|
description: >-
|
|
40661
40864
|
Object containing [metadata](/authkit/metadata)
|
|
40662
40865
|
key/value pairs associated with the Organization.
|
|
40663
|
-
example: &
|
|
40866
|
+
example: &ref_36
|
|
40664
40867
|
tier: diamond
|
|
40665
40868
|
propertyNames:
|
|
40666
40869
|
maxLength: 40
|
|
@@ -40810,7 +41013,7 @@ components:
|
|
|
40810
41013
|
description: >-
|
|
40811
41014
|
Object containing [metadata](/authkit/metadata)
|
|
40812
41015
|
key/value pairs associated with the Organization.
|
|
40813
|
-
example: *
|
|
41016
|
+
example: *ref_36
|
|
40814
41017
|
propertyNames:
|
|
40815
41018
|
maxLength: 40
|
|
40816
41019
|
maxProperties: 50
|
|
@@ -41637,7 +41840,7 @@ components:
|
|
|
41637
41840
|
items:
|
|
41638
41841
|
type: string
|
|
41639
41842
|
description: The permissions granted by the role.
|
|
41640
|
-
example: &
|
|
41843
|
+
example: &ref_37
|
|
41641
41844
|
- users:read
|
|
41642
41845
|
- users:write
|
|
41643
41846
|
created_at:
|
|
@@ -41721,7 +41924,7 @@ components:
|
|
|
41721
41924
|
items:
|
|
41722
41925
|
type: string
|
|
41723
41926
|
description: The permissions granted by the role.
|
|
41724
|
-
example: *
|
|
41927
|
+
example: *ref_37
|
|
41725
41928
|
created_at:
|
|
41726
41929
|
format: date-time
|
|
41727
41930
|
type: string
|
|
@@ -41803,7 +42006,7 @@ components:
|
|
|
41803
42006
|
items:
|
|
41804
42007
|
type: string
|
|
41805
42008
|
description: The permissions granted by the role.
|
|
41806
|
-
example: *
|
|
42009
|
+
example: *ref_37
|
|
41807
42010
|
created_at:
|
|
41808
42011
|
format: date-time
|
|
41809
42012
|
type: string
|
|
@@ -41940,7 +42143,7 @@ components:
|
|
|
41940
42143
|
description: >-
|
|
41941
42144
|
Object containing [metadata](/authkit/metadata)
|
|
41942
42145
|
key/value pairs associated with the Organization.
|
|
41943
|
-
example: *
|
|
42146
|
+
example: *ref_36
|
|
41944
42147
|
propertyNames:
|
|
41945
42148
|
maxLength: 40
|
|
41946
42149
|
maxProperties: 50
|
|
@@ -43136,7 +43339,7 @@ components:
|
|
|
43136
43339
|
items:
|
|
43137
43340
|
type: string
|
|
43138
43341
|
description: The permissions granted by the role.
|
|
43139
|
-
example: &
|
|
43342
|
+
example: &ref_38
|
|
43140
43343
|
- users:read
|
|
43141
43344
|
- users:write
|
|
43142
43345
|
created_at:
|
|
@@ -43202,7 +43405,7 @@ components:
|
|
|
43202
43405
|
items:
|
|
43203
43406
|
type: string
|
|
43204
43407
|
description: The permissions granted by the role.
|
|
43205
|
-
example: *
|
|
43408
|
+
example: *ref_38
|
|
43206
43409
|
created_at:
|
|
43207
43410
|
format: date-time
|
|
43208
43411
|
type: string
|
|
@@ -43266,7 +43469,7 @@ components:
|
|
|
43266
43469
|
items:
|
|
43267
43470
|
type: string
|
|
43268
43471
|
description: The permissions granted by the role.
|
|
43269
|
-
example: *
|
|
43472
|
+
example: *ref_38
|
|
43270
43473
|
created_at:
|
|
43271
43474
|
format: date-time
|
|
43272
43475
|
type: string
|
|
@@ -44468,7 +44671,7 @@ components:
|
|
|
44468
44671
|
- data
|
|
44469
44672
|
- created_at
|
|
44470
44673
|
- object
|
|
44471
|
-
example: *
|
|
44674
|
+
example: *ref_39
|
|
44472
44675
|
description: An event emitted by WorkOS.
|
|
44473
44676
|
EventList:
|
|
44474
44677
|
type: object
|
|
@@ -44503,7 +44706,7 @@ components:
|
|
|
44503
44706
|
example:
|
|
44504
44707
|
object: list
|
|
44505
44708
|
data:
|
|
44506
|
-
- *
|
|
44709
|
+
- *ref_39
|
|
44507
44710
|
list_metadata:
|
|
44508
44711
|
after: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
44509
44712
|
JwtTemplate:
|
|
@@ -45810,6 +46013,25 @@ components:
|
|
|
45810
46013
|
https://api.workos.com/data-integrations/q2czJKmVAraSBg8xFpT7M9uR/authorize-redirect
|
|
45811
46014
|
required:
|
|
45812
46015
|
- url
|
|
46016
|
+
AuthMethodMismatchError:
|
|
46017
|
+
type: object
|
|
46018
|
+
properties:
|
|
46019
|
+
code:
|
|
46020
|
+
type: string
|
|
46021
|
+
description: >-
|
|
46022
|
+
Error code indicating the endpoint does not match the installation
|
|
46023
|
+
auth method.
|
|
46024
|
+
example: auth_method_mismatch
|
|
46025
|
+
const: auth_method_mismatch
|
|
46026
|
+
message:
|
|
46027
|
+
type: string
|
|
46028
|
+
description: A human-readable explanation of the mismatch.
|
|
46029
|
+
example: >-
|
|
46030
|
+
This installation uses oauth authentication. Use the POST
|
|
46031
|
+
/:slug/token endpoint instead.
|
|
46032
|
+
required:
|
|
46033
|
+
- code
|
|
46034
|
+
- message
|
|
45813
46035
|
DataIntegrationAccessTokenResponse:
|
|
45814
46036
|
oneOf:
|
|
45815
46037
|
- type: object
|
|
@@ -45909,25 +46131,6 @@ components:
|
|
|
45909
46131
|
required:
|
|
45910
46132
|
- code
|
|
45911
46133
|
- message
|
|
45912
|
-
AuthMethodMismatchError:
|
|
45913
|
-
type: object
|
|
45914
|
-
properties:
|
|
45915
|
-
code:
|
|
45916
|
-
type: string
|
|
45917
|
-
description: >-
|
|
45918
|
-
Error code indicating the endpoint does not match the installation
|
|
45919
|
-
auth method.
|
|
45920
|
-
example: auth_method_mismatch
|
|
45921
|
-
const: auth_method_mismatch
|
|
45922
|
-
message:
|
|
45923
|
-
type: string
|
|
45924
|
-
description: A human-readable explanation of the mismatch.
|
|
45925
|
-
example: >-
|
|
45926
|
-
This installation uses oauth authentication. Use the POST
|
|
45927
|
-
/:slug/token endpoint instead.
|
|
45928
|
-
required:
|
|
45929
|
-
- code
|
|
45930
|
-
- message
|
|
45931
46134
|
DataIntegrationVendedCredential:
|
|
45932
46135
|
discriminator:
|
|
45933
46136
|
propertyName: auth_method
|
|
@@ -45998,7 +46201,7 @@ components:
|
|
|
45998
46201
|
integration or organization pins require reconnecting or
|
|
45999
46202
|
explicitly rebinding the connection. Defaults are live and can
|
|
46000
46203
|
differ from a cached token's audience until refresh or re-mint.
|
|
46001
|
-
example: &
|
|
46204
|
+
example: &ref_40
|
|
46002
46205
|
account: myorg-myaccount
|
|
46003
46206
|
required:
|
|
46004
46207
|
- object
|
|
@@ -46043,7 +46246,7 @@ components:
|
|
|
46043
46246
|
integration or organization pins require reconnecting or
|
|
46044
46247
|
explicitly rebinding the connection. Defaults are live and can
|
|
46045
46248
|
differ from a cached token's audience until refresh or re-mint.
|
|
46046
|
-
example: *
|
|
46249
|
+
example: *ref_40
|
|
46047
46250
|
required:
|
|
46048
46251
|
- object
|
|
46049
46252
|
- auth_method
|
|
@@ -46120,7 +46323,7 @@ components:
|
|
|
46120
46323
|
integration or organization pins require reconnecting or
|
|
46121
46324
|
explicitly rebinding the connection. Defaults are live and can
|
|
46122
46325
|
differ from a cached token's audience until refresh or re-mint.
|
|
46123
|
-
example: *
|
|
46326
|
+
example: *ref_40
|
|
46124
46327
|
required:
|
|
46125
46328
|
- object
|
|
46126
46329
|
- auth_method
|
|
@@ -46275,8 +46478,8 @@ components:
|
|
|
46275
46478
|
description: >-
|
|
46276
46479
|
The connection-level configuration values stored for this connection
|
|
46277
46480
|
— the fields the provider declares at `installation` scope,
|
|
46278
|
-
excluding
|
|
46279
|
-
|
|
46481
|
+
excluding secret and undeclared fields. Returned for every
|
|
46482
|
+
authentication method; empty when no stored values can be disclosed.
|
|
46280
46483
|
example:
|
|
46281
46484
|
instance_url: https://example.my.salesforce.com
|
|
46282
46485
|
state:
|
|
@@ -46500,7 +46703,7 @@ components:
|
|
|
46500
46703
|
items:
|
|
46501
46704
|
type: string
|
|
46502
46705
|
description: The OAuth scopes granted for this connection.
|
|
46503
|
-
example: &
|
|
46706
|
+
example: &ref_41
|
|
46504
46707
|
- repo
|
|
46505
46708
|
- user:email
|
|
46506
46709
|
auth_method:
|
|
@@ -46547,10 +46750,10 @@ components:
|
|
|
46547
46750
|
description: >-
|
|
46548
46751
|
The connection-level configuration values stored for
|
|
46549
46752
|
this connection — the fields the provider declares at
|
|
46550
|
-
`installation` scope, excluding
|
|
46551
|
-
|
|
46552
|
-
|
|
46553
|
-
example: &
|
|
46753
|
+
`installation` scope, excluding secret and undeclared
|
|
46754
|
+
fields. Returned for every authentication method;
|
|
46755
|
+
empty when no stored values can be disclosed.
|
|
46756
|
+
example: &ref_42
|
|
46554
46757
|
instance_url: https://example.my.salesforce.com
|
|
46555
46758
|
state:
|
|
46556
46759
|
type: string
|
|
@@ -46679,7 +46882,7 @@ components:
|
|
|
46679
46882
|
items:
|
|
46680
46883
|
type: string
|
|
46681
46884
|
description: The OAuth scopes granted for this connection.
|
|
46682
|
-
example: *
|
|
46885
|
+
example: *ref_41
|
|
46683
46886
|
auth_method:
|
|
46684
46887
|
type: string
|
|
46685
46888
|
enum:
|
|
@@ -46723,10 +46926,10 @@ components:
|
|
|
46723
46926
|
description: >-
|
|
46724
46927
|
The connection-level configuration values stored for
|
|
46725
46928
|
this connection — the fields the provider declares at
|
|
46726
|
-
`installation` scope, excluding
|
|
46727
|
-
|
|
46728
|
-
|
|
46729
|
-
example: *
|
|
46929
|
+
`installation` scope, excluding secret and undeclared
|
|
46930
|
+
fields. Returned for every authentication method; empty
|
|
46931
|
+
when no stored values can be disclosed.
|
|
46932
|
+
example: *ref_42
|
|
46730
46933
|
state:
|
|
46731
46934
|
type: string
|
|
46732
46935
|
enum:
|