@workos/openapi-spec 0.17.1 → 0.19.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 +1289 -80
- package/dist/services.mjs +40 -0
- package/dist/types.d.ts +1160 -39
- package/package.json +5 -5
package/dist/types.d.ts
CHANGED
|
@@ -1053,6 +1053,58 @@ export interface paths {
|
|
|
1053
1053
|
patch?: never;
|
|
1054
1054
|
trace?: never;
|
|
1055
1055
|
};
|
|
1056
|
+
"/data-integrations": {
|
|
1057
|
+
parameters: {
|
|
1058
|
+
query?: never;
|
|
1059
|
+
header?: never;
|
|
1060
|
+
path?: never;
|
|
1061
|
+
cookie?: never;
|
|
1062
|
+
};
|
|
1063
|
+
/**
|
|
1064
|
+
* List data integrations
|
|
1065
|
+
* @description Lists the environment's data integrations configured with `custom` or `organization` credentials, including custom providers.
|
|
1066
|
+
*/
|
|
1067
|
+
get: operations["DataIntegrationsManagementController_listDataIntegrations"];
|
|
1068
|
+
put?: never;
|
|
1069
|
+
/**
|
|
1070
|
+
* Create a data integration
|
|
1071
|
+
* @description Creates a data integration for a provider. Set `credentials.type` to `custom` to use your own OAuth app credentials, or `organization` to have each organization supply its own. For a built-in provider, pass its slug as `provider`. For a custom provider, pass a new slug plus a `custom_provider` definition.
|
|
1072
|
+
*/
|
|
1073
|
+
post: operations["DataIntegrationsManagementController_createDataIntegration"];
|
|
1074
|
+
delete?: never;
|
|
1075
|
+
options?: never;
|
|
1076
|
+
head?: never;
|
|
1077
|
+
patch?: never;
|
|
1078
|
+
trace?: never;
|
|
1079
|
+
};
|
|
1080
|
+
"/data-integrations/{slug}": {
|
|
1081
|
+
parameters: {
|
|
1082
|
+
query?: never;
|
|
1083
|
+
header?: never;
|
|
1084
|
+
path?: never;
|
|
1085
|
+
cookie?: never;
|
|
1086
|
+
};
|
|
1087
|
+
/**
|
|
1088
|
+
* Get a data integration
|
|
1089
|
+
* @description Retrieves a data integration by its slug.
|
|
1090
|
+
*/
|
|
1091
|
+
get: operations["DataIntegrationsManagementController_getDataIntegration"];
|
|
1092
|
+
/**
|
|
1093
|
+
* Update a data integration
|
|
1094
|
+
* @description Updates the description, enabled state, or custom credentials of a data integration. For custom providers, `custom_provider` updates the OAuth definition.
|
|
1095
|
+
*/
|
|
1096
|
+
put: operations["DataIntegrationsManagementController_updateDataIntegration"];
|
|
1097
|
+
post?: never;
|
|
1098
|
+
/**
|
|
1099
|
+
* Delete a data integration
|
|
1100
|
+
* @description Deletes a data integration and all of its connected installations. For a custom provider, also deletes the custom provider definition.
|
|
1101
|
+
*/
|
|
1102
|
+
delete: operations["DataIntegrationsManagementController_deleteDataIntegration"];
|
|
1103
|
+
options?: never;
|
|
1104
|
+
head?: never;
|
|
1105
|
+
patch?: never;
|
|
1106
|
+
trace?: never;
|
|
1107
|
+
};
|
|
1056
1108
|
"/data-integrations/{slug}/api-key": {
|
|
1057
1109
|
parameters: {
|
|
1058
1110
|
query?: never;
|
|
@@ -2423,6 +2475,26 @@ export interface paths {
|
|
|
2423
2475
|
patch?: never;
|
|
2424
2476
|
trace?: never;
|
|
2425
2477
|
};
|
|
2478
|
+
"/user_management/radar_challenges": {
|
|
2479
|
+
parameters: {
|
|
2480
|
+
query?: never;
|
|
2481
|
+
header?: never;
|
|
2482
|
+
path?: never;
|
|
2483
|
+
cookie?: never;
|
|
2484
|
+
};
|
|
2485
|
+
get?: never;
|
|
2486
|
+
put?: never;
|
|
2487
|
+
/**
|
|
2488
|
+
* Send a Radar SMS challenge
|
|
2489
|
+
* @description Sends a one-time verification code over SMS to a user as part of a Radar challenge. Use the returned `verification_id` to authenticate the user with the `urn:workos:oauth:grant-type:radar-sms-challenge:code` grant type.
|
|
2490
|
+
*/
|
|
2491
|
+
post: operations["PublicRadarChallengesController_sendRadarSmsChallenge"];
|
|
2492
|
+
delete?: never;
|
|
2493
|
+
options?: never;
|
|
2494
|
+
head?: never;
|
|
2495
|
+
patch?: never;
|
|
2496
|
+
trace?: never;
|
|
2497
|
+
};
|
|
2426
2498
|
"/user_management/redirect_uris": {
|
|
2427
2499
|
parameters: {
|
|
2428
2500
|
query?: never;
|
|
@@ -2775,8 +2847,16 @@ export interface paths {
|
|
|
2775
2847
|
* @description Retrieves a user's [connected account](/reference/pipes/connected-account) for a specific provider.
|
|
2776
2848
|
*/
|
|
2777
2849
|
get: operations["DataIntegrationsUserManagementController_getUserDataInstallation"];
|
|
2778
|
-
|
|
2779
|
-
|
|
2850
|
+
/**
|
|
2851
|
+
* Update a connected account
|
|
2852
|
+
* @description Updates a user's [connected account](/reference/pipes/connected-account) tokens, scopes, or state for a specific provider.
|
|
2853
|
+
*/
|
|
2854
|
+
put: operations["DataIntegrationsUserManagementController_updateUserDataInstallation"];
|
|
2855
|
+
/**
|
|
2856
|
+
* Import a connected account
|
|
2857
|
+
* @description Imports a [connected account](/reference/pipes/connected-account) for a user by providing OAuth tokens directly. Use this to migrate existing connections or set up connections without going through the OAuth flow.
|
|
2858
|
+
*/
|
|
2859
|
+
post: operations["DataIntegrationsUserManagementController_createUserDataInstallation"];
|
|
2780
2860
|
/**
|
|
2781
2861
|
* Delete a connected account
|
|
2782
2862
|
* @description Disconnects WorkOS's account for the user, including removing any stored access and refresh tokens. The user will need to reauthorize if they want to reconnect. This does not revoke access on the provider side.
|
|
@@ -3421,11 +3501,13 @@ export interface components {
|
|
|
3421
3501
|
*/
|
|
3422
3502
|
organization_id: string;
|
|
3423
3503
|
/**
|
|
3504
|
+
* Format: date-time
|
|
3424
3505
|
* @description ISO-8601 value for start of the export range.
|
|
3425
3506
|
* @example 2022-07-02T18:09:06.996Z
|
|
3426
3507
|
*/
|
|
3427
3508
|
range_start: string;
|
|
3428
3509
|
/**
|
|
3510
|
+
* Format: date-time
|
|
3429
3511
|
* @description ISO-8601 value for end of the export range.
|
|
3430
3512
|
* @example 2022-09-02T18:09:06.996Z
|
|
3431
3513
|
*/
|
|
@@ -4035,6 +4117,239 @@ export interface components {
|
|
|
4035
4117
|
*/
|
|
4036
4118
|
external_id?: string | null;
|
|
4037
4119
|
};
|
|
4120
|
+
DataIntegrationCredentialsDto: {
|
|
4121
|
+
/**
|
|
4122
|
+
* @description The credentials type. `custom` uses your own OAuth app credentials; `organization` has each organization supply its own credentials (configured per-organization).
|
|
4123
|
+
* @example custom
|
|
4124
|
+
* @enum {string}
|
|
4125
|
+
*/
|
|
4126
|
+
type: "custom" | "organization";
|
|
4127
|
+
/**
|
|
4128
|
+
* @description OAuth client ID for the provider app. Required when `type` is `custom`; omit for `organization`.
|
|
4129
|
+
* @example Iv1.abc123
|
|
4130
|
+
*/
|
|
4131
|
+
client_id?: string;
|
|
4132
|
+
/**
|
|
4133
|
+
* @description OAuth client secret for the provider app. Required when `type` is `custom`; omit for `organization`.
|
|
4134
|
+
* @example secret_…
|
|
4135
|
+
*/
|
|
4136
|
+
client_secret?: string;
|
|
4137
|
+
};
|
|
4138
|
+
CustomProviderDefinitionDto: {
|
|
4139
|
+
/**
|
|
4140
|
+
* @description A descriptive name for the custom provider.
|
|
4141
|
+
* @example My OAuth App
|
|
4142
|
+
*/
|
|
4143
|
+
name: string;
|
|
4144
|
+
/**
|
|
4145
|
+
* Format: uri
|
|
4146
|
+
* @description The provider's OAuth authorization endpoint.
|
|
4147
|
+
* @example https://provider.example.com/oauth/authorize
|
|
4148
|
+
*/
|
|
4149
|
+
authorization_url: string;
|
|
4150
|
+
/**
|
|
4151
|
+
* Format: uri
|
|
4152
|
+
* @description The provider's OAuth token endpoint.
|
|
4153
|
+
* @example https://provider.example.com/oauth/token
|
|
4154
|
+
*/
|
|
4155
|
+
token_url: string;
|
|
4156
|
+
/**
|
|
4157
|
+
* Format: uri
|
|
4158
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
4159
|
+
* @example https://provider.example.com/oauth/token
|
|
4160
|
+
*/
|
|
4161
|
+
refresh_token_url?: string | null;
|
|
4162
|
+
/**
|
|
4163
|
+
* @description Whether PKCE is used during the authorization code flow. Defaults to `true`.
|
|
4164
|
+
* @example true
|
|
4165
|
+
*/
|
|
4166
|
+
pkce_enabled?: boolean;
|
|
4167
|
+
/**
|
|
4168
|
+
* @description The separator used to join requested scopes. Defaults to a space.
|
|
4169
|
+
* @example
|
|
4170
|
+
*/
|
|
4171
|
+
request_scope_separator?: string;
|
|
4172
|
+
/**
|
|
4173
|
+
* @description Whether at least one scope must be selected when connecting an account. Defaults to `false`.
|
|
4174
|
+
* @example false
|
|
4175
|
+
*/
|
|
4176
|
+
scopes_required?: boolean;
|
|
4177
|
+
/**
|
|
4178
|
+
* @description Whether a client secret is required for this provider. Defaults to `true`.
|
|
4179
|
+
* @example true
|
|
4180
|
+
*/
|
|
4181
|
+
client_secret_required?: boolean;
|
|
4182
|
+
/**
|
|
4183
|
+
* @description Additional static query parameters appended to the authorization request.
|
|
4184
|
+
* @example {
|
|
4185
|
+
* "prompt": "consent"
|
|
4186
|
+
* }
|
|
4187
|
+
*/
|
|
4188
|
+
additional_authorization_parameters?: {
|
|
4189
|
+
[key: string]: string;
|
|
4190
|
+
};
|
|
4191
|
+
/**
|
|
4192
|
+
* @description The Content-Type used when exchanging the token request.
|
|
4193
|
+
* @example application/x-www-form-urlencoded
|
|
4194
|
+
*/
|
|
4195
|
+
token_body_content_type?: string;
|
|
4196
|
+
/**
|
|
4197
|
+
* @description How client credentials are sent when exchanging authorization codes and refreshing tokens.
|
|
4198
|
+
* @example request_body
|
|
4199
|
+
* @enum {string}
|
|
4200
|
+
*/
|
|
4201
|
+
authenticate_via?: "request_body" | "basic_auth_header";
|
|
4202
|
+
};
|
|
4203
|
+
CreateDataIntegrationDto: {
|
|
4204
|
+
/**
|
|
4205
|
+
* @description The provider to create a Data Integration for. For a built-in provider use its slug (e.g. `github`, `slack`). For a custom provider, this is the new provider slug and `custom_provider` must be supplied. A custom provider slug cannot shadow an existing global provider slug.
|
|
4206
|
+
* @example github
|
|
4207
|
+
*/
|
|
4208
|
+
provider: string;
|
|
4209
|
+
/**
|
|
4210
|
+
* @description An optional description of the Data Integration.
|
|
4211
|
+
* @example Production GitHub app
|
|
4212
|
+
*/
|
|
4213
|
+
description?: string | null;
|
|
4214
|
+
/**
|
|
4215
|
+
* @description Whether the Data Integration is enabled. Defaults to `false`.
|
|
4216
|
+
* @example true
|
|
4217
|
+
*/
|
|
4218
|
+
enabled?: boolean;
|
|
4219
|
+
/**
|
|
4220
|
+
* @description The OAuth scopes to request for the Data Integration. Defaults to the provider's configured scopes when omitted.
|
|
4221
|
+
* @example [
|
|
4222
|
+
* "repo",
|
|
4223
|
+
* "read:org"
|
|
4224
|
+
* ]
|
|
4225
|
+
*/
|
|
4226
|
+
scopes?: string[] | null;
|
|
4227
|
+
/** @description The credentials to configure for the Data Integration. Required for both built-in and custom providers. */
|
|
4228
|
+
credentials?: components["schemas"]["DataIntegrationCredentialsDto"];
|
|
4229
|
+
/** @description The OAuth definition for a custom provider. Supply this to define a custom provider; omit it to create an integration for a built-in provider. */
|
|
4230
|
+
custom_provider?: components["schemas"]["CustomProviderDefinitionDto"];
|
|
4231
|
+
};
|
|
4232
|
+
UpdateCustomProviderDefinitionDto: {
|
|
4233
|
+
/**
|
|
4234
|
+
* @description A descriptive name for the custom provider.
|
|
4235
|
+
* @example My OAuth App
|
|
4236
|
+
*/
|
|
4237
|
+
name?: string;
|
|
4238
|
+
/**
|
|
4239
|
+
* Format: uri
|
|
4240
|
+
* @description The provider's OAuth authorization endpoint.
|
|
4241
|
+
* @example https://provider.example.com/oauth/authorize
|
|
4242
|
+
*/
|
|
4243
|
+
authorization_url?: string;
|
|
4244
|
+
/**
|
|
4245
|
+
* Format: uri
|
|
4246
|
+
* @description The provider's OAuth token endpoint.
|
|
4247
|
+
* @example https://provider.example.com/oauth/token
|
|
4248
|
+
*/
|
|
4249
|
+
token_url?: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* Format: uri
|
|
4252
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
4253
|
+
* @example https://provider.example.com/oauth/token
|
|
4254
|
+
*/
|
|
4255
|
+
refresh_token_url?: string | null;
|
|
4256
|
+
/**
|
|
4257
|
+
* @description Whether PKCE is used during the authorization code flow.
|
|
4258
|
+
* @example true
|
|
4259
|
+
*/
|
|
4260
|
+
pkce_enabled?: boolean;
|
|
4261
|
+
/**
|
|
4262
|
+
* @description The separator used to join requested scopes.
|
|
4263
|
+
* @example
|
|
4264
|
+
*/
|
|
4265
|
+
request_scope_separator?: string;
|
|
4266
|
+
/**
|
|
4267
|
+
* @description Whether at least one scope must be selected when connecting an account.
|
|
4268
|
+
* @example false
|
|
4269
|
+
*/
|
|
4270
|
+
scopes_required?: boolean;
|
|
4271
|
+
/**
|
|
4272
|
+
* @description Whether a client secret is required for this provider.
|
|
4273
|
+
* @example true
|
|
4274
|
+
*/
|
|
4275
|
+
client_secret_required?: boolean;
|
|
4276
|
+
/**
|
|
4277
|
+
* @description Additional static query parameters appended to the authorization request.
|
|
4278
|
+
* @example {
|
|
4279
|
+
* "prompt": "consent"
|
|
4280
|
+
* }
|
|
4281
|
+
*/
|
|
4282
|
+
additional_authorization_parameters?: {
|
|
4283
|
+
[key: string]: string;
|
|
4284
|
+
};
|
|
4285
|
+
/**
|
|
4286
|
+
* @description The Content-Type used when exchanging the token request.
|
|
4287
|
+
* @example application/x-www-form-urlencoded
|
|
4288
|
+
*/
|
|
4289
|
+
token_body_content_type?: string;
|
|
4290
|
+
/**
|
|
4291
|
+
* @description How client credentials are sent when exchanging authorization codes and refreshing tokens.
|
|
4292
|
+
* @example request_body
|
|
4293
|
+
* @enum {string}
|
|
4294
|
+
*/
|
|
4295
|
+
authenticate_via?: "request_body" | "basic_auth_header";
|
|
4296
|
+
};
|
|
4297
|
+
UpdateDataIntegrationDto: {
|
|
4298
|
+
/**
|
|
4299
|
+
* @description An optional description of the Data Integration.
|
|
4300
|
+
* @example Production GitHub app
|
|
4301
|
+
*/
|
|
4302
|
+
description?: string | null;
|
|
4303
|
+
/**
|
|
4304
|
+
* @description Whether the Data Integration is enabled.
|
|
4305
|
+
* @example true
|
|
4306
|
+
*/
|
|
4307
|
+
enabled?: boolean;
|
|
4308
|
+
/**
|
|
4309
|
+
* @description The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes.
|
|
4310
|
+
* @example [
|
|
4311
|
+
* "repo",
|
|
4312
|
+
* "read:org"
|
|
4313
|
+
* ]
|
|
4314
|
+
*/
|
|
4315
|
+
scopes?: string[] | null;
|
|
4316
|
+
/** @description New credentials for the Data Integration. When provided, rotates the stored client secret. */
|
|
4317
|
+
credentials?: components["schemas"]["DataIntegrationCredentialsDto"];
|
|
4318
|
+
/** @description Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations. */
|
|
4319
|
+
custom_provider?: components["schemas"]["UpdateCustomProviderDefinitionDto"];
|
|
4320
|
+
};
|
|
4321
|
+
ConnectedAccountDto: {
|
|
4322
|
+
/**
|
|
4323
|
+
* @description The OAuth access token for the connected account.
|
|
4324
|
+
* @example gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
4325
|
+
*/
|
|
4326
|
+
access_token?: string;
|
|
4327
|
+
/**
|
|
4328
|
+
* @description The OAuth refresh token for the connected account.
|
|
4329
|
+
* @example ghr_xxxxxxxxxxxxxxxxxxxx
|
|
4330
|
+
*/
|
|
4331
|
+
refresh_token?: string;
|
|
4332
|
+
/**
|
|
4333
|
+
* Format: date-time
|
|
4334
|
+
* @description The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
|
|
4335
|
+
* @example 2025-12-31T23:59:59.000Z
|
|
4336
|
+
*/
|
|
4337
|
+
expires_at?: string;
|
|
4338
|
+
/**
|
|
4339
|
+
* @description The OAuth scopes granted for this connection.
|
|
4340
|
+
* @example [
|
|
4341
|
+
* "repo",
|
|
4342
|
+
* "user:email"
|
|
4343
|
+
* ]
|
|
4344
|
+
*/
|
|
4345
|
+
scopes?: string[];
|
|
4346
|
+
/**
|
|
4347
|
+
* @description Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
|
|
4348
|
+
* @example connected
|
|
4349
|
+
* @enum {string}
|
|
4350
|
+
*/
|
|
4351
|
+
state?: "connected" | "needs_reauthorization";
|
|
4352
|
+
};
|
|
4038
4353
|
GenerateLinkDto: {
|
|
4039
4354
|
/**
|
|
4040
4355
|
* @description The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
|
|
@@ -4072,6 +4387,33 @@ export interface components {
|
|
|
4072
4387
|
*/
|
|
4073
4388
|
it_contact_emails?: string[];
|
|
4074
4389
|
};
|
|
4390
|
+
SendRadarSmsChallengeDto: {
|
|
4391
|
+
/**
|
|
4392
|
+
* @description The ID of the user to send the SMS challenge to.
|
|
4393
|
+
* @example user_01E4ZCR3C56J083X43JQXF3JK5
|
|
4394
|
+
*/
|
|
4395
|
+
user_id: string;
|
|
4396
|
+
/**
|
|
4397
|
+
* @description The pending authentication token from a previous authentication attempt that triggered the Radar challenge.
|
|
4398
|
+
* @example cTDQJTTkTkkVYxbn...
|
|
4399
|
+
*/
|
|
4400
|
+
pending_authentication_token: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* @description The phone number to send the SMS verification code to.
|
|
4403
|
+
* @example +15555550123
|
|
4404
|
+
*/
|
|
4405
|
+
phone_number: string;
|
|
4406
|
+
/**
|
|
4407
|
+
* @description The IP address of the user's request.
|
|
4408
|
+
* @example 203.0.113.42
|
|
4409
|
+
*/
|
|
4410
|
+
ip_address?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* @description The user agent string from the user's request.
|
|
4413
|
+
* @example Mozilla/5.0
|
|
4414
|
+
*/
|
|
4415
|
+
user_agent?: string;
|
|
4416
|
+
};
|
|
4075
4417
|
CreateRedirectUriDto: {
|
|
4076
4418
|
/**
|
|
4077
4419
|
* @description The redirect URI to create.
|
|
@@ -4114,6 +4456,26 @@ export interface components {
|
|
|
4114
4456
|
* @example Z1Y2X3W4V5U6T7S8R9Q0P1O2N3
|
|
4115
4457
|
*/
|
|
4116
4458
|
invitation_token?: string;
|
|
4459
|
+
/**
|
|
4460
|
+
* @description The IP address of the user's request.
|
|
4461
|
+
* @example 203.0.113.42
|
|
4462
|
+
*/
|
|
4463
|
+
ip_address?: string;
|
|
4464
|
+
/**
|
|
4465
|
+
* @description The user agent string from the user's request.
|
|
4466
|
+
* @example Mozilla/5.0
|
|
4467
|
+
*/
|
|
4468
|
+
user_agent?: string;
|
|
4469
|
+
/**
|
|
4470
|
+
* @description The ID of an existing Radar authentication attempt to associate with this request.
|
|
4471
|
+
* @example radar_auth_attempt_01HXYZ123456789ABCDEFGHIJ
|
|
4472
|
+
*/
|
|
4473
|
+
radar_auth_attempt_id?: string;
|
|
4474
|
+
/**
|
|
4475
|
+
* @description An optional Radar signals ID to correlate client-side signals with this request.
|
|
4476
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
4477
|
+
*/
|
|
4478
|
+
signals_id?: string;
|
|
4117
4479
|
};
|
|
4118
4480
|
CreateUserlandUserInviteOptionsDto: {
|
|
4119
4481
|
/**
|
|
@@ -4265,6 +4627,21 @@ export interface components {
|
|
|
4265
4627
|
* @example f1ffa2b2-c20b-4d39-be5c-212726e11222
|
|
4266
4628
|
*/
|
|
4267
4629
|
external_id?: string | null;
|
|
4630
|
+
/**
|
|
4631
|
+
* @description The IP address of the user's request.
|
|
4632
|
+
* @example 203.0.113.42
|
|
4633
|
+
*/
|
|
4634
|
+
ip_address?: string | null;
|
|
4635
|
+
/**
|
|
4636
|
+
* @description The user agent string from the user's request.
|
|
4637
|
+
* @example Mozilla/5.0
|
|
4638
|
+
*/
|
|
4639
|
+
user_agent?: string | null;
|
|
4640
|
+
/**
|
|
4641
|
+
* @description An optional Radar signals ID to correlate client-side signals with this request.
|
|
4642
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
4643
|
+
*/
|
|
4644
|
+
signals_id?: string;
|
|
4268
4645
|
} & (Record<string, never> | {
|
|
4269
4646
|
/**
|
|
4270
4647
|
* @description The password to set for the user. Mutually exclusive with `password_hash` and `password_hash_type`.
|
|
@@ -14512,45 +14889,213 @@ export interface components {
|
|
|
14512
14889
|
*/
|
|
14513
14890
|
client_secret?: string;
|
|
14514
14891
|
};
|
|
14515
|
-
|
|
14892
|
+
DataIntegration: {
|
|
14516
14893
|
/**
|
|
14517
|
-
* @description
|
|
14518
|
-
* @example
|
|
14894
|
+
* @description Distinguishes the Data Integration object.
|
|
14895
|
+
* @example data_integration
|
|
14896
|
+
* @constant
|
|
14519
14897
|
*/
|
|
14520
|
-
|
|
14521
|
-
};
|
|
14522
|
-
DataIntegrationAccessTokenResponse: {
|
|
14898
|
+
object: "data_integration";
|
|
14523
14899
|
/**
|
|
14524
|
-
* @description
|
|
14525
|
-
* @
|
|
14900
|
+
* @description Unique identifier of the Data Integration.
|
|
14901
|
+
* @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
14526
14902
|
*/
|
|
14527
|
-
|
|
14528
|
-
/**
|
|
14529
|
-
|
|
14530
|
-
|
|
14531
|
-
|
|
14532
|
-
|
|
14533
|
-
|
|
14534
|
-
|
|
14535
|
-
|
|
14536
|
-
|
|
14537
|
-
|
|
14538
|
-
|
|
14539
|
-
|
|
14540
|
-
|
|
14541
|
-
|
|
14542
|
-
|
|
14543
|
-
|
|
14544
|
-
|
|
14545
|
-
|
|
14546
|
-
|
|
14547
|
-
|
|
14548
|
-
|
|
14549
|
-
|
|
14550
|
-
|
|
14551
|
-
|
|
14552
|
-
|
|
14553
|
-
|
|
14903
|
+
id: string;
|
|
14904
|
+
/**
|
|
14905
|
+
* @description The provider slug for this Data Integration.
|
|
14906
|
+
* @example github
|
|
14907
|
+
*/
|
|
14908
|
+
slug: string;
|
|
14909
|
+
/**
|
|
14910
|
+
* @description The integration type derived from the provider.
|
|
14911
|
+
* @example github
|
|
14912
|
+
*/
|
|
14913
|
+
integration_type: string;
|
|
14914
|
+
/**
|
|
14915
|
+
* @description An optional description of the Data Integration.
|
|
14916
|
+
* @example Production GitHub app
|
|
14917
|
+
*/
|
|
14918
|
+
description: string | null;
|
|
14919
|
+
/**
|
|
14920
|
+
* @description Whether the Data Integration is enabled.
|
|
14921
|
+
* @example true
|
|
14922
|
+
*/
|
|
14923
|
+
enabled: boolean;
|
|
14924
|
+
/**
|
|
14925
|
+
* @description The state of the Data Integration.
|
|
14926
|
+
* @example valid
|
|
14927
|
+
* @enum {string}
|
|
14928
|
+
*/
|
|
14929
|
+
state: "valid" | "invalid" | "requested";
|
|
14930
|
+
/**
|
|
14931
|
+
* @description The OAuth scopes configured for the Data Integration. `null` when the provider's configured scopes are used.
|
|
14932
|
+
* @example [
|
|
14933
|
+
* "repo",
|
|
14934
|
+
* "read:org"
|
|
14935
|
+
* ]
|
|
14936
|
+
*/
|
|
14937
|
+
scopes: string[] | null;
|
|
14938
|
+
/**
|
|
14939
|
+
* @description The OAuth redirect URI to register with the provider when configuring the custom application.
|
|
14940
|
+
* @example https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
|
|
14941
|
+
*/
|
|
14942
|
+
redirect_uri: string;
|
|
14943
|
+
/** @description The credentials configured for the Data Integration. */
|
|
14944
|
+
credentials: {
|
|
14945
|
+
/**
|
|
14946
|
+
* @description The credentials type. `custom` uses your own OAuth app credentials; `organization` has each organization supply its own credentials (so `client_id`/`redacted_client_secret` are null on the integration itself).
|
|
14947
|
+
* @example custom
|
|
14948
|
+
* @enum {string}
|
|
14949
|
+
*/
|
|
14950
|
+
type: "custom" | "organization";
|
|
14951
|
+
/**
|
|
14952
|
+
* @description The OAuth client ID configured for the provider app. Null for `organization` credentials.
|
|
14953
|
+
* @example Iv1.abc123
|
|
14954
|
+
*/
|
|
14955
|
+
client_id: string | null;
|
|
14956
|
+
/**
|
|
14957
|
+
* @description The last four characters of the OAuth client secret. The full secret is never returned. Null for `organization` credentials.
|
|
14958
|
+
* @example 6789
|
|
14959
|
+
*/
|
|
14960
|
+
redacted_client_secret: string | null;
|
|
14961
|
+
};
|
|
14962
|
+
/** @description The OAuth definition when this is a custom provider; `null` for built-in providers. */
|
|
14963
|
+
custom_provider: {
|
|
14964
|
+
/**
|
|
14965
|
+
* @description A descriptive name for the custom provider.
|
|
14966
|
+
* @example My OAuth App
|
|
14967
|
+
*/
|
|
14968
|
+
name: string;
|
|
14969
|
+
/**
|
|
14970
|
+
* @description The provider's OAuth authorization endpoint.
|
|
14971
|
+
* @example https://provider.example.com/oauth/authorize
|
|
14972
|
+
*/
|
|
14973
|
+
authorization_url: string | null;
|
|
14974
|
+
/**
|
|
14975
|
+
* @description The provider's OAuth token endpoint.
|
|
14976
|
+
* @example https://provider.example.com/oauth/token
|
|
14977
|
+
*/
|
|
14978
|
+
token_url: string | null;
|
|
14979
|
+
/**
|
|
14980
|
+
* @description The endpoint used to refresh tokens, if different from the token endpoint.
|
|
14981
|
+
* @example https://provider.example.com/oauth/token
|
|
14982
|
+
*/
|
|
14983
|
+
refresh_token_url: string | null;
|
|
14984
|
+
/**
|
|
14985
|
+
* @description Whether PKCE is used during the authorization code flow.
|
|
14986
|
+
* @example true
|
|
14987
|
+
*/
|
|
14988
|
+
pkce_enabled: boolean;
|
|
14989
|
+
/**
|
|
14990
|
+
* @description The separator used to join requested scopes.
|
|
14991
|
+
* @example
|
|
14992
|
+
*/
|
|
14993
|
+
request_scope_separator: string;
|
|
14994
|
+
/**
|
|
14995
|
+
* @description Whether at least one scope must be selected when connecting an account.
|
|
14996
|
+
* @example false
|
|
14997
|
+
*/
|
|
14998
|
+
scopes_required: boolean;
|
|
14999
|
+
/**
|
|
15000
|
+
* @description Whether a client secret is required for this provider.
|
|
15001
|
+
* @example true
|
|
15002
|
+
*/
|
|
15003
|
+
client_secret_required: boolean;
|
|
15004
|
+
/**
|
|
15005
|
+
* @description Additional static query parameters appended to the authorization request.
|
|
15006
|
+
* @example {
|
|
15007
|
+
* "prompt": "consent"
|
|
15008
|
+
* }
|
|
15009
|
+
*/
|
|
15010
|
+
additional_authorization_parameters: {
|
|
15011
|
+
[key: string]: string;
|
|
15012
|
+
};
|
|
15013
|
+
/**
|
|
15014
|
+
* @description The Content-Type used when exchanging the token request.
|
|
15015
|
+
* @example application/x-www-form-urlencoded
|
|
15016
|
+
*/
|
|
15017
|
+
token_body_content_type: string;
|
|
15018
|
+
/**
|
|
15019
|
+
* @description How client credentials are sent when exchanging authorization codes and refreshing tokens.
|
|
15020
|
+
* @example request_body
|
|
15021
|
+
* @enum {string}
|
|
15022
|
+
*/
|
|
15023
|
+
authenticate_via: "request_body" | "basic_auth_header";
|
|
15024
|
+
} | null;
|
|
15025
|
+
/**
|
|
15026
|
+
* Format: date-time
|
|
15027
|
+
* @description An ISO 8601 timestamp.
|
|
15028
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15029
|
+
*/
|
|
15030
|
+
created_at: string;
|
|
15031
|
+
/**
|
|
15032
|
+
* Format: date-time
|
|
15033
|
+
* @description An ISO 8601 timestamp.
|
|
15034
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
15035
|
+
*/
|
|
15036
|
+
updated_at: string;
|
|
15037
|
+
};
|
|
15038
|
+
DataIntegrationList: {
|
|
15039
|
+
/**
|
|
15040
|
+
* @description Indicates this is a list response.
|
|
15041
|
+
* @constant
|
|
15042
|
+
*/
|
|
15043
|
+
object: "list";
|
|
15044
|
+
/** @description The list of records for the current page. */
|
|
15045
|
+
data: components["schemas"]["DataIntegration"][];
|
|
15046
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
15047
|
+
list_metadata: {
|
|
15048
|
+
/**
|
|
15049
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
15050
|
+
* @example data_integration_01HXYZ123456789ABCDEFGHIJ
|
|
15051
|
+
*/
|
|
15052
|
+
before: string | null;
|
|
15053
|
+
/**
|
|
15054
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
15055
|
+
* @example data_integration_01HXYZ987654321KJIHGFEDCBA
|
|
15056
|
+
*/
|
|
15057
|
+
after: string | null;
|
|
15058
|
+
};
|
|
15059
|
+
};
|
|
15060
|
+
DataIntegrationAuthorizeUrlResponse: {
|
|
15061
|
+
/**
|
|
15062
|
+
* @description The OAuth authorization URL to redirect the user to.
|
|
15063
|
+
* @example https://api.workos.com/data-integrations/q2czJKmVAraSBg8xFpT7M9uR/authorize-redirect
|
|
15064
|
+
*/
|
|
15065
|
+
url: string;
|
|
15066
|
+
};
|
|
15067
|
+
DataIntegrationAccessTokenResponse: {
|
|
15068
|
+
/**
|
|
15069
|
+
* @description Indicates whether the access token is valid and ready for use, or if reauthorization is required.
|
|
15070
|
+
* @constant
|
|
15071
|
+
*/
|
|
15072
|
+
active: true;
|
|
15073
|
+
/** @description The [access token](/reference/pipes/access-token) object, present when `active` is `true`. */
|
|
15074
|
+
access_token: {
|
|
15075
|
+
/**
|
|
15076
|
+
* @description Distinguishes the access token object.
|
|
15077
|
+
* @constant
|
|
15078
|
+
*/
|
|
15079
|
+
object: "access_token";
|
|
15080
|
+
/**
|
|
15081
|
+
* @description The OAuth access token for the connected integration.
|
|
15082
|
+
* @example gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
15083
|
+
*/
|
|
15084
|
+
access_token: string;
|
|
15085
|
+
/**
|
|
15086
|
+
* @description The ISO-8601 formatted timestamp indicating when the access token expires.
|
|
15087
|
+
* @example 2025-12-31T23:59:59.000Z
|
|
15088
|
+
*/
|
|
15089
|
+
expires_at: string | null;
|
|
15090
|
+
/**
|
|
15091
|
+
* @description The scopes granted to the access token.
|
|
15092
|
+
* @example [
|
|
15093
|
+
* "repo",
|
|
15094
|
+
* "user:email"
|
|
15095
|
+
* ]
|
|
15096
|
+
*/
|
|
15097
|
+
scopes: string[];
|
|
15098
|
+
/**
|
|
14554
15099
|
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
14555
15100
|
* @example []
|
|
14556
15101
|
*/
|
|
@@ -14907,6 +15452,18 @@ export interface components {
|
|
|
14907
15452
|
*/
|
|
14908
15453
|
link: string;
|
|
14909
15454
|
};
|
|
15455
|
+
SendRadarSmsChallengeResponse: {
|
|
15456
|
+
/**
|
|
15457
|
+
* @description The ID of the SMS verification. Pass this to the authenticate endpoint to verify the code.
|
|
15458
|
+
* @example vrf_01HXYZ123456789ABCDEFGHIJ
|
|
15459
|
+
*/
|
|
15460
|
+
verification_id: string;
|
|
15461
|
+
/**
|
|
15462
|
+
* @description The phone number the verification code was sent to.
|
|
15463
|
+
* @example +15555550123
|
|
15464
|
+
*/
|
|
15465
|
+
phone_number: string;
|
|
15466
|
+
};
|
|
14910
15467
|
RadarStandaloneResponse: {
|
|
14911
15468
|
/**
|
|
14912
15469
|
* @description The verdict of the risk assessment.
|
|
@@ -22116,6 +22673,285 @@ export interface operations {
|
|
|
22116
22673
|
};
|
|
22117
22674
|
};
|
|
22118
22675
|
};
|
|
22676
|
+
DataIntegrationsManagementController_listDataIntegrations: {
|
|
22677
|
+
parameters: {
|
|
22678
|
+
query?: {
|
|
22679
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
22680
|
+
before?: string;
|
|
22681
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
22682
|
+
after?: string;
|
|
22683
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
22684
|
+
limit?: number;
|
|
22685
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). */
|
|
22686
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
22687
|
+
};
|
|
22688
|
+
header?: never;
|
|
22689
|
+
path?: never;
|
|
22690
|
+
cookie?: never;
|
|
22691
|
+
};
|
|
22692
|
+
requestBody?: never;
|
|
22693
|
+
responses: {
|
|
22694
|
+
/** @description OK */
|
|
22695
|
+
200: {
|
|
22696
|
+
headers: {
|
|
22697
|
+
[name: string]: unknown;
|
|
22698
|
+
};
|
|
22699
|
+
content: {
|
|
22700
|
+
"application/json": components["schemas"]["DataIntegrationList"];
|
|
22701
|
+
};
|
|
22702
|
+
};
|
|
22703
|
+
/** @description Unauthorized */
|
|
22704
|
+
401: {
|
|
22705
|
+
headers: {
|
|
22706
|
+
[name: string]: unknown;
|
|
22707
|
+
};
|
|
22708
|
+
content?: never;
|
|
22709
|
+
};
|
|
22710
|
+
};
|
|
22711
|
+
};
|
|
22712
|
+
DataIntegrationsManagementController_createDataIntegration: {
|
|
22713
|
+
parameters: {
|
|
22714
|
+
query?: never;
|
|
22715
|
+
header?: never;
|
|
22716
|
+
path?: never;
|
|
22717
|
+
cookie?: never;
|
|
22718
|
+
};
|
|
22719
|
+
requestBody: {
|
|
22720
|
+
content: {
|
|
22721
|
+
"application/json": components["schemas"]["CreateDataIntegrationDto"];
|
|
22722
|
+
};
|
|
22723
|
+
};
|
|
22724
|
+
responses: {
|
|
22725
|
+
/** @description Created */
|
|
22726
|
+
201: {
|
|
22727
|
+
headers: {
|
|
22728
|
+
[name: string]: unknown;
|
|
22729
|
+
};
|
|
22730
|
+
content: {
|
|
22731
|
+
"application/json": components["schemas"]["DataIntegration"];
|
|
22732
|
+
};
|
|
22733
|
+
};
|
|
22734
|
+
/** @description Bad Request */
|
|
22735
|
+
400: {
|
|
22736
|
+
headers: {
|
|
22737
|
+
[name: string]: unknown;
|
|
22738
|
+
};
|
|
22739
|
+
content: {
|
|
22740
|
+
"application/json": {
|
|
22741
|
+
/**
|
|
22742
|
+
* @description A human-readable description of the error.
|
|
22743
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22744
|
+
*/
|
|
22745
|
+
message: string;
|
|
22746
|
+
};
|
|
22747
|
+
};
|
|
22748
|
+
};
|
|
22749
|
+
/** @description Unauthorized */
|
|
22750
|
+
401: {
|
|
22751
|
+
headers: {
|
|
22752
|
+
[name: string]: unknown;
|
|
22753
|
+
};
|
|
22754
|
+
content?: never;
|
|
22755
|
+
};
|
|
22756
|
+
/** @description Not Found */
|
|
22757
|
+
404: {
|
|
22758
|
+
headers: {
|
|
22759
|
+
[name: string]: unknown;
|
|
22760
|
+
};
|
|
22761
|
+
content: {
|
|
22762
|
+
"application/json": {
|
|
22763
|
+
/**
|
|
22764
|
+
* @description A human-readable description of the error.
|
|
22765
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22766
|
+
*/
|
|
22767
|
+
message: string;
|
|
22768
|
+
};
|
|
22769
|
+
};
|
|
22770
|
+
};
|
|
22771
|
+
/** @description Unprocessable Entity */
|
|
22772
|
+
422: {
|
|
22773
|
+
headers: {
|
|
22774
|
+
[name: string]: unknown;
|
|
22775
|
+
};
|
|
22776
|
+
content: {
|
|
22777
|
+
"application/json": {
|
|
22778
|
+
/**
|
|
22779
|
+
* @description A human-readable description of the error.
|
|
22780
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22781
|
+
*/
|
|
22782
|
+
message: string;
|
|
22783
|
+
};
|
|
22784
|
+
};
|
|
22785
|
+
};
|
|
22786
|
+
};
|
|
22787
|
+
};
|
|
22788
|
+
DataIntegrationsManagementController_getDataIntegration: {
|
|
22789
|
+
parameters: {
|
|
22790
|
+
query?: never;
|
|
22791
|
+
header?: never;
|
|
22792
|
+
path: {
|
|
22793
|
+
/** @description The slug identifier of the data integration. */
|
|
22794
|
+
slug: string;
|
|
22795
|
+
};
|
|
22796
|
+
cookie?: never;
|
|
22797
|
+
};
|
|
22798
|
+
requestBody?: never;
|
|
22799
|
+
responses: {
|
|
22800
|
+
/** @description OK */
|
|
22801
|
+
200: {
|
|
22802
|
+
headers: {
|
|
22803
|
+
[name: string]: unknown;
|
|
22804
|
+
};
|
|
22805
|
+
content: {
|
|
22806
|
+
"application/json": components["schemas"]["DataIntegration"];
|
|
22807
|
+
};
|
|
22808
|
+
};
|
|
22809
|
+
/** @description Unauthorized */
|
|
22810
|
+
401: {
|
|
22811
|
+
headers: {
|
|
22812
|
+
[name: string]: unknown;
|
|
22813
|
+
};
|
|
22814
|
+
content?: never;
|
|
22815
|
+
};
|
|
22816
|
+
/** @description Not Found */
|
|
22817
|
+
404: {
|
|
22818
|
+
headers: {
|
|
22819
|
+
[name: string]: unknown;
|
|
22820
|
+
};
|
|
22821
|
+
content: {
|
|
22822
|
+
"application/json": {
|
|
22823
|
+
/**
|
|
22824
|
+
* @description A human-readable description of the error.
|
|
22825
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22826
|
+
*/
|
|
22827
|
+
message: string;
|
|
22828
|
+
};
|
|
22829
|
+
};
|
|
22830
|
+
};
|
|
22831
|
+
};
|
|
22832
|
+
};
|
|
22833
|
+
DataIntegrationsManagementController_updateDataIntegration: {
|
|
22834
|
+
parameters: {
|
|
22835
|
+
query?: never;
|
|
22836
|
+
header?: never;
|
|
22837
|
+
path: {
|
|
22838
|
+
/** @description The slug identifier of the data integration. */
|
|
22839
|
+
slug: string;
|
|
22840
|
+
};
|
|
22841
|
+
cookie?: never;
|
|
22842
|
+
};
|
|
22843
|
+
requestBody: {
|
|
22844
|
+
content: {
|
|
22845
|
+
"application/json": components["schemas"]["UpdateDataIntegrationDto"];
|
|
22846
|
+
};
|
|
22847
|
+
};
|
|
22848
|
+
responses: {
|
|
22849
|
+
/** @description OK */
|
|
22850
|
+
200: {
|
|
22851
|
+
headers: {
|
|
22852
|
+
[name: string]: unknown;
|
|
22853
|
+
};
|
|
22854
|
+
content: {
|
|
22855
|
+
"application/json": components["schemas"]["DataIntegration"];
|
|
22856
|
+
};
|
|
22857
|
+
};
|
|
22858
|
+
/** @description Bad Request */
|
|
22859
|
+
400: {
|
|
22860
|
+
headers: {
|
|
22861
|
+
[name: string]: unknown;
|
|
22862
|
+
};
|
|
22863
|
+
content: {
|
|
22864
|
+
"application/json": {
|
|
22865
|
+
/**
|
|
22866
|
+
* @description A human-readable description of the error.
|
|
22867
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22868
|
+
*/
|
|
22869
|
+
message: string;
|
|
22870
|
+
};
|
|
22871
|
+
};
|
|
22872
|
+
};
|
|
22873
|
+
/** @description Unauthorized */
|
|
22874
|
+
401: {
|
|
22875
|
+
headers: {
|
|
22876
|
+
[name: string]: unknown;
|
|
22877
|
+
};
|
|
22878
|
+
content?: never;
|
|
22879
|
+
};
|
|
22880
|
+
/** @description Not Found */
|
|
22881
|
+
404: {
|
|
22882
|
+
headers: {
|
|
22883
|
+
[name: string]: unknown;
|
|
22884
|
+
};
|
|
22885
|
+
content: {
|
|
22886
|
+
"application/json": {
|
|
22887
|
+
/**
|
|
22888
|
+
* @description A human-readable description of the error.
|
|
22889
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22890
|
+
*/
|
|
22891
|
+
message: string;
|
|
22892
|
+
};
|
|
22893
|
+
};
|
|
22894
|
+
};
|
|
22895
|
+
/** @description Unprocessable Entity */
|
|
22896
|
+
422: {
|
|
22897
|
+
headers: {
|
|
22898
|
+
[name: string]: unknown;
|
|
22899
|
+
};
|
|
22900
|
+
content: {
|
|
22901
|
+
"application/json": {
|
|
22902
|
+
/**
|
|
22903
|
+
* @description A human-readable description of the error.
|
|
22904
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22905
|
+
*/
|
|
22906
|
+
message: string;
|
|
22907
|
+
};
|
|
22908
|
+
};
|
|
22909
|
+
};
|
|
22910
|
+
};
|
|
22911
|
+
};
|
|
22912
|
+
DataIntegrationsManagementController_deleteDataIntegration: {
|
|
22913
|
+
parameters: {
|
|
22914
|
+
query?: never;
|
|
22915
|
+
header?: never;
|
|
22916
|
+
path: {
|
|
22917
|
+
/** @description The slug identifier of the data integration. */
|
|
22918
|
+
slug: string;
|
|
22919
|
+
};
|
|
22920
|
+
cookie?: never;
|
|
22921
|
+
};
|
|
22922
|
+
requestBody?: never;
|
|
22923
|
+
responses: {
|
|
22924
|
+
/** @description No Content */
|
|
22925
|
+
204: {
|
|
22926
|
+
headers: {
|
|
22927
|
+
[name: string]: unknown;
|
|
22928
|
+
};
|
|
22929
|
+
content?: never;
|
|
22930
|
+
};
|
|
22931
|
+
/** @description Unauthorized */
|
|
22932
|
+
401: {
|
|
22933
|
+
headers: {
|
|
22934
|
+
[name: string]: unknown;
|
|
22935
|
+
};
|
|
22936
|
+
content?: never;
|
|
22937
|
+
};
|
|
22938
|
+
/** @description Not Found */
|
|
22939
|
+
404: {
|
|
22940
|
+
headers: {
|
|
22941
|
+
[name: string]: unknown;
|
|
22942
|
+
};
|
|
22943
|
+
content: {
|
|
22944
|
+
"application/json": {
|
|
22945
|
+
/**
|
|
22946
|
+
* @description A human-readable description of the error.
|
|
22947
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
22948
|
+
*/
|
|
22949
|
+
message: string;
|
|
22950
|
+
};
|
|
22951
|
+
};
|
|
22952
|
+
};
|
|
22953
|
+
};
|
|
22954
|
+
};
|
|
22119
22955
|
DataIntegrationsController_upsertApiKey: {
|
|
22120
22956
|
parameters: {
|
|
22121
22957
|
query?: never;
|
|
@@ -25962,6 +26798,11 @@ export interface operations {
|
|
|
25962
26798
|
* @example Mozilla/5.0
|
|
25963
26799
|
*/
|
|
25964
26800
|
user_agent?: string;
|
|
26801
|
+
/**
|
|
26802
|
+
* @description An optional Radar signals ID to correlate client-side signals with this authentication attempt.
|
|
26803
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
26804
|
+
*/
|
|
26805
|
+
signals_id?: string;
|
|
25965
26806
|
} | {
|
|
25966
26807
|
/**
|
|
25967
26808
|
* @description The client ID of the application.
|
|
@@ -26005,6 +26846,16 @@ export interface operations {
|
|
|
26005
26846
|
* @example Mozilla/5.0
|
|
26006
26847
|
*/
|
|
26007
26848
|
user_agent?: string;
|
|
26849
|
+
/**
|
|
26850
|
+
* @description An optional Radar signals ID to correlate client-side signals with this authentication attempt.
|
|
26851
|
+
* @example 01JBS0GN92GC2RJQS4X9DBPQ2A
|
|
26852
|
+
*/
|
|
26853
|
+
signals_id?: string;
|
|
26854
|
+
/**
|
|
26855
|
+
* @description The ID of an existing Radar authentication attempt to associate with this authentication.
|
|
26856
|
+
* @example radar_auth_attempt_01HXYZ123456789ABCDEFGHIJ
|
|
26857
|
+
*/
|
|
26858
|
+
radar_auth_attempt_id?: string;
|
|
26008
26859
|
} | {
|
|
26009
26860
|
/**
|
|
26010
26861
|
* @description The client ID of the application.
|
|
@@ -26086,6 +26937,11 @@ export interface operations {
|
|
|
26086
26937
|
* @example Mozilla/5.0
|
|
26087
26938
|
*/
|
|
26088
26939
|
user_agent?: string;
|
|
26940
|
+
/**
|
|
26941
|
+
* @description The ID of an existing Radar authentication attempt to associate with this authentication.
|
|
26942
|
+
* @example radar_auth_attempt_01HXYZ123456789ABCDEFGHIJ
|
|
26943
|
+
*/
|
|
26944
|
+
radar_auth_attempt_id?: string;
|
|
26089
26945
|
} | {
|
|
26090
26946
|
/**
|
|
26091
26947
|
* @description The client ID of the application.
|
|
@@ -26205,6 +27061,97 @@ export interface operations {
|
|
|
26205
27061
|
* @example Mozilla/5.0
|
|
26206
27062
|
*/
|
|
26207
27063
|
user_agent?: string;
|
|
27064
|
+
} | {
|
|
27065
|
+
/**
|
|
27066
|
+
* @description The client ID of the application.
|
|
27067
|
+
* @example client_01HXYZ123456789ABCDEFGHIJ
|
|
27068
|
+
*/
|
|
27069
|
+
client_id: string;
|
|
27070
|
+
/**
|
|
27071
|
+
* @description The client secret of the application.
|
|
27072
|
+
* @example sk_test_....
|
|
27073
|
+
*/
|
|
27074
|
+
client_secret: string;
|
|
27075
|
+
/** @constant */
|
|
27076
|
+
grant_type: "urn:workos:oauth:grant-type:radar-email-challenge:code";
|
|
27077
|
+
/**
|
|
27078
|
+
* @description The one-time code from the Radar email challenge.
|
|
27079
|
+
* @example 123456
|
|
27080
|
+
*/
|
|
27081
|
+
code: string;
|
|
27082
|
+
/**
|
|
27083
|
+
* @description The ID of the Radar email challenge being verified.
|
|
27084
|
+
* @example radar_challenge_01HXYZ123456789ABCDEFGHIJ
|
|
27085
|
+
*/
|
|
27086
|
+
radar_challenge_id: string;
|
|
27087
|
+
/**
|
|
27088
|
+
* @description The pending authentication token from a previous authentication attempt.
|
|
27089
|
+
* @example cTDQJTTkTkkVYxbn...
|
|
27090
|
+
*/
|
|
27091
|
+
pending_authentication_token: string;
|
|
27092
|
+
/**
|
|
27093
|
+
* @description The IP address of the user's request.
|
|
27094
|
+
* @example 203.0.113.42
|
|
27095
|
+
*/
|
|
27096
|
+
ip_address?: string;
|
|
27097
|
+
/**
|
|
27098
|
+
* @description A unique identifier for the device.
|
|
27099
|
+
* @example device_01HXYZ123456789ABCDEFGHIJ
|
|
27100
|
+
*/
|
|
27101
|
+
device_id?: string;
|
|
27102
|
+
/**
|
|
27103
|
+
* @description The user agent string from the user's browser.
|
|
27104
|
+
* @example Mozilla/5.0
|
|
27105
|
+
*/
|
|
27106
|
+
user_agent?: string;
|
|
27107
|
+
} | {
|
|
27108
|
+
/**
|
|
27109
|
+
* @description The client ID of the application.
|
|
27110
|
+
* @example client_01HXYZ123456789ABCDEFGHIJ
|
|
27111
|
+
*/
|
|
27112
|
+
client_id: string;
|
|
27113
|
+
/**
|
|
27114
|
+
* @description The client secret of the application.
|
|
27115
|
+
* @example sk_test_....
|
|
27116
|
+
*/
|
|
27117
|
+
client_secret: string;
|
|
27118
|
+
/** @constant */
|
|
27119
|
+
grant_type: "urn:workos:oauth:grant-type:radar-sms-challenge:code";
|
|
27120
|
+
/**
|
|
27121
|
+
* @description The one-time code from the Radar SMS challenge.
|
|
27122
|
+
* @example 123456
|
|
27123
|
+
*/
|
|
27124
|
+
code: string;
|
|
27125
|
+
/**
|
|
27126
|
+
* @description The ID of the Radar SMS verification being confirmed.
|
|
27127
|
+
* @example vrf_01HXYZ123456789ABCDEFGHIJ
|
|
27128
|
+
*/
|
|
27129
|
+
verification_id: string;
|
|
27130
|
+
/**
|
|
27131
|
+
* @description The phone number the Radar SMS challenge was sent to.
|
|
27132
|
+
* @example +15555550123
|
|
27133
|
+
*/
|
|
27134
|
+
phone_number: string;
|
|
27135
|
+
/**
|
|
27136
|
+
* @description The pending authentication token from a previous authentication attempt.
|
|
27137
|
+
* @example cTDQJTTkTkkVYxbn...
|
|
27138
|
+
*/
|
|
27139
|
+
pending_authentication_token: string;
|
|
27140
|
+
/**
|
|
27141
|
+
* @description The IP address of the user's request.
|
|
27142
|
+
* @example 203.0.113.42
|
|
27143
|
+
*/
|
|
27144
|
+
ip_address?: string;
|
|
27145
|
+
/**
|
|
27146
|
+
* @description A unique identifier for the device.
|
|
27147
|
+
* @example device_01HXYZ123456789ABCDEFGHIJ
|
|
27148
|
+
*/
|
|
27149
|
+
device_id?: string;
|
|
27150
|
+
/**
|
|
27151
|
+
* @description The user agent string from the user's browser.
|
|
27152
|
+
* @example Mozilla/5.0
|
|
27153
|
+
*/
|
|
27154
|
+
user_agent?: string;
|
|
26208
27155
|
} | {
|
|
26209
27156
|
/**
|
|
26210
27157
|
* @description The client ID of the application.
|
|
@@ -27888,7 +28835,13 @@ export interface operations {
|
|
|
27888
28835
|
[name: string]: unknown;
|
|
27889
28836
|
};
|
|
27890
28837
|
content: {
|
|
27891
|
-
"application/json": components["schemas"]["MagicAuth"]
|
|
28838
|
+
"application/json": components["schemas"]["MagicAuth"] & {
|
|
28839
|
+
/**
|
|
28840
|
+
* @description The ID of the Radar authentication attempt created for this request when Radar is enabled. Pass this value to the authenticate endpoint to associate the subsequent authentication with this Radar attempt.
|
|
28841
|
+
* @example radar_auth_attempt_01HXYZ123456789ABCDEFGHIJ
|
|
28842
|
+
*/
|
|
28843
|
+
radar_auth_attempt_id?: string;
|
|
28844
|
+
};
|
|
27892
28845
|
};
|
|
27893
28846
|
};
|
|
27894
28847
|
/** @description Bad Request */
|
|
@@ -29014,6 +29967,30 @@ export interface operations {
|
|
|
29014
29967
|
};
|
|
29015
29968
|
};
|
|
29016
29969
|
};
|
|
29970
|
+
PublicRadarChallengesController_sendRadarSmsChallenge: {
|
|
29971
|
+
parameters: {
|
|
29972
|
+
query?: never;
|
|
29973
|
+
header?: never;
|
|
29974
|
+
path?: never;
|
|
29975
|
+
cookie?: never;
|
|
29976
|
+
};
|
|
29977
|
+
requestBody: {
|
|
29978
|
+
content: {
|
|
29979
|
+
"application/json": components["schemas"]["SendRadarSmsChallengeDto"];
|
|
29980
|
+
};
|
|
29981
|
+
};
|
|
29982
|
+
responses: {
|
|
29983
|
+
/** @description Created */
|
|
29984
|
+
201: {
|
|
29985
|
+
headers: {
|
|
29986
|
+
[name: string]: unknown;
|
|
29987
|
+
};
|
|
29988
|
+
content: {
|
|
29989
|
+
"application/json": components["schemas"]["SendRadarSmsChallengeResponse"];
|
|
29990
|
+
};
|
|
29991
|
+
};
|
|
29992
|
+
};
|
|
29993
|
+
};
|
|
29017
29994
|
RedirectUrisController_list: {
|
|
29018
29995
|
parameters: {
|
|
29019
29996
|
query?: {
|
|
@@ -29334,7 +30311,13 @@ export interface operations {
|
|
|
29334
30311
|
[name: string]: unknown;
|
|
29335
30312
|
};
|
|
29336
30313
|
content: {
|
|
29337
|
-
"application/json": components["schemas"]["UserlandUser"]
|
|
30314
|
+
"application/json": components["schemas"]["UserlandUser"] & {
|
|
30315
|
+
/**
|
|
30316
|
+
* @description The ID of the Radar authentication attempt created for this request when Radar is enabled. Pass this value to the authenticate endpoint to associate the subsequent authentication with this Radar attempt.
|
|
30317
|
+
* @example radar_auth_attempt_01HXYZ123456789ABCDEFGHIJ
|
|
30318
|
+
*/
|
|
30319
|
+
radar_auth_attempt_id?: string;
|
|
30320
|
+
};
|
|
29338
30321
|
};
|
|
29339
30322
|
};
|
|
29340
30323
|
/** @description Bad Request */
|
|
@@ -30960,6 +31943,144 @@ export interface operations {
|
|
|
30960
31943
|
};
|
|
30961
31944
|
};
|
|
30962
31945
|
};
|
|
31946
|
+
DataIntegrationsUserManagementController_updateUserDataInstallation: {
|
|
31947
|
+
parameters: {
|
|
31948
|
+
query?: {
|
|
31949
|
+
/** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
31950
|
+
organization_id?: string;
|
|
31951
|
+
};
|
|
31952
|
+
header?: never;
|
|
31953
|
+
path: {
|
|
31954
|
+
/** @description A [User](/reference/authkit/user) identifier. */
|
|
31955
|
+
user_id: string;
|
|
31956
|
+
/** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
31957
|
+
slug: string;
|
|
31958
|
+
};
|
|
31959
|
+
cookie?: never;
|
|
31960
|
+
};
|
|
31961
|
+
requestBody: {
|
|
31962
|
+
content: {
|
|
31963
|
+
"application/json": components["schemas"]["ConnectedAccountDto"];
|
|
31964
|
+
};
|
|
31965
|
+
};
|
|
31966
|
+
responses: {
|
|
31967
|
+
/** @description The connected account was updated successfully. */
|
|
31968
|
+
200: {
|
|
31969
|
+
headers: {
|
|
31970
|
+
[name: string]: unknown;
|
|
31971
|
+
};
|
|
31972
|
+
content: {
|
|
31973
|
+
"application/json": components["schemas"]["ConnectedAccount"];
|
|
31974
|
+
};
|
|
31975
|
+
};
|
|
31976
|
+
/** @description The request is missing a valid API key. */
|
|
31977
|
+
401: {
|
|
31978
|
+
headers: {
|
|
31979
|
+
[name: string]: unknown;
|
|
31980
|
+
};
|
|
31981
|
+
content?: never;
|
|
31982
|
+
};
|
|
31983
|
+
/** @description The user, organization, or connected account was not found. */
|
|
31984
|
+
404: {
|
|
31985
|
+
headers: {
|
|
31986
|
+
[name: string]: unknown;
|
|
31987
|
+
};
|
|
31988
|
+
content: {
|
|
31989
|
+
"application/json": {
|
|
31990
|
+
/**
|
|
31991
|
+
* @description A human-readable description of the error.
|
|
31992
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
31993
|
+
*/
|
|
31994
|
+
message: string;
|
|
31995
|
+
};
|
|
31996
|
+
};
|
|
31997
|
+
};
|
|
31998
|
+
};
|
|
31999
|
+
};
|
|
32000
|
+
DataIntegrationsUserManagementController_createUserDataInstallation: {
|
|
32001
|
+
parameters: {
|
|
32002
|
+
query?: {
|
|
32003
|
+
/** @description An [Organization](/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
32004
|
+
organization_id?: string;
|
|
32005
|
+
};
|
|
32006
|
+
header?: never;
|
|
32007
|
+
path: {
|
|
32008
|
+
/** @description A [User](/reference/authkit/user) identifier. */
|
|
32009
|
+
user_id: string;
|
|
32010
|
+
/** @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
32011
|
+
slug: string;
|
|
32012
|
+
};
|
|
32013
|
+
cookie?: never;
|
|
32014
|
+
};
|
|
32015
|
+
requestBody: {
|
|
32016
|
+
content: {
|
|
32017
|
+
"application/json": components["schemas"]["ConnectedAccountDto"];
|
|
32018
|
+
};
|
|
32019
|
+
};
|
|
32020
|
+
responses: {
|
|
32021
|
+
/** @description The connected account was created successfully. */
|
|
32022
|
+
201: {
|
|
32023
|
+
headers: {
|
|
32024
|
+
[name: string]: unknown;
|
|
32025
|
+
};
|
|
32026
|
+
content: {
|
|
32027
|
+
"application/json": components["schemas"]["ConnectedAccount"];
|
|
32028
|
+
};
|
|
32029
|
+
};
|
|
32030
|
+
/** @description The request is missing a valid API key. */
|
|
32031
|
+
401: {
|
|
32032
|
+
headers: {
|
|
32033
|
+
[name: string]: unknown;
|
|
32034
|
+
};
|
|
32035
|
+
content?: never;
|
|
32036
|
+
};
|
|
32037
|
+
/** @description The user, organization, or data integration was not found. */
|
|
32038
|
+
404: {
|
|
32039
|
+
headers: {
|
|
32040
|
+
[name: string]: unknown;
|
|
32041
|
+
};
|
|
32042
|
+
content: {
|
|
32043
|
+
"application/json": {
|
|
32044
|
+
/**
|
|
32045
|
+
* @description A human-readable description of the error.
|
|
32046
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
32047
|
+
*/
|
|
32048
|
+
message: string;
|
|
32049
|
+
};
|
|
32050
|
+
};
|
|
32051
|
+
};
|
|
32052
|
+
/** @description A connected account already exists for this user, integration, and organization. */
|
|
32053
|
+
409: {
|
|
32054
|
+
headers: {
|
|
32055
|
+
[name: string]: unknown;
|
|
32056
|
+
};
|
|
32057
|
+
content: {
|
|
32058
|
+
"application/json": {
|
|
32059
|
+
/**
|
|
32060
|
+
* @description A human-readable description of the error.
|
|
32061
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
32062
|
+
*/
|
|
32063
|
+
message: string;
|
|
32064
|
+
};
|
|
32065
|
+
};
|
|
32066
|
+
};
|
|
32067
|
+
/** @description The data integration is not in a valid state or the token combination is invalid. */
|
|
32068
|
+
422: {
|
|
32069
|
+
headers: {
|
|
32070
|
+
[name: string]: unknown;
|
|
32071
|
+
};
|
|
32072
|
+
content: {
|
|
32073
|
+
"application/json": {
|
|
32074
|
+
/**
|
|
32075
|
+
* @description A human-readable description of the error.
|
|
32076
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
32077
|
+
*/
|
|
32078
|
+
message: string;
|
|
32079
|
+
};
|
|
32080
|
+
};
|
|
32081
|
+
};
|
|
32082
|
+
};
|
|
32083
|
+
};
|
|
30963
32084
|
DataIntegrationsUserManagementController_deleteUserDataInstallation: {
|
|
30964
32085
|
parameters: {
|
|
30965
32086
|
query?: {
|