@workos/openapi-spec 0.81.0 → 0.82.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 +151 -5
- package/dist/types.d.ts +101 -1
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -43143,7 +43143,7 @@ components:
|
|
|
43143
43143
|
items:
|
|
43144
43144
|
type: string
|
|
43145
43145
|
description: The OAuth scopes granted for this connection.
|
|
43146
|
-
example:
|
|
43146
|
+
example: &ref_34
|
|
43147
43147
|
- repo
|
|
43148
43148
|
- user:email
|
|
43149
43149
|
auth_method:
|
|
@@ -43193,7 +43193,7 @@ components:
|
|
|
43193
43193
|
`installation` scope, excluding any it declares as
|
|
43194
43194
|
secret. Only present when `auth_method` is
|
|
43195
43195
|
`client_credentials`.
|
|
43196
|
-
example:
|
|
43196
|
+
example: &ref_35
|
|
43197
43197
|
instance_url: https://example.my.salesforce.com
|
|
43198
43198
|
state:
|
|
43199
43199
|
type: string
|
|
@@ -43256,6 +43256,151 @@ components:
|
|
|
43256
43256
|
- createdAt
|
|
43257
43257
|
- updatedAt
|
|
43258
43258
|
- type: 'null'
|
|
43259
|
+
connected_accounts:
|
|
43260
|
+
type: array
|
|
43261
|
+
items:
|
|
43262
|
+
type: object
|
|
43263
|
+
properties:
|
|
43264
|
+
object:
|
|
43265
|
+
type: string
|
|
43266
|
+
description: Distinguishes the connected account object.
|
|
43267
|
+
const: connected_account
|
|
43268
|
+
id:
|
|
43269
|
+
type: string
|
|
43270
|
+
description: The unique identifier of the connected account.
|
|
43271
|
+
example: data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
43272
|
+
user_id:
|
|
43273
|
+
type:
|
|
43274
|
+
- string
|
|
43275
|
+
- 'null'
|
|
43276
|
+
description: >-
|
|
43277
|
+
The [User](/reference/authkit/user) identifier
|
|
43278
|
+
associated with this connection.
|
|
43279
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
43280
|
+
organization_id:
|
|
43281
|
+
type:
|
|
43282
|
+
- string
|
|
43283
|
+
- 'null'
|
|
43284
|
+
description: >-
|
|
43285
|
+
The [Organization](/reference/organization) identifier
|
|
43286
|
+
associated with this connection, or `null` if not scoped
|
|
43287
|
+
to an organization.
|
|
43288
|
+
example: null
|
|
43289
|
+
scopes:
|
|
43290
|
+
type: array
|
|
43291
|
+
items:
|
|
43292
|
+
type: string
|
|
43293
|
+
description: The OAuth scopes granted for this connection.
|
|
43294
|
+
example: *ref_34
|
|
43295
|
+
auth_method:
|
|
43296
|
+
type: string
|
|
43297
|
+
enum:
|
|
43298
|
+
- oauth
|
|
43299
|
+
- api_key
|
|
43300
|
+
- client_credentials
|
|
43301
|
+
description: >-
|
|
43302
|
+
The authentication method used for this connection
|
|
43303
|
+
(`oauth`, `api_key`, or `client_credentials`). Defaults
|
|
43304
|
+
to `oauth` if absent.
|
|
43305
|
+
example: oauth
|
|
43306
|
+
api_key_last_4:
|
|
43307
|
+
type:
|
|
43308
|
+
- string
|
|
43309
|
+
- 'null'
|
|
43310
|
+
description: >-
|
|
43311
|
+
The last four characters of the API key, or `null` for
|
|
43312
|
+
OAuth connections.
|
|
43313
|
+
example: null
|
|
43314
|
+
client_id:
|
|
43315
|
+
type:
|
|
43316
|
+
- string
|
|
43317
|
+
- 'null'
|
|
43318
|
+
description: >-
|
|
43319
|
+
The client ID supplied for this connection. Only present
|
|
43320
|
+
when `auth_method` is `client_credentials`.
|
|
43321
|
+
example: 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
43322
|
+
client_secret_last_4:
|
|
43323
|
+
type:
|
|
43324
|
+
- string
|
|
43325
|
+
- 'null'
|
|
43326
|
+
description: >-
|
|
43327
|
+
The last four characters of the client secret supplied
|
|
43328
|
+
for this connection, or `null` when it can't be read.
|
|
43329
|
+
Only present when `auth_method` is `client_credentials`.
|
|
43330
|
+
example: cdef
|
|
43331
|
+
config:
|
|
43332
|
+
type: object
|
|
43333
|
+
additionalProperties:
|
|
43334
|
+
type: string
|
|
43335
|
+
description: >-
|
|
43336
|
+
The connection-level configuration values stored for
|
|
43337
|
+
this connection — the fields the provider declares at
|
|
43338
|
+
`installation` scope, excluding any it declares as
|
|
43339
|
+
secret. Only present when `auth_method` is
|
|
43340
|
+
`client_credentials`.
|
|
43341
|
+
example: *ref_35
|
|
43342
|
+
state:
|
|
43343
|
+
type: string
|
|
43344
|
+
enum:
|
|
43345
|
+
- connected
|
|
43346
|
+
- needs_reauthorization
|
|
43347
|
+
- disconnected
|
|
43348
|
+
description: >-
|
|
43349
|
+
The state of the connected account:
|
|
43350
|
+
|
|
43351
|
+
- `connected`: The connection is active and tokens are
|
|
43352
|
+
valid.
|
|
43353
|
+
|
|
43354
|
+
- `needs_reauthorization`: The user needs to reauthorize
|
|
43355
|
+
the connection, typically because required scopes have
|
|
43356
|
+
changed.
|
|
43357
|
+
|
|
43358
|
+
- `disconnected`: The connection has been disconnected.
|
|
43359
|
+
example: connected
|
|
43360
|
+
created_at:
|
|
43361
|
+
type: string
|
|
43362
|
+
description: The timestamp when the connection was created.
|
|
43363
|
+
example: '2024-01-16T14:20:00.000Z'
|
|
43364
|
+
updated_at:
|
|
43365
|
+
type: string
|
|
43366
|
+
description: The timestamp when the connection was last updated.
|
|
43367
|
+
example: '2024-01-16T14:20:00.000Z'
|
|
43368
|
+
userlandUserId:
|
|
43369
|
+
type:
|
|
43370
|
+
- string
|
|
43371
|
+
- 'null'
|
|
43372
|
+
deprecated: true
|
|
43373
|
+
description: Use `user_id` instead.
|
|
43374
|
+
organizationId:
|
|
43375
|
+
type:
|
|
43376
|
+
- string
|
|
43377
|
+
- 'null'
|
|
43378
|
+
deprecated: true
|
|
43379
|
+
description: Use `organization_id` instead.
|
|
43380
|
+
createdAt:
|
|
43381
|
+
type: string
|
|
43382
|
+
deprecated: true
|
|
43383
|
+
description: Use `created_at` instead.
|
|
43384
|
+
updatedAt:
|
|
43385
|
+
type: string
|
|
43386
|
+
deprecated: true
|
|
43387
|
+
description: Use `updated_at` instead.
|
|
43388
|
+
required:
|
|
43389
|
+
- object
|
|
43390
|
+
- id
|
|
43391
|
+
- user_id
|
|
43392
|
+
- organization_id
|
|
43393
|
+
- scopes
|
|
43394
|
+
- state
|
|
43395
|
+
- created_at
|
|
43396
|
+
- updated_at
|
|
43397
|
+
- userlandUserId
|
|
43398
|
+
- organizationId
|
|
43399
|
+
- createdAt
|
|
43400
|
+
- updatedAt
|
|
43401
|
+
description: >-
|
|
43402
|
+
The user's connected accounts for this provider in the
|
|
43403
|
+
requested ownership context.
|
|
43259
43404
|
required:
|
|
43260
43405
|
- object
|
|
43261
43406
|
- id
|
|
@@ -43273,10 +43418,11 @@ components:
|
|
|
43273
43418
|
- createdAt
|
|
43274
43419
|
- updatedAt
|
|
43275
43420
|
- connected_account
|
|
43421
|
+
- connected_accounts
|
|
43276
43422
|
description: >-
|
|
43277
|
-
A list of [providers](/reference/pipes/provider), each including
|
|
43278
|
-
|
|
43279
|
-
|
|
43423
|
+
A list of [providers](/reference/pipes/provider), each including the
|
|
43424
|
+
legacy `connected_account` field and the additive
|
|
43425
|
+
`connected_accounts` collection.
|
|
43280
43426
|
required:
|
|
43281
43427
|
- object
|
|
43282
43428
|
- data
|
package/dist/types.d.ts
CHANGED
|
@@ -17797,7 +17797,7 @@ export interface components {
|
|
|
17797
17797
|
* @constant
|
|
17798
17798
|
*/
|
|
17799
17799
|
object: "list";
|
|
17800
|
-
/** @description A list of [providers](/reference/pipes/provider), each including
|
|
17800
|
+
/** @description A list of [providers](/reference/pipes/provider), each including the legacy `connected_account` field and the additive `connected_accounts` collection. */
|
|
17801
17801
|
data: {
|
|
17802
17802
|
/**
|
|
17803
17803
|
* @description Distinguishes the data provider object.
|
|
@@ -17984,6 +17984,106 @@ export interface components {
|
|
|
17984
17984
|
*/
|
|
17985
17985
|
updatedAt: string;
|
|
17986
17986
|
} | null;
|
|
17987
|
+
/** @description The user's connected accounts for this provider in the requested ownership context. */
|
|
17988
|
+
connected_accounts: {
|
|
17989
|
+
/**
|
|
17990
|
+
* @description Distinguishes the connected account object.
|
|
17991
|
+
* @constant
|
|
17992
|
+
*/
|
|
17993
|
+
object: "connected_account";
|
|
17994
|
+
/**
|
|
17995
|
+
* @description The unique identifier of the connected account.
|
|
17996
|
+
* @example data_installation_01EHZNVPK3SFK441A1RGBFSHRT
|
|
17997
|
+
*/
|
|
17998
|
+
id: string;
|
|
17999
|
+
/**
|
|
18000
|
+
* @description The [User](/reference/authkit/user) identifier associated with this connection.
|
|
18001
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
18002
|
+
*/
|
|
18003
|
+
user_id: string | null;
|
|
18004
|
+
/**
|
|
18005
|
+
* @description The [Organization](/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization.
|
|
18006
|
+
* @example null
|
|
18007
|
+
*/
|
|
18008
|
+
organization_id: string | null;
|
|
18009
|
+
/**
|
|
18010
|
+
* @description The OAuth scopes granted for this connection.
|
|
18011
|
+
* @example [
|
|
18012
|
+
* "repo",
|
|
18013
|
+
* "user:email"
|
|
18014
|
+
* ]
|
|
18015
|
+
*/
|
|
18016
|
+
scopes: string[];
|
|
18017
|
+
/**
|
|
18018
|
+
* @description The authentication method used for this connection (`oauth`, `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
|
|
18019
|
+
* @example oauth
|
|
18020
|
+
* @enum {string}
|
|
18021
|
+
*/
|
|
18022
|
+
auth_method?: "oauth" | "api_key" | "client_credentials";
|
|
18023
|
+
/**
|
|
18024
|
+
* @description The last four characters of the API key, or `null` for OAuth connections.
|
|
18025
|
+
* @example null
|
|
18026
|
+
*/
|
|
18027
|
+
api_key_last_4?: string | null;
|
|
18028
|
+
/**
|
|
18029
|
+
* @description The client ID supplied for this connection. Only present when `auth_method` is `client_credentials`.
|
|
18030
|
+
* @example 3MVG9dZJodJWxft2VoStSCVwPFsx0eDcpVc
|
|
18031
|
+
*/
|
|
18032
|
+
client_id?: string | null;
|
|
18033
|
+
/**
|
|
18034
|
+
* @description The last four characters of the client secret supplied for this connection, or `null` when it can't be read. Only present when `auth_method` is `client_credentials`.
|
|
18035
|
+
* @example cdef
|
|
18036
|
+
*/
|
|
18037
|
+
client_secret_last_4?: string | null;
|
|
18038
|
+
/**
|
|
18039
|
+
* @description The connection-level configuration values stored for this connection — the fields the provider declares at `installation` scope, excluding any it declares as secret. Only present when `auth_method` is `client_credentials`.
|
|
18040
|
+
* @example {
|
|
18041
|
+
* "instance_url": "https://example.my.salesforce.com"
|
|
18042
|
+
* }
|
|
18043
|
+
*/
|
|
18044
|
+
config?: {
|
|
18045
|
+
[key: string]: string;
|
|
18046
|
+
};
|
|
18047
|
+
/**
|
|
18048
|
+
* @description The state of the connected account:
|
|
18049
|
+
* - `connected`: The connection is active and tokens are valid.
|
|
18050
|
+
* - `needs_reauthorization`: The user needs to reauthorize the connection, typically because required scopes have changed.
|
|
18051
|
+
* - `disconnected`: The connection has been disconnected.
|
|
18052
|
+
* @example connected
|
|
18053
|
+
* @enum {string}
|
|
18054
|
+
*/
|
|
18055
|
+
state: "connected" | "needs_reauthorization" | "disconnected";
|
|
18056
|
+
/**
|
|
18057
|
+
* @description The timestamp when the connection was created.
|
|
18058
|
+
* @example 2024-01-16T14:20:00.000Z
|
|
18059
|
+
*/
|
|
18060
|
+
created_at: string;
|
|
18061
|
+
/**
|
|
18062
|
+
* @description The timestamp when the connection was last updated.
|
|
18063
|
+
* @example 2024-01-16T14:20:00.000Z
|
|
18064
|
+
*/
|
|
18065
|
+
updated_at: string;
|
|
18066
|
+
/**
|
|
18067
|
+
* @deprecated
|
|
18068
|
+
* @description Use `user_id` instead.
|
|
18069
|
+
*/
|
|
18070
|
+
userlandUserId: string | null;
|
|
18071
|
+
/**
|
|
18072
|
+
* @deprecated
|
|
18073
|
+
* @description Use `organization_id` instead.
|
|
18074
|
+
*/
|
|
18075
|
+
organizationId: string | null;
|
|
18076
|
+
/**
|
|
18077
|
+
* @deprecated
|
|
18078
|
+
* @description Use `created_at` instead.
|
|
18079
|
+
*/
|
|
18080
|
+
createdAt: string;
|
|
18081
|
+
/**
|
|
18082
|
+
* @deprecated
|
|
18083
|
+
* @description Use `updated_at` instead.
|
|
18084
|
+
*/
|
|
18085
|
+
updatedAt: string;
|
|
18086
|
+
}[];
|
|
17987
18087
|
}[];
|
|
17988
18088
|
};
|
|
17989
18089
|
PortalLinkResponse: {
|