@workos/openapi-spec 0.1.0 → 0.3.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.
Files changed (3) hide show
  1. package/open-api-spec.yaml +694 -608
  2. package/package.json +1 -1
  3. package/types.d.ts +285 -75
package/types.d.ts CHANGED
@@ -541,6 +541,26 @@ export interface paths {
541
541
  patch?: never;
542
542
  trace?: never;
543
543
  };
544
+ "/authorization/organizations/{organization_id}/resources/{resource_type_slug}/{external_id}/role_assignments": {
545
+ parameters: {
546
+ query?: never;
547
+ header?: never;
548
+ path?: never;
549
+ cookie?: never;
550
+ };
551
+ /**
552
+ * List role assignments for a resource by external ID
553
+ * @description List all role assignments granted on a resource, identified by its external ID. Each assignment includes the organization membership it was granted to.
554
+ */
555
+ get: operations["AuthorizationRoleAssignmentsController_listRoleAssignmentsForResourceByExternalId"];
556
+ put?: never;
557
+ post?: never;
558
+ delete?: never;
559
+ options?: never;
560
+ head?: never;
561
+ patch?: never;
562
+ trace?: never;
563
+ };
544
564
  "/authorization/permissions": {
545
565
  parameters: {
546
566
  query?: never;
@@ -665,6 +685,26 @@ export interface paths {
665
685
  patch?: never;
666
686
  trace?: never;
667
687
  };
688
+ "/authorization/resources/{resource_id}/role_assignments": {
689
+ parameters: {
690
+ query?: never;
691
+ header?: never;
692
+ path?: never;
693
+ cookie?: never;
694
+ };
695
+ /**
696
+ * List role assignments for a resource
697
+ * @description List all role assignments granted on a specific resource instance. Each assignment includes the organization membership it was granted to.
698
+ */
699
+ get: operations["AuthorizationRoleAssignmentsController_listRoleAssignmentsForResource"];
700
+ put?: never;
701
+ post?: never;
702
+ delete?: never;
703
+ options?: never;
704
+ head?: never;
705
+ patch?: never;
706
+ trace?: never;
707
+ };
668
708
  "/authorization/roles": {
669
709
  parameters: {
670
710
  query?: never;
@@ -1704,7 +1744,7 @@ export interface paths {
1704
1744
  * Authenticate
1705
1745
  * @description Authenticate a user with a specified [authentication method](/reference/authkit/authentication).
1706
1746
  */
1707
- post: operations["UserlandSessionsController_authenticate"];
1747
+ post: operations["UserlandSessionsController_authenticate[0]"];
1708
1748
  delete?: never;
1709
1749
  options?: never;
1710
1750
  head?: never;
@@ -2136,7 +2176,7 @@ export interface paths {
2136
2176
  * Reset the password
2137
2177
  * @description Sets a new password using the `token` query parameter from the link that the user received. Successfully resetting the password will verify a user's email, if it hasn't been verified yet.
2138
2178
  */
2139
- post: operations["UserlandUsersController_resetPassword"];
2179
+ post: operations["UserlandUsersController_resetPassword[0]"];
2140
2180
  delete?: never;
2141
2181
  options?: never;
2142
2182
  head?: never;
@@ -2234,13 +2274,13 @@ export interface paths {
2234
2274
  * List users
2235
2275
  * @description Get a list of all of your existing users matching the criteria specified.
2236
2276
  */
2237
- get: operations["UserlandUsersController_list"];
2277
+ get: operations["UserlandUsersController_list[0]"];
2238
2278
  put?: never;
2239
2279
  /**
2240
2280
  * Create a user
2241
2281
  * @description Create a new user in the current environment.
2242
2282
  */
2243
- post: operations["UserlandUsersController_create"];
2283
+ post: operations["UserlandUsersController_create[0]"];
2244
2284
  delete?: never;
2245
2285
  options?: never;
2246
2286
  head?: never;
@@ -2278,18 +2318,18 @@ export interface paths {
2278
2318
  * Get a user
2279
2319
  * @description Get the details of an existing user.
2280
2320
  */
2281
- get: operations["UserlandUsersController_get"];
2321
+ get: operations["UserlandUsersController_get[0]"];
2282
2322
  /**
2283
2323
  * Update a user
2284
2324
  * @description Updates properties of a user. The omitted properties will be left unchanged.
2285
2325
  */
2286
- put: operations["UserlandUsersController_update"];
2326
+ put: operations["UserlandUsersController_update[0]"];
2287
2327
  post?: never;
2288
2328
  /**
2289
2329
  * Delete a user
2290
2330
  * @description Permanently deletes a user in the current environment. It cannot be undone.
2291
2331
  */
2292
- delete: operations["UserlandUsersController_delete"];
2332
+ delete: operations["UserlandUsersController_delete[0]"];
2293
2333
  options?: never;
2294
2334
  head?: never;
2295
2335
  patch?: never;
@@ -2348,7 +2388,7 @@ export interface paths {
2348
2388
  * Verify email
2349
2389
  * @description Verifies an email address using the one-time code received by the user.
2350
2390
  */
2351
- post: operations["UserlandUsersController_emailVerification"];
2391
+ post: operations["UserlandUsersController_emailVerification[0]"];
2352
2392
  delete?: never;
2353
2393
  options?: never;
2354
2394
  head?: never;
@@ -2368,7 +2408,7 @@ export interface paths {
2368
2408
  * Send verification email
2369
2409
  * @description Sends an email that contains a one-time code used to verify a user’s email address.
2370
2410
  */
2371
- post: operations["UserlandUsersController_sendVerificationEmail"];
2411
+ post: operations["UserlandUsersController_sendVerificationEmail[0]"];
2372
2412
  delete?: never;
2373
2413
  options?: never;
2374
2414
  head?: never;
@@ -2554,13 +2594,13 @@ export interface paths {
2554
2594
  * List authentication factors
2555
2595
  * @description Lists the [authentication factors](/reference/authkit/mfa/authentication-factor) for a user.
2556
2596
  */
2557
- get: operations["UserlandUserAuthenticationFactorsController_list"];
2597
+ get: operations["UserlandUserAuthenticationFactorsController_list[0]"];
2558
2598
  put?: never;
2559
2599
  /**
2560
2600
  * Enroll an authentication factor
2561
2601
  * @description Enrolls a user in a new [authentication factor](/reference/authkit/mfa/authentication-factor).
2562
2602
  */
2563
- post: operations["UserlandUserAuthenticationFactorsController_create"];
2603
+ post: operations["UserlandUserAuthenticationFactorsController_create[0]"];
2564
2604
  delete?: never;
2565
2605
  options?: never;
2566
2606
  head?: never;
@@ -2727,6 +2767,12 @@ export interface components {
2727
2767
  */
2728
2768
  value: string;
2729
2769
  };
2770
+ /**
2771
+ * @default desc
2772
+ * @example desc
2773
+ * @enum {string}
2774
+ */
2775
+ PaginationOrder: "normal" | "desc" | "asc";
2730
2776
  RedirectUriDto: {
2731
2777
  /**
2732
2778
  * @description The redirect URI.
@@ -3601,6 +3647,7 @@ export interface components {
3601
3647
  };
3602
3648
  CreateUserlandMagicCodeAndReturnDto: {
3603
3649
  /**
3650
+ * Format: email
3604
3651
  * @description The email address to send the magic code to.
3605
3652
  * @example marcelina.davis@example.com
3606
3653
  */
@@ -3613,6 +3660,7 @@ export interface components {
3613
3660
  };
3614
3661
  CreateUserlandUserInviteOptionsDto: {
3615
3662
  /**
3663
+ * Format: email
3616
3664
  * @description The email address of the recipient.
3617
3665
  * @example marcelina.davis@example.com
3618
3666
  */
@@ -3715,6 +3763,7 @@ export interface components {
3715
3763
  };
3716
3764
  CreateUserlandUserDto: {
3717
3765
  /**
3766
+ * Format: email
3718
3767
  * @description The email address of the user.
3719
3768
  * @example marcelina.davis@example.com
3720
3769
  */
@@ -3769,6 +3818,7 @@ export interface components {
3769
3818
  });
3770
3819
  UpdateUserlandUserDto: {
3771
3820
  /**
3821
+ * Format: email
3772
3822
  * @description The email address of the user.
3773
3823
  * @example marcelina.davis@example.com
3774
3824
  */
@@ -3835,6 +3885,7 @@ export interface components {
3835
3885
  };
3836
3886
  CreatePasswordResetTokenDto: {
3837
3887
  /**
3888
+ * Format: email
3838
3889
  * @description The email address of the user requesting a password reset.
3839
3890
  * @example marcelina.davis@example.com
3840
3891
  */
@@ -4788,7 +4839,7 @@ export interface components {
4788
4839
  */
4789
4840
  slug: string;
4790
4841
  };
4791
- RoleAssignment: {
4842
+ UserRoleAssignment: {
4792
4843
  /**
4793
4844
  * @description Distinguishes the role assignment object.
4794
4845
  * @constant
@@ -4799,9 +4850,14 @@ export interface components {
4799
4850
  * @example role_assignment_01HXYZ123456789ABCDEFGH
4800
4851
  */
4801
4852
  id: string;
4853
+ /**
4854
+ * @description The ID of the organization membership the role is assigned to.
4855
+ * @example om_01HXYZ123456789ABCDEFGHIJ
4856
+ */
4857
+ organization_membership_id: string;
4802
4858
  /** @description The role included in the assignment. */
4803
4859
  role: components["schemas"]["SlimRole"];
4804
- /** @description The resource to which the role is assigned. */
4860
+ /** @description The resource the role is assigned on. */
4805
4861
  resource: {
4806
4862
  /**
4807
4863
  * @description The unique ID of the Resource.
@@ -4832,14 +4888,14 @@ export interface components {
4832
4888
  */
4833
4889
  updated_at: string;
4834
4890
  };
4835
- RoleAssignmentList: {
4891
+ UserRoleAssignmentList: {
4836
4892
  /**
4837
4893
  * @description Indicates this is a list response.
4838
4894
  * @constant
4839
4895
  */
4840
4896
  object: "list";
4841
4897
  /** @description The list of records for the current page. */
4842
- data: components["schemas"]["RoleAssignment"][];
4898
+ data: components["schemas"]["UserRoleAssignment"][];
4843
4899
  /** @description Pagination cursors for navigating between pages of results. */
4844
4900
  list_metadata: {
4845
4901
  /**
@@ -5847,6 +5903,12 @@ export interface components {
5847
5903
  */
5848
5904
  updated_at: string;
5849
5905
  };
5906
+ /**
5907
+ * @description The external key provider used for BYOK.
5908
+ * @example AWS_KMS
5909
+ * @enum {string}
5910
+ */
5911
+ VaultByokKeyProvider: "AWS_KMS" | "GCP_KMS" | "AZURE_KEY_VAULT";
5850
5912
  WaitlistUser: {
5851
5913
  /**
5852
5914
  * @description Distinguishes the Waitlist User object.
@@ -11488,12 +11550,7 @@ export interface components {
11488
11550
  * @example org_01EHT88Z8J8795GZNQ4ZP1J81T
11489
11551
  */
11490
11552
  organization_id: string;
11491
- /**
11492
- * @description The external key provider used for BYOK.
11493
- * @example AWS_KMS
11494
- * @enum {string}
11495
- */
11496
- key_provider: "AWS_KMS" | "GCP_KMS" | "AZURE_KEY_VAULT";
11553
+ key_provider: components["schemas"]["VaultByokKeyProvider"];
11497
11554
  };
11498
11555
  /**
11499
11556
  * Format: date-time
@@ -11522,12 +11579,7 @@ export interface components {
11522
11579
  * @example org_01EHT88Z8J8795GZNQ4ZP1J81T
11523
11580
  */
11524
11581
  organization_id: string;
11525
- /**
11526
- * @description The external key provider used for BYOK.
11527
- * @example AWS_KMS
11528
- * @enum {string}
11529
- */
11530
- key_provider: "AWS_KMS" | "GCP_KMS" | "AZURE_KEY_VAULT";
11582
+ key_provider: components["schemas"]["VaultByokKeyProvider"];
11531
11583
  /**
11532
11584
  * @description Whether the BYOK key verification completed successfully.
11533
11585
  * @example true
@@ -13913,7 +13965,7 @@ export interface operations {
13913
13965
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
13914
13966
  limit?: number;
13915
13967
  /** @description Order the results by the creation time. */
13916
- order?: "normal" | "desc" | "asc";
13968
+ order?: components["schemas"]["PaginationOrder"];
13917
13969
  };
13918
13970
  header?: never;
13919
13971
  path?: never;
@@ -13994,7 +14046,7 @@ export interface operations {
13994
14046
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
13995
14047
  limit?: number;
13996
14048
  /** @description Order the results by the creation time. */
13997
- order?: "normal" | "desc" | "asc";
14049
+ order?: components["schemas"]["PaginationOrder"];
13998
14050
  };
13999
14051
  header?: never;
14000
14052
  path: {
@@ -14897,7 +14949,7 @@ export interface operations {
14897
14949
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
14898
14950
  limit?: number;
14899
14951
  /** @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). Defaults to descending. */
14900
- order?: "normal" | "desc" | "asc";
14952
+ order?: components["schemas"]["PaginationOrder"];
14901
14953
  /** @description The permission slug to filter by. Only child resources where the organization membership has this permission are returned. */
14902
14954
  permission_slug: string;
14903
14955
  /** @description The WorkOS ID of the parent resource. Provide this or both `parent_resource_external_id` and `parent_resource_type_slug`, but not both. Mutually exclusive with `parent_resource_type_slug` and `parent_resource_external_id`. */
@@ -15003,7 +15055,7 @@ export interface operations {
15003
15055
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
15004
15056
  limit?: number;
15005
15057
  /** @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). Defaults to descending. */
15006
- order?: "normal" | "desc" | "asc";
15058
+ order?: components["schemas"]["PaginationOrder"];
15007
15059
  };
15008
15060
  header?: never;
15009
15061
  path: {
@@ -15082,7 +15134,7 @@ export interface operations {
15082
15134
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
15083
15135
  limit?: number;
15084
15136
  /** @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). Defaults to descending. */
15085
- order?: "normal" | "desc" | "asc";
15137
+ order?: components["schemas"]["PaginationOrder"];
15086
15138
  };
15087
15139
  header?: never;
15088
15140
  path: {
@@ -15163,7 +15215,13 @@ export interface operations {
15163
15215
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
15164
15216
  limit?: number;
15165
15217
  /** @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). Defaults to descending. */
15166
- order?: "normal" | "desc" | "asc";
15218
+ order?: components["schemas"]["PaginationOrder"];
15219
+ /** @description Filter assignments by the ID of the resource. */
15220
+ resource_id?: string;
15221
+ /** @description Filter assignments by the external ID of the resource. */
15222
+ resource_external_id?: string;
15223
+ /** @description Filter assignments by the slug of the resource type. */
15224
+ resource_type_slug?: string;
15167
15225
  };
15168
15226
  header?: never;
15169
15227
  path: {
@@ -15180,7 +15238,7 @@ export interface operations {
15180
15238
  [name: string]: unknown;
15181
15239
  };
15182
15240
  content: {
15183
- "application/json": components["schemas"]["RoleAssignmentList"];
15241
+ "application/json": components["schemas"]["UserRoleAssignmentList"];
15184
15242
  };
15185
15243
  };
15186
15244
  /** @description Forbidden */
@@ -15241,6 +15299,7 @@ export interface operations {
15241
15299
  * @example {
15242
15300
  * "object": "role_assignment",
15243
15301
  * "id": "role_assignment_01HXYZ123456789ABCDEFGH",
15302
+ * "organization_membership_id": "om_01HXYZ123456789ABCDEFGHIJ",
15244
15303
  * "role": {
15245
15304
  * "slug": "editor"
15246
15305
  * },
@@ -15253,7 +15312,7 @@ export interface operations {
15253
15312
  * "updated_at": "2026-01-15T12:00:00.000Z"
15254
15313
  * }
15255
15314
  */
15256
- "application/json": components["schemas"]["RoleAssignment"];
15315
+ "application/json": components["schemas"]["UserRoleAssignment"];
15257
15316
  };
15258
15317
  };
15259
15318
  /** @description Forbidden */
@@ -16713,7 +16772,7 @@ export interface operations {
16713
16772
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
16714
16773
  limit?: number;
16715
16774
  /** @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). Defaults to descending. */
16716
- order?: "normal" | "desc" | "asc";
16775
+ order?: components["schemas"]["PaginationOrder"];
16717
16776
  /** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
16718
16777
  permission_slug: string;
16719
16778
  /** @description Filter by assignment type. Use "direct" for direct assignments only, or "indirect" to include inherited assignments. */
@@ -16809,6 +16868,74 @@ export interface operations {
16809
16868
  };
16810
16869
  };
16811
16870
  };
16871
+ AuthorizationRoleAssignmentsController_listRoleAssignmentsForResourceByExternalId: {
16872
+ parameters: {
16873
+ query?: {
16874
+ /** @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"`. */
16875
+ before?: string;
16876
+ /** @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"`. */
16877
+ after?: string;
16878
+ /** @description Upper limit on the number of objects to return, between `1` and `100`. */
16879
+ limit?: number;
16880
+ /** @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). Defaults to descending. */
16881
+ order?: components["schemas"]["PaginationOrder"];
16882
+ /** @description Filter assignments by the slug of the role. */
16883
+ role_slug?: string;
16884
+ };
16885
+ header?: never;
16886
+ path: {
16887
+ /** @description The ID of the organization that owns the resource. */
16888
+ organization_id: string;
16889
+ /** @description The slug of the resource type. */
16890
+ resource_type_slug: string;
16891
+ /** @description An identifier you provide to reference the resource in your system. */
16892
+ external_id: string;
16893
+ };
16894
+ cookie?: never;
16895
+ };
16896
+ requestBody?: never;
16897
+ responses: {
16898
+ /** @description OK */
16899
+ 200: {
16900
+ headers: {
16901
+ [name: string]: unknown;
16902
+ };
16903
+ content: {
16904
+ "application/json": components["schemas"]["UserRoleAssignmentList"];
16905
+ };
16906
+ };
16907
+ /** @description Forbidden */
16908
+ 403: {
16909
+ headers: {
16910
+ [name: string]: unknown;
16911
+ };
16912
+ content: {
16913
+ "application/json": {
16914
+ /**
16915
+ * @description A human-readable description of the error.
16916
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
16917
+ */
16918
+ message: string;
16919
+ };
16920
+ };
16921
+ };
16922
+ /** @description Not Found */
16923
+ 404: {
16924
+ headers: {
16925
+ [name: string]: unknown;
16926
+ };
16927
+ content: {
16928
+ "application/json": {
16929
+ /**
16930
+ * @description A human-readable description of the error.
16931
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
16932
+ */
16933
+ message: string;
16934
+ };
16935
+ };
16936
+ };
16937
+ };
16938
+ };
16812
16939
  AuthorizationPermissionsController_list: {
16813
16940
  parameters: {
16814
16941
  query?: {
@@ -16819,7 +16946,7 @@ export interface operations {
16819
16946
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
16820
16947
  limit?: number;
16821
16948
  /** @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). Defaults to descending. */
16822
- order?: "normal" | "desc" | "asc";
16949
+ order?: components["schemas"]["PaginationOrder"];
16823
16950
  };
16824
16951
  header?: never;
16825
16952
  path?: never;
@@ -17167,7 +17294,7 @@ export interface operations {
17167
17294
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
17168
17295
  limit?: number;
17169
17296
  /** @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). Defaults to descending. */
17170
- order?: "normal" | "desc" | "asc";
17297
+ order?: components["schemas"]["PaginationOrder"];
17171
17298
  /** @description Filter resources by organization ID. */
17172
17299
  organization_id?: string;
17173
17300
  /** @description Filter resources by resource type slug. */
@@ -17180,8 +17307,6 @@ export interface operations {
17180
17307
  parent_resource_type_slug?: string;
17181
17308
  /** @description Filter resources by parent external ID. Required with `parent_resource_type_slug`. Mutually exclusive with `parent_resource_id`. */
17182
17309
  parent_external_id?: string;
17183
- /** @description Search resources by name. */
17184
- search?: string;
17185
17310
  };
17186
17311
  header?: never;
17187
17312
  path?: never;
@@ -17768,7 +17893,7 @@ export interface operations {
17768
17893
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
17769
17894
  limit?: number;
17770
17895
  /** @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). Defaults to descending. */
17771
- order?: "normal" | "desc" | "asc";
17896
+ order?: components["schemas"]["PaginationOrder"];
17772
17897
  /** @description The permission slug to filter by. Only users with this permission on the resource are returned. */
17773
17898
  permission_slug: string;
17774
17899
  /** @description Filter by assignment type. Use `direct` for direct assignments only, or `indirect` to include inherited assignments. */
@@ -17860,6 +17985,70 @@ export interface operations {
17860
17985
  };
17861
17986
  };
17862
17987
  };
17988
+ AuthorizationRoleAssignmentsController_listRoleAssignmentsForResource: {
17989
+ parameters: {
17990
+ query?: {
17991
+ /** @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"`. */
17992
+ before?: string;
17993
+ /** @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"`. */
17994
+ after?: string;
17995
+ /** @description Upper limit on the number of objects to return, between `1` and `100`. */
17996
+ limit?: number;
17997
+ /** @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). Defaults to descending. */
17998
+ order?: components["schemas"]["PaginationOrder"];
17999
+ /** @description Filter assignments by the slug of the role. */
18000
+ role_slug?: string;
18001
+ };
18002
+ header?: never;
18003
+ path: {
18004
+ /** @description The ID of the authorization resource. */
18005
+ resource_id: string;
18006
+ };
18007
+ cookie?: never;
18008
+ };
18009
+ requestBody?: never;
18010
+ responses: {
18011
+ /** @description OK */
18012
+ 200: {
18013
+ headers: {
18014
+ [name: string]: unknown;
18015
+ };
18016
+ content: {
18017
+ "application/json": components["schemas"]["UserRoleAssignmentList"];
18018
+ };
18019
+ };
18020
+ /** @description Forbidden */
18021
+ 403: {
18022
+ headers: {
18023
+ [name: string]: unknown;
18024
+ };
18025
+ content: {
18026
+ "application/json": {
18027
+ /**
18028
+ * @description A human-readable description of the error.
18029
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
18030
+ */
18031
+ message: string;
18032
+ };
18033
+ };
18034
+ };
18035
+ /** @description Not Found */
18036
+ 404: {
18037
+ headers: {
18038
+ [name: string]: unknown;
18039
+ };
18040
+ content: {
18041
+ "application/json": {
18042
+ /**
18043
+ * @description A human-readable description of the error.
18044
+ * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
18045
+ */
18046
+ message: string;
18047
+ };
18048
+ };
18049
+ };
18050
+ };
18051
+ };
17863
18052
  AuthorizationRolesController_list: {
17864
18053
  parameters: {
17865
18054
  query?: never;
@@ -18580,7 +18769,7 @@ export interface operations {
18580
18769
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
18581
18770
  limit?: number;
18582
18771
  /** @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). Defaults to descending. */
18583
- order?: "normal" | "desc" | "asc";
18772
+ order?: components["schemas"]["PaginationOrder"];
18584
18773
  /** @description Filter Connect Applications by organization ID. */
18585
18774
  organization_id?: string;
18586
18775
  };
@@ -18975,7 +19164,7 @@ export interface operations {
18975
19164
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
18976
19165
  limit?: number;
18977
19166
  /** @description Order the results by the creation time. */
18978
- order?: "normal" | "desc" | "asc";
19167
+ order?: components["schemas"]["PaginationOrder"];
18979
19168
  /** @description Filter Connections by their type. */
18980
19169
  connection_type?: "ADFSSAML" | "AdpOidc" | "AppleOAuth" | "Auth0SAML" | "AzureSAML" | "BitbucketOAuth" | "CasSAML" | "CloudflareSAML" | "ClassLinkSAML" | "CleverOIDC" | "CyberArkSAML" | "DiscordOAuth" | "DuoSAML" | "EntraIdOIDC" | "GenericOIDC" | "GenericSAML" | "GithubOAuth" | "GitLabOAuth" | "GoogleOAuth" | "GoogleOIDC" | "GoogleSAML" | "IntuitOAuth" | "JumpCloudSAML" | "KeycloakSAML" | "LastPassSAML" | "LinkedInOAuth" | "LoginGovOidc" | "MagicLink" | "MicrosoftOAuth" | "MiniOrangeSAML" | "NetIqSAML" | "OktaOIDC" | "OktaSAML" | "OneLoginSAML" | "OracleSAML" | "PingFederateSAML" | "PingOneSAML" | "RipplingSAML" | "SalesforceSAML" | "ShibbolethGenericSAML" | "ShibbolethSAML" | "SimpleSamlPhpSAML" | "SalesforceOAuth" | "SlackOAuth" | "VercelMarketplaceOAuth" | "VercelOAuth" | "VMwareSAML" | "XeroOAuth";
18981
19170
  /** @description Filter Connections by their associated domain. */
@@ -19324,7 +19513,7 @@ export interface operations {
19324
19513
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
19325
19514
  limit?: number;
19326
19515
  /** @description Order the results by the creation time. */
19327
- order?: "normal" | "desc" | "asc";
19516
+ order?: components["schemas"]["PaginationOrder"];
19328
19517
  /** @description Filter Directories by their associated organization. */
19329
19518
  organization_id?: string;
19330
19519
  /** @description Searchable text to match against Directory names. */
@@ -19489,7 +19678,7 @@ export interface operations {
19489
19678
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
19490
19679
  limit?: number;
19491
19680
  /** @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). Defaults to descending. */
19492
- order?: "normal" | "desc" | "asc";
19681
+ order?: components["schemas"]["PaginationOrder"];
19493
19682
  /** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
19494
19683
  directory?: string;
19495
19684
  /** @description Unique identifier of the WorkOS Directory User. This value can be obtained from the WorkOS API. */
@@ -19620,7 +19809,7 @@ export interface operations {
19620
19809
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
19621
19810
  limit?: number;
19622
19811
  /** @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). Defaults to descending. */
19623
- order?: "normal" | "desc" | "asc";
19812
+ order?: components["schemas"]["PaginationOrder"];
19624
19813
  /** @description Unique identifier of the WorkOS Directory. This value can be obtained from the WorkOS dashboard or from the WorkOS API. */
19625
19814
  directory?: string;
19626
19815
  /** @description Unique identifier of the WorkOS Directory Group. This value can be obtained from the WorkOS API. */
@@ -19759,7 +19948,7 @@ export interface operations {
19759
19948
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
19760
19949
  limit?: number;
19761
19950
  /** @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). Defaults to descending. */
19762
- order?: "normal" | "desc" | "asc";
19951
+ order?: components["schemas"]["PaginationOrder"];
19763
19952
  /** @description Filter events by one or more event types (e.g. `dsync.user.created`). */
19764
19953
  events?: string[];
19765
19954
  /** @description ISO-8601 date string to filter events created after this date. */
@@ -19839,7 +20028,7 @@ export interface operations {
19839
20028
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
19840
20029
  limit?: number;
19841
20030
  /** @description Order the results by the creation time. */
19842
- order?: "normal" | "desc" | "asc";
20031
+ order?: components["schemas"]["PaginationOrder"];
19843
20032
  };
19844
20033
  header?: never;
19845
20034
  path?: never;
@@ -20550,7 +20739,7 @@ export interface operations {
20550
20739
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
20551
20740
  limit?: number;
20552
20741
  /** @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). Defaults to descending. */
20553
- order?: "normal" | "desc" | "asc";
20742
+ order?: components["schemas"]["PaginationOrder"];
20554
20743
  /** @description The domains of an Organization. Any Organization with a matching domain will be returned. */
20555
20744
  domains?: string[];
20556
20745
  /** @description Searchable text for an Organization. Matches against the organization name. */
@@ -21124,7 +21313,7 @@ export interface operations {
21124
21313
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
21125
21314
  limit?: number;
21126
21315
  /** @description Order the results by the creation time. */
21127
- order?: "normal" | "desc" | "asc";
21316
+ order?: components["schemas"]["PaginationOrder"];
21128
21317
  };
21129
21318
  header?: never;
21130
21319
  path: {
@@ -21241,7 +21430,7 @@ export interface operations {
21241
21430
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
21242
21431
  limit?: number;
21243
21432
  /** @description Order the results by the creation time. */
21244
- order?: "normal" | "desc" | "asc";
21433
+ order?: components["schemas"]["PaginationOrder"];
21245
21434
  };
21246
21435
  header?: never;
21247
21436
  path: {
@@ -21288,7 +21477,7 @@ export interface operations {
21288
21477
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
21289
21478
  limit?: number;
21290
21479
  /** @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). Defaults to descending. */
21291
- order?: "normal" | "desc" | "asc";
21480
+ order?: components["schemas"]["PaginationOrder"];
21292
21481
  };
21293
21482
  header?: never;
21294
21483
  path: {
@@ -21646,7 +21835,7 @@ export interface operations {
21646
21835
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
21647
21836
  limit?: number;
21648
21837
  /** @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). Defaults to descending. */
21649
- order?: "normal" | "desc" | "asc";
21838
+ order?: components["schemas"]["PaginationOrder"];
21650
21839
  };
21651
21840
  header?: never;
21652
21841
  path: {
@@ -21727,6 +21916,27 @@ export interface operations {
21727
21916
  "application/json": components["schemas"]["Group"];
21728
21917
  };
21729
21918
  };
21919
+ /** @description Bad Request */
21920
+ 400: {
21921
+ headers: {
21922
+ [name: string]: unknown;
21923
+ };
21924
+ content: {
21925
+ "application/json": {
21926
+ /**
21927
+ * @description The error code identifying the type of error.
21928
+ * @example group_membership_limit_exceeded
21929
+ * @constant
21930
+ */
21931
+ code: "group_membership_limit_exceeded";
21932
+ /**
21933
+ * @description A human-readable description of the error.
21934
+ * @example Request could not be processed.
21935
+ */
21936
+ message: string;
21937
+ };
21938
+ };
21939
+ };
21730
21940
  /** @description Forbidden */
21731
21941
  403: {
21732
21942
  headers: {
@@ -22228,7 +22438,7 @@ export interface operations {
22228
22438
  organization?: string;
22229
22439
  /** @description Can be used to pre-fill the domain field when initiating authentication with Microsoft OAuth or with a Google SAML connection type. */
22230
22440
  domain_hint?: string;
22231
- /** @description Can be used to pre-fill the username/email address field of the IdP sign-in page for the user, if you know their username ahead of time. Currently supported for OAuth, OpenID Connect, Okta, and Entra ID connections. */
22441
+ /** @description Can be used to pre-fill the username/email address field of the IdP sign-in page for the user, if you know their username ahead of time. Currently supported for OAuth, OpenID Connect, Okta, Entra ID, and custom SAML connections. */
22232
22442
  login_hint?: string;
22233
22443
  /** @description A random string generated by the client that is used to mitigate replay attacks. */
22234
22444
  nonce?: string;
@@ -22573,7 +22783,7 @@ export interface operations {
22573
22783
  };
22574
22784
  };
22575
22785
  };
22576
- UserlandSessionsController_authenticate: {
22786
+ "UserlandSessionsController_authenticate[0]": {
22577
22787
  parameters: {
22578
22788
  query?: never;
22579
22789
  header?: never;
@@ -23747,7 +23957,7 @@ export interface operations {
23747
23957
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
23748
23958
  limit?: number;
23749
23959
  /** @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). Defaults to descending. */
23750
- order?: "normal" | "desc" | "asc";
23960
+ order?: components["schemas"]["PaginationOrder"];
23751
23961
  /** @description The ID of the [organization](/reference/organization) that the recipient will join. */
23752
23962
  organization_id?: string;
23753
23963
  /** @description The email address of the recipient. */
@@ -24633,7 +24843,7 @@ export interface operations {
24633
24843
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
24634
24844
  limit?: number;
24635
24845
  /** @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). Defaults to descending. */
24636
- order?: "normal" | "desc" | "asc";
24846
+ order?: components["schemas"]["PaginationOrder"];
24637
24847
  /** @description The ID of the [organization](/reference/organization) which the user belongs to. */
24638
24848
  organization_id?: string;
24639
24849
  /** @description Filter by the status of the organization membership. Array including any of `active`, `inactive`, or `pending`. */
@@ -25341,7 +25551,7 @@ export interface operations {
25341
25551
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
25342
25552
  limit?: number;
25343
25553
  /** @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). Defaults to descending. */
25344
- order?: "normal" | "desc" | "asc";
25554
+ order?: components["schemas"]["PaginationOrder"];
25345
25555
  };
25346
25556
  header?: never;
25347
25557
  path: {
@@ -25491,7 +25701,7 @@ export interface operations {
25491
25701
  };
25492
25702
  };
25493
25703
  };
25494
- UserlandUsersController_resetPassword: {
25704
+ "UserlandUsersController_resetPassword[0]": {
25495
25705
  parameters: {
25496
25706
  query?: never;
25497
25707
  header?: never;
@@ -25821,7 +26031,7 @@ export interface operations {
25821
26031
  };
25822
26032
  };
25823
26033
  };
25824
- UserlandUsersController_list: {
26034
+ "UserlandUsersController_list[0]": {
25825
26035
  parameters: {
25826
26036
  query?: {
25827
26037
  /** @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"`. */
@@ -25831,7 +26041,7 @@ export interface operations {
25831
26041
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
25832
26042
  limit?: number;
25833
26043
  /** @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). Defaults to descending. */
25834
- order?: "normal" | "desc" | "asc";
26044
+ order?: components["schemas"]["PaginationOrder"];
25835
26045
  /**
25836
26046
  * @deprecated
25837
26047
  * @description Filter users by the organization they are a member of. Deprecated in favor of `organization_id`.
@@ -25874,7 +26084,7 @@ export interface operations {
25874
26084
  };
25875
26085
  };
25876
26086
  };
25877
- UserlandUsersController_create: {
26087
+ "UserlandUsersController_create[0]": {
25878
26088
  parameters: {
25879
26089
  query?: never;
25880
26090
  header?: never;
@@ -26079,7 +26289,7 @@ export interface operations {
26079
26289
  };
26080
26290
  };
26081
26291
  };
26082
- UserlandUsersController_get: {
26292
+ "UserlandUsersController_get[0]": {
26083
26293
  parameters: {
26084
26294
  query?: never;
26085
26295
  header?: never;
@@ -26117,7 +26327,7 @@ export interface operations {
26117
26327
  };
26118
26328
  };
26119
26329
  };
26120
- UserlandUsersController_update: {
26330
+ "UserlandUsersController_update[0]": {
26121
26331
  parameters: {
26122
26332
  query?: never;
26123
26333
  header?: never;
@@ -26319,7 +26529,7 @@ export interface operations {
26319
26529
  };
26320
26530
  };
26321
26531
  };
26322
- UserlandUsersController_delete: {
26532
+ "UserlandUsersController_delete[0]": {
26323
26533
  parameters: {
26324
26534
  query?: never;
26325
26535
  header?: never;
@@ -26759,7 +26969,7 @@ export interface operations {
26759
26969
  };
26760
26970
  };
26761
26971
  };
26762
- UserlandUsersController_emailVerification: {
26972
+ "UserlandUsersController_emailVerification[0]": {
26763
26973
  parameters: {
26764
26974
  query?: never;
26765
26975
  header?: never;
@@ -26879,7 +27089,7 @@ export interface operations {
26879
27089
  };
26880
27090
  };
26881
27091
  };
26882
- UserlandUsersController_sendVerificationEmail: {
27092
+ "UserlandUsersController_sendVerificationEmail[0]": {
26883
27093
  parameters: {
26884
27094
  query?: never;
26885
27095
  header?: never;
@@ -27023,7 +27233,7 @@ export interface operations {
27023
27233
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27024
27234
  limit?: number;
27025
27235
  /** @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). Defaults to descending. */
27026
- order?: "normal" | "desc" | "asc";
27236
+ order?: components["schemas"]["PaginationOrder"];
27027
27237
  };
27028
27238
  header?: never;
27029
27239
  path: {
@@ -27193,7 +27403,7 @@ export interface operations {
27193
27403
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27194
27404
  limit?: number;
27195
27405
  /** @description Order the results by the creation time. */
27196
- order?: "normal" | "desc" | "asc";
27406
+ order?: components["schemas"]["PaginationOrder"];
27197
27407
  /** @description The ID of the organization to filter user API keys by. When provided, only API keys created against that organization membership are returned. */
27198
27408
  organization_id?: string;
27199
27409
  };
@@ -27327,7 +27537,7 @@ export interface operations {
27327
27537
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27328
27538
  limit?: number;
27329
27539
  /** @description Order the results by the creation time. */
27330
- order?: "normal" | "desc" | "asc";
27540
+ order?: components["schemas"]["PaginationOrder"];
27331
27541
  };
27332
27542
  header?: never;
27333
27543
  path: {
@@ -27374,7 +27584,7 @@ export interface operations {
27374
27584
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27375
27585
  limit?: number;
27376
27586
  /** @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). Defaults to descending. */
27377
- order?: "normal" | "desc" | "asc";
27587
+ order?: components["schemas"]["PaginationOrder"];
27378
27588
  };
27379
27589
  header?: never;
27380
27590
  path: {
@@ -27610,7 +27820,7 @@ export interface operations {
27610
27820
  };
27611
27821
  };
27612
27822
  };
27613
- UserlandUserAuthenticationFactorsController_list: {
27823
+ "UserlandUserAuthenticationFactorsController_list[0]": {
27614
27824
  parameters: {
27615
27825
  query?: {
27616
27826
  /** @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. */
@@ -27620,7 +27830,7 @@ export interface operations {
27620
27830
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27621
27831
  limit?: number;
27622
27832
  /** @description Order the results by the creation time. */
27623
- order?: "normal" | "desc" | "asc";
27833
+ order?: components["schemas"]["PaginationOrder"];
27624
27834
  };
27625
27835
  header?: never;
27626
27836
  path: {
@@ -27657,7 +27867,7 @@ export interface operations {
27657
27867
  };
27658
27868
  };
27659
27869
  };
27660
- UserlandUserAuthenticationFactorsController_create: {
27870
+ "UserlandUserAuthenticationFactorsController_create[0]": {
27661
27871
  parameters: {
27662
27872
  query?: never;
27663
27873
  header?: never;
@@ -27709,7 +27919,7 @@ export interface operations {
27709
27919
  /** @description Upper limit on the number of objects to return, between `1` and `100`. */
27710
27920
  limit?: number;
27711
27921
  /** @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). Defaults to descending. */
27712
- order?: "normal" | "desc" | "asc";
27922
+ order?: components["schemas"]["PaginationOrder"];
27713
27923
  };
27714
27924
  header?: never;
27715
27925
  path?: never;