@workos/openapi-spec 0.112.0 → 0.114.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 +486 -131
- package/dist/services.mjs +10 -0
- package/dist/types.d.ts +379 -69
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -10767,12 +10767,198 @@ paths:
|
|
|
10767
10767
|
tags:
|
|
10768
10768
|
- pipes
|
|
10769
10769
|
/data-integrations/{slug}/api-key:
|
|
10770
|
+
post:
|
|
10771
|
+
description: >-
|
|
10772
|
+
Creates another API key-based connected account for the specified
|
|
10773
|
+
integration, owned by the user or, when `connection_owner` is
|
|
10774
|
+
`organization`, shared by the organization. Requires `connection_intent:
|
|
10775
|
+
add` and does not accept `connected_account_id`; use PUT to create or
|
|
10776
|
+
rotate the compatibility connection or to update an exact connection.
|
|
10777
|
+
Creating an additional connection is not yet available: until it is,
|
|
10778
|
+
this endpoint succeeds only when the owner has no connection for this
|
|
10779
|
+
integration, which creates the compatibility connection, and otherwise
|
|
10780
|
+
returns 404 `multiple_connections_unavailable`.
|
|
10781
|
+
operationId: DataIntegrationsController_createApiKeyConnection
|
|
10782
|
+
parameters:
|
|
10783
|
+
- name: slug
|
|
10784
|
+
required: true
|
|
10785
|
+
in: path
|
|
10786
|
+
description: The identifier of the integration.
|
|
10787
|
+
schema:
|
|
10788
|
+
example: github
|
|
10789
|
+
type: string
|
|
10790
|
+
requestBody:
|
|
10791
|
+
required: true
|
|
10792
|
+
content:
|
|
10793
|
+
application/json:
|
|
10794
|
+
schema:
|
|
10795
|
+
type: object
|
|
10796
|
+
properties:
|
|
10797
|
+
user_id:
|
|
10798
|
+
type: string
|
|
10799
|
+
description: A [User](/reference/authkit/user) identifier.
|
|
10800
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10801
|
+
organization_id:
|
|
10802
|
+
type: string
|
|
10803
|
+
description: >-
|
|
10804
|
+
An [Organization](/reference/organization) identifier.
|
|
10805
|
+
Optional parameter to scope the connection to a specific
|
|
10806
|
+
organization. Required when `connection_owner` is
|
|
10807
|
+
`organization`.
|
|
10808
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10809
|
+
connection_owner:
|
|
10810
|
+
type: string
|
|
10811
|
+
enum:
|
|
10812
|
+
- user
|
|
10813
|
+
- organization
|
|
10814
|
+
description: >-
|
|
10815
|
+
Whose connection to create or rotate. `user` (the default)
|
|
10816
|
+
addresses the connection owned by `user_id`. `organization`
|
|
10817
|
+
addresses the connection shared by every member of
|
|
10818
|
+
`organization_id`; `user_id` then identifies the member
|
|
10819
|
+
performing the request and must be an active member of the
|
|
10820
|
+
organization.
|
|
10821
|
+
example: user
|
|
10822
|
+
secret:
|
|
10823
|
+
type: string
|
|
10824
|
+
minLength: 1
|
|
10825
|
+
description: The API key secret to store for this integration.
|
|
10826
|
+
example: sk-1234567890abcdef
|
|
10827
|
+
connection_intent:
|
|
10828
|
+
type: string
|
|
10829
|
+
description: >-
|
|
10830
|
+
Must be `add`: this endpoint only creates another
|
|
10831
|
+
connection. The first connection for an owner shape fills
|
|
10832
|
+
the compatibility slot; later connections are standard.
|
|
10833
|
+
Creating an additional connection is not yet available:
|
|
10834
|
+
until it is, `add` succeeds only when the owner has no
|
|
10835
|
+
connection for this integration and otherwise returns 404
|
|
10836
|
+
`multiple_connections_unavailable`.
|
|
10837
|
+
example: add
|
|
10838
|
+
const: add
|
|
10839
|
+
required:
|
|
10840
|
+
- user_id
|
|
10841
|
+
- secret
|
|
10842
|
+
- connection_intent
|
|
10843
|
+
additionalProperties: false
|
|
10844
|
+
responses:
|
|
10845
|
+
'201':
|
|
10846
|
+
description: The connected account that was created.
|
|
10847
|
+
content:
|
|
10848
|
+
application/json:
|
|
10849
|
+
schema:
|
|
10850
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
10851
|
+
example:
|
|
10852
|
+
object: connected_account
|
|
10853
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10854
|
+
connection_role: standard
|
|
10855
|
+
account_identifier: null
|
|
10856
|
+
account_display_name: null
|
|
10857
|
+
user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10858
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10859
|
+
scopes: []
|
|
10860
|
+
auth_method: api_key
|
|
10861
|
+
api_key_last_4: cdef
|
|
10862
|
+
state: connected
|
|
10863
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
10864
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
10865
|
+
'400':
|
|
10866
|
+
description: >-
|
|
10867
|
+
The request is invalid, including a missing `connection_intent: add`
|
|
10868
|
+
or a supplied `connected_account_id`.
|
|
10869
|
+
content:
|
|
10870
|
+
application/json:
|
|
10871
|
+
schema:
|
|
10872
|
+
type: object
|
|
10873
|
+
properties:
|
|
10874
|
+
message:
|
|
10875
|
+
type: string
|
|
10876
|
+
description: A human-readable description of the error.
|
|
10877
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
10878
|
+
required:
|
|
10879
|
+
- message
|
|
10880
|
+
'401':
|
|
10881
|
+
description: Unauthorized
|
|
10882
|
+
'403':
|
|
10883
|
+
description: Forbidden
|
|
10884
|
+
content:
|
|
10885
|
+
application/json:
|
|
10886
|
+
schema:
|
|
10887
|
+
type: object
|
|
10888
|
+
properties:
|
|
10889
|
+
message:
|
|
10890
|
+
type: string
|
|
10891
|
+
description: A human-readable description of the error.
|
|
10892
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
10893
|
+
required:
|
|
10894
|
+
- message
|
|
10895
|
+
'404':
|
|
10896
|
+
description: >-
|
|
10897
|
+
The data integration was not found, or
|
|
10898
|
+
`multiple_connections_unavailable` when creating an additional
|
|
10899
|
+
connection is not yet available.
|
|
10900
|
+
content:
|
|
10901
|
+
application/json:
|
|
10902
|
+
schema:
|
|
10903
|
+
anyOf:
|
|
10904
|
+
- type: object
|
|
10905
|
+
properties:
|
|
10906
|
+
code:
|
|
10907
|
+
type: string
|
|
10908
|
+
enum:
|
|
10909
|
+
- multiple_connections_unavailable
|
|
10910
|
+
- entity_not_found
|
|
10911
|
+
description: The error code identifying the type of error.
|
|
10912
|
+
example: multiple_connections_unavailable
|
|
10913
|
+
message:
|
|
10914
|
+
type: string
|
|
10915
|
+
description: A human-readable description of the error.
|
|
10916
|
+
example: Request could not be processed.
|
|
10917
|
+
required:
|
|
10918
|
+
- code
|
|
10919
|
+
- message
|
|
10920
|
+
- type: object
|
|
10921
|
+
properties:
|
|
10922
|
+
message:
|
|
10923
|
+
type: string
|
|
10924
|
+
description: A human-readable description of the error.
|
|
10925
|
+
example: >-
|
|
10926
|
+
Organization not found:
|
|
10927
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
10928
|
+
required:
|
|
10929
|
+
- message
|
|
10930
|
+
'503':
|
|
10931
|
+
description: >-
|
|
10932
|
+
Another connection is being created for this owner and provider.
|
|
10933
|
+
Retry the request.
|
|
10934
|
+
content:
|
|
10935
|
+
application/json:
|
|
10936
|
+
schema:
|
|
10937
|
+
type: object
|
|
10938
|
+
properties:
|
|
10939
|
+
code:
|
|
10940
|
+
type: string
|
|
10941
|
+
description: The error code identifying the type of error.
|
|
10942
|
+
example: concurrent_request
|
|
10943
|
+
const: concurrent_request
|
|
10944
|
+
message:
|
|
10945
|
+
type: string
|
|
10946
|
+
description: A human-readable description of the error.
|
|
10947
|
+
example: Request could not be processed.
|
|
10948
|
+
required:
|
|
10949
|
+
- code
|
|
10950
|
+
- message
|
|
10951
|
+
summary: Create another API key connected account
|
|
10952
|
+
tags:
|
|
10953
|
+
- pipes
|
|
10954
|
+
x-feature-flag: pipes-multiple-connections
|
|
10770
10955
|
put:
|
|
10771
10956
|
description: >-
|
|
10772
10957
|
Creates or updates an API-key-based installation for the specified
|
|
10773
10958
|
integration, owned by the user or, when `connection_owner` is
|
|
10774
10959
|
`organization`, shared by the organization. If an installation already
|
|
10775
|
-
exists, the stored API key is rotated to the new value.
|
|
10960
|
+
exists, the stored API key is rotated to the new value. To create
|
|
10961
|
+
another connection, use POST.
|
|
10776
10962
|
operationId: DataIntegrationsController_upsertApiKey
|
|
10777
10963
|
parameters:
|
|
10778
10964
|
- name: slug
|
|
@@ -10824,51 +11010,6 @@ paths:
|
|
|
10824
11010
|
- user_id
|
|
10825
11011
|
- secret
|
|
10826
11012
|
additionalProperties: false
|
|
10827
|
-
- type: object
|
|
10828
|
-
properties:
|
|
10829
|
-
user_id:
|
|
10830
|
-
type: string
|
|
10831
|
-
description: A [User](/reference/authkit/user) identifier.
|
|
10832
|
-
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10833
|
-
organization_id:
|
|
10834
|
-
type: string
|
|
10835
|
-
description: >-
|
|
10836
|
-
An [Organization](/reference/organization) identifier.
|
|
10837
|
-
Optional parameter to scope the connection to a specific
|
|
10838
|
-
organization. Required when `connection_owner` is
|
|
10839
|
-
`organization`.
|
|
10840
|
-
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
10841
|
-
connection_owner:
|
|
10842
|
-
type: string
|
|
10843
|
-
enum:
|
|
10844
|
-
- user
|
|
10845
|
-
- organization
|
|
10846
|
-
description: >-
|
|
10847
|
-
Whose connection to create or rotate. `user` (the
|
|
10848
|
-
default) addresses the connection owned by `user_id`.
|
|
10849
|
-
`organization` addresses the connection shared by every
|
|
10850
|
-
member of `organization_id`; `user_id` then identifies
|
|
10851
|
-
the member performing the request and must be an active
|
|
10852
|
-
member of the organization.
|
|
10853
|
-
example: user
|
|
10854
|
-
secret:
|
|
10855
|
-
type: string
|
|
10856
|
-
minLength: 1
|
|
10857
|
-
description: The API key secret to store for this integration.
|
|
10858
|
-
example: sk-1234567890abcdef
|
|
10859
|
-
connection_intent:
|
|
10860
|
-
type: string
|
|
10861
|
-
description: >-
|
|
10862
|
-
Create another connection. The first connection for an
|
|
10863
|
-
owner shape fills the compatibility slot; later
|
|
10864
|
-
connections are standard.
|
|
10865
|
-
example: add
|
|
10866
|
-
const: add
|
|
10867
|
-
required:
|
|
10868
|
-
- user_id
|
|
10869
|
-
- secret
|
|
10870
|
-
- connection_intent
|
|
10871
|
-
additionalProperties: false
|
|
10872
11013
|
- type: object
|
|
10873
11014
|
properties:
|
|
10874
11015
|
user_id:
|
|
@@ -11168,12 +11309,213 @@ paths:
|
|
|
11168
11309
|
tags:
|
|
11169
11310
|
- pipes
|
|
11170
11311
|
/data-integrations/{slug}/client-credentials:
|
|
11312
|
+
post:
|
|
11313
|
+
description: >-
|
|
11314
|
+
Creates another client credentials-based connected account for the
|
|
11315
|
+
specified integration, owned by the user or, when `connection_owner` is
|
|
11316
|
+
`organization`, shared by the organization. Requires `connection_intent:
|
|
11317
|
+
add` and does not accept `connected_account_id`; use PUT to create or
|
|
11318
|
+
rotate the compatibility connection or to update an exact connection.
|
|
11319
|
+
Creating an additional connection is not yet available: until it is,
|
|
11320
|
+
this endpoint succeeds only when the owner has no connection for this
|
|
11321
|
+
integration, which creates the compatibility connection, and otherwise
|
|
11322
|
+
returns 404 `multiple_connections_unavailable`.
|
|
11323
|
+
operationId: DataIntegrationsController_createClientCredentialsConnection
|
|
11324
|
+
parameters:
|
|
11325
|
+
- name: slug
|
|
11326
|
+
required: true
|
|
11327
|
+
in: path
|
|
11328
|
+
description: The identifier of the integration.
|
|
11329
|
+
schema:
|
|
11330
|
+
example: salesforce
|
|
11331
|
+
type: string
|
|
11332
|
+
requestBody:
|
|
11333
|
+
required: true
|
|
11334
|
+
content:
|
|
11335
|
+
application/json:
|
|
11336
|
+
schema:
|
|
11337
|
+
type: object
|
|
11338
|
+
properties:
|
|
11339
|
+
user_id:
|
|
11340
|
+
type: string
|
|
11341
|
+
description: A [User](/reference/authkit/user) identifier.
|
|
11342
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11343
|
+
organization_id:
|
|
11344
|
+
type: string
|
|
11345
|
+
description: >-
|
|
11346
|
+
An [Organization](/reference/organization) identifier.
|
|
11347
|
+
Optional parameter to scope the connection to a specific
|
|
11348
|
+
organization. Required when `connection_owner` is
|
|
11349
|
+
`organization`.
|
|
11350
|
+
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11351
|
+
connection_owner:
|
|
11352
|
+
type: string
|
|
11353
|
+
enum:
|
|
11354
|
+
- user
|
|
11355
|
+
- organization
|
|
11356
|
+
description: >-
|
|
11357
|
+
Whose connection to create or rotate. `user` (the default)
|
|
11358
|
+
addresses the connection owned by `user_id`. `organization`
|
|
11359
|
+
addresses the connection shared by every member of
|
|
11360
|
+
`organization_id`; `user_id` then identifies the member
|
|
11361
|
+
performing the request and must be an active member of the
|
|
11362
|
+
organization.
|
|
11363
|
+
example: user
|
|
11364
|
+
client_id:
|
|
11365
|
+
type: string
|
|
11366
|
+
minLength: 1
|
|
11367
|
+
description: The OAuth client ID to store for this integration.
|
|
11368
|
+
example: 3MVG9...
|
|
11369
|
+
client_secret:
|
|
11370
|
+
type: string
|
|
11371
|
+
minLength: 1
|
|
11372
|
+
description: The OAuth client secret to store for this integration.
|
|
11373
|
+
example: shhh-secret
|
|
11374
|
+
config:
|
|
11375
|
+
type: object
|
|
11376
|
+
additionalProperties:
|
|
11377
|
+
type: string
|
|
11378
|
+
description: >-
|
|
11379
|
+
Provider-specific configuration values collected for this
|
|
11380
|
+
installation, keyed by the provider's config field
|
|
11381
|
+
descriptors.
|
|
11382
|
+
example:
|
|
11383
|
+
salesforce_host: acme.my.salesforce.com
|
|
11384
|
+
connection_intent:
|
|
11385
|
+
type: string
|
|
11386
|
+
description: >-
|
|
11387
|
+
Must be `add`: this endpoint only creates another
|
|
11388
|
+
connection. The first connection for an owner shape fills
|
|
11389
|
+
the compatibility slot; later connections are standard.
|
|
11390
|
+
Creating an additional connection is not yet available:
|
|
11391
|
+
until it is, `add` succeeds only when the owner has no
|
|
11392
|
+
connection for this integration and otherwise returns 404
|
|
11393
|
+
`multiple_connections_unavailable`.
|
|
11394
|
+
example: add
|
|
11395
|
+
const: add
|
|
11396
|
+
required:
|
|
11397
|
+
- user_id
|
|
11398
|
+
- client_id
|
|
11399
|
+
- client_secret
|
|
11400
|
+
- connection_intent
|
|
11401
|
+
additionalProperties: false
|
|
11402
|
+
responses:
|
|
11403
|
+
'201':
|
|
11404
|
+
description: The connected account that was created.
|
|
11405
|
+
content:
|
|
11406
|
+
application/json:
|
|
11407
|
+
schema:
|
|
11408
|
+
$ref: '#/components/schemas/ConnectedAccount'
|
|
11409
|
+
example:
|
|
11410
|
+
object: connected_account
|
|
11411
|
+
id: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11412
|
+
connection_role: standard
|
|
11413
|
+
account_identifier: null
|
|
11414
|
+
account_display_name: null
|
|
11415
|
+
user_id: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11416
|
+
organization_id: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11417
|
+
scopes: []
|
|
11418
|
+
auth_method: client_credentials
|
|
11419
|
+
state: connected
|
|
11420
|
+
created_at: '2024-01-16T14:20:00.000Z'
|
|
11421
|
+
updated_at: '2024-01-16T14:20:00.000Z'
|
|
11422
|
+
'400':
|
|
11423
|
+
description: >-
|
|
11424
|
+
The request is invalid, including a missing `connection_intent: add`
|
|
11425
|
+
or a supplied `connected_account_id`.
|
|
11426
|
+
content:
|
|
11427
|
+
application/json:
|
|
11428
|
+
schema:
|
|
11429
|
+
type: object
|
|
11430
|
+
properties:
|
|
11431
|
+
message:
|
|
11432
|
+
type: string
|
|
11433
|
+
description: A human-readable description of the error.
|
|
11434
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11435
|
+
required:
|
|
11436
|
+
- message
|
|
11437
|
+
'401':
|
|
11438
|
+
description: Unauthorized
|
|
11439
|
+
'403':
|
|
11440
|
+
description: Forbidden
|
|
11441
|
+
content:
|
|
11442
|
+
application/json:
|
|
11443
|
+
schema:
|
|
11444
|
+
type: object
|
|
11445
|
+
properties:
|
|
11446
|
+
message:
|
|
11447
|
+
type: string
|
|
11448
|
+
description: A human-readable description of the error.
|
|
11449
|
+
example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
|
|
11450
|
+
required:
|
|
11451
|
+
- message
|
|
11452
|
+
'404':
|
|
11453
|
+
description: >-
|
|
11454
|
+
The data integration was not found, or
|
|
11455
|
+
`multiple_connections_unavailable` when creating an additional
|
|
11456
|
+
connection is not yet available.
|
|
11457
|
+
content:
|
|
11458
|
+
application/json:
|
|
11459
|
+
schema:
|
|
11460
|
+
anyOf:
|
|
11461
|
+
- type: object
|
|
11462
|
+
properties:
|
|
11463
|
+
code:
|
|
11464
|
+
type: string
|
|
11465
|
+
enum:
|
|
11466
|
+
- multiple_connections_unavailable
|
|
11467
|
+
- entity_not_found
|
|
11468
|
+
description: The error code identifying the type of error.
|
|
11469
|
+
example: multiple_connections_unavailable
|
|
11470
|
+
message:
|
|
11471
|
+
type: string
|
|
11472
|
+
description: A human-readable description of the error.
|
|
11473
|
+
example: Request could not be processed.
|
|
11474
|
+
required:
|
|
11475
|
+
- code
|
|
11476
|
+
- message
|
|
11477
|
+
- type: object
|
|
11478
|
+
properties:
|
|
11479
|
+
message:
|
|
11480
|
+
type: string
|
|
11481
|
+
description: A human-readable description of the error.
|
|
11482
|
+
example: >-
|
|
11483
|
+
Organization not found:
|
|
11484
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
11485
|
+
required:
|
|
11486
|
+
- message
|
|
11487
|
+
'503':
|
|
11488
|
+
description: >-
|
|
11489
|
+
Another connection is being created for this owner and provider.
|
|
11490
|
+
Retry the request.
|
|
11491
|
+
content:
|
|
11492
|
+
application/json:
|
|
11493
|
+
schema:
|
|
11494
|
+
type: object
|
|
11495
|
+
properties:
|
|
11496
|
+
code:
|
|
11497
|
+
type: string
|
|
11498
|
+
description: The error code identifying the type of error.
|
|
11499
|
+
example: concurrent_request
|
|
11500
|
+
const: concurrent_request
|
|
11501
|
+
message:
|
|
11502
|
+
type: string
|
|
11503
|
+
description: A human-readable description of the error.
|
|
11504
|
+
example: Request could not be processed.
|
|
11505
|
+
required:
|
|
11506
|
+
- code
|
|
11507
|
+
- message
|
|
11508
|
+
summary: Create another client credentials connected account
|
|
11509
|
+
tags:
|
|
11510
|
+
- pipes
|
|
11511
|
+
x-feature-flag: pipes-multiple-connections
|
|
11171
11512
|
put:
|
|
11172
11513
|
description: >-
|
|
11173
11514
|
Creates or updates a client-credentials-based installation for the
|
|
11174
11515
|
specified integration, owned by the user or, when `connection_owner` is
|
|
11175
11516
|
`organization`, shared by the organization. If an installation already
|
|
11176
|
-
exists, the stored client credentials are rotated to the new values.
|
|
11517
|
+
exists, the stored client credentials are rotated to the new values. To
|
|
11518
|
+
create another connection, use POST.
|
|
11177
11519
|
operationId: DataIntegrationsController_upsertClientCredentials
|
|
11178
11520
|
parameters:
|
|
11179
11521
|
- name: slug
|
|
@@ -11241,66 +11583,6 @@ paths:
|
|
|
11241
11583
|
- client_id
|
|
11242
11584
|
- client_secret
|
|
11243
11585
|
additionalProperties: false
|
|
11244
|
-
- type: object
|
|
11245
|
-
properties:
|
|
11246
|
-
user_id:
|
|
11247
|
-
type: string
|
|
11248
|
-
description: A [User](/reference/authkit/user) identifier.
|
|
11249
|
-
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11250
|
-
organization_id:
|
|
11251
|
-
type: string
|
|
11252
|
-
description: >-
|
|
11253
|
-
An [Organization](/reference/organization) identifier.
|
|
11254
|
-
Optional parameter to scope the connection to a specific
|
|
11255
|
-
organization. Required when `connection_owner` is
|
|
11256
|
-
`organization`.
|
|
11257
|
-
example: org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
11258
|
-
connection_owner:
|
|
11259
|
-
type: string
|
|
11260
|
-
enum:
|
|
11261
|
-
- user
|
|
11262
|
-
- organization
|
|
11263
|
-
description: >-
|
|
11264
|
-
Whose connection to create or rotate. `user` (the
|
|
11265
|
-
default) addresses the connection owned by `user_id`.
|
|
11266
|
-
`organization` addresses the connection shared by every
|
|
11267
|
-
member of `organization_id`; `user_id` then identifies
|
|
11268
|
-
the member performing the request and must be an active
|
|
11269
|
-
member of the organization.
|
|
11270
|
-
example: user
|
|
11271
|
-
client_id:
|
|
11272
|
-
type: string
|
|
11273
|
-
minLength: 1
|
|
11274
|
-
description: The OAuth client ID to store for this integration.
|
|
11275
|
-
example: 3MVG9...
|
|
11276
|
-
client_secret:
|
|
11277
|
-
type: string
|
|
11278
|
-
minLength: 1
|
|
11279
|
-
description: The OAuth client secret to store for this integration.
|
|
11280
|
-
example: shhh-secret
|
|
11281
|
-
config:
|
|
11282
|
-
type: object
|
|
11283
|
-
additionalProperties:
|
|
11284
|
-
type: string
|
|
11285
|
-
description: >-
|
|
11286
|
-
Provider-specific configuration values collected for
|
|
11287
|
-
this installation, keyed by the provider's config field
|
|
11288
|
-
descriptors.
|
|
11289
|
-
example: *ref_1
|
|
11290
|
-
connection_intent:
|
|
11291
|
-
type: string
|
|
11292
|
-
description: >-
|
|
11293
|
-
Create another connection. The first connection for an
|
|
11294
|
-
owner shape fills the compatibility slot; later
|
|
11295
|
-
connections are standard.
|
|
11296
|
-
example: add
|
|
11297
|
-
const: add
|
|
11298
|
-
required:
|
|
11299
|
-
- user_id
|
|
11300
|
-
- client_id
|
|
11301
|
-
- client_secret
|
|
11302
|
-
- connection_intent
|
|
11303
|
-
additionalProperties: false
|
|
11304
11586
|
- type: object
|
|
11305
11587
|
properties:
|
|
11306
11588
|
user_id:
|
|
@@ -11647,8 +11929,8 @@ paths:
|
|
|
11647
11929
|
- message
|
|
11648
11930
|
'409':
|
|
11649
11931
|
description: >-
|
|
11650
|
-
Several connected accounts match this user for the
|
|
11651
|
-
must be named.
|
|
11932
|
+
Several connected accounts match this user or organization for the
|
|
11933
|
+
provider; one must be named.
|
|
11652
11934
|
content:
|
|
11653
11935
|
application/json:
|
|
11654
11936
|
schema:
|
|
@@ -12045,8 +12327,8 @@ paths:
|
|
|
12045
12327
|
- message
|
|
12046
12328
|
'409':
|
|
12047
12329
|
description: >-
|
|
12048
|
-
Several connected accounts match this user for the
|
|
12049
|
-
must be named.
|
|
12330
|
+
Several connected accounts match this user or organization for the
|
|
12331
|
+
provider; one must be named.
|
|
12050
12332
|
content:
|
|
12051
12333
|
application/json:
|
|
12052
12334
|
schema:
|
|
@@ -15456,18 +15738,41 @@ paths:
|
|
|
15456
15738
|
required:
|
|
15457
15739
|
- message
|
|
15458
15740
|
'404':
|
|
15459
|
-
description:
|
|
15741
|
+
description: >-
|
|
15742
|
+
The organization, user, or data integration was not found, or
|
|
15743
|
+
`multiple_connections_unavailable` when `connection_intent: add`
|
|
15744
|
+
would create an additional connection before that capability is
|
|
15745
|
+
available.
|
|
15460
15746
|
content:
|
|
15461
15747
|
application/json:
|
|
15462
15748
|
schema:
|
|
15463
|
-
|
|
15464
|
-
|
|
15465
|
-
|
|
15466
|
-
|
|
15467
|
-
|
|
15468
|
-
|
|
15469
|
-
|
|
15470
|
-
|
|
15749
|
+
anyOf:
|
|
15750
|
+
- type: object
|
|
15751
|
+
properties:
|
|
15752
|
+
code:
|
|
15753
|
+
type: string
|
|
15754
|
+
enum:
|
|
15755
|
+
- multiple_connections_unavailable
|
|
15756
|
+
- entity_not_found
|
|
15757
|
+
description: The error code identifying the type of error.
|
|
15758
|
+
example: multiple_connections_unavailable
|
|
15759
|
+
message:
|
|
15760
|
+
type: string
|
|
15761
|
+
description: A human-readable description of the error.
|
|
15762
|
+
example: Request could not be processed.
|
|
15763
|
+
required:
|
|
15764
|
+
- code
|
|
15765
|
+
- message
|
|
15766
|
+
- type: object
|
|
15767
|
+
properties:
|
|
15768
|
+
message:
|
|
15769
|
+
type: string
|
|
15770
|
+
description: A human-readable description of the error.
|
|
15771
|
+
example: >-
|
|
15772
|
+
Organization not found:
|
|
15773
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
15774
|
+
required:
|
|
15775
|
+
- message
|
|
15471
15776
|
'409':
|
|
15472
15777
|
description: >-
|
|
15473
15778
|
The compatibility connection already exists for this organization
|
|
@@ -22525,6 +22830,25 @@ paths:
|
|
|
22525
22830
|
required:
|
|
22526
22831
|
- code
|
|
22527
22832
|
- message
|
|
22833
|
+
'503':
|
|
22834
|
+
description: Another request is updating the same user. Retry the request.
|
|
22835
|
+
content:
|
|
22836
|
+
application/json:
|
|
22837
|
+
schema:
|
|
22838
|
+
type: object
|
|
22839
|
+
properties:
|
|
22840
|
+
code:
|
|
22841
|
+
type: string
|
|
22842
|
+
description: The error code identifying the type of error.
|
|
22843
|
+
example: concurrent_request
|
|
22844
|
+
const: concurrent_request
|
|
22845
|
+
message:
|
|
22846
|
+
type: string
|
|
22847
|
+
description: A human-readable description of the error.
|
|
22848
|
+
example: Request could not be processed.
|
|
22849
|
+
required:
|
|
22850
|
+
- code
|
|
22851
|
+
- message
|
|
22528
22852
|
summary: Update a user
|
|
22529
22853
|
tags:
|
|
22530
22854
|
- user-management.users
|
|
@@ -24218,18 +24542,41 @@ paths:
|
|
|
24218
24542
|
'401':
|
|
24219
24543
|
description: The request is missing a valid API key.
|
|
24220
24544
|
'404':
|
|
24221
|
-
description:
|
|
24545
|
+
description: >-
|
|
24546
|
+
The user, organization, or data integration was not found, or
|
|
24547
|
+
`multiple_connections_unavailable` when `connection_intent: add`
|
|
24548
|
+
would create an additional connection before that capability is
|
|
24549
|
+
available.
|
|
24222
24550
|
content:
|
|
24223
24551
|
application/json:
|
|
24224
24552
|
schema:
|
|
24225
|
-
|
|
24226
|
-
|
|
24227
|
-
|
|
24228
|
-
|
|
24229
|
-
|
|
24230
|
-
|
|
24231
|
-
|
|
24232
|
-
|
|
24553
|
+
anyOf:
|
|
24554
|
+
- type: object
|
|
24555
|
+
properties:
|
|
24556
|
+
code:
|
|
24557
|
+
type: string
|
|
24558
|
+
enum:
|
|
24559
|
+
- multiple_connections_unavailable
|
|
24560
|
+
- entity_not_found
|
|
24561
|
+
description: The error code identifying the type of error.
|
|
24562
|
+
example: multiple_connections_unavailable
|
|
24563
|
+
message:
|
|
24564
|
+
type: string
|
|
24565
|
+
description: A human-readable description of the error.
|
|
24566
|
+
example: Request could not be processed.
|
|
24567
|
+
required:
|
|
24568
|
+
- code
|
|
24569
|
+
- message
|
|
24570
|
+
- type: object
|
|
24571
|
+
properties:
|
|
24572
|
+
message:
|
|
24573
|
+
type: string
|
|
24574
|
+
description: A human-readable description of the error.
|
|
24575
|
+
example: >-
|
|
24576
|
+
Organization not found:
|
|
24577
|
+
'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
24578
|
+
required:
|
|
24579
|
+
- message
|
|
24233
24580
|
'409':
|
|
24234
24581
|
description: >-
|
|
24235
24582
|
A connected account already exists for this user, integration, and
|
|
@@ -28669,7 +29016,11 @@ components:
|
|
|
28669
29016
|
type: string
|
|
28670
29017
|
description: >-
|
|
28671
29018
|
Set to `add` to create another connected account. Omit this field
|
|
28672
|
-
for permanent compatibility behavior.
|
|
29019
|
+
for permanent compatibility behavior. Creating an additional
|
|
29020
|
+
connection is not yet available: until it is, `add` succeeds only
|
|
29021
|
+
when the owner has no connection for this integration, which creates
|
|
29022
|
+
the compatibility connection, and otherwise returns 404
|
|
29023
|
+
`multiple_connections_unavailable`.
|
|
28673
29024
|
example: add
|
|
28674
29025
|
const: add
|
|
28675
29026
|
required:
|
|
@@ -28749,7 +29100,11 @@ components:
|
|
|
28749
29100
|
type: string
|
|
28750
29101
|
description: >-
|
|
28751
29102
|
Set to `add` to create another connected account. Omit this field
|
|
28752
|
-
for permanent compatibility behavior.
|
|
29103
|
+
for permanent compatibility behavior. Creating an additional
|
|
29104
|
+
connection is not yet available: until it is, `add` succeeds only
|
|
29105
|
+
when the owner has no connection for this integration, which creates
|
|
29106
|
+
the compatibility connection, and otherwise returns 404
|
|
29107
|
+
`multiple_connections_unavailable`.
|
|
28753
29108
|
example: add
|
|
28754
29109
|
const: add
|
|
28755
29110
|
ConnectedAccountDto:
|
package/dist/services.mjs
CHANGED
|
@@ -786,6 +786,11 @@ const serviceEndpoints = {
|
|
|
786
786
|
"path": "/data-integrations/{slug}",
|
|
787
787
|
"name": "update_data_integration"
|
|
788
788
|
},
|
|
789
|
+
{
|
|
790
|
+
"method": "POST",
|
|
791
|
+
"path": "/data-integrations/{slug}/api-key",
|
|
792
|
+
"name": "create_data_integration_api_key"
|
|
793
|
+
},
|
|
789
794
|
{
|
|
790
795
|
"method": "PUT",
|
|
791
796
|
"path": "/data-integrations/{slug}/api-key",
|
|
@@ -796,6 +801,11 @@ const serviceEndpoints = {
|
|
|
796
801
|
"path": "/data-integrations/{slug}/authorize",
|
|
797
802
|
"name": "authorize_data_integration"
|
|
798
803
|
},
|
|
804
|
+
{
|
|
805
|
+
"method": "POST",
|
|
806
|
+
"path": "/data-integrations/{slug}/client-credentials",
|
|
807
|
+
"name": "create_data_integration_client_credential"
|
|
808
|
+
},
|
|
799
809
|
{
|
|
800
810
|
"method": "PUT",
|
|
801
811
|
"path": "/data-integrations/{slug}/client-credentials",
|
package/dist/types.d.ts
CHANGED
|
@@ -1471,10 +1471,14 @@ export interface paths {
|
|
|
1471
1471
|
get?: never;
|
|
1472
1472
|
/**
|
|
1473
1473
|
* Upsert an API key for a connected account
|
|
1474
|
-
* @description Creates or updates an API-key-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored API key is rotated to the new value.
|
|
1474
|
+
* @description Creates or updates an API-key-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored API key is rotated to the new value. To create another connection, use POST.
|
|
1475
1475
|
*/
|
|
1476
1476
|
put: operations["DataIntegrationsController_upsertApiKey"];
|
|
1477
|
-
|
|
1477
|
+
/**
|
|
1478
|
+
* Create another API key connected account
|
|
1479
|
+
* @description Creates another API key-based connected account for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. Requires `connection_intent: add` and does not accept `connected_account_id`; use PUT to create or rotate the compatibility connection or to update an exact connection. Creating an additional connection is not yet available: until it is, this endpoint succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
|
|
1480
|
+
*/
|
|
1481
|
+
post: operations["DataIntegrationsController_createApiKeyConnection"];
|
|
1478
1482
|
delete?: never;
|
|
1479
1483
|
options?: never;
|
|
1480
1484
|
head?: never;
|
|
@@ -1511,10 +1515,14 @@ export interface paths {
|
|
|
1511
1515
|
get?: never;
|
|
1512
1516
|
/**
|
|
1513
1517
|
* Upsert client credentials for a connected account
|
|
1514
|
-
* @description Creates or updates a client-credentials-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored client credentials are rotated to the new values.
|
|
1518
|
+
* @description Creates or updates a client-credentials-based installation for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. If an installation already exists, the stored client credentials are rotated to the new values. To create another connection, use POST.
|
|
1515
1519
|
*/
|
|
1516
1520
|
put: operations["DataIntegrationsController_upsertClientCredentials"];
|
|
1517
|
-
|
|
1521
|
+
/**
|
|
1522
|
+
* Create another client credentials connected account
|
|
1523
|
+
* @description Creates another client credentials-based connected account for the specified integration, owned by the user or, when `connection_owner` is `organization`, shared by the organization. Requires `connection_intent: add` and does not accept `connected_account_id`; use PUT to create or rotate the compatibility connection or to update an exact connection. Creating an additional connection is not yet available: until it is, this endpoint succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
|
|
1524
|
+
*/
|
|
1525
|
+
post: operations["DataIntegrationsController_createClientCredentialsConnection"];
|
|
1518
1526
|
delete?: never;
|
|
1519
1527
|
options?: never;
|
|
1520
1528
|
head?: never;
|
|
@@ -5566,7 +5574,7 @@ export interface components {
|
|
|
5566
5574
|
*/
|
|
5567
5575
|
user_id: string;
|
|
5568
5576
|
/**
|
|
5569
|
-
* @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior.
|
|
5577
|
+
* @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
|
|
5570
5578
|
* @example add
|
|
5571
5579
|
* @constant
|
|
5572
5580
|
*/
|
|
@@ -5641,7 +5649,7 @@ export interface components {
|
|
|
5641
5649
|
*/
|
|
5642
5650
|
state?: "connected" | "needs_reauthorization";
|
|
5643
5651
|
/**
|
|
5644
|
-
* @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior.
|
|
5652
|
+
* @description Set to `add` to create another connected account. Omit this field for permanent compatibility behavior. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration, which creates the compatibility connection, and otherwise returns 404 `multiple_connections_unavailable`.
|
|
5645
5653
|
* @example add
|
|
5646
5654
|
* @constant
|
|
5647
5655
|
*/
|
|
@@ -29745,34 +29753,6 @@ export interface operations {
|
|
|
29745
29753
|
* @example sk-1234567890abcdef
|
|
29746
29754
|
*/
|
|
29747
29755
|
secret: string;
|
|
29748
|
-
} | {
|
|
29749
|
-
/**
|
|
29750
|
-
* @description A [User](/reference/authkit/user) identifier.
|
|
29751
|
-
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
29752
|
-
*/
|
|
29753
|
-
user_id: string;
|
|
29754
|
-
/**
|
|
29755
|
-
* @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
|
|
29756
|
-
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
29757
|
-
*/
|
|
29758
|
-
organization_id?: string;
|
|
29759
|
-
/**
|
|
29760
|
-
* @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
|
|
29761
|
-
* @example user
|
|
29762
|
-
* @enum {string}
|
|
29763
|
-
*/
|
|
29764
|
-
connection_owner?: "user" | "organization";
|
|
29765
|
-
/**
|
|
29766
|
-
* @description The API key secret to store for this integration.
|
|
29767
|
-
* @example sk-1234567890abcdef
|
|
29768
|
-
*/
|
|
29769
|
-
secret: string;
|
|
29770
|
-
/**
|
|
29771
|
-
* @description Create another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard.
|
|
29772
|
-
* @example add
|
|
29773
|
-
* @constant
|
|
29774
|
-
*/
|
|
29775
|
-
connection_intent: "add";
|
|
29776
29756
|
} | {
|
|
29777
29757
|
/**
|
|
29778
29758
|
* @description A [User](/reference/authkit/user) identifier.
|
|
@@ -29935,6 +29915,163 @@ export interface operations {
|
|
|
29935
29915
|
};
|
|
29936
29916
|
};
|
|
29937
29917
|
};
|
|
29918
|
+
DataIntegrationsController_createApiKeyConnection: {
|
|
29919
|
+
parameters: {
|
|
29920
|
+
query?: never;
|
|
29921
|
+
header?: never;
|
|
29922
|
+
path: {
|
|
29923
|
+
/** @description The identifier of the integration. */
|
|
29924
|
+
slug: string;
|
|
29925
|
+
};
|
|
29926
|
+
cookie?: never;
|
|
29927
|
+
};
|
|
29928
|
+
requestBody: {
|
|
29929
|
+
content: {
|
|
29930
|
+
"application/json": {
|
|
29931
|
+
/**
|
|
29932
|
+
* @description A [User](/reference/authkit/user) identifier.
|
|
29933
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
29934
|
+
*/
|
|
29935
|
+
user_id: string;
|
|
29936
|
+
/**
|
|
29937
|
+
* @description An [Organization](/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. Required when `connection_owner` is `organization`.
|
|
29938
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
29939
|
+
*/
|
|
29940
|
+
organization_id?: string;
|
|
29941
|
+
/**
|
|
29942
|
+
* @description Whose connection to create or rotate. `user` (the default) addresses the connection owned by `user_id`. `organization` addresses the connection shared by every member of `organization_id`; `user_id` then identifies the member performing the request and must be an active member of the organization.
|
|
29943
|
+
* @example user
|
|
29944
|
+
* @enum {string}
|
|
29945
|
+
*/
|
|
29946
|
+
connection_owner?: "user" | "organization";
|
|
29947
|
+
/**
|
|
29948
|
+
* @description The API key secret to store for this integration.
|
|
29949
|
+
* @example sk-1234567890abcdef
|
|
29950
|
+
*/
|
|
29951
|
+
secret: string;
|
|
29952
|
+
/**
|
|
29953
|
+
* @description Must be `add`: this endpoint only creates another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration and otherwise returns 404 `multiple_connections_unavailable`.
|
|
29954
|
+
* @example add
|
|
29955
|
+
* @constant
|
|
29956
|
+
*/
|
|
29957
|
+
connection_intent: "add";
|
|
29958
|
+
};
|
|
29959
|
+
};
|
|
29960
|
+
};
|
|
29961
|
+
responses: {
|
|
29962
|
+
/** @description The connected account that was created. */
|
|
29963
|
+
201: {
|
|
29964
|
+
headers: {
|
|
29965
|
+
[name: string]: unknown;
|
|
29966
|
+
};
|
|
29967
|
+
content: {
|
|
29968
|
+
/**
|
|
29969
|
+
* @example {
|
|
29970
|
+
* "object": "connected_account",
|
|
29971
|
+
* "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
29972
|
+
* "connection_role": "standard",
|
|
29973
|
+
* "account_identifier": null,
|
|
29974
|
+
* "account_display_name": null,
|
|
29975
|
+
* "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
29976
|
+
* "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
29977
|
+
* "scopes": [],
|
|
29978
|
+
* "auth_method": "api_key",
|
|
29979
|
+
* "api_key_last_4": "cdef",
|
|
29980
|
+
* "state": "connected",
|
|
29981
|
+
* "created_at": "2024-01-16T14:20:00.000Z",
|
|
29982
|
+
* "updated_at": "2024-01-16T14:20:00.000Z"
|
|
29983
|
+
* }
|
|
29984
|
+
*/
|
|
29985
|
+
"application/json": components["schemas"]["ConnectedAccount"];
|
|
29986
|
+
};
|
|
29987
|
+
};
|
|
29988
|
+
/** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
|
|
29989
|
+
400: {
|
|
29990
|
+
headers: {
|
|
29991
|
+
[name: string]: unknown;
|
|
29992
|
+
};
|
|
29993
|
+
content: {
|
|
29994
|
+
"application/json": {
|
|
29995
|
+
/**
|
|
29996
|
+
* @description A human-readable description of the error.
|
|
29997
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
29998
|
+
*/
|
|
29999
|
+
message: string;
|
|
30000
|
+
};
|
|
30001
|
+
};
|
|
30002
|
+
};
|
|
30003
|
+
/** @description Unauthorized */
|
|
30004
|
+
401: {
|
|
30005
|
+
headers: {
|
|
30006
|
+
[name: string]: unknown;
|
|
30007
|
+
};
|
|
30008
|
+
content?: never;
|
|
30009
|
+
};
|
|
30010
|
+
/** @description Forbidden */
|
|
30011
|
+
403: {
|
|
30012
|
+
headers: {
|
|
30013
|
+
[name: string]: unknown;
|
|
30014
|
+
};
|
|
30015
|
+
content: {
|
|
30016
|
+
"application/json": {
|
|
30017
|
+
/**
|
|
30018
|
+
* @description A human-readable description of the error.
|
|
30019
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30020
|
+
*/
|
|
30021
|
+
message: string;
|
|
30022
|
+
};
|
|
30023
|
+
};
|
|
30024
|
+
};
|
|
30025
|
+
/** @description The data integration was not found, or `multiple_connections_unavailable` when creating an additional connection is not yet available. */
|
|
30026
|
+
404: {
|
|
30027
|
+
headers: {
|
|
30028
|
+
[name: string]: unknown;
|
|
30029
|
+
};
|
|
30030
|
+
content: {
|
|
30031
|
+
"application/json": {
|
|
30032
|
+
/**
|
|
30033
|
+
* @description The error code identifying the type of error.
|
|
30034
|
+
* @example multiple_connections_unavailable
|
|
30035
|
+
* @enum {string}
|
|
30036
|
+
*/
|
|
30037
|
+
code: "multiple_connections_unavailable" | "entity_not_found";
|
|
30038
|
+
/**
|
|
30039
|
+
* @description A human-readable description of the error.
|
|
30040
|
+
* @example Request could not be processed.
|
|
30041
|
+
*/
|
|
30042
|
+
message: string;
|
|
30043
|
+
} | {
|
|
30044
|
+
/**
|
|
30045
|
+
* @description A human-readable description of the error.
|
|
30046
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30047
|
+
*/
|
|
30048
|
+
message: string;
|
|
30049
|
+
};
|
|
30050
|
+
};
|
|
30051
|
+
};
|
|
30052
|
+
/** @description Another connection is being created for this owner and provider. Retry the request. */
|
|
30053
|
+
503: {
|
|
30054
|
+
headers: {
|
|
30055
|
+
[name: string]: unknown;
|
|
30056
|
+
};
|
|
30057
|
+
content: {
|
|
30058
|
+
"application/json": {
|
|
30059
|
+
/**
|
|
30060
|
+
* @description The error code identifying the type of error.
|
|
30061
|
+
* @example concurrent_request
|
|
30062
|
+
* @constant
|
|
30063
|
+
*/
|
|
30064
|
+
code: "concurrent_request";
|
|
30065
|
+
/**
|
|
30066
|
+
* @description A human-readable description of the error.
|
|
30067
|
+
* @example Request could not be processed.
|
|
30068
|
+
*/
|
|
30069
|
+
message: string;
|
|
30070
|
+
};
|
|
30071
|
+
};
|
|
30072
|
+
};
|
|
30073
|
+
};
|
|
30074
|
+
};
|
|
29938
30075
|
DataIntegrationsController_getDataIntegrationAuthorizeUrl: {
|
|
29939
30076
|
parameters: {
|
|
29940
30077
|
query?: never;
|
|
@@ -30131,11 +30268,16 @@ export interface operations {
|
|
|
30131
30268
|
[key: string]: string;
|
|
30132
30269
|
};
|
|
30133
30270
|
/**
|
|
30134
|
-
* @description
|
|
30135
|
-
* @example
|
|
30271
|
+
* @description Reauthorize exactly the connection named by `connected_account_id`.
|
|
30272
|
+
* @example reauthorize
|
|
30136
30273
|
* @constant
|
|
30137
30274
|
*/
|
|
30138
|
-
connection_intent: "
|
|
30275
|
+
connection_intent: "reauthorize";
|
|
30276
|
+
/**
|
|
30277
|
+
* @description The exact connected account to reauthorize. Required with `connection_intent: reauthorize`.
|
|
30278
|
+
* @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30279
|
+
*/
|
|
30280
|
+
connected_account_id: string;
|
|
30139
30281
|
} | {
|
|
30140
30282
|
/**
|
|
30141
30283
|
* @description A [User](/reference/authkit/user) identifier.
|
|
@@ -30173,17 +30315,124 @@ export interface operations {
|
|
|
30173
30315
|
[key: string]: string;
|
|
30174
30316
|
};
|
|
30175
30317
|
/**
|
|
30176
|
-
* @description
|
|
30177
|
-
* @example reauthorize
|
|
30178
|
-
* @constant
|
|
30179
|
-
*/
|
|
30180
|
-
connection_intent: "reauthorize";
|
|
30181
|
-
/**
|
|
30182
|
-
* @description The exact connected account to reauthorize. Required with `connection_intent: reauthorize`.
|
|
30318
|
+
* @description The exact connected account to reauthorize. The reauthorize intent may be omitted for compatibility.
|
|
30183
30319
|
* @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30184
30320
|
*/
|
|
30185
30321
|
connected_account_id: string;
|
|
30186
|
-
}
|
|
30322
|
+
};
|
|
30323
|
+
};
|
|
30324
|
+
};
|
|
30325
|
+
responses: {
|
|
30326
|
+
/** @description The resulting connected account after the upsert. */
|
|
30327
|
+
200: {
|
|
30328
|
+
headers: {
|
|
30329
|
+
[name: string]: unknown;
|
|
30330
|
+
};
|
|
30331
|
+
content: {
|
|
30332
|
+
/**
|
|
30333
|
+
* @example {
|
|
30334
|
+
* "object": "connected_account",
|
|
30335
|
+
* "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
30336
|
+
* "connection_role": "compatibility",
|
|
30337
|
+
* "account_identifier": null,
|
|
30338
|
+
* "account_display_name": null,
|
|
30339
|
+
* "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
30340
|
+
* "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
30341
|
+
* "scopes": [],
|
|
30342
|
+
* "auth_method": "client_credentials",
|
|
30343
|
+
* "state": "connected",
|
|
30344
|
+
* "created_at": "2024-01-16T14:20:00.000Z",
|
|
30345
|
+
* "updated_at": "2024-01-16T14:20:00.000Z"
|
|
30346
|
+
* }
|
|
30347
|
+
*/
|
|
30348
|
+
"application/json": components["schemas"]["ConnectedAccount"];
|
|
30349
|
+
};
|
|
30350
|
+
};
|
|
30351
|
+
/** @description Bad Request */
|
|
30352
|
+
400: {
|
|
30353
|
+
headers: {
|
|
30354
|
+
[name: string]: unknown;
|
|
30355
|
+
};
|
|
30356
|
+
content: {
|
|
30357
|
+
"application/json": {
|
|
30358
|
+
/**
|
|
30359
|
+
* @description A human-readable description of the error.
|
|
30360
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30361
|
+
*/
|
|
30362
|
+
message: string;
|
|
30363
|
+
};
|
|
30364
|
+
};
|
|
30365
|
+
};
|
|
30366
|
+
/** @description Unauthorized */
|
|
30367
|
+
401: {
|
|
30368
|
+
headers: {
|
|
30369
|
+
[name: string]: unknown;
|
|
30370
|
+
};
|
|
30371
|
+
content?: never;
|
|
30372
|
+
};
|
|
30373
|
+
/** @description Forbidden */
|
|
30374
|
+
403: {
|
|
30375
|
+
headers: {
|
|
30376
|
+
[name: string]: unknown;
|
|
30377
|
+
};
|
|
30378
|
+
content: {
|
|
30379
|
+
"application/json": {
|
|
30380
|
+
/**
|
|
30381
|
+
* @description A human-readable description of the error.
|
|
30382
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30383
|
+
*/
|
|
30384
|
+
message: string;
|
|
30385
|
+
};
|
|
30386
|
+
};
|
|
30387
|
+
};
|
|
30388
|
+
/** @description The data integration or selected connected account was not found. */
|
|
30389
|
+
404: {
|
|
30390
|
+
headers: {
|
|
30391
|
+
[name: string]: unknown;
|
|
30392
|
+
};
|
|
30393
|
+
content: {
|
|
30394
|
+
"application/json": {
|
|
30395
|
+
/**
|
|
30396
|
+
* @description A human-readable description of the error.
|
|
30397
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
30398
|
+
*/
|
|
30399
|
+
message: string;
|
|
30400
|
+
};
|
|
30401
|
+
};
|
|
30402
|
+
};
|
|
30403
|
+
/** @description Several connected accounts match the connection owner for the provider; one must be named. */
|
|
30404
|
+
409: {
|
|
30405
|
+
headers: {
|
|
30406
|
+
[name: string]: unknown;
|
|
30407
|
+
};
|
|
30408
|
+
content: {
|
|
30409
|
+
"application/json": components["schemas"]["AccountSelectionRequiredError"];
|
|
30410
|
+
};
|
|
30411
|
+
};
|
|
30412
|
+
/** @description The matched installation uses a different auth method than this endpoint expects. */
|
|
30413
|
+
422: {
|
|
30414
|
+
headers: {
|
|
30415
|
+
[name: string]: unknown;
|
|
30416
|
+
};
|
|
30417
|
+
content: {
|
|
30418
|
+
"application/json": components["schemas"]["AuthMethodMismatchError"];
|
|
30419
|
+
};
|
|
30420
|
+
};
|
|
30421
|
+
};
|
|
30422
|
+
};
|
|
30423
|
+
DataIntegrationsController_createClientCredentialsConnection: {
|
|
30424
|
+
parameters: {
|
|
30425
|
+
query?: never;
|
|
30426
|
+
header?: never;
|
|
30427
|
+
path: {
|
|
30428
|
+
/** @description The identifier of the integration. */
|
|
30429
|
+
slug: string;
|
|
30430
|
+
};
|
|
30431
|
+
cookie?: never;
|
|
30432
|
+
};
|
|
30433
|
+
requestBody: {
|
|
30434
|
+
content: {
|
|
30435
|
+
"application/json": {
|
|
30187
30436
|
/**
|
|
30188
30437
|
* @description A [User](/reference/authkit/user) identifier.
|
|
30189
30438
|
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
@@ -30220,16 +30469,17 @@ export interface operations {
|
|
|
30220
30469
|
[key: string]: string;
|
|
30221
30470
|
};
|
|
30222
30471
|
/**
|
|
30223
|
-
* @description
|
|
30224
|
-
* @example
|
|
30472
|
+
* @description Must be `add`: this endpoint only creates another connection. The first connection for an owner shape fills the compatibility slot; later connections are standard. Creating an additional connection is not yet available: until it is, `add` succeeds only when the owner has no connection for this integration and otherwise returns 404 `multiple_connections_unavailable`.
|
|
30473
|
+
* @example add
|
|
30474
|
+
* @constant
|
|
30225
30475
|
*/
|
|
30226
|
-
|
|
30476
|
+
connection_intent: "add";
|
|
30227
30477
|
};
|
|
30228
30478
|
};
|
|
30229
30479
|
};
|
|
30230
30480
|
responses: {
|
|
30231
|
-
/** @description The
|
|
30232
|
-
|
|
30481
|
+
/** @description The connected account that was created. */
|
|
30482
|
+
201: {
|
|
30233
30483
|
headers: {
|
|
30234
30484
|
[name: string]: unknown;
|
|
30235
30485
|
};
|
|
@@ -30238,7 +30488,7 @@ export interface operations {
|
|
|
30238
30488
|
* @example {
|
|
30239
30489
|
* "object": "connected_account",
|
|
30240
30490
|
* "id": "data_installation_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
30241
|
-
* "connection_role": "
|
|
30491
|
+
* "connection_role": "standard",
|
|
30242
30492
|
* "account_identifier": null,
|
|
30243
30493
|
* "account_display_name": null,
|
|
30244
30494
|
* "user_id": "user_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
@@ -30253,7 +30503,7 @@ export interface operations {
|
|
|
30253
30503
|
"application/json": components["schemas"]["ConnectedAccount"];
|
|
30254
30504
|
};
|
|
30255
30505
|
};
|
|
30256
|
-
/** @description
|
|
30506
|
+
/** @description The request is invalid, including a missing `connection_intent: add` or a supplied `connected_account_id`. */
|
|
30257
30507
|
400: {
|
|
30258
30508
|
headers: {
|
|
30259
30509
|
[name: string]: unknown;
|
|
@@ -30290,13 +30540,25 @@ export interface operations {
|
|
|
30290
30540
|
};
|
|
30291
30541
|
};
|
|
30292
30542
|
};
|
|
30293
|
-
/** @description The data integration or
|
|
30543
|
+
/** @description The data integration was not found, or `multiple_connections_unavailable` when creating an additional connection is not yet available. */
|
|
30294
30544
|
404: {
|
|
30295
30545
|
headers: {
|
|
30296
30546
|
[name: string]: unknown;
|
|
30297
30547
|
};
|
|
30298
30548
|
content: {
|
|
30299
30549
|
"application/json": {
|
|
30550
|
+
/**
|
|
30551
|
+
* @description The error code identifying the type of error.
|
|
30552
|
+
* @example multiple_connections_unavailable
|
|
30553
|
+
* @enum {string}
|
|
30554
|
+
*/
|
|
30555
|
+
code: "multiple_connections_unavailable" | "entity_not_found";
|
|
30556
|
+
/**
|
|
30557
|
+
* @description A human-readable description of the error.
|
|
30558
|
+
* @example Request could not be processed.
|
|
30559
|
+
*/
|
|
30560
|
+
message: string;
|
|
30561
|
+
} | {
|
|
30300
30562
|
/**
|
|
30301
30563
|
* @description A human-readable description of the error.
|
|
30302
30564
|
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
@@ -30305,22 +30567,25 @@ export interface operations {
|
|
|
30305
30567
|
};
|
|
30306
30568
|
};
|
|
30307
30569
|
};
|
|
30308
|
-
/** @description
|
|
30309
|
-
|
|
30310
|
-
headers: {
|
|
30311
|
-
[name: string]: unknown;
|
|
30312
|
-
};
|
|
30313
|
-
content: {
|
|
30314
|
-
"application/json": components["schemas"]["AccountSelectionRequiredError"];
|
|
30315
|
-
};
|
|
30316
|
-
};
|
|
30317
|
-
/** @description The matched installation uses a different auth method than this endpoint expects. */
|
|
30318
|
-
422: {
|
|
30570
|
+
/** @description Another connection is being created for this owner and provider. Retry the request. */
|
|
30571
|
+
503: {
|
|
30319
30572
|
headers: {
|
|
30320
30573
|
[name: string]: unknown;
|
|
30321
30574
|
};
|
|
30322
30575
|
content: {
|
|
30323
|
-
"application/json":
|
|
30576
|
+
"application/json": {
|
|
30577
|
+
/**
|
|
30578
|
+
* @description The error code identifying the type of error.
|
|
30579
|
+
* @example concurrent_request
|
|
30580
|
+
* @constant
|
|
30581
|
+
*/
|
|
30582
|
+
code: "concurrent_request";
|
|
30583
|
+
/**
|
|
30584
|
+
* @description A human-readable description of the error.
|
|
30585
|
+
* @example Request could not be processed.
|
|
30586
|
+
*/
|
|
30587
|
+
message: string;
|
|
30588
|
+
};
|
|
30324
30589
|
};
|
|
30325
30590
|
};
|
|
30326
30591
|
};
|
|
@@ -30446,7 +30711,7 @@ export interface operations {
|
|
|
30446
30711
|
};
|
|
30447
30712
|
};
|
|
30448
30713
|
};
|
|
30449
|
-
/** @description Several connected accounts match this user for the provider; one must be named. */
|
|
30714
|
+
/** @description Several connected accounts match this user or organization for the provider; one must be named. */
|
|
30450
30715
|
409: {
|
|
30451
30716
|
headers: {
|
|
30452
30717
|
[name: string]: unknown;
|
|
@@ -30864,7 +31129,7 @@ export interface operations {
|
|
|
30864
31129
|
};
|
|
30865
31130
|
};
|
|
30866
31131
|
};
|
|
30867
|
-
/** @description Several connected accounts match this user for the provider; one must be named. */
|
|
31132
|
+
/** @description Several connected accounts match this user or organization for the provider; one must be named. */
|
|
30868
31133
|
409: {
|
|
30869
31134
|
headers: {
|
|
30870
31135
|
[name: string]: unknown;
|
|
@@ -33945,13 +34210,25 @@ export interface operations {
|
|
|
33945
34210
|
};
|
|
33946
34211
|
};
|
|
33947
34212
|
};
|
|
33948
|
-
/** @description The organization, user, or data integration was not found. */
|
|
34213
|
+
/** @description The organization, user, or data integration was not found, or `multiple_connections_unavailable` when `connection_intent: add` would create an additional connection before that capability is available. */
|
|
33949
34214
|
404: {
|
|
33950
34215
|
headers: {
|
|
33951
34216
|
[name: string]: unknown;
|
|
33952
34217
|
};
|
|
33953
34218
|
content: {
|
|
33954
34219
|
"application/json": {
|
|
34220
|
+
/**
|
|
34221
|
+
* @description The error code identifying the type of error.
|
|
34222
|
+
* @example multiple_connections_unavailable
|
|
34223
|
+
* @enum {string}
|
|
34224
|
+
*/
|
|
34225
|
+
code: "multiple_connections_unavailable" | "entity_not_found";
|
|
34226
|
+
/**
|
|
34227
|
+
* @description A human-readable description of the error.
|
|
34228
|
+
* @example Request could not be processed.
|
|
34229
|
+
*/
|
|
34230
|
+
message: string;
|
|
34231
|
+
} | {
|
|
33955
34232
|
/**
|
|
33956
34233
|
* @description A human-readable description of the error.
|
|
33957
34234
|
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
@@ -40053,6 +40330,27 @@ export interface operations {
|
|
|
40053
40330
|
};
|
|
40054
40331
|
};
|
|
40055
40332
|
};
|
|
40333
|
+
/** @description Another request is updating the same user. Retry the request. */
|
|
40334
|
+
503: {
|
|
40335
|
+
headers: {
|
|
40336
|
+
[name: string]: unknown;
|
|
40337
|
+
};
|
|
40338
|
+
content: {
|
|
40339
|
+
"application/json": {
|
|
40340
|
+
/**
|
|
40341
|
+
* @description The error code identifying the type of error.
|
|
40342
|
+
* @example concurrent_request
|
|
40343
|
+
* @constant
|
|
40344
|
+
*/
|
|
40345
|
+
code: "concurrent_request";
|
|
40346
|
+
/**
|
|
40347
|
+
* @description A human-readable description of the error.
|
|
40348
|
+
* @example Request could not be processed.
|
|
40349
|
+
*/
|
|
40350
|
+
message: string;
|
|
40351
|
+
};
|
|
40352
|
+
};
|
|
40353
|
+
};
|
|
40056
40354
|
};
|
|
40057
40355
|
};
|
|
40058
40356
|
"UserlandUsersController_delete[0]": {
|
|
@@ -41471,13 +41769,25 @@ export interface operations {
|
|
|
41471
41769
|
};
|
|
41472
41770
|
content?: never;
|
|
41473
41771
|
};
|
|
41474
|
-
/** @description The user, organization, or data integration was not found. */
|
|
41772
|
+
/** @description The user, organization, or data integration was not found, or `multiple_connections_unavailable` when `connection_intent: add` would create an additional connection before that capability is available. */
|
|
41475
41773
|
404: {
|
|
41476
41774
|
headers: {
|
|
41477
41775
|
[name: string]: unknown;
|
|
41478
41776
|
};
|
|
41479
41777
|
content: {
|
|
41480
41778
|
"application/json": {
|
|
41779
|
+
/**
|
|
41780
|
+
* @description The error code identifying the type of error.
|
|
41781
|
+
* @example multiple_connections_unavailable
|
|
41782
|
+
* @enum {string}
|
|
41783
|
+
*/
|
|
41784
|
+
code: "multiple_connections_unavailable" | "entity_not_found";
|
|
41785
|
+
/**
|
|
41786
|
+
* @description A human-readable description of the error.
|
|
41787
|
+
* @example Request could not be processed.
|
|
41788
|
+
*/
|
|
41789
|
+
message: string;
|
|
41790
|
+
} | {
|
|
41481
41791
|
/**
|
|
41482
41792
|
* @description A human-readable description of the error.
|
|
41483
41793
|
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|