@workos/openapi-spec 0.7.0 → 0.9.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 +1196 -134
- package/dist/policy.mjs +6 -0
- package/dist/services.d.mts +5 -0
- package/dist/services.mjs +27 -0
- package/dist/types.d.ts +1150 -111
- package/package.json +8 -3
package/dist/types.d.ts
CHANGED
|
@@ -287,6 +287,62 @@ export interface paths {
|
|
|
287
287
|
patch?: never;
|
|
288
288
|
trace?: never;
|
|
289
289
|
};
|
|
290
|
+
"/authorization/groups/{group_id}/role_assignments": {
|
|
291
|
+
parameters: {
|
|
292
|
+
query?: never;
|
|
293
|
+
header?: never;
|
|
294
|
+
path?: never;
|
|
295
|
+
cookie?: never;
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* List role assignments for a group
|
|
299
|
+
* @description List all role assignments granted to a group. Each assignment represents a role granted to the group on a resource.
|
|
300
|
+
*/
|
|
301
|
+
get: operations["AuthorizationGroupRoleAssignmentsController_list"];
|
|
302
|
+
/**
|
|
303
|
+
* Replace all role assignments for a group
|
|
304
|
+
* @description Replace all role assignments for a group with the provided list. Existing assignments not in the list will be removed.
|
|
305
|
+
*/
|
|
306
|
+
put: operations["AuthorizationGroupRoleAssignmentsController_replaceGroupRoleAssignments"];
|
|
307
|
+
/**
|
|
308
|
+
* Assign a role to a group
|
|
309
|
+
* @description Assign a role to a group on a specific resource.
|
|
310
|
+
*/
|
|
311
|
+
post: operations["AuthorizationGroupRoleAssignmentsController_create"];
|
|
312
|
+
/**
|
|
313
|
+
* Remove group role assignments by criteria
|
|
314
|
+
* @description Remove role assignments from a group that match the provided criteria. Returns 404 when no matching active assignment is found.
|
|
315
|
+
*/
|
|
316
|
+
delete: operations["AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignments"];
|
|
317
|
+
options?: never;
|
|
318
|
+
head?: never;
|
|
319
|
+
patch?: never;
|
|
320
|
+
trace?: never;
|
|
321
|
+
};
|
|
322
|
+
"/authorization/groups/{group_id}/role_assignments/{role_assignment_id}": {
|
|
323
|
+
parameters: {
|
|
324
|
+
query?: never;
|
|
325
|
+
header?: never;
|
|
326
|
+
path?: never;
|
|
327
|
+
cookie?: never;
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* Get a group role assignment
|
|
331
|
+
* @description Get a specific role assignment for a group by its ID.
|
|
332
|
+
*/
|
|
333
|
+
get: operations["AuthorizationGroupRoleAssignmentsController_get"];
|
|
334
|
+
put?: never;
|
|
335
|
+
post?: never;
|
|
336
|
+
/**
|
|
337
|
+
* Remove a group role assignment
|
|
338
|
+
* @description Remove a specific role assignment from a group by its ID.
|
|
339
|
+
*/
|
|
340
|
+
delete: operations["AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignment"];
|
|
341
|
+
options?: never;
|
|
342
|
+
head?: never;
|
|
343
|
+
patch?: never;
|
|
344
|
+
trace?: never;
|
|
345
|
+
};
|
|
290
346
|
"/authorization/organization_memberships/{organization_membership_id}/check": {
|
|
291
347
|
parameters: {
|
|
292
348
|
query?: never;
|
|
@@ -797,6 +853,26 @@ export interface paths {
|
|
|
797
853
|
patch?: never;
|
|
798
854
|
trace?: never;
|
|
799
855
|
};
|
|
856
|
+
"/client/token": {
|
|
857
|
+
parameters: {
|
|
858
|
+
query?: never;
|
|
859
|
+
header?: never;
|
|
860
|
+
path?: never;
|
|
861
|
+
cookie?: never;
|
|
862
|
+
};
|
|
863
|
+
get?: never;
|
|
864
|
+
put?: never;
|
|
865
|
+
/**
|
|
866
|
+
* Generate a Client API token
|
|
867
|
+
* @description Generate a short-lived, session-bound token for the Client GraphQL API, scoped to an organization and user.
|
|
868
|
+
*/
|
|
869
|
+
post: operations["ClientApiTokenController_issueClientApiToken"];
|
|
870
|
+
delete?: never;
|
|
871
|
+
options?: never;
|
|
872
|
+
head?: never;
|
|
873
|
+
patch?: never;
|
|
874
|
+
trace?: never;
|
|
875
|
+
};
|
|
800
876
|
"/connect/applications": {
|
|
801
877
|
parameters: {
|
|
802
878
|
query?: never;
|
|
@@ -1429,6 +1505,46 @@ export interface paths {
|
|
|
1429
1505
|
patch?: never;
|
|
1430
1506
|
trace?: never;
|
|
1431
1507
|
};
|
|
1508
|
+
"/organizations/{organizationId}/data_integration_configurations": {
|
|
1509
|
+
parameters: {
|
|
1510
|
+
query?: never;
|
|
1511
|
+
header?: never;
|
|
1512
|
+
path?: never;
|
|
1513
|
+
cookie?: never;
|
|
1514
|
+
};
|
|
1515
|
+
/**
|
|
1516
|
+
* List providers for an organization
|
|
1517
|
+
* @description Returns a list of all providers available to the specified organization, along with any configured custom OAuth scopes, enabled state, and organization-managed credentials where applicable.
|
|
1518
|
+
*/
|
|
1519
|
+
get: operations["ProviderController_listForOrganization"];
|
|
1520
|
+
put?: never;
|
|
1521
|
+
post?: never;
|
|
1522
|
+
delete?: never;
|
|
1523
|
+
options?: never;
|
|
1524
|
+
head?: never;
|
|
1525
|
+
patch?: never;
|
|
1526
|
+
trace?: never;
|
|
1527
|
+
};
|
|
1528
|
+
"/organizations/{organizationId}/data_integration_configurations/{slug}": {
|
|
1529
|
+
parameters: {
|
|
1530
|
+
query?: never;
|
|
1531
|
+
header?: never;
|
|
1532
|
+
path?: never;
|
|
1533
|
+
cookie?: never;
|
|
1534
|
+
};
|
|
1535
|
+
get?: never;
|
|
1536
|
+
/**
|
|
1537
|
+
* Configure a provider for an organization
|
|
1538
|
+
* @description Creates or updates an organization's provider configuration. Use this endpoint to enable or disable a provider, set custom OAuth scopes, or supply organization-managed OAuth credentials.
|
|
1539
|
+
*/
|
|
1540
|
+
put: operations["ProviderController_configure"];
|
|
1541
|
+
post?: never;
|
|
1542
|
+
delete?: never;
|
|
1543
|
+
options?: never;
|
|
1544
|
+
head?: never;
|
|
1545
|
+
patch?: never;
|
|
1546
|
+
trace?: never;
|
|
1547
|
+
};
|
|
1432
1548
|
"/organizations/{organizationId}/feature-flags": {
|
|
1433
1549
|
parameters: {
|
|
1434
1550
|
query?: never;
|
|
@@ -2234,7 +2350,7 @@ export interface paths {
|
|
|
2234
2350
|
put?: never;
|
|
2235
2351
|
/**
|
|
2236
2352
|
* Create a redirect URI
|
|
2237
|
-
* @description Creates a new redirect URI for an
|
|
2353
|
+
* @description Creates a new redirect URI for an application.
|
|
2238
2354
|
*/
|
|
2239
2355
|
post: operations["RedirectUrisController_create"];
|
|
2240
2356
|
delete?: never;
|
|
@@ -2426,7 +2542,7 @@ export interface paths {
|
|
|
2426
2542
|
put?: never;
|
|
2427
2543
|
/**
|
|
2428
2544
|
* Send verification email
|
|
2429
|
-
* @description Sends an email that contains a one-time code used to verify a user
|
|
2545
|
+
* @description Sends an email that contains a one-time code used to verify a user's email address.
|
|
2430
2546
|
*/
|
|
2431
2547
|
post: operations["UserlandUsersController_sendVerificationEmail[0]"];
|
|
2432
2548
|
delete?: never;
|
|
@@ -2591,7 +2707,7 @@ export interface paths {
|
|
|
2591
2707
|
cookie?: never;
|
|
2592
2708
|
};
|
|
2593
2709
|
/**
|
|
2594
|
-
* List providers
|
|
2710
|
+
* List providers for a user
|
|
2595
2711
|
* @description Retrieves a list of available providers and the user's connection status for each. Returns all providers configured for your environment, along with the user's [connected account](/reference/pipes/connected-account) information where applicable.
|
|
2596
2712
|
*/
|
|
2597
2713
|
get: operations["DataIntegrationsUserManagementController_getUserDataIntegrations"];
|
|
@@ -3352,6 +3468,76 @@ export interface components {
|
|
|
3352
3468
|
*/
|
|
3353
3469
|
resource_type_slug: string;
|
|
3354
3470
|
});
|
|
3471
|
+
CreateGroupRoleAssignmentDto: {
|
|
3472
|
+
/**
|
|
3473
|
+
* @description The slug of the role to assign to the group.
|
|
3474
|
+
* @example admin
|
|
3475
|
+
*/
|
|
3476
|
+
role_slug: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* @description The ID of the resource. Omit along with the external-id fields to target the organization itself.
|
|
3479
|
+
* @example authz_resource_01HXYZ123456789ABCDEFGH
|
|
3480
|
+
*/
|
|
3481
|
+
resource_id?: string;
|
|
3482
|
+
/**
|
|
3483
|
+
* @description The external ID of the resource.
|
|
3484
|
+
* @example proj-456
|
|
3485
|
+
*/
|
|
3486
|
+
resource_external_id?: string;
|
|
3487
|
+
/**
|
|
3488
|
+
* @description The resource type slug.
|
|
3489
|
+
* @example project
|
|
3490
|
+
*/
|
|
3491
|
+
resource_type_slug?: string;
|
|
3492
|
+
};
|
|
3493
|
+
ReplaceGroupRoleAssignmentEntryDto: {
|
|
3494
|
+
/**
|
|
3495
|
+
* @description The slug of the role to assign to the group.
|
|
3496
|
+
* @example admin
|
|
3497
|
+
*/
|
|
3498
|
+
role_slug: string;
|
|
3499
|
+
/**
|
|
3500
|
+
* @description The ID of the resource. Omit along with the external-id fields to target the organization itself.
|
|
3501
|
+
* @example authz_resource_01HXYZ123456789ABCDEFGH
|
|
3502
|
+
*/
|
|
3503
|
+
resource_id?: string;
|
|
3504
|
+
/**
|
|
3505
|
+
* @description The external ID of the resource.
|
|
3506
|
+
* @example proj-456
|
|
3507
|
+
*/
|
|
3508
|
+
resource_external_id?: string;
|
|
3509
|
+
/**
|
|
3510
|
+
* @description The resource type slug.
|
|
3511
|
+
* @example project
|
|
3512
|
+
*/
|
|
3513
|
+
resource_type_slug?: string;
|
|
3514
|
+
};
|
|
3515
|
+
ReplaceGroupRoleAssignmentsDto: {
|
|
3516
|
+
/** @description The list of role assignments that should exist for the group. All existing assignments will be replaced. */
|
|
3517
|
+
role_assignments: components["schemas"]["ReplaceGroupRoleAssignmentEntryDto"][];
|
|
3518
|
+
};
|
|
3519
|
+
DeleteGroupRoleAssignmentsByCriteriaDto: {
|
|
3520
|
+
/**
|
|
3521
|
+
* @description The slug of the role to remove assignments for.
|
|
3522
|
+
* @example admin
|
|
3523
|
+
*/
|
|
3524
|
+
role_slug: string;
|
|
3525
|
+
/**
|
|
3526
|
+
* @description The ID of the resource. Mutually exclusive with `resource_external_id` and `resource_type_slug`.
|
|
3527
|
+
* @example authz_resource_01HXYZ123456789ABCDEFGH
|
|
3528
|
+
*/
|
|
3529
|
+
resource_id?: string;
|
|
3530
|
+
/**
|
|
3531
|
+
* @description The external ID of the resource.
|
|
3532
|
+
* @example proj-456
|
|
3533
|
+
*/
|
|
3534
|
+
resource_external_id?: string;
|
|
3535
|
+
/**
|
|
3536
|
+
* @description The resource type slug.
|
|
3537
|
+
* @example project
|
|
3538
|
+
*/
|
|
3539
|
+
resource_type_slug?: string;
|
|
3540
|
+
};
|
|
3355
3541
|
AssignRoleDto: {
|
|
3356
3542
|
/**
|
|
3357
3543
|
* @description The slug of the role to assign.
|
|
@@ -4204,7 +4390,19 @@ export interface components {
|
|
|
4204
4390
|
* "widgets:users-table:manage"
|
|
4205
4391
|
* ]
|
|
4206
4392
|
*/
|
|
4207
|
-
scopes?: ("widgets:users-table:manage" | "widgets:domain-verification:manage" | "widgets:sso:manage" | "widgets:api-keys:manage" | "widgets:dsync:manage" | "widgets:audit-log-streaming:manage")[];
|
|
4393
|
+
scopes?: ("widgets:users-table:manage" | "widgets:domain-verification:manage" | "widgets:sso:manage" | "widgets:api-keys:manage" | "widgets:dsync:manage" | "widgets:audit-log-streaming:manage" | "widgets:pipes:manage")[];
|
|
4394
|
+
};
|
|
4395
|
+
ClientApiTokenDto: {
|
|
4396
|
+
/**
|
|
4397
|
+
* @description The ID of the organization to scope the Client API token to.
|
|
4398
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
4399
|
+
*/
|
|
4400
|
+
organization_id: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* @description The ID of the user to issue the Client API token for.
|
|
4403
|
+
* @example user_01E4ZCR3C56J083X43JQXF3JK5
|
|
4404
|
+
*/
|
|
4405
|
+
user_id: string;
|
|
4208
4406
|
};
|
|
4209
4407
|
TokenQueryDto: {
|
|
4210
4408
|
/**
|
|
@@ -5383,6 +5581,77 @@ export interface components {
|
|
|
5383
5581
|
*/
|
|
5384
5582
|
slug: string;
|
|
5385
5583
|
};
|
|
5584
|
+
GroupRoleAssignment: {
|
|
5585
|
+
/**
|
|
5586
|
+
* @description Distinguishes the group role assignment object.
|
|
5587
|
+
* @constant
|
|
5588
|
+
*/
|
|
5589
|
+
object: "group_role_assignment";
|
|
5590
|
+
/**
|
|
5591
|
+
* @description Unique identifier of the group role assignment.
|
|
5592
|
+
* @example gra_01HXYZ123456789ABCDEFGH
|
|
5593
|
+
*/
|
|
5594
|
+
id: string;
|
|
5595
|
+
/**
|
|
5596
|
+
* @description The ID of the group the role is assigned to.
|
|
5597
|
+
* @example group_01HXYZ123456789ABCDEFGHIJ
|
|
5598
|
+
*/
|
|
5599
|
+
group_id: string;
|
|
5600
|
+
/** @description The role included in the assignment. */
|
|
5601
|
+
role: components["schemas"]["SlimRole"];
|
|
5602
|
+
/** @description The resource the role is assigned on. */
|
|
5603
|
+
resource: {
|
|
5604
|
+
/**
|
|
5605
|
+
* @description The unique ID of the Resource.
|
|
5606
|
+
* @example authz_resource_01HXYZ123456789ABCDEFGH
|
|
5607
|
+
*/
|
|
5608
|
+
id: string;
|
|
5609
|
+
/**
|
|
5610
|
+
* @description An identifier you provide to reference the resource in your system.
|
|
5611
|
+
* @example proj-456
|
|
5612
|
+
*/
|
|
5613
|
+
external_id: string;
|
|
5614
|
+
/**
|
|
5615
|
+
* @description The slug of the resource type this resource belongs to.
|
|
5616
|
+
* @example project
|
|
5617
|
+
*/
|
|
5618
|
+
resource_type_slug: string;
|
|
5619
|
+
};
|
|
5620
|
+
/**
|
|
5621
|
+
* Format: date-time
|
|
5622
|
+
* @description An ISO 8601 timestamp.
|
|
5623
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
5624
|
+
*/
|
|
5625
|
+
created_at: string;
|
|
5626
|
+
/**
|
|
5627
|
+
* Format: date-time
|
|
5628
|
+
* @description An ISO 8601 timestamp.
|
|
5629
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
5630
|
+
*/
|
|
5631
|
+
updated_at: string;
|
|
5632
|
+
};
|
|
5633
|
+
GroupRoleAssignmentList: {
|
|
5634
|
+
/**
|
|
5635
|
+
* @description Indicates this is a list response.
|
|
5636
|
+
* @constant
|
|
5637
|
+
*/
|
|
5638
|
+
object: "list";
|
|
5639
|
+
/** @description The list of records for the current page. */
|
|
5640
|
+
data: components["schemas"]["GroupRoleAssignment"][];
|
|
5641
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
5642
|
+
list_metadata: {
|
|
5643
|
+
/**
|
|
5644
|
+
* @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.
|
|
5645
|
+
* @example gra_01HXYZ123456789ABCDEFGHIJ
|
|
5646
|
+
*/
|
|
5647
|
+
before: string | null;
|
|
5648
|
+
/**
|
|
5649
|
+
* @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.
|
|
5650
|
+
* @example gra_01HXYZ987654321KJIHGFEDCBA
|
|
5651
|
+
*/
|
|
5652
|
+
after: string | null;
|
|
5653
|
+
};
|
|
5654
|
+
};
|
|
5386
5655
|
UserRoleAssignment: {
|
|
5387
5656
|
/**
|
|
5388
5657
|
* @description Distinguishes the role assignment object.
|
|
@@ -13441,68 +13710,182 @@ export interface components {
|
|
|
13441
13710
|
created_at: string;
|
|
13442
13711
|
};
|
|
13443
13712
|
};
|
|
13444
|
-
|
|
13713
|
+
/** @description Organization-managed OAuth credential configuration. Present only for integrations whose credentials are supplied by the organization; absent otherwise. */
|
|
13714
|
+
DataIntegrationCredentials: {
|
|
13445
13715
|
/**
|
|
13446
|
-
* @description The
|
|
13447
|
-
* @example
|
|
13716
|
+
* @description The credentials type for this integration (e.g., `shared`, `custom`, or `organization`).
|
|
13717
|
+
* @example organization
|
|
13718
|
+
* @enum {string}
|
|
13448
13719
|
*/
|
|
13449
|
-
|
|
13450
|
-
};
|
|
13451
|
-
DataIntegrationAccessTokenResponse: {
|
|
13720
|
+
credentials_type: "shared" | "custom" | "organization";
|
|
13452
13721
|
/**
|
|
13453
|
-
* @description
|
|
13454
|
-
* @
|
|
13722
|
+
* @description Whether the organization has supplied OAuth credentials for this integration.
|
|
13723
|
+
* @example true
|
|
13455
13724
|
*/
|
|
13456
|
-
|
|
13457
|
-
/** @description The [access token](/reference/pipes/access-token) object, present when `active` is `true`. */
|
|
13458
|
-
access_token: {
|
|
13459
|
-
/**
|
|
13460
|
-
* @description Distinguishes the access token object.
|
|
13461
|
-
* @constant
|
|
13462
|
-
*/
|
|
13463
|
-
object: "access_token";
|
|
13464
|
-
/**
|
|
13465
|
-
* @description The OAuth access token for the connected integration.
|
|
13466
|
-
* @example gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
13467
|
-
*/
|
|
13468
|
-
access_token: string;
|
|
13469
|
-
/**
|
|
13470
|
-
* @description The ISO-8601 formatted timestamp indicating when the access token expires.
|
|
13471
|
-
* @example 2025-12-31T23:59:59.000Z
|
|
13472
|
-
*/
|
|
13473
|
-
expires_at: string | null;
|
|
13474
|
-
/**
|
|
13475
|
-
* @description The scopes granted to the access token.
|
|
13476
|
-
* @example [
|
|
13477
|
-
* "repo",
|
|
13478
|
-
* "user:email"
|
|
13479
|
-
* ]
|
|
13480
|
-
*/
|
|
13481
|
-
scopes: string[];
|
|
13482
|
-
/**
|
|
13483
|
-
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
13484
|
-
* @example []
|
|
13485
|
-
*/
|
|
13486
|
-
missing_scopes: string[];
|
|
13487
|
-
};
|
|
13488
|
-
} | {
|
|
13725
|
+
has_credentials: boolean;
|
|
13489
13726
|
/**
|
|
13490
|
-
* @description
|
|
13491
|
-
* @
|
|
13727
|
+
* @description The OAuth client ID supplied by the organization, or `null` when none is configured.
|
|
13728
|
+
* @example client_01EHZNVPK3SFK441A1RGBFSHRT
|
|
13492
13729
|
*/
|
|
13493
|
-
|
|
13730
|
+
client_id: string | null;
|
|
13494
13731
|
/**
|
|
13495
|
-
* @description -
|
|
13496
|
-
*
|
|
13497
|
-
* @example not_installed
|
|
13498
|
-
* @enum {string}
|
|
13732
|
+
* @description The last four characters of the organization-supplied OAuth client secret, or `null` when none is configured.
|
|
13733
|
+
* @example 1a2b
|
|
13499
13734
|
*/
|
|
13500
|
-
|
|
13501
|
-
};
|
|
13502
|
-
ConnectedAccount: {
|
|
13735
|
+
client_secret_last_four: string | null;
|
|
13503
13736
|
/**
|
|
13504
|
-
* @description
|
|
13505
|
-
* @
|
|
13737
|
+
* @description The redirect URI to register with the provider when configuring the organization-managed OAuth application.
|
|
13738
|
+
* @example https://api.workos.com/data-integrations/github/dik_01EHZNVPK3SFK441A1RGBFSHRT/callback
|
|
13739
|
+
*/
|
|
13740
|
+
redirect_uri: string;
|
|
13741
|
+
};
|
|
13742
|
+
DataIntegrationConfigurationResponse: {
|
|
13743
|
+
/**
|
|
13744
|
+
* @description Distinguishes the data integration configuration object.
|
|
13745
|
+
* @constant
|
|
13746
|
+
*/
|
|
13747
|
+
object: "data_integration_configuration";
|
|
13748
|
+
/**
|
|
13749
|
+
* @description The unique identifier of the data integration.
|
|
13750
|
+
* @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
13751
|
+
*/
|
|
13752
|
+
id: string;
|
|
13753
|
+
/**
|
|
13754
|
+
* @description The [Organization](/reference/organization) this configuration applies to.
|
|
13755
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
13756
|
+
*/
|
|
13757
|
+
organization_id: string;
|
|
13758
|
+
/**
|
|
13759
|
+
* @description The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
13760
|
+
* @example github
|
|
13761
|
+
*/
|
|
13762
|
+
slug: string;
|
|
13763
|
+
/**
|
|
13764
|
+
* @description The display name of the data integration.
|
|
13765
|
+
* @example GitHub
|
|
13766
|
+
*/
|
|
13767
|
+
name: string;
|
|
13768
|
+
/**
|
|
13769
|
+
* @description Whether the integration is enabled for this organization. Reflects the organization override when one exists, otherwise the provider default.
|
|
13770
|
+
* @example true
|
|
13771
|
+
*/
|
|
13772
|
+
enabled: boolean;
|
|
13773
|
+
/**
|
|
13774
|
+
* @description The OAuth scopes in effect for this organization. Reflects the organization override when one is set, otherwise the provider scopes, or `null` when none are configured.
|
|
13775
|
+
* @example [
|
|
13776
|
+
* "repo",
|
|
13777
|
+
* "user:email"
|
|
13778
|
+
* ]
|
|
13779
|
+
*/
|
|
13780
|
+
scopes: string[] | null;
|
|
13781
|
+
/**
|
|
13782
|
+
* @description The timestamp when the configuration was created.
|
|
13783
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
13784
|
+
*/
|
|
13785
|
+
created_at: string;
|
|
13786
|
+
/**
|
|
13787
|
+
* @description The timestamp when the configuration was last updated.
|
|
13788
|
+
* @example 2024-01-15T10:30:00.000Z
|
|
13789
|
+
*/
|
|
13790
|
+
updated_at: string;
|
|
13791
|
+
credentials?: components["schemas"]["DataIntegrationCredentials"];
|
|
13792
|
+
};
|
|
13793
|
+
DataIntegrationConfigurationListResponse: {
|
|
13794
|
+
/**
|
|
13795
|
+
* @description Indicates this is a list response.
|
|
13796
|
+
* @constant
|
|
13797
|
+
*/
|
|
13798
|
+
object: "list";
|
|
13799
|
+
/** @description A list of data integration configurations for the organization. */
|
|
13800
|
+
data: components["schemas"]["DataIntegrationConfigurationResponse"][];
|
|
13801
|
+
};
|
|
13802
|
+
ConfigureDataIntegrationBody: {
|
|
13803
|
+
/**
|
|
13804
|
+
* @description Whether the provider is enabled for the organization.
|
|
13805
|
+
* @example true
|
|
13806
|
+
*/
|
|
13807
|
+
enabled?: boolean;
|
|
13808
|
+
/**
|
|
13809
|
+
* @description The OAuth scopes to request for the organization. Pass `null` to inherit the provider scopes.
|
|
13810
|
+
* @example [
|
|
13811
|
+
* "repo",
|
|
13812
|
+
* "user:email"
|
|
13813
|
+
* ]
|
|
13814
|
+
*/
|
|
13815
|
+
scopes?: string[] | null;
|
|
13816
|
+
/**
|
|
13817
|
+
* @description The OAuth client ID of the organization's own application. Must be provided together with `client_secret`, and only for providers whose credentials are supplied by the organization.
|
|
13818
|
+
* @example client_01EHZNVPK3SFK441A1RGBFSHRT
|
|
13819
|
+
*/
|
|
13820
|
+
client_id?: string;
|
|
13821
|
+
/**
|
|
13822
|
+
* @description The OAuth client secret of the organization's own application. Must be provided together with `client_id`.
|
|
13823
|
+
* @example ••••••••
|
|
13824
|
+
*/
|
|
13825
|
+
client_secret?: string;
|
|
13826
|
+
};
|
|
13827
|
+
DataIntegrationAuthorizeUrlResponse: {
|
|
13828
|
+
/**
|
|
13829
|
+
* @description The OAuth authorization URL to redirect the user to.
|
|
13830
|
+
* @example https://api.workos.com/data-integrations/q2czJKmVAraSBg8xFpT7M9uR/authorize-redirect
|
|
13831
|
+
*/
|
|
13832
|
+
url: string;
|
|
13833
|
+
};
|
|
13834
|
+
DataIntegrationAccessTokenResponse: {
|
|
13835
|
+
/**
|
|
13836
|
+
* @description Indicates whether the access token is valid and ready for use, or if reauthorization is required.
|
|
13837
|
+
* @constant
|
|
13838
|
+
*/
|
|
13839
|
+
active: true;
|
|
13840
|
+
/** @description The [access token](/reference/pipes/access-token) object, present when `active` is `true`. */
|
|
13841
|
+
access_token: {
|
|
13842
|
+
/**
|
|
13843
|
+
* @description Distinguishes the access token object.
|
|
13844
|
+
* @constant
|
|
13845
|
+
*/
|
|
13846
|
+
object: "access_token";
|
|
13847
|
+
/**
|
|
13848
|
+
* @description The OAuth access token for the connected integration.
|
|
13849
|
+
* @example gho_16C7e42F292c6912E7710c838347Ae178B4a
|
|
13850
|
+
*/
|
|
13851
|
+
access_token: string;
|
|
13852
|
+
/**
|
|
13853
|
+
* @description The ISO-8601 formatted timestamp indicating when the access token expires.
|
|
13854
|
+
* @example 2025-12-31T23:59:59.000Z
|
|
13855
|
+
*/
|
|
13856
|
+
expires_at: string | null;
|
|
13857
|
+
/**
|
|
13858
|
+
* @description The scopes granted to the access token.
|
|
13859
|
+
* @example [
|
|
13860
|
+
* "repo",
|
|
13861
|
+
* "user:email"
|
|
13862
|
+
* ]
|
|
13863
|
+
*/
|
|
13864
|
+
scopes: string[];
|
|
13865
|
+
/**
|
|
13866
|
+
* @description If the integration has requested scopes that aren't present on the access token, they're listed here.
|
|
13867
|
+
* @example []
|
|
13868
|
+
*/
|
|
13869
|
+
missing_scopes: string[];
|
|
13870
|
+
};
|
|
13871
|
+
} | {
|
|
13872
|
+
/**
|
|
13873
|
+
* @description Indicates whether the access token is valid and ready for use, or if reauthorization is required.
|
|
13874
|
+
* @constant
|
|
13875
|
+
*/
|
|
13876
|
+
active: false;
|
|
13877
|
+
/**
|
|
13878
|
+
* @description - `"not_installed"`: The user does not have the integration installed.
|
|
13879
|
+
* - `"needs_reauthorization"`: The user needs to reauthorize the integration.
|
|
13880
|
+
* @example not_installed
|
|
13881
|
+
* @enum {string}
|
|
13882
|
+
*/
|
|
13883
|
+
error: "needs_reauthorization" | "not_installed";
|
|
13884
|
+
};
|
|
13885
|
+
ConnectedAccount: {
|
|
13886
|
+
/**
|
|
13887
|
+
* @description Distinguishes the connected account object.
|
|
13888
|
+
* @constant
|
|
13506
13889
|
*/
|
|
13507
13890
|
object: "connected_account";
|
|
13508
13891
|
/**
|
|
@@ -13528,6 +13911,17 @@ export interface components {
|
|
|
13528
13911
|
* ]
|
|
13529
13912
|
*/
|
|
13530
13913
|
scopes: string[];
|
|
13914
|
+
/**
|
|
13915
|
+
* @description The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent.
|
|
13916
|
+
* @example oauth
|
|
13917
|
+
* @enum {string}
|
|
13918
|
+
*/
|
|
13919
|
+
auth_method?: "oauth" | "api_key";
|
|
13920
|
+
/**
|
|
13921
|
+
* @description The last four characters of the API key, or `null` for OAuth connections.
|
|
13922
|
+
* @example null
|
|
13923
|
+
*/
|
|
13924
|
+
api_key_last_4?: string | null;
|
|
13531
13925
|
/**
|
|
13532
13926
|
* @description The state of the connected account:
|
|
13533
13927
|
* - `connected`: The connection is active and tokens are valid.
|
|
@@ -13599,6 +13993,13 @@ export interface components {
|
|
|
13599
13993
|
* ]
|
|
13600
13994
|
*/
|
|
13601
13995
|
scopes: string[] | null;
|
|
13996
|
+
/**
|
|
13997
|
+
* @description The authentication methods supported by this provider (`oauth`, `api_key`, or both). Defaults to `["oauth"]` if absent.
|
|
13998
|
+
* @example [
|
|
13999
|
+
* "oauth"
|
|
14000
|
+
* ]
|
|
14001
|
+
*/
|
|
14002
|
+
auth_methods?: ("oauth" | "api_key")[];
|
|
13602
14003
|
/**
|
|
13603
14004
|
* @description Whether the provider is owned by a user or organization.
|
|
13604
14005
|
* @enum {string}
|
|
@@ -13664,6 +14065,17 @@ export interface components {
|
|
|
13664
14065
|
* ]
|
|
13665
14066
|
*/
|
|
13666
14067
|
scopes: string[];
|
|
14068
|
+
/**
|
|
14069
|
+
* @description The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent.
|
|
14070
|
+
* @example oauth
|
|
14071
|
+
* @enum {string}
|
|
14072
|
+
*/
|
|
14073
|
+
auth_method?: "oauth" | "api_key";
|
|
14074
|
+
/**
|
|
14075
|
+
* @description The last four characters of the API key, or `null` for OAuth connections.
|
|
14076
|
+
* @example null
|
|
14077
|
+
*/
|
|
14078
|
+
api_key_last_4?: string | null;
|
|
13667
14079
|
/**
|
|
13668
14080
|
* @description The state of the connected account:
|
|
13669
14081
|
* - `connected`: The connection is active and tokens are valid.
|
|
@@ -13938,6 +14350,28 @@ export interface components {
|
|
|
13938
14350
|
*/
|
|
13939
14351
|
accept_invitation_url: string;
|
|
13940
14352
|
};
|
|
14353
|
+
UserlandUserInviteList: {
|
|
14354
|
+
/**
|
|
14355
|
+
* @description Indicates this is a list response.
|
|
14356
|
+
* @constant
|
|
14357
|
+
*/
|
|
14358
|
+
object: "list";
|
|
14359
|
+
/** @description The list of records for the current page. */
|
|
14360
|
+
data: components["schemas"]["UserlandUserInvite"][];
|
|
14361
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
14362
|
+
list_metadata: {
|
|
14363
|
+
/**
|
|
14364
|
+
* @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.
|
|
14365
|
+
* @example invitation_01HXYZ123456789ABCDEFGHIJ
|
|
14366
|
+
*/
|
|
14367
|
+
before: string | null;
|
|
14368
|
+
/**
|
|
14369
|
+
* @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.
|
|
14370
|
+
* @example invitation_01HXYZ987654321KJIHGFEDCBA
|
|
14371
|
+
*/
|
|
14372
|
+
after: string | null;
|
|
14373
|
+
};
|
|
14374
|
+
};
|
|
13941
14375
|
UserlandUserOrganizationMembership: {
|
|
13942
14376
|
/**
|
|
13943
14377
|
* @description Distinguishes the organization membership object.
|
|
@@ -14003,6 +14437,28 @@ export interface components {
|
|
|
14003
14437
|
/** @description The user that belongs to the organization through this membership. */
|
|
14004
14438
|
user: components["schemas"]["UserlandUser"];
|
|
14005
14439
|
};
|
|
14440
|
+
UserlandUserOrganizationMembershipList: {
|
|
14441
|
+
/**
|
|
14442
|
+
* @description Indicates this is a list response.
|
|
14443
|
+
* @constant
|
|
14444
|
+
*/
|
|
14445
|
+
object: "list";
|
|
14446
|
+
/** @description The list of records for the current page. */
|
|
14447
|
+
data: components["schemas"]["UserlandUserOrganizationMembership"][];
|
|
14448
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
14449
|
+
list_metadata: {
|
|
14450
|
+
/**
|
|
14451
|
+
* @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.
|
|
14452
|
+
* @example om_01HXYZ123456789ABCDEFGHIJ
|
|
14453
|
+
*/
|
|
14454
|
+
before: string | null;
|
|
14455
|
+
/**
|
|
14456
|
+
* @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.
|
|
14457
|
+
* @example om_01HXYZ987654321KJIHGFEDCBA
|
|
14458
|
+
*/
|
|
14459
|
+
after: string | null;
|
|
14460
|
+
};
|
|
14461
|
+
};
|
|
14006
14462
|
UserApiKey: {
|
|
14007
14463
|
/**
|
|
14008
14464
|
* @description Distinguishes the API Key object.
|
|
@@ -14510,6 +14966,13 @@ export interface components {
|
|
|
14510
14966
|
*/
|
|
14511
14967
|
token: string;
|
|
14512
14968
|
};
|
|
14969
|
+
ClientApiTokenResponse: {
|
|
14970
|
+
/**
|
|
14971
|
+
* @description The Client API token.
|
|
14972
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6InNlc3Npb24...
|
|
14973
|
+
*/
|
|
14974
|
+
token: string;
|
|
14975
|
+
};
|
|
14513
14976
|
SsoAuthorizeUrlResponse: {
|
|
14514
14977
|
/**
|
|
14515
14978
|
* Format: uri
|
|
@@ -15771,8 +16234,412 @@ export interface operations {
|
|
|
15771
16234
|
};
|
|
15772
16235
|
};
|
|
15773
16236
|
};
|
|
15774
|
-
/** @description Not Found */
|
|
15775
|
-
404: {
|
|
16237
|
+
/** @description Not Found */
|
|
16238
|
+
404: {
|
|
16239
|
+
headers: {
|
|
16240
|
+
[name: string]: unknown;
|
|
16241
|
+
};
|
|
16242
|
+
content: {
|
|
16243
|
+
"application/json": {
|
|
16244
|
+
/**
|
|
16245
|
+
* @description A human-readable description of the error.
|
|
16246
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16247
|
+
*/
|
|
16248
|
+
message: string;
|
|
16249
|
+
};
|
|
16250
|
+
};
|
|
16251
|
+
};
|
|
16252
|
+
/** @description Unprocessable Entity */
|
|
16253
|
+
422: {
|
|
16254
|
+
headers: {
|
|
16255
|
+
[name: string]: unknown;
|
|
16256
|
+
};
|
|
16257
|
+
content: {
|
|
16258
|
+
"application/json": {
|
|
16259
|
+
/**
|
|
16260
|
+
* @description A human-readable description of the error.
|
|
16261
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16262
|
+
*/
|
|
16263
|
+
message: string;
|
|
16264
|
+
};
|
|
16265
|
+
};
|
|
16266
|
+
};
|
|
16267
|
+
};
|
|
16268
|
+
};
|
|
16269
|
+
AuthorizationGroupRoleAssignmentsController_list: {
|
|
16270
|
+
parameters: {
|
|
16271
|
+
query?: {
|
|
16272
|
+
/** @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"`. */
|
|
16273
|
+
before?: string;
|
|
16274
|
+
/** @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"`. */
|
|
16275
|
+
after?: string;
|
|
16276
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
16277
|
+
limit?: number;
|
|
16278
|
+
/** @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). */
|
|
16279
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
16280
|
+
};
|
|
16281
|
+
header?: never;
|
|
16282
|
+
path: {
|
|
16283
|
+
/** @description The ID of the group. */
|
|
16284
|
+
group_id: string;
|
|
16285
|
+
};
|
|
16286
|
+
cookie?: never;
|
|
16287
|
+
};
|
|
16288
|
+
requestBody?: never;
|
|
16289
|
+
responses: {
|
|
16290
|
+
/** @description OK */
|
|
16291
|
+
200: {
|
|
16292
|
+
headers: {
|
|
16293
|
+
[name: string]: unknown;
|
|
16294
|
+
};
|
|
16295
|
+
content: {
|
|
16296
|
+
"application/json": components["schemas"]["GroupRoleAssignmentList"];
|
|
16297
|
+
};
|
|
16298
|
+
};
|
|
16299
|
+
/** @description Forbidden */
|
|
16300
|
+
403: {
|
|
16301
|
+
headers: {
|
|
16302
|
+
[name: string]: unknown;
|
|
16303
|
+
};
|
|
16304
|
+
content: {
|
|
16305
|
+
"application/json": {
|
|
16306
|
+
/**
|
|
16307
|
+
* @description A human-readable description of the error.
|
|
16308
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16309
|
+
*/
|
|
16310
|
+
message: string;
|
|
16311
|
+
};
|
|
16312
|
+
};
|
|
16313
|
+
};
|
|
16314
|
+
/** @description Not Found */
|
|
16315
|
+
404: {
|
|
16316
|
+
headers: {
|
|
16317
|
+
[name: string]: unknown;
|
|
16318
|
+
};
|
|
16319
|
+
content: {
|
|
16320
|
+
"application/json": {
|
|
16321
|
+
/**
|
|
16322
|
+
* @description A human-readable description of the error.
|
|
16323
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16324
|
+
*/
|
|
16325
|
+
message: string;
|
|
16326
|
+
};
|
|
16327
|
+
};
|
|
16328
|
+
};
|
|
16329
|
+
};
|
|
16330
|
+
};
|
|
16331
|
+
AuthorizationGroupRoleAssignmentsController_replaceGroupRoleAssignments: {
|
|
16332
|
+
parameters: {
|
|
16333
|
+
query?: never;
|
|
16334
|
+
header?: never;
|
|
16335
|
+
path: {
|
|
16336
|
+
/** @description The ID of the group. */
|
|
16337
|
+
group_id: string;
|
|
16338
|
+
};
|
|
16339
|
+
cookie?: never;
|
|
16340
|
+
};
|
|
16341
|
+
requestBody: {
|
|
16342
|
+
content: {
|
|
16343
|
+
"application/json": components["schemas"]["ReplaceGroupRoleAssignmentsDto"];
|
|
16344
|
+
};
|
|
16345
|
+
};
|
|
16346
|
+
responses: {
|
|
16347
|
+
/** @description OK */
|
|
16348
|
+
200: {
|
|
16349
|
+
headers: {
|
|
16350
|
+
[name: string]: unknown;
|
|
16351
|
+
};
|
|
16352
|
+
content: {
|
|
16353
|
+
"application/json": components["schemas"]["GroupRoleAssignmentList"];
|
|
16354
|
+
};
|
|
16355
|
+
};
|
|
16356
|
+
/** @description Forbidden */
|
|
16357
|
+
403: {
|
|
16358
|
+
headers: {
|
|
16359
|
+
[name: string]: unknown;
|
|
16360
|
+
};
|
|
16361
|
+
content: {
|
|
16362
|
+
"application/json": {
|
|
16363
|
+
/**
|
|
16364
|
+
* @description A human-readable description of the error.
|
|
16365
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16366
|
+
*/
|
|
16367
|
+
message: string;
|
|
16368
|
+
};
|
|
16369
|
+
};
|
|
16370
|
+
};
|
|
16371
|
+
/** @description Not Found */
|
|
16372
|
+
404: {
|
|
16373
|
+
headers: {
|
|
16374
|
+
[name: string]: unknown;
|
|
16375
|
+
};
|
|
16376
|
+
content: {
|
|
16377
|
+
"application/json": {
|
|
16378
|
+
/**
|
|
16379
|
+
* @description A human-readable description of the error.
|
|
16380
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16381
|
+
*/
|
|
16382
|
+
message: string;
|
|
16383
|
+
};
|
|
16384
|
+
};
|
|
16385
|
+
};
|
|
16386
|
+
/** @description Unprocessable Entity */
|
|
16387
|
+
422: {
|
|
16388
|
+
headers: {
|
|
16389
|
+
[name: string]: unknown;
|
|
16390
|
+
};
|
|
16391
|
+
content: {
|
|
16392
|
+
"application/json": {
|
|
16393
|
+
/**
|
|
16394
|
+
* @description A human-readable description of the error.
|
|
16395
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16396
|
+
*/
|
|
16397
|
+
message: string;
|
|
16398
|
+
};
|
|
16399
|
+
};
|
|
16400
|
+
};
|
|
16401
|
+
};
|
|
16402
|
+
};
|
|
16403
|
+
AuthorizationGroupRoleAssignmentsController_create: {
|
|
16404
|
+
parameters: {
|
|
16405
|
+
query?: never;
|
|
16406
|
+
header?: never;
|
|
16407
|
+
path: {
|
|
16408
|
+
/** @description The ID of the group. */
|
|
16409
|
+
group_id: string;
|
|
16410
|
+
};
|
|
16411
|
+
cookie?: never;
|
|
16412
|
+
};
|
|
16413
|
+
requestBody: {
|
|
16414
|
+
content: {
|
|
16415
|
+
"application/json": components["schemas"]["CreateGroupRoleAssignmentDto"];
|
|
16416
|
+
};
|
|
16417
|
+
};
|
|
16418
|
+
responses: {
|
|
16419
|
+
/** @description Created */
|
|
16420
|
+
201: {
|
|
16421
|
+
headers: {
|
|
16422
|
+
[name: string]: unknown;
|
|
16423
|
+
};
|
|
16424
|
+
content: {
|
|
16425
|
+
"application/json": components["schemas"]["GroupRoleAssignment"];
|
|
16426
|
+
};
|
|
16427
|
+
};
|
|
16428
|
+
/** @description Forbidden */
|
|
16429
|
+
403: {
|
|
16430
|
+
headers: {
|
|
16431
|
+
[name: string]: unknown;
|
|
16432
|
+
};
|
|
16433
|
+
content: {
|
|
16434
|
+
"application/json": {
|
|
16435
|
+
/**
|
|
16436
|
+
* @description A human-readable description of the error.
|
|
16437
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16438
|
+
*/
|
|
16439
|
+
message: string;
|
|
16440
|
+
};
|
|
16441
|
+
};
|
|
16442
|
+
};
|
|
16443
|
+
/** @description Not Found */
|
|
16444
|
+
404: {
|
|
16445
|
+
headers: {
|
|
16446
|
+
[name: string]: unknown;
|
|
16447
|
+
};
|
|
16448
|
+
content: {
|
|
16449
|
+
"application/json": {
|
|
16450
|
+
/**
|
|
16451
|
+
* @description A human-readable description of the error.
|
|
16452
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16453
|
+
*/
|
|
16454
|
+
message: string;
|
|
16455
|
+
};
|
|
16456
|
+
};
|
|
16457
|
+
};
|
|
16458
|
+
409: {
|
|
16459
|
+
headers: {
|
|
16460
|
+
[name: string]: unknown;
|
|
16461
|
+
};
|
|
16462
|
+
content: {
|
|
16463
|
+
"application/json": {
|
|
16464
|
+
/**
|
|
16465
|
+
* @description The error code identifying the type of error.
|
|
16466
|
+
* @example duplicate_group_role_assignment
|
|
16467
|
+
* @constant
|
|
16468
|
+
*/
|
|
16469
|
+
code: "duplicate_group_role_assignment";
|
|
16470
|
+
/**
|
|
16471
|
+
* @description A human-readable description of the error.
|
|
16472
|
+
* @example Request could not be processed.
|
|
16473
|
+
*/
|
|
16474
|
+
message: string;
|
|
16475
|
+
};
|
|
16476
|
+
};
|
|
16477
|
+
};
|
|
16478
|
+
/** @description Unprocessable Entity */
|
|
16479
|
+
422: {
|
|
16480
|
+
headers: {
|
|
16481
|
+
[name: string]: unknown;
|
|
16482
|
+
};
|
|
16483
|
+
content: {
|
|
16484
|
+
"application/json": {
|
|
16485
|
+
/**
|
|
16486
|
+
* @description A human-readable description of the error.
|
|
16487
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16488
|
+
*/
|
|
16489
|
+
message: string;
|
|
16490
|
+
};
|
|
16491
|
+
};
|
|
16492
|
+
};
|
|
16493
|
+
};
|
|
16494
|
+
};
|
|
16495
|
+
AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignments: {
|
|
16496
|
+
parameters: {
|
|
16497
|
+
query?: never;
|
|
16498
|
+
header?: never;
|
|
16499
|
+
path: {
|
|
16500
|
+
/** @description The ID of the group. */
|
|
16501
|
+
group_id: string;
|
|
16502
|
+
};
|
|
16503
|
+
cookie?: never;
|
|
16504
|
+
};
|
|
16505
|
+
requestBody: {
|
|
16506
|
+
content: {
|
|
16507
|
+
"application/json": components["schemas"]["DeleteGroupRoleAssignmentsByCriteriaDto"];
|
|
16508
|
+
};
|
|
16509
|
+
};
|
|
16510
|
+
responses: {
|
|
16511
|
+
/** @description No Content */
|
|
16512
|
+
204: {
|
|
16513
|
+
headers: {
|
|
16514
|
+
[name: string]: unknown;
|
|
16515
|
+
};
|
|
16516
|
+
content?: never;
|
|
16517
|
+
};
|
|
16518
|
+
/** @description Forbidden */
|
|
16519
|
+
403: {
|
|
16520
|
+
headers: {
|
|
16521
|
+
[name: string]: unknown;
|
|
16522
|
+
};
|
|
16523
|
+
content: {
|
|
16524
|
+
"application/json": {
|
|
16525
|
+
/**
|
|
16526
|
+
* @description A human-readable description of the error.
|
|
16527
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16528
|
+
*/
|
|
16529
|
+
message: string;
|
|
16530
|
+
};
|
|
16531
|
+
};
|
|
16532
|
+
};
|
|
16533
|
+
/** @description Not Found */
|
|
16534
|
+
404: {
|
|
16535
|
+
headers: {
|
|
16536
|
+
[name: string]: unknown;
|
|
16537
|
+
};
|
|
16538
|
+
content: {
|
|
16539
|
+
"application/json": {
|
|
16540
|
+
/**
|
|
16541
|
+
* @description A human-readable description of the error.
|
|
16542
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16543
|
+
*/
|
|
16544
|
+
message: string;
|
|
16545
|
+
};
|
|
16546
|
+
};
|
|
16547
|
+
};
|
|
16548
|
+
/** @description Unprocessable Entity */
|
|
16549
|
+
422: {
|
|
16550
|
+
headers: {
|
|
16551
|
+
[name: string]: unknown;
|
|
16552
|
+
};
|
|
16553
|
+
content: {
|
|
16554
|
+
"application/json": {
|
|
16555
|
+
/**
|
|
16556
|
+
* @description A human-readable description of the error.
|
|
16557
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16558
|
+
*/
|
|
16559
|
+
message: string;
|
|
16560
|
+
};
|
|
16561
|
+
};
|
|
16562
|
+
};
|
|
16563
|
+
};
|
|
16564
|
+
};
|
|
16565
|
+
AuthorizationGroupRoleAssignmentsController_get: {
|
|
16566
|
+
parameters: {
|
|
16567
|
+
query?: never;
|
|
16568
|
+
header?: never;
|
|
16569
|
+
path: {
|
|
16570
|
+
/** @description The ID of the group. */
|
|
16571
|
+
group_id: string;
|
|
16572
|
+
/** @description The ID of the group role assignment. */
|
|
16573
|
+
role_assignment_id: string;
|
|
16574
|
+
};
|
|
16575
|
+
cookie?: never;
|
|
16576
|
+
};
|
|
16577
|
+
requestBody?: never;
|
|
16578
|
+
responses: {
|
|
16579
|
+
/** @description OK */
|
|
16580
|
+
200: {
|
|
16581
|
+
headers: {
|
|
16582
|
+
[name: string]: unknown;
|
|
16583
|
+
};
|
|
16584
|
+
content: {
|
|
16585
|
+
"application/json": components["schemas"]["GroupRoleAssignment"];
|
|
16586
|
+
};
|
|
16587
|
+
};
|
|
16588
|
+
/** @description Forbidden */
|
|
16589
|
+
403: {
|
|
16590
|
+
headers: {
|
|
16591
|
+
[name: string]: unknown;
|
|
16592
|
+
};
|
|
16593
|
+
content: {
|
|
16594
|
+
"application/json": {
|
|
16595
|
+
/**
|
|
16596
|
+
* @description A human-readable description of the error.
|
|
16597
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16598
|
+
*/
|
|
16599
|
+
message: string;
|
|
16600
|
+
};
|
|
16601
|
+
};
|
|
16602
|
+
};
|
|
16603
|
+
/** @description Not Found */
|
|
16604
|
+
404: {
|
|
16605
|
+
headers: {
|
|
16606
|
+
[name: string]: unknown;
|
|
16607
|
+
};
|
|
16608
|
+
content: {
|
|
16609
|
+
"application/json": {
|
|
16610
|
+
/**
|
|
16611
|
+
* @description A human-readable description of the error.
|
|
16612
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
16613
|
+
*/
|
|
16614
|
+
message: string;
|
|
16615
|
+
};
|
|
16616
|
+
};
|
|
16617
|
+
};
|
|
16618
|
+
};
|
|
16619
|
+
};
|
|
16620
|
+
AuthorizationGroupRoleAssignmentsController_removeGroupRoleAssignment: {
|
|
16621
|
+
parameters: {
|
|
16622
|
+
query?: never;
|
|
16623
|
+
header?: never;
|
|
16624
|
+
path: {
|
|
16625
|
+
/** @description The ID of the group. */
|
|
16626
|
+
group_id: string;
|
|
16627
|
+
/** @description The ID of the group role assignment to remove. */
|
|
16628
|
+
role_assignment_id: string;
|
|
16629
|
+
};
|
|
16630
|
+
cookie?: never;
|
|
16631
|
+
};
|
|
16632
|
+
requestBody?: never;
|
|
16633
|
+
responses: {
|
|
16634
|
+
/** @description No Content */
|
|
16635
|
+
204: {
|
|
16636
|
+
headers: {
|
|
16637
|
+
[name: string]: unknown;
|
|
16638
|
+
};
|
|
16639
|
+
content?: never;
|
|
16640
|
+
};
|
|
16641
|
+
/** @description Forbidden */
|
|
16642
|
+
403: {
|
|
15776
16643
|
headers: {
|
|
15777
16644
|
[name: string]: unknown;
|
|
15778
16645
|
};
|
|
@@ -15786,8 +16653,8 @@ export interface operations {
|
|
|
15786
16653
|
};
|
|
15787
16654
|
};
|
|
15788
16655
|
};
|
|
15789
|
-
/** @description
|
|
15790
|
-
|
|
16656
|
+
/** @description Not Found */
|
|
16657
|
+
404: {
|
|
15791
16658
|
headers: {
|
|
15792
16659
|
[name: string]: unknown;
|
|
15793
16660
|
};
|
|
@@ -18259,6 +19126,27 @@ export interface operations {
|
|
|
18259
19126
|
"application/json": components["schemas"]["AuthorizationResourceList"];
|
|
18260
19127
|
};
|
|
18261
19128
|
};
|
|
19129
|
+
/** @description Bad Request */
|
|
19130
|
+
400: {
|
|
19131
|
+
headers: {
|
|
19132
|
+
[name: string]: unknown;
|
|
19133
|
+
};
|
|
19134
|
+
content: {
|
|
19135
|
+
"application/json": {
|
|
19136
|
+
/**
|
|
19137
|
+
* @description The error code identifying the type of error.
|
|
19138
|
+
* @example missing_organization_id_or_resource_type_slug
|
|
19139
|
+
* @constant
|
|
19140
|
+
*/
|
|
19141
|
+
code: "missing_organization_id_or_resource_type_slug";
|
|
19142
|
+
/**
|
|
19143
|
+
* @description A human-readable description of the error.
|
|
19144
|
+
* @example Request could not be processed.
|
|
19145
|
+
*/
|
|
19146
|
+
message: string;
|
|
19147
|
+
};
|
|
19148
|
+
};
|
|
19149
|
+
};
|
|
18262
19150
|
/** @description Forbidden */
|
|
18263
19151
|
403: {
|
|
18264
19152
|
headers: {
|
|
@@ -19695,6 +20583,75 @@ export interface operations {
|
|
|
19695
20583
|
};
|
|
19696
20584
|
};
|
|
19697
20585
|
};
|
|
20586
|
+
ClientApiTokenController_issueClientApiToken: {
|
|
20587
|
+
parameters: {
|
|
20588
|
+
query?: never;
|
|
20589
|
+
header?: never;
|
|
20590
|
+
path?: never;
|
|
20591
|
+
cookie?: never;
|
|
20592
|
+
};
|
|
20593
|
+
requestBody: {
|
|
20594
|
+
content: {
|
|
20595
|
+
"application/json": components["schemas"]["ClientApiTokenDto"];
|
|
20596
|
+
};
|
|
20597
|
+
};
|
|
20598
|
+
responses: {
|
|
20599
|
+
/** @description Created */
|
|
20600
|
+
201: {
|
|
20601
|
+
headers: {
|
|
20602
|
+
[name: string]: unknown;
|
|
20603
|
+
};
|
|
20604
|
+
content: {
|
|
20605
|
+
"application/json": components["schemas"]["ClientApiTokenResponse"];
|
|
20606
|
+
};
|
|
20607
|
+
};
|
|
20608
|
+
/** @description Bad Request */
|
|
20609
|
+
400: {
|
|
20610
|
+
headers: {
|
|
20611
|
+
[name: string]: unknown;
|
|
20612
|
+
};
|
|
20613
|
+
content: {
|
|
20614
|
+
"application/json": {
|
|
20615
|
+
/**
|
|
20616
|
+
* @description A human-readable description of the error.
|
|
20617
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20618
|
+
*/
|
|
20619
|
+
message: string;
|
|
20620
|
+
};
|
|
20621
|
+
};
|
|
20622
|
+
};
|
|
20623
|
+
/** @description Not Found */
|
|
20624
|
+
404: {
|
|
20625
|
+
headers: {
|
|
20626
|
+
[name: string]: unknown;
|
|
20627
|
+
};
|
|
20628
|
+
content: {
|
|
20629
|
+
"application/json": {
|
|
20630
|
+
/**
|
|
20631
|
+
* @description A human-readable description of the error.
|
|
20632
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20633
|
+
*/
|
|
20634
|
+
message: string;
|
|
20635
|
+
};
|
|
20636
|
+
};
|
|
20637
|
+
};
|
|
20638
|
+
/** @description Unprocessable Entity */
|
|
20639
|
+
422: {
|
|
20640
|
+
headers: {
|
|
20641
|
+
[name: string]: unknown;
|
|
20642
|
+
};
|
|
20643
|
+
content: {
|
|
20644
|
+
"application/json": {
|
|
20645
|
+
/**
|
|
20646
|
+
* @description A human-readable description of the error.
|
|
20647
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20648
|
+
*/
|
|
20649
|
+
message: string;
|
|
20650
|
+
};
|
|
20651
|
+
};
|
|
20652
|
+
};
|
|
20653
|
+
};
|
|
20654
|
+
};
|
|
19698
20655
|
ApplicationsController_list: {
|
|
19699
20656
|
parameters: {
|
|
19700
20657
|
query?: {
|
|
@@ -22357,6 +23314,132 @@ export interface operations {
|
|
|
22357
23314
|
};
|
|
22358
23315
|
};
|
|
22359
23316
|
};
|
|
23317
|
+
ProviderController_listForOrganization: {
|
|
23318
|
+
parameters: {
|
|
23319
|
+
query?: never;
|
|
23320
|
+
header?: never;
|
|
23321
|
+
path: {
|
|
23322
|
+
/** @description An [Organization](/reference/organization) identifier to list provider configurations for. */
|
|
23323
|
+
organizationId: string;
|
|
23324
|
+
};
|
|
23325
|
+
cookie?: never;
|
|
23326
|
+
};
|
|
23327
|
+
requestBody?: never;
|
|
23328
|
+
responses: {
|
|
23329
|
+
/** @description A list of provider configurations for the organization. */
|
|
23330
|
+
200: {
|
|
23331
|
+
headers: {
|
|
23332
|
+
[name: string]: unknown;
|
|
23333
|
+
};
|
|
23334
|
+
content: {
|
|
23335
|
+
"application/json": components["schemas"]["DataIntegrationConfigurationListResponse"];
|
|
23336
|
+
};
|
|
23337
|
+
};
|
|
23338
|
+
/** @description The request is missing a valid API key. */
|
|
23339
|
+
401: {
|
|
23340
|
+
headers: {
|
|
23341
|
+
[name: string]: unknown;
|
|
23342
|
+
};
|
|
23343
|
+
content?: never;
|
|
23344
|
+
};
|
|
23345
|
+
/** @description The organization was not found. */
|
|
23346
|
+
404: {
|
|
23347
|
+
headers: {
|
|
23348
|
+
[name: string]: unknown;
|
|
23349
|
+
};
|
|
23350
|
+
content: {
|
|
23351
|
+
"application/json": {
|
|
23352
|
+
/**
|
|
23353
|
+
* @description A human-readable description of the error.
|
|
23354
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
23355
|
+
*/
|
|
23356
|
+
message: string;
|
|
23357
|
+
};
|
|
23358
|
+
};
|
|
23359
|
+
};
|
|
23360
|
+
};
|
|
23361
|
+
};
|
|
23362
|
+
ProviderController_configure: {
|
|
23363
|
+
parameters: {
|
|
23364
|
+
query?: never;
|
|
23365
|
+
header?: never;
|
|
23366
|
+
path: {
|
|
23367
|
+
/** @description An [Organization](/reference/organization) identifier to configure the provider for. */
|
|
23368
|
+
organizationId: string;
|
|
23369
|
+
/** @description The slug identifier of the provider to configure (e.g., `github`, `slack`, `notion`). */
|
|
23370
|
+
slug: string;
|
|
23371
|
+
};
|
|
23372
|
+
cookie?: never;
|
|
23373
|
+
};
|
|
23374
|
+
requestBody: {
|
|
23375
|
+
content: {
|
|
23376
|
+
"application/json": components["schemas"]["ConfigureDataIntegrationBody"];
|
|
23377
|
+
};
|
|
23378
|
+
};
|
|
23379
|
+
responses: {
|
|
23380
|
+
/** @description The provider configuration that was created or updated. */
|
|
23381
|
+
200: {
|
|
23382
|
+
headers: {
|
|
23383
|
+
[name: string]: unknown;
|
|
23384
|
+
};
|
|
23385
|
+
content: {
|
|
23386
|
+
"application/json": components["schemas"]["DataIntegrationConfigurationResponse"];
|
|
23387
|
+
};
|
|
23388
|
+
};
|
|
23389
|
+
/** @description The request body is invalid. Possible reasons: the body is empty (at least one of `enabled`, `scopes`, or `client_id` must be provided); `client_id` and `client_secret` are not provided together; or `client_id`/`client_secret` were supplied for a provider that does not support organization-managed credentials. */
|
|
23390
|
+
400: {
|
|
23391
|
+
headers: {
|
|
23392
|
+
[name: string]: unknown;
|
|
23393
|
+
};
|
|
23394
|
+
content: {
|
|
23395
|
+
"application/json": {
|
|
23396
|
+
/**
|
|
23397
|
+
* @description A human-readable description of the error.
|
|
23398
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
23399
|
+
*/
|
|
23400
|
+
message: string;
|
|
23401
|
+
};
|
|
23402
|
+
};
|
|
23403
|
+
};
|
|
23404
|
+
/** @description The request is missing a valid API key. */
|
|
23405
|
+
401: {
|
|
23406
|
+
headers: {
|
|
23407
|
+
[name: string]: unknown;
|
|
23408
|
+
};
|
|
23409
|
+
content?: never;
|
|
23410
|
+
};
|
|
23411
|
+
/** @description The organization or provider was not found. */
|
|
23412
|
+
404: {
|
|
23413
|
+
headers: {
|
|
23414
|
+
[name: string]: unknown;
|
|
23415
|
+
};
|
|
23416
|
+
content: {
|
|
23417
|
+
"application/json": {
|
|
23418
|
+
/**
|
|
23419
|
+
* @description A human-readable description of the error.
|
|
23420
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
23421
|
+
*/
|
|
23422
|
+
message: string;
|
|
23423
|
+
};
|
|
23424
|
+
};
|
|
23425
|
+
};
|
|
23426
|
+
/** @description One or more of the supplied `scopes` are not valid for the provider. Only scopes configured on the provider may be used. */
|
|
23427
|
+
422: {
|
|
23428
|
+
headers: {
|
|
23429
|
+
[name: string]: unknown;
|
|
23430
|
+
};
|
|
23431
|
+
content: {
|
|
23432
|
+
"application/json": {
|
|
23433
|
+
/**
|
|
23434
|
+
* @description A human-readable description of the error.
|
|
23435
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
23436
|
+
*/
|
|
23437
|
+
message: string;
|
|
23438
|
+
};
|
|
23439
|
+
};
|
|
23440
|
+
};
|
|
23441
|
+
};
|
|
23442
|
+
};
|
|
22360
23443
|
OrganizationFeatureFlagsController_list: {
|
|
22361
23444
|
parameters: {
|
|
22362
23445
|
query?: {
|
|
@@ -23726,10 +24809,10 @@ export interface operations {
|
|
|
23726
24809
|
*/
|
|
23727
24810
|
client_id: string;
|
|
23728
24811
|
/**
|
|
23729
|
-
* @description The client secret of the application.
|
|
24812
|
+
* @description The client secret of the application. May be omitted by public clients that authenticate through other means, such as a PKCE `code_verifier`.
|
|
23730
24813
|
* @example sk_test_....
|
|
23731
24814
|
*/
|
|
23732
|
-
client_secret
|
|
24815
|
+
client_secret?: string;
|
|
23733
24816
|
/** @constant */
|
|
23734
24817
|
grant_type: "authorization_code";
|
|
23735
24818
|
/**
|
|
@@ -23812,10 +24895,10 @@ export interface operations {
|
|
|
23812
24895
|
*/
|
|
23813
24896
|
client_id: string;
|
|
23814
24897
|
/**
|
|
23815
|
-
* @description The client secret of the application.
|
|
24898
|
+
* @description The client secret of the application. May be omitted by public clients that authenticate through other means, such as a PKCE `code_verifier`.
|
|
23816
24899
|
* @example sk_test_....
|
|
23817
24900
|
*/
|
|
23818
|
-
client_secret
|
|
24901
|
+
client_secret?: string;
|
|
23819
24902
|
/** @constant */
|
|
23820
24903
|
grant_type: "refresh_token";
|
|
23821
24904
|
/**
|
|
@@ -24902,29 +25985,7 @@ export interface operations {
|
|
|
24902
25985
|
[name: string]: unknown;
|
|
24903
25986
|
};
|
|
24904
25987
|
content: {
|
|
24905
|
-
"application/json":
|
|
24906
|
-
/**
|
|
24907
|
-
* @description Indicates this is a list response.
|
|
24908
|
-
* @constant
|
|
24909
|
-
*/
|
|
24910
|
-
object?: "list";
|
|
24911
|
-
/** @description Pagination cursors for navigating between pages of results. */
|
|
24912
|
-
list_metadata?: {
|
|
24913
|
-
/**
|
|
24914
|
-
* @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.
|
|
24915
|
-
* @example invitation_01HXYZ123456789ABCDEFGHIJ
|
|
24916
|
-
*/
|
|
24917
|
-
before: string | null;
|
|
24918
|
-
/**
|
|
24919
|
-
* @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.
|
|
24920
|
-
* @example invitation_01HXYZ987654321KJIHGFEDCBA
|
|
24921
|
-
*/
|
|
24922
|
-
after: string | null;
|
|
24923
|
-
};
|
|
24924
|
-
} & {
|
|
24925
|
-
/** @description The list of records for the current page. */
|
|
24926
|
-
data?: components["schemas"]["UserlandUserInvite"][];
|
|
24927
|
-
};
|
|
25988
|
+
"application/json": components["schemas"]["UserlandUserInviteList"];
|
|
24928
25989
|
};
|
|
24929
25990
|
};
|
|
24930
25991
|
/** @description Unprocessable Entity */
|
|
@@ -25790,29 +26851,7 @@ export interface operations {
|
|
|
25790
26851
|
[name: string]: unknown;
|
|
25791
26852
|
};
|
|
25792
26853
|
content: {
|
|
25793
|
-
"application/json":
|
|
25794
|
-
/**
|
|
25795
|
-
* @description Indicates this is a list response.
|
|
25796
|
-
* @constant
|
|
25797
|
-
*/
|
|
25798
|
-
object?: "list";
|
|
25799
|
-
/** @description Pagination cursors for navigating between pages of results. */
|
|
25800
|
-
list_metadata?: {
|
|
25801
|
-
/**
|
|
25802
|
-
* @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.
|
|
25803
|
-
* @example om_01HXYZ123456789ABCDEFGHIJ
|
|
25804
|
-
*/
|
|
25805
|
-
before: string | null;
|
|
25806
|
-
/**
|
|
25807
|
-
* @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.
|
|
25808
|
-
* @example om_01HXYZ987654321KJIHGFEDCBA
|
|
25809
|
-
*/
|
|
25810
|
-
after: string | null;
|
|
25811
|
-
};
|
|
25812
|
-
} & {
|
|
25813
|
-
/** @description The list of records for the current page. */
|
|
25814
|
-
data?: components["schemas"]["UserlandUserOrganizationMembership"][];
|
|
25815
|
-
};
|
|
26854
|
+
"application/json": components["schemas"]["UserlandUserOrganizationMembershipList"];
|
|
25816
26855
|
};
|
|
25817
26856
|
};
|
|
25818
26857
|
/** @description Bad Request */
|