@workos-inc/node 8.13.0 → 9.1.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/README.md +1 -1
- package/lib/{factory-HM2NchXm.mjs → factory-B7cG7pDB.mjs} +1691 -588
- package/lib/factory-B7cG7pDB.mjs.map +1 -0
- package/lib/{factory-yopqWYw5.cjs → factory-D3tT03aV.cjs} +1706 -609
- package/lib/factory-D3tT03aV.cjs.map +1 -0
- package/lib/index.cjs +5 -6
- package/lib/index.cjs.map +1 -1
- package/lib/index.d.cts +2 -2
- package/lib/index.d.mts +2 -2
- package/lib/index.mjs +2 -2
- package/lib/index.mjs.map +1 -1
- package/lib/index.worker.cjs +5 -6
- package/lib/index.worker.cjs.map +1 -1
- package/lib/index.worker.d.cts +2 -2
- package/lib/index.worker.d.mts +2 -2
- package/lib/index.worker.mjs +2 -2
- package/lib/index.worker.mjs.map +1 -1
- package/lib/{workos-9ENvbxSO.d.cts → workos-C0YAqze0.d.cts} +1943 -549
- package/lib/{workos-CESKLr5j.d.mts → workos-DhbLRXvR.d.mts} +1943 -549
- package/package.json +7 -7
- package/lib/factory-HM2NchXm.mjs.map +0 -1
- package/lib/factory-yopqWYw5.cjs.map +0 -1
|
@@ -127,15 +127,25 @@ type DirectoryType = 'azure scim v2.0' | 'bamboohr' | 'breathe hr' | 'cezanne hr
|
|
|
127
127
|
type DirectoryState = 'active' | 'deleting' | 'inactive' | 'invalid_credentials' | 'validating';
|
|
128
128
|
type DirectoryStateResponse = 'deleting' | 'invalid_credentials' | 'linked' | 'unlinked' | 'validating';
|
|
129
129
|
interface Directory {
|
|
130
|
+
/** Distinguishes the Directory object. */
|
|
130
131
|
object: 'directory';
|
|
132
|
+
/** Unique identifier for the Directory. */
|
|
131
133
|
id: string;
|
|
134
|
+
/** The URL associated with an Enterprise Client. */
|
|
132
135
|
domain: string;
|
|
136
|
+
/** External Key for the Directory. */
|
|
133
137
|
externalKey: string;
|
|
138
|
+
/** The name of the directory. */
|
|
134
139
|
name: string;
|
|
140
|
+
/** The unique identifier for the Organization in which the directory resides. */
|
|
135
141
|
organizationId?: string;
|
|
142
|
+
/** Describes whether the Directory has been successfully connected to an external provider. */
|
|
136
143
|
state: DirectoryState;
|
|
144
|
+
/** The type of external Directory Provider integrated with. */
|
|
137
145
|
type: DirectoryType;
|
|
146
|
+
/** An ISO 8601 timestamp. */
|
|
138
147
|
createdAt: string;
|
|
148
|
+
/** An ISO 8601 timestamp. */
|
|
139
149
|
updatedAt: string;
|
|
140
150
|
}
|
|
141
151
|
interface DirectoryResponse {
|
|
@@ -212,7 +222,9 @@ interface PaginationOptions {
|
|
|
212
222
|
//#endregion
|
|
213
223
|
//#region src/directory-sync/interfaces/list-directories-options.interface.d.ts
|
|
214
224
|
interface ListDirectoriesOptions extends PaginationOptions {
|
|
225
|
+
/** Filter Directories by their associated organization. */
|
|
215
226
|
organizationId?: string;
|
|
227
|
+
/** Searchable text to match against Directory names. */
|
|
216
228
|
search?: string;
|
|
217
229
|
}
|
|
218
230
|
interface SerializedListDirectoriesOptions extends PaginationOptions {
|
|
@@ -376,22 +388,6 @@ interface PermissionResponse {
|
|
|
376
388
|
created_at: string;
|
|
377
389
|
updated_at: string;
|
|
378
390
|
}
|
|
379
|
-
interface PermissionList {
|
|
380
|
-
object: 'list';
|
|
381
|
-
data: Permission[];
|
|
382
|
-
listMetadata: {
|
|
383
|
-
before: string | null;
|
|
384
|
-
after: string | null;
|
|
385
|
-
};
|
|
386
|
-
}
|
|
387
|
-
interface PermissionListResponse {
|
|
388
|
-
object: 'list';
|
|
389
|
-
data: PermissionResponse[];
|
|
390
|
-
list_metadata: {
|
|
391
|
-
before: string | null;
|
|
392
|
-
after: string | null;
|
|
393
|
-
};
|
|
394
|
-
}
|
|
395
391
|
//#endregion
|
|
396
392
|
//#region src/authorization/interfaces/create-permission-options.interface.d.ts
|
|
397
393
|
interface CreatePermissionOptions {
|
|
@@ -422,15 +418,25 @@ type ListPermissionsOptions = PaginationOptions;
|
|
|
422
418
|
//#endregion
|
|
423
419
|
//#region src/authorization/interfaces/authorization-resource.interface.d.ts
|
|
424
420
|
interface AuthorizationResource {
|
|
421
|
+
/** Distinguishes the Resource object. */
|
|
425
422
|
object: 'authorization_resource';
|
|
423
|
+
/** The unique ID of the Resource. */
|
|
426
424
|
id: string;
|
|
425
|
+
/** An identifier you provide to reference the resource in your system. */
|
|
427
426
|
externalId: string;
|
|
427
|
+
/** A human-readable name for the Resource. */
|
|
428
428
|
name: string;
|
|
429
|
+
/** An optional description of the Resource. */
|
|
429
430
|
description: string | null;
|
|
431
|
+
/** The slug of the resource type this resource belongs to. */
|
|
430
432
|
resourceTypeSlug: string;
|
|
433
|
+
/** The ID of the organization that owns the resource. */
|
|
431
434
|
organizationId: string;
|
|
435
|
+
/** The ID of the parent resource, if this resource is nested. */
|
|
432
436
|
parentResourceId: string | null;
|
|
437
|
+
/** An ISO 8601 timestamp. */
|
|
433
438
|
createdAt: string;
|
|
439
|
+
/** An ISO 8601 timestamp. */
|
|
434
440
|
updatedAt: string;
|
|
435
441
|
}
|
|
436
442
|
interface AuthorizationResourceResponse {
|
|
@@ -479,22 +485,6 @@ interface SerializedUpdateAuthorizationResourceOptions {
|
|
|
479
485
|
name?: string;
|
|
480
486
|
description?: string | null;
|
|
481
487
|
}
|
|
482
|
-
interface AuthorizationResourceList {
|
|
483
|
-
object: 'list';
|
|
484
|
-
data: AuthorizationResource[];
|
|
485
|
-
listMetadata: {
|
|
486
|
-
before: string | null;
|
|
487
|
-
after: string | null;
|
|
488
|
-
};
|
|
489
|
-
}
|
|
490
|
-
interface AuthorizationResourceListResponse {
|
|
491
|
-
object: 'list';
|
|
492
|
-
data: AuthorizationResourceResponse[];
|
|
493
|
-
list_metadata: {
|
|
494
|
-
before: string | null;
|
|
495
|
-
after: string | null;
|
|
496
|
-
};
|
|
497
|
-
}
|
|
498
488
|
//#endregion
|
|
499
489
|
//#region src/authorization/interfaces/list-authorization-resources-options.interface.d.ts
|
|
500
490
|
interface ListAuthorizationResourcesOptions extends PaginationOptions {
|
|
@@ -594,7 +584,9 @@ interface SerializedListResourcesForMembershipOptions extends PaginationOptions
|
|
|
594
584
|
//#region src/authorization/interfaces/list-memberships-for-resource-options.interface.d.ts
|
|
595
585
|
interface ListMembershipsForResourceOptions extends PaginationOptions {
|
|
596
586
|
resourceId: string;
|
|
587
|
+
/** The permission slug to filter by. Only users with this permission on the resource are returned. */
|
|
597
588
|
permissionSlug: string;
|
|
589
|
+
/** Filter by assignment type. Use `direct` for direct assignments only, or `indirect` to include inherited assignments. */
|
|
598
590
|
assignment?: 'direct' | 'indirect';
|
|
599
591
|
}
|
|
600
592
|
//#endregion
|
|
@@ -622,11 +614,17 @@ interface RoleAssignmentResourceResponse {
|
|
|
622
614
|
resource_type_slug: string;
|
|
623
615
|
}
|
|
624
616
|
interface RoleAssignment {
|
|
617
|
+
/** Distinguishes the role assignment object. */
|
|
625
618
|
object: 'role_assignment';
|
|
619
|
+
/** Unique identifier of the role assignment. */
|
|
626
620
|
id: string;
|
|
621
|
+
/** The role included in the assignment. */
|
|
627
622
|
role: RoleAssignmentRole;
|
|
623
|
+
/** The resource to which the role is assigned. */
|
|
628
624
|
resource: RoleAssignmentResource;
|
|
625
|
+
/** An ISO 8601 timestamp. */
|
|
629
626
|
createdAt: string;
|
|
627
|
+
/** An ISO 8601 timestamp. */
|
|
630
628
|
updatedAt: string;
|
|
631
629
|
}
|
|
632
630
|
interface RoleAssignmentResponse {
|
|
@@ -637,22 +635,6 @@ interface RoleAssignmentResponse {
|
|
|
637
635
|
created_at: string;
|
|
638
636
|
updated_at: string;
|
|
639
637
|
}
|
|
640
|
-
interface RoleAssignmentList {
|
|
641
|
-
object: 'list';
|
|
642
|
-
data: RoleAssignment[];
|
|
643
|
-
listMetadata: {
|
|
644
|
-
before: string | null;
|
|
645
|
-
after: string | null;
|
|
646
|
-
};
|
|
647
|
-
}
|
|
648
|
-
interface RoleAssignmentListResponse {
|
|
649
|
-
object: 'list';
|
|
650
|
-
data: RoleAssignmentResponse[];
|
|
651
|
-
list_metadata: {
|
|
652
|
-
before: string | null;
|
|
653
|
-
after: string | null;
|
|
654
|
-
};
|
|
655
|
-
}
|
|
656
638
|
//#endregion
|
|
657
639
|
//#region src/authorization/interfaces/list-role-assignments-options.interface.d.ts
|
|
658
640
|
interface ListRoleAssignmentsOptions extends PaginationOptions {
|
|
@@ -695,6 +677,20 @@ interface RemoveRoleAssignmentOptions {
|
|
|
695
677
|
roleAssignmentId: string;
|
|
696
678
|
}
|
|
697
679
|
//#endregion
|
|
680
|
+
//#region src/authorization/interfaces/list-effective-permissions-options.interface.d.ts
|
|
681
|
+
interface ListEffectivePermissionsOptions extends PaginationOptions {
|
|
682
|
+
organizationMembershipId: string;
|
|
683
|
+
resourceId: string;
|
|
684
|
+
}
|
|
685
|
+
//#endregion
|
|
686
|
+
//#region src/authorization/interfaces/list-effective-permissions-by-external-id-options.interface.d.ts
|
|
687
|
+
interface ListEffectivePermissionsByExternalIdOptions extends PaginationOptions {
|
|
688
|
+
organizationMembershipId: string;
|
|
689
|
+
organizationId: string;
|
|
690
|
+
resourceTypeSlug: string;
|
|
691
|
+
externalId: string;
|
|
692
|
+
}
|
|
693
|
+
//#endregion
|
|
698
694
|
//#region src/roles/interfaces/role.interface.d.ts
|
|
699
695
|
interface RoleResponse {
|
|
700
696
|
slug: string;
|
|
@@ -861,10 +857,12 @@ declare enum ConnectionType {
|
|
|
861
857
|
Auth0SAML = "Auth0SAML",
|
|
862
858
|
AzureSAML = "AzureSAML",
|
|
863
859
|
CasSAML = "CasSAML",
|
|
860
|
+
CleverOIDC = "CleverOIDC",
|
|
864
861
|
ClassLinkSAML = "ClassLinkSAML",
|
|
865
862
|
CloudflareSAML = "CloudflareSAML",
|
|
866
863
|
CyberArkSAML = "CyberArkSAML",
|
|
867
864
|
DuoSAML = "DuoSAML",
|
|
865
|
+
EntraIdOIDC = "EntraIdOIDC",
|
|
868
866
|
GenericOIDC = "GenericOIDC",
|
|
869
867
|
GenericSAML = "GenericSAML",
|
|
870
868
|
GitHubOAuth = "GitHubOAuth",
|
|
@@ -878,6 +876,7 @@ declare enum ConnectionType {
|
|
|
878
876
|
MicrosoftOAuth = "MicrosoftOAuth",
|
|
879
877
|
MiniOrangeSAML = "MiniOrangeSAML",
|
|
880
878
|
NetIqSAML = "NetIqSAML",
|
|
879
|
+
OktaOIDC = "OktaOIDC",
|
|
881
880
|
OktaSAML = "OktaSAML",
|
|
882
881
|
OneLoginSAML = "OneLoginSAML",
|
|
883
882
|
OracleSAML = "OracleSAML",
|
|
@@ -899,14 +898,22 @@ interface ConnectionDomain {
|
|
|
899
898
|
domain: string;
|
|
900
899
|
}
|
|
901
900
|
interface Connection {
|
|
901
|
+
/** Distinguishes the Connection object. */
|
|
902
902
|
object: 'connection';
|
|
903
|
+
/** Unique identifier for the Connection. */
|
|
903
904
|
id: string;
|
|
905
|
+
/** Unique identifier for the Organization in which the Connection resides. */
|
|
904
906
|
organizationId?: string;
|
|
907
|
+
/** A human-readable name for the Connection. This will most commonly be the organization's name. */
|
|
905
908
|
name: string;
|
|
909
|
+
/** Indicates whether a Connection is able to authenticate users. */
|
|
906
910
|
state: 'draft' | 'active' | 'inactive' | 'validating';
|
|
911
|
+
/** List of Organization Domains. */
|
|
907
912
|
domains: ConnectionDomain[];
|
|
908
913
|
type: ConnectionType;
|
|
914
|
+
/** An ISO 8601 timestamp. */
|
|
909
915
|
createdAt: string;
|
|
916
|
+
/** An ISO 8601 timestamp. */
|
|
910
917
|
updatedAt: string;
|
|
911
918
|
}
|
|
912
919
|
interface ConnectionResponse {
|
|
@@ -940,8 +947,11 @@ interface GetProfileAndTokenOptions {
|
|
|
940
947
|
//#endregion
|
|
941
948
|
//#region src/sso/interfaces/list-connections-options.interface.d.ts
|
|
942
949
|
interface ListConnectionsOptions extends PaginationOptions {
|
|
950
|
+
/** Filter Connections by their type. */
|
|
943
951
|
connectionType?: ConnectionType;
|
|
952
|
+
/** Filter Connections by their associated domain. */
|
|
944
953
|
domain?: string;
|
|
954
|
+
/** Filter Connections by their associated organization. */
|
|
945
955
|
organizationId?: string;
|
|
946
956
|
}
|
|
947
957
|
interface SerializedListConnectionsOptions extends PaginationOptions {
|
|
@@ -969,18 +979,31 @@ interface OauthTokensResponse {
|
|
|
969
979
|
//#endregion
|
|
970
980
|
//#region src/sso/interfaces/profile.interface.d.ts
|
|
971
981
|
interface Profile<CustomAttributesType extends UnknownRecord> {
|
|
982
|
+
/** Unique identifier of the profile. */
|
|
972
983
|
id: string;
|
|
984
|
+
/** The user's unique identifier from the identity provider. */
|
|
973
985
|
idpId: string;
|
|
986
|
+
/** The ID of the organization the user belongs to. */
|
|
974
987
|
organizationId?: string;
|
|
988
|
+
/** The ID of the SSO connection used for authentication. */
|
|
975
989
|
connectionId: string;
|
|
990
|
+
/** The type of SSO connection. */
|
|
976
991
|
connectionType: ConnectionType;
|
|
992
|
+
/** The user's email address. */
|
|
977
993
|
email: string;
|
|
994
|
+
/** The user's first name. */
|
|
978
995
|
firstName?: string;
|
|
996
|
+
/** The user's last name. */
|
|
979
997
|
lastName?: string;
|
|
998
|
+
/** The role assigned to the user within the organization, if applicable. */
|
|
980
999
|
role?: RoleResponse;
|
|
1000
|
+
/** The roles assigned to the user within the organization, if applicable. */
|
|
981
1001
|
roles?: RoleResponse[];
|
|
1002
|
+
/** The groups the user belongs to, as returned by the identity provider. */
|
|
982
1003
|
groups?: string[];
|
|
1004
|
+
/** Custom attribute mappings defined for the connection, returned as key-value pairs. */
|
|
983
1005
|
customAttributes?: CustomAttributesType;
|
|
1006
|
+
/** The complete set of raw attributes returned by the identity provider. */
|
|
984
1007
|
rawAttributes?: {
|
|
985
1008
|
[key: string]: any;
|
|
986
1009
|
};
|
|
@@ -1182,19 +1205,33 @@ interface ImpersonatorResponse {
|
|
|
1182
1205
|
}
|
|
1183
1206
|
//#endregion
|
|
1184
1207
|
//#region src/user-management/interfaces/user.interface.d.ts
|
|
1208
|
+
/** The user object. */
|
|
1185
1209
|
interface User {
|
|
1210
|
+
/** Distinguishes the user object. */
|
|
1186
1211
|
object: 'user';
|
|
1212
|
+
/** The unique ID of the user. */
|
|
1187
1213
|
id: string;
|
|
1214
|
+
/** The email address of the user. */
|
|
1188
1215
|
email: string;
|
|
1216
|
+
/** Whether the user's email has been verified. */
|
|
1189
1217
|
emailVerified: boolean;
|
|
1218
|
+
/** A URL reference to an image representing the user. */
|
|
1190
1219
|
profilePictureUrl: string | null;
|
|
1220
|
+
/** The first name of the user. */
|
|
1191
1221
|
firstName: string | null;
|
|
1222
|
+
/** The last name of the user. */
|
|
1192
1223
|
lastName: string | null;
|
|
1224
|
+
/** The timestamp when the user last signed in. */
|
|
1193
1225
|
lastSignInAt: string | null;
|
|
1226
|
+
/** The user's preferred locale. */
|
|
1194
1227
|
locale: string | null;
|
|
1228
|
+
/** An ISO 8601 timestamp. */
|
|
1195
1229
|
createdAt: string;
|
|
1230
|
+
/** An ISO 8601 timestamp. */
|
|
1196
1231
|
updatedAt: string;
|
|
1232
|
+
/** The external ID of the user. */
|
|
1197
1233
|
externalId: string | null;
|
|
1234
|
+
/** Object containing metadata key/value pairs associated with the user. */
|
|
1198
1235
|
metadata: Record<string, string>;
|
|
1199
1236
|
}
|
|
1200
1237
|
interface UserResponse {
|
|
@@ -1455,13 +1492,21 @@ interface SerializedCreateUserOptions {
|
|
|
1455
1492
|
//#endregion
|
|
1456
1493
|
//#region src/user-management/interfaces/email-verification.interface.d.ts
|
|
1457
1494
|
interface EmailVerification {
|
|
1495
|
+
/** Distinguishes the email verification object. */
|
|
1458
1496
|
object: 'email_verification';
|
|
1497
|
+
/** The unique ID of the email verification code. */
|
|
1459
1498
|
id: string;
|
|
1499
|
+
/** The unique ID of the user. */
|
|
1460
1500
|
userId: string;
|
|
1501
|
+
/** The email address of the user. */
|
|
1461
1502
|
email: string;
|
|
1503
|
+
/** The timestamp when the email verification code expires. */
|
|
1462
1504
|
expiresAt: string;
|
|
1505
|
+
/** The code used to verify the email. */
|
|
1463
1506
|
code: string;
|
|
1507
|
+
/** An ISO 8601 timestamp. */
|
|
1464
1508
|
createdAt: string;
|
|
1509
|
+
/** An ISO 8601 timestamp. */
|
|
1465
1510
|
updatedAt: string;
|
|
1466
1511
|
}
|
|
1467
1512
|
interface EmailVerificationEvent {
|
|
@@ -1508,7 +1553,7 @@ interface SerializedEnrollUserInMfaFactorOptions {
|
|
|
1508
1553
|
totp_secret?: string;
|
|
1509
1554
|
}
|
|
1510
1555
|
//#endregion
|
|
1511
|
-
//#region src/
|
|
1556
|
+
//#region src/multi-factor-auth/interfaces/totp.interface.d.ts
|
|
1512
1557
|
interface Totp {
|
|
1513
1558
|
issuer: string;
|
|
1514
1559
|
user: string;
|
|
@@ -1572,27 +1617,38 @@ interface Identity {
|
|
|
1572
1617
|
type: 'OAuth';
|
|
1573
1618
|
provider: 'AppleOAuth' | 'GoogleOAuth' | 'GitHubOAuth' | 'MicrosoftOAuth' | 'SalesforceOAuth';
|
|
1574
1619
|
}
|
|
1575
|
-
interface IdentityResponse {
|
|
1576
|
-
idp_id: string;
|
|
1577
|
-
type: 'OAuth';
|
|
1578
|
-
provider: 'AppleOAuth' | 'GoogleOAuth' | 'GitHubOAuth' | 'MicrosoftOAuth' | 'SalesforceOAuth';
|
|
1579
|
-
}
|
|
1580
1620
|
//#endregion
|
|
1581
1621
|
//#region src/user-management/interfaces/invitation.interface.d.ts
|
|
1582
1622
|
interface Invitation {
|
|
1623
|
+
/** Distinguishes the invitation object. */
|
|
1583
1624
|
object: 'invitation';
|
|
1625
|
+
/** The unique ID of the invitation. */
|
|
1584
1626
|
id: string;
|
|
1627
|
+
/** The email address of the recipient. */
|
|
1585
1628
|
email: string;
|
|
1629
|
+
/** The state of the invitation. */
|
|
1586
1630
|
state: 'pending' | 'accepted' | 'expired' | 'revoked';
|
|
1631
|
+
/** The timestamp when the invitation was accepted, or null if not yet accepted. */
|
|
1587
1632
|
acceptedAt: string | null;
|
|
1633
|
+
/** The timestamp when the invitation was revoked, or null if not revoked. */
|
|
1588
1634
|
revokedAt: string | null;
|
|
1635
|
+
/** The timestamp when the invitation expires. */
|
|
1589
1636
|
expiresAt: string;
|
|
1637
|
+
/** The ID of the [organization](https://workos.com/docs/reference/organization) that the recipient will join. */
|
|
1590
1638
|
organizationId: string | null;
|
|
1639
|
+
/** The ID of the user who invited the recipient, if provided. */
|
|
1591
1640
|
inviterUserId: string | null;
|
|
1641
|
+
/** The ID of the user who accepted the invitation, once accepted. */
|
|
1592
1642
|
acceptedUserId: string | null;
|
|
1643
|
+
/** Slug of the role the invitee will be assigned on acceptance. Reflects the current role on the pending organization membership, which may change before acceptance. null when the invitation has no associated organization. */
|
|
1644
|
+
roleSlug: string | null;
|
|
1645
|
+
/** The token used to accept the invitation. */
|
|
1593
1646
|
token: string;
|
|
1647
|
+
/** The URL where the recipient can accept the invitation. */
|
|
1594
1648
|
acceptInvitationUrl: string;
|
|
1649
|
+
/** An ISO 8601 timestamp. */
|
|
1595
1650
|
createdAt: string;
|
|
1651
|
+
/** An ISO 8601 timestamp. */
|
|
1596
1652
|
updatedAt: string;
|
|
1597
1653
|
}
|
|
1598
1654
|
interface InvitationEvent {
|
|
@@ -1606,6 +1662,7 @@ interface InvitationEvent {
|
|
|
1606
1662
|
organizationId: string | null;
|
|
1607
1663
|
inviterUserId: string | null;
|
|
1608
1664
|
acceptedUserId: string | null;
|
|
1665
|
+
roleSlug: string | null;
|
|
1609
1666
|
createdAt: string;
|
|
1610
1667
|
updatedAt: string;
|
|
1611
1668
|
}
|
|
@@ -1620,6 +1677,7 @@ interface InvitationResponse {
|
|
|
1620
1677
|
organization_id: string | null;
|
|
1621
1678
|
inviter_user_id: string | null;
|
|
1622
1679
|
accepted_user_id: string | null;
|
|
1680
|
+
role_slug: string | null;
|
|
1623
1681
|
token: string;
|
|
1624
1682
|
accept_invitation_url: string;
|
|
1625
1683
|
created_at: string;
|
|
@@ -1636,6 +1694,7 @@ interface InvitationEventResponse {
|
|
|
1636
1694
|
organization_id: string | null;
|
|
1637
1695
|
inviter_user_id: string | null;
|
|
1638
1696
|
accepted_user_id: string | null;
|
|
1697
|
+
role_slug: string | null;
|
|
1639
1698
|
created_at: string;
|
|
1640
1699
|
updated_at: string;
|
|
1641
1700
|
}
|
|
@@ -1645,9 +1704,16 @@ interface ListAuthFactorsOptions extends PaginationOptions {
|
|
|
1645
1704
|
userId: string;
|
|
1646
1705
|
}
|
|
1647
1706
|
//#endregion
|
|
1707
|
+
//#region src/user-management/interfaces/list-groups-for-organization-membership-options.interface.d.ts
|
|
1708
|
+
interface ListGroupsForOrganizationMembershipOptions extends PaginationOptions {
|
|
1709
|
+
organizationMembershipId: string;
|
|
1710
|
+
}
|
|
1711
|
+
//#endregion
|
|
1648
1712
|
//#region src/user-management/interfaces/list-invitations-options.interface.d.ts
|
|
1649
1713
|
interface ListInvitationsOptions extends PaginationOptions {
|
|
1714
|
+
/** The ID of the [organization](https://workos.com/docs/reference/organization) that the recipient will join. */
|
|
1650
1715
|
organizationId?: string;
|
|
1716
|
+
/** The email address of the recipient. */
|
|
1651
1717
|
email?: string;
|
|
1652
1718
|
}
|
|
1653
1719
|
interface SerializedListInvitationsOptions extends PaginationOptions {
|
|
@@ -1669,7 +1735,9 @@ interface BaseOrganizationMembership {
|
|
|
1669
1735
|
customAttributes: Record<string, unknown>;
|
|
1670
1736
|
}
|
|
1671
1737
|
interface OrganizationMembership extends BaseOrganizationMembership {
|
|
1738
|
+
/** The name of the organization which the user belongs to. */
|
|
1672
1739
|
organizationName: string;
|
|
1740
|
+
/** The primary role assigned to the user within the organization. */
|
|
1673
1741
|
role: RoleResponse;
|
|
1674
1742
|
roles?: RoleResponse[];
|
|
1675
1743
|
}
|
|
@@ -1691,22 +1759,6 @@ interface OrganizationMembershipResponse extends BaseOrganizationMembershipRespo
|
|
|
1691
1759
|
roles?: RoleResponse[];
|
|
1692
1760
|
}
|
|
1693
1761
|
type AuthorizationOrganizationMembershipResponse = BaseOrganizationMembershipResponse;
|
|
1694
|
-
interface AuthorizationOrganizationMembershipList {
|
|
1695
|
-
object: 'list';
|
|
1696
|
-
data: AuthorizationOrganizationMembership[];
|
|
1697
|
-
listMetadata: {
|
|
1698
|
-
before: string | null;
|
|
1699
|
-
after: string | null;
|
|
1700
|
-
};
|
|
1701
|
-
}
|
|
1702
|
-
interface AuthorizationOrganizationMembershipListResponse {
|
|
1703
|
-
object: 'list';
|
|
1704
|
-
data: AuthorizationOrganizationMembershipResponse[];
|
|
1705
|
-
list_metadata: {
|
|
1706
|
-
before: string | null;
|
|
1707
|
-
after: string | null;
|
|
1708
|
-
};
|
|
1709
|
-
}
|
|
1710
1762
|
//#endregion
|
|
1711
1763
|
//#region src/user-management/interfaces/list-organization-memberships-options.interface.d.ts
|
|
1712
1764
|
type ListOrganizationMembershipsOptions = PaginationOptions & {
|
|
@@ -1735,7 +1787,9 @@ interface ListUserFeatureFlagsOptions extends PaginationOptions {
|
|
|
1735
1787
|
//#endregion
|
|
1736
1788
|
//#region src/user-management/interfaces/list-users-options.interface.d.ts
|
|
1737
1789
|
interface ListUsersOptions extends PaginationOptions {
|
|
1790
|
+
/** Filter users by their email address. */
|
|
1738
1791
|
email?: string;
|
|
1792
|
+
/** Filter users by the organization they are a member of. */
|
|
1739
1793
|
organizationId?: string;
|
|
1740
1794
|
}
|
|
1741
1795
|
interface SerializedListUsersOptions extends PaginationOptions {
|
|
@@ -1754,13 +1808,21 @@ interface LogoutURLOptions {
|
|
|
1754
1808
|
//#endregion
|
|
1755
1809
|
//#region src/user-management/interfaces/magic-auth.interface.d.ts
|
|
1756
1810
|
interface MagicAuth {
|
|
1811
|
+
/** Distinguishes the Magic Auth object. */
|
|
1757
1812
|
object: 'magic_auth';
|
|
1813
|
+
/** The unique ID of the Magic Auth code. */
|
|
1758
1814
|
id: string;
|
|
1815
|
+
/** The unique ID of the user. */
|
|
1759
1816
|
userId: string;
|
|
1817
|
+
/** The email address of the user. */
|
|
1760
1818
|
email: string;
|
|
1819
|
+
/** The timestamp when the Magic Auth code expires. */
|
|
1761
1820
|
expiresAt: string;
|
|
1821
|
+
/** The code used to verify the Magic Auth code. */
|
|
1762
1822
|
code: string;
|
|
1823
|
+
/** An ISO 8601 timestamp. */
|
|
1763
1824
|
createdAt: string;
|
|
1825
|
+
/** An ISO 8601 timestamp. */
|
|
1764
1826
|
updatedAt: string;
|
|
1765
1827
|
}
|
|
1766
1828
|
interface MagicAuthEvent {
|
|
@@ -1794,13 +1856,21 @@ interface MagicAuthEventResponse {
|
|
|
1794
1856
|
//#endregion
|
|
1795
1857
|
//#region src/user-management/interfaces/password-reset.interface.d.ts
|
|
1796
1858
|
interface PasswordReset {
|
|
1859
|
+
/** Distinguishes the password reset object. */
|
|
1797
1860
|
object: 'password_reset';
|
|
1861
|
+
/** The unique ID of the password reset object. */
|
|
1798
1862
|
id: string;
|
|
1863
|
+
/** The unique ID of the user. */
|
|
1799
1864
|
userId: string;
|
|
1865
|
+
/** The email address of the user. */
|
|
1800
1866
|
email: string;
|
|
1867
|
+
/** The token used to reset the password. */
|
|
1801
1868
|
passwordResetToken: string;
|
|
1869
|
+
/** The URL where the user can reset their password. */
|
|
1802
1870
|
passwordResetUrl: string;
|
|
1871
|
+
/** The timestamp when the password reset token expires. */
|
|
1803
1872
|
expiresAt: string;
|
|
1873
|
+
/** The timestamp when the password reset token was created. */
|
|
1804
1874
|
createdAt: string;
|
|
1805
1875
|
}
|
|
1806
1876
|
interface PasswordResetEvent {
|
|
@@ -2009,15 +2079,25 @@ declare enum OrganizationDomainVerificationStrategy {
|
|
|
2009
2079
|
Manual = "manual"
|
|
2010
2080
|
}
|
|
2011
2081
|
interface OrganizationDomain {
|
|
2082
|
+
/** Distinguishes the organization domain object. */
|
|
2012
2083
|
object: 'organization_domain';
|
|
2084
|
+
/** Unique identifier of the organization domain. */
|
|
2013
2085
|
id: string;
|
|
2086
|
+
/** Domain for the organization domain. */
|
|
2014
2087
|
domain: string;
|
|
2088
|
+
/** ID of the parent Organization. */
|
|
2015
2089
|
organizationId: string;
|
|
2090
|
+
/** Verification state of the domain. */
|
|
2016
2091
|
state: OrganizationDomainState;
|
|
2092
|
+
/** Validation token to be used in DNS TXT record. */
|
|
2017
2093
|
verificationToken?: string;
|
|
2094
|
+
/** Strategy used to verify the domain. */
|
|
2018
2095
|
verificationStrategy: OrganizationDomainVerificationStrategy;
|
|
2096
|
+
/** The prefix used in DNS verification. */
|
|
2019
2097
|
verificationPrefix?: string;
|
|
2098
|
+
/** An ISO 8601 timestamp. */
|
|
2020
2099
|
createdAt: string;
|
|
2100
|
+
/** An ISO 8601 timestamp. */
|
|
2021
2101
|
updatedAt: string;
|
|
2022
2102
|
}
|
|
2023
2103
|
interface OrganizationDomainResponse {
|
|
@@ -2044,18 +2124,28 @@ interface OrganizationDomainVerificationFailedResponse {
|
|
|
2044
2124
|
}
|
|
2045
2125
|
//#endregion
|
|
2046
2126
|
//#region src/api-keys/interfaces/api-key.interface.d.ts
|
|
2127
|
+
/** The API Key object if the value is valid, or `null` if invalid. */
|
|
2047
2128
|
interface ApiKey {
|
|
2129
|
+
/** Distinguishes the API Key object. */
|
|
2048
2130
|
object: 'api_key';
|
|
2131
|
+
/** Unique identifier of the API Key. */
|
|
2049
2132
|
id: string;
|
|
2133
|
+
/** The entity that owns the API Key. */
|
|
2050
2134
|
owner: {
|
|
2051
2135
|
type: 'organization';
|
|
2052
2136
|
id: string;
|
|
2053
2137
|
};
|
|
2138
|
+
/** A descriptive name for the API Key. */
|
|
2054
2139
|
name: string;
|
|
2140
|
+
/** An obfuscated representation of the API Key value. */
|
|
2055
2141
|
obfuscatedValue: string;
|
|
2142
|
+
/** Timestamp of when the API Key was last used. */
|
|
2056
2143
|
lastUsedAt: string | null;
|
|
2144
|
+
/** The permission slugs assigned to the API Key. */
|
|
2057
2145
|
permissions: string[];
|
|
2146
|
+
/** An ISO 8601 timestamp. */
|
|
2058
2147
|
createdAt: string;
|
|
2148
|
+
/** An ISO 8601 timestamp. */
|
|
2059
2149
|
updatedAt: string;
|
|
2060
2150
|
}
|
|
2061
2151
|
interface SerializedApiKey {
|
|
@@ -2147,15 +2237,25 @@ interface EvaluationContext {
|
|
|
2147
2237
|
//#endregion
|
|
2148
2238
|
//#region src/feature-flags/interfaces/feature-flag.interface.d.ts
|
|
2149
2239
|
interface FeatureFlag {
|
|
2240
|
+
/** Distinguishes the Feature Flag object. */
|
|
2150
2241
|
object: 'feature_flag';
|
|
2242
|
+
/** Unique identifier of the Feature Flag. */
|
|
2151
2243
|
id: string;
|
|
2244
|
+
/** A descriptive name for the Feature Flag. This field does not need to be unique. */
|
|
2152
2245
|
name: string;
|
|
2246
|
+
/** A unique key to reference the Feature Flag. */
|
|
2153
2247
|
slug: string;
|
|
2248
|
+
/** A description for the Feature Flag. */
|
|
2154
2249
|
description: string;
|
|
2250
|
+
/** Labels assigned to the Feature Flag for categorizing and filtering. */
|
|
2155
2251
|
tags: string[];
|
|
2252
|
+
/** Specifies whether the Feature Flag is active for the current environment. */
|
|
2156
2253
|
enabled: boolean;
|
|
2254
|
+
/** The value returned for users and organizations who don't match any configured targeting rules. */
|
|
2157
2255
|
defaultValue: boolean;
|
|
2256
|
+
/** An ISO 8601 timestamp. */
|
|
2158
2257
|
createdAt: string;
|
|
2258
|
+
/** An ISO 8601 timestamp. */
|
|
2159
2259
|
updatedAt: string;
|
|
2160
2260
|
}
|
|
2161
2261
|
interface FeatureFlagResponse {
|
|
@@ -2220,6 +2320,89 @@ interface RuntimeClientStats {
|
|
|
2220
2320
|
flagCount: number;
|
|
2221
2321
|
}
|
|
2222
2322
|
//#endregion
|
|
2323
|
+
//#region src/groups/interfaces/add-group-organization-membership-options.interface.d.ts
|
|
2324
|
+
interface AddGroupOrganizationMembershipOptions {
|
|
2325
|
+
organizationId: string;
|
|
2326
|
+
groupId: string;
|
|
2327
|
+
organizationMembershipId: string;
|
|
2328
|
+
}
|
|
2329
|
+
interface SerializedAddGroupOrganizationMembershipOptions {
|
|
2330
|
+
organization_membership_id: string;
|
|
2331
|
+
}
|
|
2332
|
+
//#endregion
|
|
2333
|
+
//#region src/groups/interfaces/create-group-options.interface.d.ts
|
|
2334
|
+
interface CreateGroupOptions {
|
|
2335
|
+
organizationId: string;
|
|
2336
|
+
name: string;
|
|
2337
|
+
description?: string | null;
|
|
2338
|
+
}
|
|
2339
|
+
interface SerializedCreateGroupOptions {
|
|
2340
|
+
name: string;
|
|
2341
|
+
description?: string | null;
|
|
2342
|
+
}
|
|
2343
|
+
//#endregion
|
|
2344
|
+
//#region src/groups/interfaces/delete-group-options.interface.d.ts
|
|
2345
|
+
interface DeleteGroupOptions {
|
|
2346
|
+
organizationId: string;
|
|
2347
|
+
groupId: string;
|
|
2348
|
+
}
|
|
2349
|
+
//#endregion
|
|
2350
|
+
//#region src/groups/interfaces/get-group-options.interface.d.ts
|
|
2351
|
+
interface GetGroupOptions {
|
|
2352
|
+
organizationId: string;
|
|
2353
|
+
groupId: string;
|
|
2354
|
+
}
|
|
2355
|
+
//#endregion
|
|
2356
|
+
//#region src/groups/interfaces/group.interface.d.ts
|
|
2357
|
+
interface Group {
|
|
2358
|
+
object: 'group';
|
|
2359
|
+
id: string;
|
|
2360
|
+
organizationId: string;
|
|
2361
|
+
name: string;
|
|
2362
|
+
description: string | null;
|
|
2363
|
+
createdAt: string;
|
|
2364
|
+
updatedAt: string;
|
|
2365
|
+
}
|
|
2366
|
+
interface GroupResponse {
|
|
2367
|
+
object: 'group';
|
|
2368
|
+
id: string;
|
|
2369
|
+
organization_id: string;
|
|
2370
|
+
name: string;
|
|
2371
|
+
description: string | null;
|
|
2372
|
+
created_at: string;
|
|
2373
|
+
updated_at: string;
|
|
2374
|
+
}
|
|
2375
|
+
//#endregion
|
|
2376
|
+
//#region src/groups/interfaces/list-group-organization-memberships-options.interface.d.ts
|
|
2377
|
+
interface ListGroupOrganizationMembershipsOptions extends PaginationOptions {
|
|
2378
|
+
organizationId: string;
|
|
2379
|
+
groupId: string;
|
|
2380
|
+
}
|
|
2381
|
+
//#endregion
|
|
2382
|
+
//#region src/groups/interfaces/list-groups-options.interface.d.ts
|
|
2383
|
+
interface ListGroupsOptions extends PaginationOptions {
|
|
2384
|
+
organizationId: string;
|
|
2385
|
+
}
|
|
2386
|
+
//#endregion
|
|
2387
|
+
//#region src/groups/interfaces/remove-group-organization-membership-options.interface.d.ts
|
|
2388
|
+
interface RemoveGroupOrganizationMembershipOptions {
|
|
2389
|
+
organizationId: string;
|
|
2390
|
+
groupId: string;
|
|
2391
|
+
organizationMembershipId: string;
|
|
2392
|
+
}
|
|
2393
|
+
//#endregion
|
|
2394
|
+
//#region src/groups/interfaces/update-group-options.interface.d.ts
|
|
2395
|
+
interface UpdateGroupOptions {
|
|
2396
|
+
organizationId: string;
|
|
2397
|
+
groupId: string;
|
|
2398
|
+
name?: string;
|
|
2399
|
+
description?: string | null;
|
|
2400
|
+
}
|
|
2401
|
+
interface SerializedUpdateGroupOptions {
|
|
2402
|
+
name?: string;
|
|
2403
|
+
description?: string | null;
|
|
2404
|
+
}
|
|
2405
|
+
//#endregion
|
|
2223
2406
|
//#region src/vault/interfaces/key.interface.d.ts
|
|
2224
2407
|
interface KeyContext {
|
|
2225
2408
|
[key: string]: any;
|
|
@@ -2863,6 +3046,54 @@ interface FlagRuleUpdatedEventResponse extends EventResponseBase {
|
|
|
2863
3046
|
event: 'flag.rule_updated';
|
|
2864
3047
|
data: FeatureFlagResponse;
|
|
2865
3048
|
}
|
|
3049
|
+
interface GroupCreatedEvent extends EventBase {
|
|
3050
|
+
event: 'group.created';
|
|
3051
|
+
data: Group;
|
|
3052
|
+
}
|
|
3053
|
+
interface GroupCreatedEventResponse extends EventResponseBase {
|
|
3054
|
+
event: 'group.created';
|
|
3055
|
+
data: GroupResponse;
|
|
3056
|
+
}
|
|
3057
|
+
interface GroupUpdatedEvent extends EventBase {
|
|
3058
|
+
event: 'group.updated';
|
|
3059
|
+
data: Group;
|
|
3060
|
+
}
|
|
3061
|
+
interface GroupUpdatedEventResponse extends EventResponseBase {
|
|
3062
|
+
event: 'group.updated';
|
|
3063
|
+
data: GroupResponse;
|
|
3064
|
+
}
|
|
3065
|
+
interface GroupDeletedEvent extends EventBase {
|
|
3066
|
+
event: 'group.deleted';
|
|
3067
|
+
data: Group;
|
|
3068
|
+
}
|
|
3069
|
+
interface GroupDeletedEventResponse extends EventResponseBase {
|
|
3070
|
+
event: 'group.deleted';
|
|
3071
|
+
data: GroupResponse;
|
|
3072
|
+
}
|
|
3073
|
+
interface GroupMemberEventData {
|
|
3074
|
+
groupId: string;
|
|
3075
|
+
organizationMembershipId: string;
|
|
3076
|
+
}
|
|
3077
|
+
interface GroupMemberEventResponseData {
|
|
3078
|
+
group_id: string;
|
|
3079
|
+
organization_membership_id: string;
|
|
3080
|
+
}
|
|
3081
|
+
interface GroupMemberAddedEvent extends EventBase {
|
|
3082
|
+
event: 'group.member_added';
|
|
3083
|
+
data: GroupMemberEventData;
|
|
3084
|
+
}
|
|
3085
|
+
interface GroupMemberAddedEventResponse extends EventResponseBase {
|
|
3086
|
+
event: 'group.member_added';
|
|
3087
|
+
data: GroupMemberEventResponseData;
|
|
3088
|
+
}
|
|
3089
|
+
interface GroupMemberRemovedEvent extends EventBase {
|
|
3090
|
+
event: 'group.member_removed';
|
|
3091
|
+
data: GroupMemberEventData;
|
|
3092
|
+
}
|
|
3093
|
+
interface GroupMemberRemovedEventResponse extends EventResponseBase {
|
|
3094
|
+
event: 'group.member_removed';
|
|
3095
|
+
data: GroupMemberEventResponseData;
|
|
3096
|
+
}
|
|
2866
3097
|
interface VaultDataCreatedEvent extends EventBase {
|
|
2867
3098
|
event: 'vault.data.created';
|
|
2868
3099
|
data: VaultDataCreatedEventData;
|
|
@@ -2943,10 +3174,26 @@ interface VaultByokKeyVerificationCompletedEventResponse extends EventResponseBa
|
|
|
2943
3174
|
event: 'vault.byok_key.verification_completed';
|
|
2944
3175
|
data: VaultByokKeyVerificationCompletedEventResponseData;
|
|
2945
3176
|
}
|
|
2946
|
-
|
|
2947
|
-
|
|
3177
|
+
interface UnknownEvent extends EventBase {
|
|
3178
|
+
event: string;
|
|
3179
|
+
data: Record<string, unknown>;
|
|
3180
|
+
}
|
|
3181
|
+
type Event = AuthenticationEmailVerificationSucceededEvent | AuthenticationMfaSucceededEvent | AuthenticationOAuthFailedEvent | AuthenticationOAuthSucceededEvent | AuthenticationSSOFailedEvent | AuthenticationSSOSucceededEvent | AuthenticationPasskeyFailedEvent | AuthenticationPasskeySucceededEvent | AuthenticationPasswordFailedEvent | AuthenticationPasswordSucceededEvent | AuthenticationMagicAuthFailedEvent | AuthenticationMagicAuthSucceededEvent | AuthenticationRadarRiskDetectedEvent | ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | EmailVerificationCreatedEvent | InvitationAcceptedEvent | InvitationCreatedEvent | InvitationRevokedEvent | InvitationResentEvent | MagicAuthCreatedEvent | PasswordResetCreatedEvent | PasswordResetSucceededEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | RoleCreatedEvent | RoleDeletedEvent | RoleUpdatedEvent | OrganizationRoleCreatedEvent | OrganizationRoleUpdatedEvent | OrganizationRoleDeletedEvent | PermissionCreatedEvent | PermissionUpdatedEvent | PermissionDeletedEvent | SessionCreatedEvent | SessionRevokedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent | OrganizationDomainVerifiedEvent | OrganizationDomainVerificationFailedEvent | OrganizationDomainCreatedEvent | OrganizationDomainUpdatedEvent | OrganizationDomainDeletedEvent | ApiKeyCreatedEvent | ApiKeyRevokedEvent | FlagCreatedEvent | FlagUpdatedEvent | FlagDeletedEvent | FlagRuleUpdatedEvent | GroupCreatedEvent | GroupUpdatedEvent | GroupDeletedEvent | GroupMemberAddedEvent | GroupMemberRemovedEvent | VaultDataCreatedEvent | VaultDataUpdatedEvent | VaultDataReadEvent | VaultDataDeletedEvent | VaultNamesListedEvent | VaultMetadataReadEvent | VaultKekCreatedEvent | VaultDekReadEvent | VaultDekDecryptedEvent | VaultByokKeyVerificationCompletedEvent;
|
|
3182
|
+
type EventResponse = AuthenticationEmailVerificationSucceededEventResponse | AuthenticationMagicAuthFailedEventResponse | AuthenticationMagicAuthSucceededEventResponse | AuthenticationMfaSucceededEventResponse | AuthenticationOAuthFailedEventResponse | AuthenticationOAuthSucceededEventResponse | AuthenticationPasskeyFailedEventResponse | AuthenticationPasskeySucceededEventResponse | AuthenticationPasswordFailedEventResponse | AuthenticationPasswordSucceededEventResponse | AuthenticationSSOFailedEventResponse | AuthenticationSSOSucceededEventResponse | AuthenticationRadarRiskDetectedEventResponse | ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | EmailVerificationCreatedEventResponse | InvitationAcceptedEventResponse | InvitationCreatedEventResponse | InvitationRevokedEventResponse | InvitationResentEventResponse | MagicAuthCreatedEventResponse | PasswordResetCreatedEventResponse | PasswordResetSucceededEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | RoleUpdatedEventResponse | OrganizationRoleCreatedEventResponse | OrganizationRoleUpdatedEventResponse | OrganizationRoleDeletedEventResponse | PermissionCreatedEventResponse | PermissionUpdatedEventResponse | PermissionDeletedEventResponse | SessionCreatedEventResponse | SessionRevokedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse | OrganizationDomainVerifiedEventResponse | OrganizationDomainVerificationFailedEventResponse | OrganizationDomainCreatedEventResponse | OrganizationDomainUpdatedEventResponse | OrganizationDomainDeletedEventResponse | ApiKeyCreatedEventResponse | ApiKeyRevokedEventResponse | FlagCreatedEventResponse | FlagUpdatedEventResponse | FlagDeletedEventResponse | FlagRuleUpdatedEventResponse | GroupCreatedEventResponse | GroupUpdatedEventResponse | GroupDeletedEventResponse | GroupMemberAddedEventResponse | GroupMemberRemovedEventResponse | VaultDataCreatedEventResponse | VaultDataUpdatedEventResponse | VaultDataReadEventResponse | VaultDataDeletedEventResponse | VaultNamesListedEventResponse | VaultMetadataReadEventResponse | VaultKekCreatedEventResponse | VaultDekReadEventResponse | VaultDekDecryptedEventResponse | VaultByokKeyVerificationCompletedEventResponse;
|
|
2948
3183
|
type EventName = Event['event'];
|
|
2949
3184
|
//#endregion
|
|
3185
|
+
//#region src/common/interfaces/generate-link-intent.interface.d.ts
|
|
3186
|
+
declare const GenerateLinkIntent: {
|
|
3187
|
+
readonly SSO: "sso";
|
|
3188
|
+
readonly DSync: "dsync";
|
|
3189
|
+
readonly AuditLogs: "audit_logs";
|
|
3190
|
+
readonly LogStreams: "log_streams";
|
|
3191
|
+
readonly DomainVerification: "domain_verification";
|
|
3192
|
+
readonly CertificateRenewal: "certificate_renewal";
|
|
3193
|
+
readonly BringYourOwnKey: "bring_your_own_key";
|
|
3194
|
+
};
|
|
3195
|
+
type GenerateLinkIntent = (typeof GenerateLinkIntent)[keyof typeof GenerateLinkIntent];
|
|
3196
|
+
//#endregion
|
|
2950
3197
|
//#region src/common/interfaces/get-options.interface.d.ts
|
|
2951
3198
|
interface GetOptions {
|
|
2952
3199
|
query?: Record<string, any>;
|
|
@@ -3037,6 +3284,7 @@ interface WorkOSResponseError {
|
|
|
3037
3284
|
error?: string;
|
|
3038
3285
|
errors?: UnprocessableEntityError[];
|
|
3039
3286
|
message: string;
|
|
3287
|
+
[key: string]: unknown;
|
|
3040
3288
|
}
|
|
3041
3289
|
//#endregion
|
|
3042
3290
|
//#region src/organizations/interfaces/domain-data.interface.d.ts
|
|
@@ -3071,20 +3319,34 @@ interface ListOrganizationFeatureFlagsOptions extends PaginationOptions {
|
|
|
3071
3319
|
//#endregion
|
|
3072
3320
|
//#region src/organizations/interfaces/list-organizations-options.interface.d.ts
|
|
3073
3321
|
interface ListOrganizationsOptions extends PaginationOptions {
|
|
3322
|
+
/** The domains of an Organization. Any Organization with a matching domain will be returned. */
|
|
3074
3323
|
domains?: string[];
|
|
3075
3324
|
}
|
|
3076
3325
|
//#endregion
|
|
3077
3326
|
//#region src/organizations/interfaces/organization.interface.d.ts
|
|
3078
3327
|
interface Organization {
|
|
3328
|
+
/** Distinguishes the Organization object. */
|
|
3079
3329
|
object: 'organization';
|
|
3330
|
+
/** Unique identifier of the Organization. */
|
|
3080
3331
|
id: string;
|
|
3332
|
+
/** A descriptive name for the Organization. This field does not need to be unique. */
|
|
3081
3333
|
name: string;
|
|
3334
|
+
/**
|
|
3335
|
+
* Whether the Organization allows profiles outside of its managed domains.
|
|
3336
|
+
* @deprecated
|
|
3337
|
+
*/
|
|
3082
3338
|
allowProfilesOutsideOrganization: boolean;
|
|
3339
|
+
/** List of Organization Domains. */
|
|
3083
3340
|
domains: OrganizationDomain[];
|
|
3341
|
+
/** The Stripe customer ID of the Organization. */
|
|
3084
3342
|
stripeCustomerId?: string;
|
|
3343
|
+
/** An ISO 8601 timestamp. */
|
|
3085
3344
|
createdAt: string;
|
|
3345
|
+
/** An ISO 8601 timestamp. */
|
|
3086
3346
|
updatedAt: string;
|
|
3347
|
+
/** The external ID of the Organization. */
|
|
3087
3348
|
externalId: string | null;
|
|
3349
|
+
/** Object containing [metadata](https://workos.com/docs/authkit/metadata) key/value pairs associated with the Organization. */
|
|
3088
3350
|
metadata: Record<string, string>;
|
|
3089
3351
|
}
|
|
3090
3352
|
interface OrganizationResponse {
|
|
@@ -3298,14 +3560,6 @@ declare class PKCE {
|
|
|
3298
3560
|
private base64UrlEncode;
|
|
3299
3561
|
}
|
|
3300
3562
|
//#endregion
|
|
3301
|
-
//#region src/api-keys/api-keys.d.ts
|
|
3302
|
-
declare class ApiKeys {
|
|
3303
|
-
private readonly workos;
|
|
3304
|
-
constructor(workos: WorkOS);
|
|
3305
|
-
validateApiKey(payload: ValidateApiKeyOptions): Promise<ValidateApiKeyResponse>;
|
|
3306
|
-
deleteApiKey(id: string): Promise<void>;
|
|
3307
|
-
}
|
|
3308
|
-
//#endregion
|
|
3309
3563
|
//#region src/common/utils/pagination.d.ts
|
|
3310
3564
|
declare class AutoPaginatable<ResourceType, ParametersType extends PaginationOptions = PaginationOptions> {
|
|
3311
3565
|
protected list: List<ResourceType>;
|
|
@@ -3326,16 +3580,153 @@ declare class AutoPaginatable<ResourceType, ParametersType extends PaginationOpt
|
|
|
3326
3580
|
autoPagination(): Promise<ResourceType[]>;
|
|
3327
3581
|
}
|
|
3328
3582
|
//#endregion
|
|
3583
|
+
//#region src/api-keys/api-keys.d.ts
|
|
3584
|
+
declare class ApiKeys {
|
|
3585
|
+
private readonly workos;
|
|
3586
|
+
constructor(workos: WorkOS);
|
|
3587
|
+
/**
|
|
3588
|
+
* Validate API key
|
|
3589
|
+
*
|
|
3590
|
+
* Validate an API key value and return the API key object if valid.
|
|
3591
|
+
* @param payload - Object containing value.
|
|
3592
|
+
* @returns {Promise<ApiKeyValidationResponse>}
|
|
3593
|
+
* @throws {UnauthorizedException} 401
|
|
3594
|
+
* @throws {UnprocessableEntityException} 422
|
|
3595
|
+
*/
|
|
3596
|
+
createValidation(payload: ValidateApiKeyOptions): Promise<ValidateApiKeyResponse>;
|
|
3597
|
+
/**
|
|
3598
|
+
* Delete an API key
|
|
3599
|
+
*
|
|
3600
|
+
* Permanently deletes an API key. This action cannot be undone. Once deleted, any requests using this API key will fail authentication.
|
|
3601
|
+
* @param id - The unique ID of the API key.
|
|
3602
|
+
*
|
|
3603
|
+
* @example
|
|
3604
|
+
* "api_key_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
3605
|
+
*
|
|
3606
|
+
* @returns {Promise<void>}
|
|
3607
|
+
* @throws {NotFoundException} 404
|
|
3608
|
+
*/
|
|
3609
|
+
deleteApiKey(id: string): Promise<void>;
|
|
3610
|
+
/**
|
|
3611
|
+
* List API keys for an organization
|
|
3612
|
+
*
|
|
3613
|
+
* Get a list of all API keys for an organization.
|
|
3614
|
+
* @param organizationId - Unique identifier of the Organization.
|
|
3615
|
+
*
|
|
3616
|
+
* @example
|
|
3617
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
3618
|
+
*
|
|
3619
|
+
* @param options - Pagination and filter options.
|
|
3620
|
+
* @returns {Promise<AutoPaginatable<ApiKey>>}
|
|
3621
|
+
* @throws {NotFoundException} 404
|
|
3622
|
+
*/
|
|
3623
|
+
listOrganizationApiKeys(options: ListOrganizationApiKeysOptions): Promise<AutoPaginatable<ApiKey>>;
|
|
3624
|
+
/**
|
|
3625
|
+
* Create an API key for an organization
|
|
3626
|
+
*
|
|
3627
|
+
* Create a new API key for an organization.
|
|
3628
|
+
* @param organizationId - Unique identifier of the Organization.
|
|
3629
|
+
*
|
|
3630
|
+
* @example
|
|
3631
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
3632
|
+
*
|
|
3633
|
+
* @param options - Object containing name.
|
|
3634
|
+
* @returns {Promise<ApiKeyWithValue>}
|
|
3635
|
+
* @throws {NotFoundException} 404
|
|
3636
|
+
* @throws {UnprocessableEntityException} 422
|
|
3637
|
+
*/
|
|
3638
|
+
createOrganizationApiKey(options: CreateOrganizationApiKeyOptions, requestOptions?: CreateOrganizationApiKeyRequestOptions): Promise<CreatedApiKey>;
|
|
3639
|
+
}
|
|
3640
|
+
//#endregion
|
|
3329
3641
|
//#region src/directory-sync/directory-sync.d.ts
|
|
3330
3642
|
declare class DirectorySync {
|
|
3331
3643
|
private readonly workos;
|
|
3332
3644
|
constructor(workos: WorkOS);
|
|
3645
|
+
/**
|
|
3646
|
+
* List Directories
|
|
3647
|
+
*
|
|
3648
|
+
* Get a list of all of your existing directories matching the criteria specified.
|
|
3649
|
+
* @param options - Pagination and filter options.
|
|
3650
|
+
* @returns {Promise<AutoPaginatable<Directory, SerializedListDirectoriesOptions>>}
|
|
3651
|
+
* @throws 403 response from the API.
|
|
3652
|
+
* @throws {UnprocessableEntityException} 422
|
|
3653
|
+
*/
|
|
3333
3654
|
listDirectories(options?: ListDirectoriesOptions): Promise<AutoPaginatable<Directory, SerializedListDirectoriesOptions>>;
|
|
3655
|
+
/**
|
|
3656
|
+
* Get a Directory
|
|
3657
|
+
*
|
|
3658
|
+
* Get the details of an existing directory.
|
|
3659
|
+
* @param id - Unique identifier for the Directory.
|
|
3660
|
+
*
|
|
3661
|
+
* @example
|
|
3662
|
+
* "directory_01ECAZ4NV9QMV47GW873HDCX74"
|
|
3663
|
+
*
|
|
3664
|
+
* @returns {Promise<Directory>}
|
|
3665
|
+
* @throws 403 response from the API.
|
|
3666
|
+
* @throws {NotFoundException} 404
|
|
3667
|
+
*/
|
|
3334
3668
|
getDirectory(id: string): Promise<Directory>;
|
|
3669
|
+
/**
|
|
3670
|
+
* Delete a Directory
|
|
3671
|
+
*
|
|
3672
|
+
* Permanently deletes an existing directory. It cannot be undone.
|
|
3673
|
+
* @param id - Unique identifier for the Directory.
|
|
3674
|
+
*
|
|
3675
|
+
* @example
|
|
3676
|
+
* "directory_01ECAZ4NV9QMV47GW873HDCX74"
|
|
3677
|
+
*
|
|
3678
|
+
* @returns {Promise<void>}
|
|
3679
|
+
* @throws 403 response from the API.
|
|
3680
|
+
*/
|
|
3335
3681
|
deleteDirectory(id: string): Promise<void>;
|
|
3682
|
+
/**
|
|
3683
|
+
* List Directory Groups
|
|
3684
|
+
*
|
|
3685
|
+
* Get a list of all of existing directory groups matching the criteria specified.
|
|
3686
|
+
* @param options - Pagination and filter options.
|
|
3687
|
+
* @returns {Promise<AutoPaginatable<DirectoryGroup, ListDirectoryGroupsOptions>>}
|
|
3688
|
+
* @throws 403 response from the API.
|
|
3689
|
+
* @throws {NotFoundException} 404
|
|
3690
|
+
* @throws {UnprocessableEntityException} 422
|
|
3691
|
+
*/
|
|
3336
3692
|
listGroups(options: ListDirectoryGroupsOptions): Promise<AutoPaginatable<DirectoryGroup, ListDirectoryGroupsOptions>>;
|
|
3693
|
+
/**
|
|
3694
|
+
* List Directory Users
|
|
3695
|
+
*
|
|
3696
|
+
* Get a list of all of existing Directory Users matching the criteria specified.
|
|
3697
|
+
* @param options - Pagination and filter options.
|
|
3698
|
+
* @returns {Promise<AutoPaginatable<DirectoryUserWithGroups<TCustomAttributes>, ListDirectoryUsersOptions>>}
|
|
3699
|
+
* @throws 403 response from the API.
|
|
3700
|
+
* @throws {NotFoundException} 404
|
|
3701
|
+
* @throws {UnprocessableEntityException} 422
|
|
3702
|
+
* @throws {RateLimitExceededException} 429
|
|
3703
|
+
*/
|
|
3337
3704
|
listUsers<TCustomAttributes extends object = DefaultCustomAttributes>(options: ListDirectoryUsersOptions): Promise<AutoPaginatable<DirectoryUserWithGroups<TCustomAttributes>, ListDirectoryUsersOptions>>;
|
|
3705
|
+
/**
|
|
3706
|
+
* Get a Directory User
|
|
3707
|
+
*
|
|
3708
|
+
* Get the details of an existing Directory User.
|
|
3709
|
+
* @param user - Unique identifier for the Directory User.
|
|
3710
|
+
*
|
|
3711
|
+
* @example
|
|
3712
|
+
* "directory_user_01E1JG7J09H96KYP8HM9B0G5SJ"
|
|
3713
|
+
* @returns {Promise<DirectoryUserWithGroups<TCustomAttributes>>}
|
|
3714
|
+
* @throws 403 response from the API.
|
|
3715
|
+
* @throws {NotFoundException} 404
|
|
3716
|
+
*/
|
|
3338
3717
|
getUser<TCustomAttributes extends object = DefaultCustomAttributes>(user: string): Promise<DirectoryUserWithGroups<TCustomAttributes>>;
|
|
3718
|
+
/**
|
|
3719
|
+
* Get a Directory Group
|
|
3720
|
+
*
|
|
3721
|
+
* Get the details of an existing Directory Group.
|
|
3722
|
+
* @param group - Unique identifier for the Directory Group.
|
|
3723
|
+
*
|
|
3724
|
+
* @example
|
|
3725
|
+
* "directory_group_01E1JJS84MFPPQ3G655FHTKX6Z"
|
|
3726
|
+
* @returns {Promise<DirectoryGroup>}
|
|
3727
|
+
* @throws 403 response from the API.
|
|
3728
|
+
* @throws {NotFoundException} 404
|
|
3729
|
+
*/
|
|
3339
3730
|
getGroup(group: string): Promise<DirectoryGroup>;
|
|
3340
3731
|
}
|
|
3341
3732
|
//#endregion
|
|
@@ -3363,38 +3754,148 @@ interface SerializedListEventOptions {
|
|
|
3363
3754
|
declare class Events {
|
|
3364
3755
|
private readonly workos;
|
|
3365
3756
|
constructor(workos: WorkOS);
|
|
3757
|
+
/**
|
|
3758
|
+
* List events
|
|
3759
|
+
*
|
|
3760
|
+
* List events for the current environment.
|
|
3761
|
+
* @param options - Pagination and filter options.
|
|
3762
|
+
* @returns {Promise<List<Event>>}
|
|
3763
|
+
* @throws {BadRequestException} 400
|
|
3764
|
+
* @throws {UnprocessableEntityException} 422
|
|
3765
|
+
*/
|
|
3366
3766
|
listEvents(options: ListEventOptions): Promise<List<Event>>;
|
|
3367
3767
|
}
|
|
3368
3768
|
//#endregion
|
|
3369
|
-
//#region src/organizations/interfaces/list-organization-roles-options.interface.d.ts
|
|
3370
|
-
interface ListOrganizationRolesOptions {
|
|
3371
|
-
organizationId: string;
|
|
3372
|
-
}
|
|
3373
|
-
//#endregion
|
|
3374
3769
|
//#region src/organizations/organizations.d.ts
|
|
3375
3770
|
declare class Organizations {
|
|
3376
3771
|
private readonly workos;
|
|
3377
3772
|
constructor(workos: WorkOS);
|
|
3773
|
+
/**
|
|
3774
|
+
* List Organizations
|
|
3775
|
+
*
|
|
3776
|
+
* Get a list of all of your existing organizations matching the criteria specified.
|
|
3777
|
+
* @param options - Pagination and filter options.
|
|
3778
|
+
* @returns {Promise<AutoPaginatable<Organization, ListOrganizationsOptions>>}
|
|
3779
|
+
* @throws {UnprocessableEntityException} 422
|
|
3780
|
+
*/
|
|
3378
3781
|
listOrganizations(options?: ListOrganizationsOptions): Promise<AutoPaginatable<Organization, ListOrganizationsOptions>>;
|
|
3782
|
+
/**
|
|
3783
|
+
* Create an Organization
|
|
3784
|
+
*
|
|
3785
|
+
* Creates a new organization in the current environment.
|
|
3786
|
+
* @param payload - Object containing name.
|
|
3787
|
+
* @returns {Promise<Organization>}
|
|
3788
|
+
* @throws {BadRequestException} 400
|
|
3789
|
+
* @throws {ConflictException} 409
|
|
3790
|
+
* @throws {UnprocessableEntityException} 422
|
|
3791
|
+
*/
|
|
3379
3792
|
createOrganization(payload: CreateOrganizationOptions, requestOptions?: CreateOrganizationRequestOptions): Promise<Organization>;
|
|
3793
|
+
/**
|
|
3794
|
+
* Delete an Organization
|
|
3795
|
+
*
|
|
3796
|
+
* Permanently deletes an organization in the current environment. It cannot be undone.
|
|
3797
|
+
* @param id - Unique identifier of the Organization.
|
|
3798
|
+
*
|
|
3799
|
+
* @example
|
|
3800
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
3801
|
+
*
|
|
3802
|
+
* @returns {Promise<void>}
|
|
3803
|
+
* @throws 403 response from the API.
|
|
3804
|
+
*/
|
|
3380
3805
|
deleteOrganization(id: string): Promise<void>;
|
|
3806
|
+
/**
|
|
3807
|
+
* Get an Organization
|
|
3808
|
+
*
|
|
3809
|
+
* Get the details of an existing organization.
|
|
3810
|
+
* @param id - Unique identifier of the Organization.
|
|
3811
|
+
*
|
|
3812
|
+
* @example
|
|
3813
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
3814
|
+
*
|
|
3815
|
+
* @returns {Promise<Organization>}
|
|
3816
|
+
* @throws {NotFoundException} 404
|
|
3817
|
+
*/
|
|
3381
3818
|
getOrganization(id: string): Promise<Organization>;
|
|
3819
|
+
/**
|
|
3820
|
+
* Get an Organization by External ID
|
|
3821
|
+
*
|
|
3822
|
+
* Get the details of an existing organization by an [external identifier](https://workos.com/docs/authkit/metadata/external-identifiers).
|
|
3823
|
+
* @param externalId - The external ID of the Organization.
|
|
3824
|
+
*
|
|
3825
|
+
* @example
|
|
3826
|
+
* "2fe01467-f7ea-4dd2-8b79-c2b4f56d0191"
|
|
3827
|
+
*
|
|
3828
|
+
* @returns {Promise<Organization>}
|
|
3829
|
+
* @throws {NotFoundException} 404
|
|
3830
|
+
*/
|
|
3382
3831
|
getOrganizationByExternalId(externalId: string): Promise<Organization>;
|
|
3832
|
+
/**
|
|
3833
|
+
* Update an Organization
|
|
3834
|
+
*
|
|
3835
|
+
* Updates an organization in the current environment.
|
|
3836
|
+
* @param payload - The request body.
|
|
3837
|
+
* @returns {Promise<Organization>}
|
|
3838
|
+
* @throws {BadRequestException} 400
|
|
3839
|
+
* @throws 403 response from the API.
|
|
3840
|
+
* @throws {NotFoundException} 404
|
|
3841
|
+
* @throws {ConflictException} 409
|
|
3842
|
+
* @throws {UnprocessableEntityException} 422
|
|
3843
|
+
*/
|
|
3383
3844
|
updateOrganization(options: UpdateOrganizationOptions): Promise<Organization>;
|
|
3384
|
-
listOrganizationRoles(options: ListOrganizationRolesOptions): Promise<RoleList>;
|
|
3385
|
-
listOrganizationFeatureFlags(options: ListOrganizationFeatureFlagsOptions): Promise<AutoPaginatable<FeatureFlag>>;
|
|
3386
|
-
listOrganizationApiKeys(options: ListOrganizationApiKeysOptions): Promise<AutoPaginatable<ApiKey>>;
|
|
3387
|
-
createOrganizationApiKey(options: CreateOrganizationApiKeyOptions, requestOptions?: CreateOrganizationApiKeyRequestOptions): Promise<CreatedApiKey>;
|
|
3388
3845
|
}
|
|
3389
3846
|
//#endregion
|
|
3390
3847
|
//#region src/organization-domains/organization-domains.d.ts
|
|
3391
3848
|
declare class OrganizationDomains {
|
|
3392
3849
|
private readonly workos;
|
|
3393
3850
|
constructor(workos: WorkOS);
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3851
|
+
/**
|
|
3852
|
+
* Get an Organization Domain
|
|
3853
|
+
*
|
|
3854
|
+
* Get the details of an existing organization domain.
|
|
3855
|
+
* @param id - Unique identifier of the organization domain.
|
|
3856
|
+
*
|
|
3857
|
+
* @example
|
|
3858
|
+
* "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A"
|
|
3859
|
+
*
|
|
3860
|
+
* @returns {Promise<OrganizationDomain>}
|
|
3861
|
+
* @throws {NotFoundException} 404
|
|
3862
|
+
*/
|
|
3863
|
+
getOrganizationDomain(id: string): Promise<OrganizationDomain>;
|
|
3864
|
+
/**
|
|
3865
|
+
* Verify an Organization Domain
|
|
3866
|
+
*
|
|
3867
|
+
* Initiates verification process for an Organization Domain.
|
|
3868
|
+
* @param id - Unique identifier of the organization domain.
|
|
3869
|
+
*
|
|
3870
|
+
* @example
|
|
3871
|
+
* "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A"
|
|
3872
|
+
*
|
|
3873
|
+
* @returns {Promise<OrganizationDomain>}
|
|
3874
|
+
* @throws {BadRequestException} 400
|
|
3875
|
+
*/
|
|
3876
|
+
verifyOrganizationDomain(id: string): Promise<OrganizationDomain>;
|
|
3877
|
+
/**
|
|
3878
|
+
* Create an Organization Domain
|
|
3879
|
+
*
|
|
3880
|
+
* Creates a new Organization Domain.
|
|
3881
|
+
* @param payload - Object containing domain, organizationId.
|
|
3882
|
+
* @returns {Promise<OrganizationDomain>}
|
|
3883
|
+
* @throws {ConflictException} 409
|
|
3884
|
+
*/
|
|
3885
|
+
createOrganizationDomain(payload: CreateOrganizationDomainOptions): Promise<OrganizationDomain>;
|
|
3886
|
+
/**
|
|
3887
|
+
* Delete an Organization Domain
|
|
3888
|
+
*
|
|
3889
|
+
* Permanently deletes an organization domain. It cannot be undone.
|
|
3890
|
+
* @param id - Unique identifier of the organization domain.
|
|
3891
|
+
*
|
|
3892
|
+
* @example
|
|
3893
|
+
* "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A"
|
|
3894
|
+
*
|
|
3895
|
+
* @returns {Promise<void>}
|
|
3896
|
+
* @throws {NotFoundException} 404
|
|
3897
|
+
*/
|
|
3898
|
+
deleteOrganizationDomain(id: string): Promise<void>;
|
|
3398
3899
|
}
|
|
3399
3900
|
//#endregion
|
|
3400
3901
|
//#region src/passwordless/interfaces/passwordless-session.interface.d.ts
|
|
@@ -3485,31 +3986,40 @@ declare class Pipes {
|
|
|
3485
3986
|
}): Promise<GetAccessTokenResponse>;
|
|
3486
3987
|
}
|
|
3487
3988
|
//#endregion
|
|
3488
|
-
//#region src/portal/
|
|
3489
|
-
declare
|
|
3490
|
-
AuditLogs = "audit_logs",
|
|
3491
|
-
DomainVerification = "domain_verification",
|
|
3492
|
-
DSync = "dsync",
|
|
3493
|
-
LogStreams = "log_streams",
|
|
3494
|
-
SSO = "sso",
|
|
3495
|
-
CertificateRenewal = "certificate_renewal",
|
|
3496
|
-
BringYourOwnKey = "bring_your_own_key"
|
|
3497
|
-
}
|
|
3498
|
-
//#endregion
|
|
3499
|
-
//#region src/portal/portal.d.ts
|
|
3500
|
-
declare class Portal {
|
|
3989
|
+
//#region src/admin-portal/admin-portal.d.ts
|
|
3990
|
+
declare class AdminPortal {
|
|
3501
3991
|
private readonly workos;
|
|
3502
3992
|
constructor(workos: WorkOS);
|
|
3993
|
+
/**
|
|
3994
|
+
* Generate a Portal Link
|
|
3995
|
+
*
|
|
3996
|
+
* Generate a Portal Link scoped to an Organization.
|
|
3997
|
+
* @param payload - Object containing organization.
|
|
3998
|
+
* @returns {Promise<{ link: string; }>}
|
|
3999
|
+
* @throws {BadRequestException} 400
|
|
4000
|
+
* @throws 403 response from the API.
|
|
4001
|
+
* @throws {NotFoundException} 404
|
|
4002
|
+
* @throws {UnprocessableEntityException} 422
|
|
4003
|
+
*/
|
|
3503
4004
|
generateLink({
|
|
3504
4005
|
intent,
|
|
3505
4006
|
organization,
|
|
3506
4007
|
returnUrl,
|
|
3507
|
-
successUrl
|
|
4008
|
+
successUrl,
|
|
4009
|
+
intentOptions,
|
|
4010
|
+
adminEmails
|
|
3508
4011
|
}: {
|
|
3509
|
-
intent
|
|
4012
|
+
intent?: GenerateLinkIntent;
|
|
3510
4013
|
organization: string;
|
|
3511
4014
|
returnUrl?: string;
|
|
3512
4015
|
successUrl?: string;
|
|
4016
|
+
intentOptions?: {
|
|
4017
|
+
sso: {
|
|
4018
|
+
bookmarkSlug?: string;
|
|
4019
|
+
providerType?: string;
|
|
4020
|
+
};
|
|
4021
|
+
};
|
|
4022
|
+
adminEmails?: string[];
|
|
3513
4023
|
}): Promise<{
|
|
3514
4024
|
link: string;
|
|
3515
4025
|
}>;
|
|
@@ -3519,13 +4029,35 @@ declare class Portal {
|
|
|
3519
4029
|
declare class SSO {
|
|
3520
4030
|
private readonly workos;
|
|
3521
4031
|
constructor(workos: WorkOS);
|
|
3522
|
-
listConnections(options?: ListConnectionsOptions): Promise<AutoPaginatable<Connection, SerializedListConnectionsOptions>>;
|
|
3523
|
-
deleteConnection(id: string): Promise<void>;
|
|
3524
|
-
getAuthorizationUrl(options: SSOAuthorizationURLOptions): string;
|
|
3525
4032
|
/**
|
|
3526
|
-
*
|
|
3527
|
-
*
|
|
3528
|
-
*
|
|
4033
|
+
* List Connections
|
|
4034
|
+
*
|
|
4035
|
+
* Get a list of all of your existing connections matching the criteria specified.
|
|
4036
|
+
* @param options - Pagination and filter options.
|
|
4037
|
+
* @returns {Promise<AutoPaginatable<Connection, SerializedListConnectionsOptions>>}
|
|
4038
|
+
* @throws 403 response from the API.
|
|
4039
|
+
* @throws {UnprocessableEntityException} 422
|
|
4040
|
+
*/
|
|
4041
|
+
listConnections(options?: ListConnectionsOptions): Promise<AutoPaginatable<Connection, SerializedListConnectionsOptions>>;
|
|
4042
|
+
/**
|
|
4043
|
+
* Delete a Connection
|
|
4044
|
+
*
|
|
4045
|
+
* Permanently deletes an existing connection. It cannot be undone.
|
|
4046
|
+
* @param id - Unique identifier for the Connection.
|
|
4047
|
+
*
|
|
4048
|
+
* @example
|
|
4049
|
+
* "conn_01E4ZCR3C56J083X43JQXF3JK5"
|
|
4050
|
+
*
|
|
4051
|
+
* @returns {Promise<void>}
|
|
4052
|
+
* @throws 403 response from the API.
|
|
4053
|
+
* @throws {NotFoundException} 404
|
|
4054
|
+
*/
|
|
4055
|
+
deleteConnection(id: string): Promise<void>;
|
|
4056
|
+
getAuthorizationUrl(options: SSOAuthorizationURLOptions): string;
|
|
4057
|
+
/**
|
|
4058
|
+
* Generates an authorization URL with PKCE parameters automatically generated.
|
|
4059
|
+
* Use this for public clients (CLI apps, Electron, mobile) that cannot
|
|
4060
|
+
* securely store a client secret.
|
|
3529
4061
|
*
|
|
3530
4062
|
* @returns Object containing url, state, and codeVerifier
|
|
3531
4063
|
*
|
|
@@ -3547,6 +4079,19 @@ declare class SSO {
|
|
|
3547
4079
|
* ```
|
|
3548
4080
|
*/
|
|
3549
4081
|
getAuthorizationUrlWithPKCE(options: Omit<SSOAuthorizationURLOptions, 'codeChallenge' | 'codeChallengeMethod' | 'state'>): Promise<SSOPKCEAuthorizationURLResult>;
|
|
4082
|
+
/**
|
|
4083
|
+
* Get a Connection
|
|
4084
|
+
*
|
|
4085
|
+
* Get the details of an existing connection.
|
|
4086
|
+
* @param id - Unique identifier for the Connection.
|
|
4087
|
+
*
|
|
4088
|
+
* @example
|
|
4089
|
+
* "conn_01E4ZCR3C56J083X43JQXF3JK5"
|
|
4090
|
+
*
|
|
4091
|
+
* @returns {Promise<Connection>}
|
|
4092
|
+
* @throws 403 response from the API.
|
|
4093
|
+
* @throws {NotFoundException} 404
|
|
4094
|
+
*/
|
|
3550
4095
|
getConnection(id: string): Promise<Connection>;
|
|
3551
4096
|
/**
|
|
3552
4097
|
* Exchange an authorization code for a profile and access token.
|
|
@@ -3566,12 +4111,20 @@ declare class SSO {
|
|
|
3566
4111
|
clientId,
|
|
3567
4112
|
codeVerifier
|
|
3568
4113
|
}: GetProfileAndTokenOptions): Promise<ProfileAndToken<CustomAttributesType>>;
|
|
4114
|
+
/**
|
|
4115
|
+
* Get a User Profile
|
|
4116
|
+
*
|
|
4117
|
+
* Exchange an access token for a user's [Profile](https://workos.com/docs/reference/sso/profile). Because this profile is returned in the [Get a Profile and Token endpoint](https://workos.com/docs/reference/sso/profile/get-profile-and-token) your application usually does not need to call this endpoint. It is available for any authentication flows that require an additional endpoint to retrieve a user's profile.
|
|
4118
|
+
* @returns {Promise<Profile<CustomAttributesType>>}
|
|
4119
|
+
* @throws {UnauthorizedException} 401
|
|
4120
|
+
* @throws {NotFoundException} 404
|
|
4121
|
+
*/
|
|
3569
4122
|
getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({
|
|
3570
4123
|
accessToken
|
|
3571
4124
|
}: GetProfileOptions): Promise<Profile<CustomAttributesType>>;
|
|
3572
4125
|
}
|
|
3573
4126
|
//#endregion
|
|
3574
|
-
//#region src/
|
|
4127
|
+
//#region src/multi-factor-auth/interfaces/challenge-factor-options.d.ts
|
|
3575
4128
|
type ChallengeFactorOptions = {
|
|
3576
4129
|
authenticationFactorId: string;
|
|
3577
4130
|
} | {
|
|
@@ -3579,7 +4132,7 @@ type ChallengeFactorOptions = {
|
|
|
3579
4132
|
smsTemplate: string;
|
|
3580
4133
|
};
|
|
3581
4134
|
//#endregion
|
|
3582
|
-
//#region src/
|
|
4135
|
+
//#region src/multi-factor-auth/interfaces/challenge.interface.d.ts
|
|
3583
4136
|
interface Challenge {
|
|
3584
4137
|
object: 'authentication_challenge';
|
|
3585
4138
|
id: string;
|
|
@@ -3590,7 +4143,7 @@ interface Challenge {
|
|
|
3590
4143
|
authenticationFactorId: string;
|
|
3591
4144
|
}
|
|
3592
4145
|
//#endregion
|
|
3593
|
-
//#region src/
|
|
4146
|
+
//#region src/multi-factor-auth/interfaces/enroll-factor-options.d.ts
|
|
3594
4147
|
type EnrollFactorOptions = {
|
|
3595
4148
|
type: 'sms';
|
|
3596
4149
|
phoneNumber: string;
|
|
@@ -3602,12 +4155,12 @@ type EnrollFactorOptions = {
|
|
|
3602
4155
|
type: 'generic_otp';
|
|
3603
4156
|
};
|
|
3604
4157
|
//#endregion
|
|
3605
|
-
//#region src/
|
|
4158
|
+
//#region src/multi-factor-auth/interfaces/sms.interface.d.ts
|
|
3606
4159
|
interface Sms {
|
|
3607
4160
|
phoneNumber: string;
|
|
3608
4161
|
}
|
|
3609
4162
|
//#endregion
|
|
3610
|
-
//#region src/
|
|
4163
|
+
//#region src/multi-factor-auth/interfaces/factor.interface.d.ts
|
|
3611
4164
|
type FactorType = 'sms' | 'totp' | 'generic_otp';
|
|
3612
4165
|
interface Factor {
|
|
3613
4166
|
object: 'authentication_factor';
|
|
@@ -3628,27 +4181,99 @@ interface FactorWithSecrets {
|
|
|
3628
4181
|
totp?: TotpWithSecrets;
|
|
3629
4182
|
}
|
|
3630
4183
|
//#endregion
|
|
3631
|
-
//#region src/
|
|
4184
|
+
//#region src/multi-factor-auth/interfaces/verify-challenge-options.d.ts
|
|
3632
4185
|
interface VerifyChallengeOptions {
|
|
3633
4186
|
authenticationChallengeId: string;
|
|
3634
4187
|
code: string;
|
|
3635
4188
|
}
|
|
3636
4189
|
//#endregion
|
|
3637
|
-
//#region src/
|
|
4190
|
+
//#region src/multi-factor-auth/interfaces/verify-challenge-response.d.ts
|
|
3638
4191
|
interface VerifyResponse {
|
|
3639
4192
|
challenge: Challenge;
|
|
3640
4193
|
valid: boolean;
|
|
3641
4194
|
}
|
|
3642
4195
|
//#endregion
|
|
3643
|
-
//#region src/
|
|
3644
|
-
declare class
|
|
4196
|
+
//#region src/multi-factor-auth/multi-factor-auth.d.ts
|
|
4197
|
+
declare class MultiFactorAuth {
|
|
3645
4198
|
private readonly workos;
|
|
3646
4199
|
constructor(workos: WorkOS);
|
|
4200
|
+
/**
|
|
4201
|
+
* Delete Factor
|
|
4202
|
+
*
|
|
4203
|
+
* Permanently deletes an Authentication Factor. It cannot be undone.
|
|
4204
|
+
* @param id - The unique ID of the Factor.
|
|
4205
|
+
*
|
|
4206
|
+
* @example
|
|
4207
|
+
* "auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ"
|
|
4208
|
+
*
|
|
4209
|
+
* @returns {Promise<void>}
|
|
4210
|
+
* @throws {NotFoundException} 404
|
|
4211
|
+
*/
|
|
3647
4212
|
deleteFactor(id: string): Promise<void>;
|
|
4213
|
+
/**
|
|
4214
|
+
* Get Factor
|
|
4215
|
+
*
|
|
4216
|
+
* Gets an Authentication Factor.
|
|
4217
|
+
* @param id - The unique ID of the Factor.
|
|
4218
|
+
*
|
|
4219
|
+
* @example
|
|
4220
|
+
* "auth_factor_01FVYZ5QM8N98T9ME5BCB2BBMJ"
|
|
4221
|
+
*
|
|
4222
|
+
* @returns {Promise<Factor>}
|
|
4223
|
+
* @throws {NotFoundException} 404
|
|
4224
|
+
*/
|
|
3648
4225
|
getFactor(id: string): Promise<Factor>;
|
|
4226
|
+
/**
|
|
4227
|
+
* Enroll Factor
|
|
4228
|
+
*
|
|
4229
|
+
* Enrolls an Authentication Factor to be used as an additional factor of authentication. The returned ID should be used to create an authentication Challenge.
|
|
4230
|
+
* @param options - Object containing type.
|
|
4231
|
+
* @returns {Promise<FactorWithSecrets>}
|
|
4232
|
+
* @throws {UnprocessableEntityException} 422
|
|
4233
|
+
*/
|
|
3649
4234
|
enrollFactor(options: EnrollFactorOptions): Promise<FactorWithSecrets>;
|
|
4235
|
+
/**
|
|
4236
|
+
* Challenge Factor
|
|
4237
|
+
*
|
|
4238
|
+
* Creates a Challenge for an Authentication Factor.
|
|
4239
|
+
* @param options - The request body.
|
|
4240
|
+
* @returns {Promise<Challenge>}
|
|
4241
|
+
* @throws {NotFoundException} 404
|
|
4242
|
+
* @throws {UnprocessableEntityException} 422
|
|
4243
|
+
*/
|
|
3650
4244
|
challengeFactor(options: ChallengeFactorOptions): Promise<Challenge>;
|
|
4245
|
+
/**
|
|
4246
|
+
* Verify Challenge
|
|
4247
|
+
*
|
|
4248
|
+
* Verifies an Authentication Challenge.
|
|
4249
|
+
* @param options - Object containing code.
|
|
4250
|
+
* @returns {Promise<VerifyResponse>}
|
|
4251
|
+
* @throws {BadRequestException} 400
|
|
4252
|
+
* @throws {NotFoundException} 404
|
|
4253
|
+
* @throws {UnprocessableEntityException} 422
|
|
4254
|
+
*/
|
|
3651
4255
|
verifyChallenge(options: VerifyChallengeOptions): Promise<VerifyResponse>;
|
|
4256
|
+
/**
|
|
4257
|
+
* Enroll an authentication factor
|
|
4258
|
+
*
|
|
4259
|
+
* Enrolls a user in a new [authentication factor](https://workos.com/docs/reference/authkit/mfa/authentication-factor).
|
|
4260
|
+
* @param payload - Object containing type.
|
|
4261
|
+
* @returns {Promise<{authenticationFactor: UMFactorWithSecrets; authenticationChallenge: Challenge}>}
|
|
4262
|
+
* @throws {UnprocessableEntityException} 422
|
|
4263
|
+
*/
|
|
4264
|
+
createUserAuthFactor(payload: EnrollAuthFactorOptions): Promise<{
|
|
4265
|
+
authenticationFactor: FactorWithSecrets$1;
|
|
4266
|
+
authenticationChallenge: Challenge;
|
|
4267
|
+
}>;
|
|
4268
|
+
/**
|
|
4269
|
+
* List authentication factors
|
|
4270
|
+
*
|
|
4271
|
+
* Lists the [authentication factors](https://workos.com/docs/reference/authkit/mfa/authentication-factor) for a user.
|
|
4272
|
+
* @param options - Pagination and filter options.
|
|
4273
|
+
* @returns {Promise<AutoPaginatable<UMFactor, PaginationOptions>>}
|
|
4274
|
+
* @throws {UnprocessableEntityException} 422
|
|
4275
|
+
*/
|
|
4276
|
+
listUserAuthFactors(options: ListAuthFactorsOptions): Promise<AutoPaginatable<Factor$1, PaginationOptions>>;
|
|
3652
4277
|
}
|
|
3653
4278
|
//#endregion
|
|
3654
4279
|
//#region src/audit-logs/interfaces/audit-log-export-options.interface.d.ts
|
|
@@ -3689,6 +4314,49 @@ interface AuditLogExportResponse {
|
|
|
3689
4314
|
updated_at: string;
|
|
3690
4315
|
}
|
|
3691
4316
|
//#endregion
|
|
4317
|
+
//#region src/audit-logs/interfaces/audit-log-schema.interface.d.ts
|
|
4318
|
+
type AuditLogSchemaMetadata = Record<string, {
|
|
4319
|
+
type: 'string' | 'boolean' | 'number';
|
|
4320
|
+
}> | undefined;
|
|
4321
|
+
interface AuditLogActorSchema {
|
|
4322
|
+
metadata: Record<string, string | boolean | number>;
|
|
4323
|
+
}
|
|
4324
|
+
interface AuditLogTargetSchema {
|
|
4325
|
+
type: string;
|
|
4326
|
+
metadata?: Record<string, string | boolean | number>;
|
|
4327
|
+
}
|
|
4328
|
+
interface AuditLogSchema {
|
|
4329
|
+
object: 'audit_log_schema';
|
|
4330
|
+
version: number;
|
|
4331
|
+
targets: AuditLogTargetSchema[];
|
|
4332
|
+
actor: AuditLogActorSchema | undefined;
|
|
4333
|
+
metadata: Record<string, string | boolean | number> | undefined;
|
|
4334
|
+
createdAt: string;
|
|
4335
|
+
}
|
|
4336
|
+
interface SerializedAuditLogTargetSchema$1 {
|
|
4337
|
+
type: string;
|
|
4338
|
+
metadata?: {
|
|
4339
|
+
type: 'object';
|
|
4340
|
+
properties: AuditLogSchemaMetadata;
|
|
4341
|
+
};
|
|
4342
|
+
}
|
|
4343
|
+
interface AuditLogSchemaResponse {
|
|
4344
|
+
object: 'audit_log_schema';
|
|
4345
|
+
version: number;
|
|
4346
|
+
targets: SerializedAuditLogTargetSchema$1[];
|
|
4347
|
+
actor?: {
|
|
4348
|
+
metadata: {
|
|
4349
|
+
type: 'object';
|
|
4350
|
+
properties: AuditLogSchemaMetadata;
|
|
4351
|
+
};
|
|
4352
|
+
};
|
|
4353
|
+
metadata?: {
|
|
4354
|
+
type: 'object';
|
|
4355
|
+
properties: AuditLogSchemaMetadata;
|
|
4356
|
+
};
|
|
4357
|
+
created_at: string;
|
|
4358
|
+
}
|
|
4359
|
+
//#endregion
|
|
3692
4360
|
//#region src/audit-logs/interfaces/create-audit-log-event-options.interface.d.ts
|
|
3693
4361
|
interface AuditLogActor {
|
|
3694
4362
|
id: string;
|
|
@@ -3729,24 +4397,6 @@ interface SerializedCreateAuditLogEventOptions {
|
|
|
3729
4397
|
type CreateAuditLogEventRequestOptions = Pick<PostOptions, 'idempotencyKey'>;
|
|
3730
4398
|
//#endregion
|
|
3731
4399
|
//#region src/audit-logs/interfaces/create-audit-log-schema-options.interface.d.ts
|
|
3732
|
-
type AuditLogSchemaMetadata = Record<string, {
|
|
3733
|
-
type: 'string' | 'boolean' | 'number';
|
|
3734
|
-
}> | undefined;
|
|
3735
|
-
interface AuditLogSchema {
|
|
3736
|
-
object: 'audit_log_schema';
|
|
3737
|
-
version: number;
|
|
3738
|
-
targets: AuditLogTargetSchema[];
|
|
3739
|
-
actor: AuditLogActorSchema;
|
|
3740
|
-
metadata: Record<string, string | boolean | number> | undefined;
|
|
3741
|
-
createdAt: string;
|
|
3742
|
-
}
|
|
3743
|
-
interface AuditLogActorSchema {
|
|
3744
|
-
metadata: Record<string, string | boolean | number>;
|
|
3745
|
-
}
|
|
3746
|
-
interface AuditLogTargetSchema {
|
|
3747
|
-
type: string;
|
|
3748
|
-
metadata?: Record<string, string | boolean | number> | undefined;
|
|
3749
|
-
}
|
|
3750
4400
|
interface CreateAuditLogSchemaOptions {
|
|
3751
4401
|
action: string;
|
|
3752
4402
|
targets: AuditLogTargetSchema[];
|
|
@@ -3773,32 +4423,64 @@ interface SerializedCreateAuditLogSchemaOptions {
|
|
|
3773
4423
|
properties: AuditLogSchemaMetadata;
|
|
3774
4424
|
};
|
|
3775
4425
|
}
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
version: number;
|
|
3779
|
-
targets: SerializedAuditLogTargetSchema[];
|
|
3780
|
-
actor: {
|
|
3781
|
-
metadata: {
|
|
3782
|
-
type: 'object';
|
|
3783
|
-
properties: AuditLogSchemaMetadata;
|
|
3784
|
-
};
|
|
3785
|
-
};
|
|
3786
|
-
metadata?: {
|
|
3787
|
-
type: 'object';
|
|
3788
|
-
properties: AuditLogSchemaMetadata;
|
|
3789
|
-
};
|
|
3790
|
-
created_at: string;
|
|
3791
|
-
}
|
|
4426
|
+
/** @deprecated Use AuditLogSchemaResponse instead */
|
|
4427
|
+
type CreateAuditLogSchemaResponse = AuditLogSchemaResponse;
|
|
3792
4428
|
type CreateAuditLogSchemaRequestOptions = Pick<PostOptions, 'idempotencyKey'>;
|
|
3793
4429
|
//#endregion
|
|
3794
4430
|
//#region src/audit-logs/audit-logs.d.ts
|
|
3795
4431
|
declare class AuditLogs {
|
|
3796
4432
|
private readonly workos;
|
|
3797
4433
|
constructor(workos: WorkOS);
|
|
4434
|
+
/**
|
|
4435
|
+
* Create Event
|
|
4436
|
+
*
|
|
4437
|
+
* Create an Audit Log Event.
|
|
4438
|
+
*
|
|
4439
|
+
* This API supports idempotency which guarantees that performing the same operation multiple times will have the same result as if the operation were performed only once. This is handy in situations where you may need to retry a request due to a failure or prevent accidental duplicate requests from creating more than one resource.
|
|
4440
|
+
*
|
|
4441
|
+
* To achieve idempotency, you can add `Idempotency-Key` request header to a Create Event request with a unique string as the value. Each subsequent request matching this unique string will return the same response. We suggest using [v4 UUIDs](https://en.wikipedia.org/wiki/Universally_unique_identifier) for idempotency keys to avoid collisions.
|
|
4442
|
+
*
|
|
4443
|
+
* Idempotency keys expire after 24 hours. The API will generate a new response if you submit a request with an expired key.
|
|
4444
|
+
* @param payload - Object containing organizationId, event.
|
|
4445
|
+
* @returns {Promise<void>}
|
|
4446
|
+
* @throws {BadRequestException} 400
|
|
4447
|
+
* @throws {NotFoundException} 404
|
|
4448
|
+
* @throws {UnprocessableEntityException} 422
|
|
4449
|
+
* @throws {RateLimitExceededException} 429
|
|
4450
|
+
*/
|
|
3798
4451
|
createEvent(organization: string, event: CreateAuditLogEventOptions, options?: CreateAuditLogEventRequestOptions): Promise<void>;
|
|
4452
|
+
/**
|
|
4453
|
+
* Create Export
|
|
4454
|
+
*
|
|
4455
|
+
* Create an Audit Log Export. Exports are scoped to a single organization within a specified date range.
|
|
4456
|
+
* @param payload - Object containing organizationId, rangeStart, rangeEnd.
|
|
4457
|
+
* @returns {Promise<AuditLogExport>}
|
|
4458
|
+
* @throws {BadRequestException} 400
|
|
4459
|
+
*/
|
|
3799
4460
|
createExport(options: AuditLogExportOptions): Promise<AuditLogExport>;
|
|
4461
|
+
/**
|
|
4462
|
+
* Get Export
|
|
4463
|
+
*
|
|
4464
|
+
* Get an Audit Log Export. The URL will expire after 10 minutes. If the export is needed again at a later time, refetching the export will regenerate the URL.
|
|
4465
|
+
* @param auditLogExportId - The unique ID of the Audit Log Export.
|
|
4466
|
+
*
|
|
4467
|
+
* @example
|
|
4468
|
+
* "audit_log_export_01GBZK5MP7TD1YCFQHFR22180V"
|
|
4469
|
+
*
|
|
4470
|
+
* @returns {Promise<AuditLogExport>}
|
|
4471
|
+
* @throws {NotFoundException} 404
|
|
4472
|
+
*/
|
|
3800
4473
|
getExport(auditLogExportId: string): Promise<AuditLogExport>;
|
|
4474
|
+
/**
|
|
4475
|
+
* Create Schema
|
|
4476
|
+
*
|
|
4477
|
+
* Creates a new Audit Log schema used to validate the payload of incoming Audit Log Events. If the `action` does not exist, it will also be created.
|
|
4478
|
+
* @param payload - Object containing targets.
|
|
4479
|
+
* @returns {Promise<AuditLogSchema>}
|
|
4480
|
+
* @throws {UnprocessableEntityException} 422
|
|
4481
|
+
*/
|
|
3801
4482
|
createSchema(schema: CreateAuditLogSchemaOptions, options?: CreateAuditLogSchemaRequestOptions): Promise<AuditLogSchema>;
|
|
4483
|
+
listSchemas(action: string, options?: PaginationOptions): Promise<AutoPaginatable<AuditLogSchema, PaginationOptions>>;
|
|
3802
4484
|
}
|
|
3803
4485
|
//#endregion
|
|
3804
4486
|
//#region node_modules/jose/dist/types/types.d.ts
|
|
@@ -4254,11 +4936,51 @@ declare class UserManagement {
|
|
|
4254
4936
|
sessionData: string;
|
|
4255
4937
|
cookiePassword: string;
|
|
4256
4938
|
}): CookieSession;
|
|
4939
|
+
/**
|
|
4940
|
+
* Get a user
|
|
4941
|
+
*
|
|
4942
|
+
* Get the details of an existing user.
|
|
4943
|
+
* @param userId - The unique ID of the user.
|
|
4944
|
+
* @returns {Promise<User>}
|
|
4945
|
+
* @throws {NotFoundException} 404
|
|
4946
|
+
*/
|
|
4257
4947
|
getUser(userId: string): Promise<User>;
|
|
4948
|
+
/**
|
|
4949
|
+
* Get a user by external ID
|
|
4950
|
+
*
|
|
4951
|
+
* Get the details of an existing user by an [external identifier](https://workos.com/docs/authkit/metadata/external-identifiers).
|
|
4952
|
+
* @param externalId - The external ID of the user.
|
|
4953
|
+
*
|
|
4954
|
+
* @example
|
|
4955
|
+
* "f1ffa2b2-c20b-4d39-be5c-212726e11222"
|
|
4956
|
+
*
|
|
4957
|
+
* @returns {Promise<User>}
|
|
4958
|
+
* @throws {NotFoundException} 404
|
|
4959
|
+
*/
|
|
4258
4960
|
getUserByExternalId(externalId: string): Promise<User>;
|
|
4961
|
+
/**
|
|
4962
|
+
* List users
|
|
4963
|
+
*
|
|
4964
|
+
* Get a list of all of your existing users matching the criteria specified.
|
|
4965
|
+
* @param options - Pagination and filter options.
|
|
4966
|
+
* @returns {Promise<AutoPaginatable<User, SerializedListUsersOptions>>}
|
|
4967
|
+
* @throws {UnprocessableEntityException} 422
|
|
4968
|
+
*/
|
|
4259
4969
|
listUsers(options?: ListUsersOptions): Promise<AutoPaginatable<User, SerializedListUsersOptions>>;
|
|
4970
|
+
/**
|
|
4971
|
+
* Create a user
|
|
4972
|
+
*
|
|
4973
|
+
* Create a new user in the current environment.
|
|
4974
|
+
* @param payload - Object containing email.
|
|
4975
|
+
* @returns {Promise<User>}
|
|
4976
|
+
* @throws {BadRequestException} 400
|
|
4977
|
+
* @throws {NotFoundException} 404
|
|
4978
|
+
* @throws {UnprocessableEntityException} 422
|
|
4979
|
+
*/
|
|
4260
4980
|
createUser(payload: CreateUserOptions): Promise<User>;
|
|
4981
|
+
/** Authenticate with magic auth. */
|
|
4261
4982
|
authenticateWithMagicAuth(payload: AuthenticateWithMagicAuthOptions): Promise<AuthenticationResponse>;
|
|
4983
|
+
/** Authenticate with password. */
|
|
4262
4984
|
authenticateWithPassword(payload: AuthenticateWithPasswordOptions): Promise<AuthenticationResponse>;
|
|
4263
4985
|
/**
|
|
4264
4986
|
* Exchange an authorization code for tokens.
|
|
@@ -4290,8 +5012,11 @@ declare class UserManagement {
|
|
|
4290
5012
|
* omits client_secret from the request.
|
|
4291
5013
|
*/
|
|
4292
5014
|
authenticateWithRefreshToken(payload: AuthenticateWithRefreshTokenOptions): Promise<AuthenticationResponse>;
|
|
5015
|
+
/** Authenticate with totp. */
|
|
4293
5016
|
authenticateWithTotp(payload: AuthenticateWithTotpOptions): Promise<AuthenticationResponse>;
|
|
5017
|
+
/** Authenticate with email verification. */
|
|
4294
5018
|
authenticateWithEmailVerification(payload: AuthenticateWithEmailVerificationOptions): Promise<AuthenticationResponse>;
|
|
5019
|
+
/** Authenticate with organization selection. */
|
|
4295
5020
|
authenticateWithOrganizationSelection(payload: AuthenticateWithOrganizationSelectionOptions): Promise<AuthenticationResponse>;
|
|
4296
5021
|
authenticateWithSessionCookie({
|
|
4297
5022
|
sessionData,
|
|
@@ -4304,49 +5029,270 @@ declare class UserManagement {
|
|
|
4304
5029
|
sessionData,
|
|
4305
5030
|
cookiePassword
|
|
4306
5031
|
}: SessionHandlerOptions): Promise<SessionCookieData | undefined>;
|
|
5032
|
+
/**
|
|
5033
|
+
* Get an email verification code
|
|
5034
|
+
*
|
|
5035
|
+
* Get the details of an existing email verification code that can be used to send an email to a user for verification.
|
|
5036
|
+
* @returns {Promise<EmailVerification>}
|
|
5037
|
+
* @throws {NotFoundException} 404
|
|
5038
|
+
*/
|
|
4307
5039
|
getEmailVerification(emailVerificationId: string): Promise<EmailVerification>;
|
|
5040
|
+
/**
|
|
5041
|
+
* Send verification email
|
|
5042
|
+
*
|
|
5043
|
+
* Sends an email that contains a one-time code used to verify a user’s email address.
|
|
5044
|
+
* @returns {Promise<{ user: User; }>}
|
|
5045
|
+
* @throws {BadRequestException} 400
|
|
5046
|
+
* @throws {NotFoundException} 404
|
|
5047
|
+
* @throws {RateLimitExceededException} 429
|
|
5048
|
+
*/
|
|
4308
5049
|
sendVerificationEmail({
|
|
4309
5050
|
userId
|
|
4310
5051
|
}: SendVerificationEmailOptions): Promise<{
|
|
4311
5052
|
user: User;
|
|
4312
5053
|
}>;
|
|
5054
|
+
/**
|
|
5055
|
+
* Get Magic Auth code details
|
|
5056
|
+
*
|
|
5057
|
+
* Get the details of an existing [Magic Auth](https://workos.com/docs/reference/authkit/magic-auth) code that can be used to send an email to a user for authentication.
|
|
5058
|
+
* @returns {Promise<MagicAuth>}
|
|
5059
|
+
* @throws {NotFoundException} 404
|
|
5060
|
+
*/
|
|
4313
5061
|
getMagicAuth(magicAuthId: string): Promise<MagicAuth>;
|
|
5062
|
+
/**
|
|
5063
|
+
* Create a Magic Auth code
|
|
5064
|
+
*
|
|
5065
|
+
* Creates a one-time authentication code that can be sent to the user's email address. The code expires in 10 minutes. To verify the code, [authenticate the user with Magic Auth](https://workos.com/docs/reference/authkit/authentication/magic-auth).
|
|
5066
|
+
* @param options - Object containing email.
|
|
5067
|
+
* @returns {Promise<MagicAuth>}
|
|
5068
|
+
* @throws {BadRequestException} 400
|
|
5069
|
+
* @throws {UnprocessableEntityException} 422
|
|
5070
|
+
* @throws {RateLimitExceededException} 429
|
|
5071
|
+
*/
|
|
4314
5072
|
createMagicAuth(options: CreateMagicAuthOptions): Promise<MagicAuth>;
|
|
5073
|
+
/**
|
|
5074
|
+
* Verify email
|
|
5075
|
+
*
|
|
5076
|
+
* Verifies an email address using the one-time code received by the user.
|
|
5077
|
+
* @param options - Object containing code.
|
|
5078
|
+
* @returns {Promise<{ user: User; }>}
|
|
5079
|
+
* @throws {BadRequestException} 400
|
|
5080
|
+
* @throws {NotFoundException} 404
|
|
5081
|
+
* @throws {UnprocessableEntityException} 422
|
|
5082
|
+
*/
|
|
4315
5083
|
verifyEmail({
|
|
4316
5084
|
code,
|
|
4317
5085
|
userId
|
|
4318
5086
|
}: VerifyEmailOptions): Promise<{
|
|
4319
5087
|
user: User;
|
|
4320
5088
|
}>;
|
|
5089
|
+
/**
|
|
5090
|
+
* Get a password reset token
|
|
5091
|
+
*
|
|
5092
|
+
* Get the details of an existing password reset token that can be used to reset a user's password.
|
|
5093
|
+
* @returns {Promise<PasswordReset>}
|
|
5094
|
+
* @throws {NotFoundException} 404
|
|
5095
|
+
*/
|
|
4321
5096
|
getPasswordReset(passwordResetId: string): Promise<PasswordReset>;
|
|
4322
5097
|
createPasswordReset(options: CreatePasswordResetOptions): Promise<PasswordReset>;
|
|
5098
|
+
/**
|
|
5099
|
+
* Reset the password
|
|
5100
|
+
*
|
|
5101
|
+
* Sets a new password using the `token` query parameter from the link that
|
|
5102
|
+
* the user received. Successfully resetting the password will verify a
|
|
5103
|
+
* user's email, if it hasn't been verified yet.
|
|
5104
|
+
* @param payload - Object containing the reset token and new password.
|
|
5105
|
+
* @returns {Promise<{ user: User; }>}
|
|
5106
|
+
* @throws 403 response from the API.
|
|
5107
|
+
* @throws {NotFoundException} 404
|
|
5108
|
+
* @throws {UnprocessableEntityException} 422
|
|
5109
|
+
* @throws {RateLimitExceededException} 429
|
|
5110
|
+
*/
|
|
4323
5111
|
resetPassword(payload: ResetPasswordOptions): Promise<{
|
|
4324
5112
|
user: User;
|
|
4325
5113
|
}>;
|
|
5114
|
+
/**
|
|
5115
|
+
* Update a user
|
|
5116
|
+
*
|
|
5117
|
+
* Updates properties of a user. The omitted properties will be left unchanged.
|
|
5118
|
+
* @param payload - The request body.
|
|
5119
|
+
* @returns {Promise<User>}
|
|
5120
|
+
* @throws {BadRequestException} 400
|
|
5121
|
+
* @throws {UnprocessableEntityException} 422
|
|
5122
|
+
*/
|
|
4326
5123
|
updateUser(payload: UpdateUserOptions): Promise<User>;
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
|
|
4330
|
-
|
|
4331
|
-
|
|
4332
|
-
|
|
5124
|
+
/**
|
|
5125
|
+
* List sessions
|
|
5126
|
+
*
|
|
5127
|
+
* Get a list of all active sessions for a specific user.
|
|
5128
|
+
* @param options - Pagination and filter options.
|
|
5129
|
+
* @returns {Promise<AutoPaginatable<Session, SerializedListSessionsOptions>>}
|
|
5130
|
+
* @throws {NotFoundException} 404
|
|
5131
|
+
* @throws {UnprocessableEntityException} 422
|
|
5132
|
+
*/
|
|
4333
5133
|
listSessions(userId: string, options?: ListSessionsOptions): Promise<AutoPaginatable<Session, SerializedListSessionsOptions>>;
|
|
5134
|
+
/**
|
|
5135
|
+
* Delete a user
|
|
5136
|
+
*
|
|
5137
|
+
* Permanently deletes a user in the current environment. It cannot be undone.
|
|
5138
|
+
* @returns {Promise<void>}
|
|
5139
|
+
* @throws {NotFoundException} 404
|
|
5140
|
+
*/
|
|
4334
5141
|
deleteUser(userId: string): Promise<void>;
|
|
5142
|
+
/**
|
|
5143
|
+
* Get user identities
|
|
5144
|
+
*
|
|
5145
|
+
* Get a list of identities associated with the user. A user can have multiple associated identities after going through [identity linking](https://workos.com/docs/authkit/identity-linking). Currently only OAuth identities are supported. More provider types may be added in the future.
|
|
5146
|
+
* @returns {Promise<Identity[]>}
|
|
5147
|
+
* @throws {NotFoundException} 404
|
|
5148
|
+
*/
|
|
4335
5149
|
getUserIdentities(userId: string): Promise<Identity[]>;
|
|
5150
|
+
/**
|
|
5151
|
+
* Get an organization membership
|
|
5152
|
+
*
|
|
5153
|
+
* Get the details of an existing organization membership.
|
|
5154
|
+
* @returns {Promise<OrganizationMembership>}
|
|
5155
|
+
* @throws {NotFoundException} 404
|
|
5156
|
+
*/
|
|
4336
5157
|
getOrganizationMembership(organizationMembershipId: string): Promise<OrganizationMembership>;
|
|
5158
|
+
/**
|
|
5159
|
+
* List organization memberships
|
|
5160
|
+
*
|
|
5161
|
+
* Get a list of all organization memberships matching the criteria specified. At least one of `user_id` or `organization_id` must be provided. By default only active memberships are returned. Use the `statuses` parameter to filter by other statuses.
|
|
5162
|
+
* @param options - Pagination and filter options.
|
|
5163
|
+
* @returns {Promise<AutoPaginatable<OrganizationMembership, SerializedListOrganizationMembershipsOptions>>}
|
|
5164
|
+
* @throws {BadRequestException} 400
|
|
5165
|
+
* @throws {NotFoundException} 404
|
|
5166
|
+
* @throws {UnprocessableEntityException} 422
|
|
5167
|
+
*/
|
|
4337
5168
|
listOrganizationMemberships(options: ListOrganizationMembershipsOptions): Promise<AutoPaginatable<OrganizationMembership, SerializedListOrganizationMembershipsOptions>>;
|
|
5169
|
+
/**
|
|
5170
|
+
* Create an organization membership
|
|
5171
|
+
*
|
|
5172
|
+
* Creates a new `active` organization membership for the given organization and user.
|
|
5173
|
+
*
|
|
5174
|
+
* Calling this API with an organization and user that match an `inactive` organization membership will activate the membership with the specified role(s).
|
|
5175
|
+
* @param options - Object containing userId, organizationId.
|
|
5176
|
+
* @returns {Promise<OrganizationMembership>}
|
|
5177
|
+
* @throws {BadRequestException} 400
|
|
5178
|
+
* @throws {NotFoundException} 404
|
|
5179
|
+
* @throws {UnprocessableEntityException} 422
|
|
5180
|
+
*/
|
|
4338
5181
|
createOrganizationMembership(options: CreateOrganizationMembershipOptions): Promise<OrganizationMembership>;
|
|
5182
|
+
/**
|
|
5183
|
+
* Update an organization membership
|
|
5184
|
+
*
|
|
5185
|
+
* Update the details of an existing organization membership.
|
|
5186
|
+
* @param options - The request body.
|
|
5187
|
+
* @returns {Promise<OrganizationMembership>}
|
|
5188
|
+
* @throws {NotFoundException} 404
|
|
5189
|
+
* @throws {UnprocessableEntityException} 422
|
|
5190
|
+
*/
|
|
4339
5191
|
updateOrganizationMembership(organizationMembershipId: string, options: UpdateOrganizationMembershipOptions): Promise<OrganizationMembership>;
|
|
5192
|
+
/**
|
|
5193
|
+
* Delete an organization membership
|
|
5194
|
+
*
|
|
5195
|
+
* Permanently deletes an existing organization membership. It cannot be undone.
|
|
5196
|
+
* @returns {Promise<void>}
|
|
5197
|
+
* @throws {NotFoundException} 404
|
|
5198
|
+
*/
|
|
4340
5199
|
deleteOrganizationMembership(organizationMembershipId: string): Promise<void>;
|
|
5200
|
+
/**
|
|
5201
|
+
* Deactivate an organization membership
|
|
5202
|
+
*
|
|
5203
|
+
* Deactivates an `active` organization membership. Emits an [organization_membership.updated](https://workos.com/docs/events/organization-membership) event upon successful deactivation.
|
|
5204
|
+
*
|
|
5205
|
+
* - Deactivating an `inactive` membership is a no-op and does not emit an event.
|
|
5206
|
+
* - Deactivating a `pending` membership returns an error. This membership should be [deleted](https://workos.com/docs/reference/authkit/organization-membership/delete) instead.
|
|
5207
|
+
*
|
|
5208
|
+
* See the [membership management documentation](https://workos.com/docs/authkit/users-organizations/organizations/membership-management) for additional details.
|
|
5209
|
+
* @returns {Promise<OrganizationMembership>}
|
|
5210
|
+
* @throws {BadRequestException} 400
|
|
5211
|
+
* @throws {NotFoundException} 404
|
|
5212
|
+
* @throws {UnprocessableEntityException} 422
|
|
5213
|
+
*/
|
|
4341
5214
|
deactivateOrganizationMembership(organizationMembershipId: string): Promise<OrganizationMembership>;
|
|
5215
|
+
/**
|
|
5216
|
+
* Reactivate an organization membership
|
|
5217
|
+
*
|
|
5218
|
+
* Reactivates an `inactive` organization membership, retaining the pre-existing role(s). Emits an [organization_membership.updated](https://workos.com/docs/events/organization-membership) event upon successful reactivation.
|
|
5219
|
+
*
|
|
5220
|
+
* - Reactivating an `active` membership is a no-op and does not emit an event.
|
|
5221
|
+
* - Reactivating a `pending` membership returns an error. The user needs to [accept the invitation](https://workos.com/docs/authkit/invitations) instead.
|
|
5222
|
+
*
|
|
5223
|
+
* See the [membership management documentation](https://workos.com/docs/authkit/users-organizations/organizations/membership-management) for additional details.
|
|
5224
|
+
* @returns {Promise<OrganizationMembership>}
|
|
5225
|
+
* @throws {BadRequestException} 400
|
|
5226
|
+
* @throws {NotFoundException} 404
|
|
5227
|
+
* @throws {UnprocessableEntityException} 422
|
|
5228
|
+
*/
|
|
4342
5229
|
reactivateOrganizationMembership(organizationMembershipId: string): Promise<OrganizationMembership>;
|
|
5230
|
+
listGroupsForOrganizationMembership(options: ListGroupsForOrganizationMembershipOptions): Promise<AutoPaginatable<Group>>;
|
|
4343
5231
|
getInvitation(invitationId: string): Promise<Invitation>;
|
|
5232
|
+
/**
|
|
5233
|
+
* Find an invitation by token
|
|
5234
|
+
*
|
|
5235
|
+
* Retrieve an existing invitation using the token.
|
|
5236
|
+
* @returns {Promise<Invitation>}
|
|
5237
|
+
* @throws {NotFoundException} 404
|
|
5238
|
+
*/
|
|
4344
5239
|
findInvitationByToken(invitationToken: string): Promise<Invitation>;
|
|
5240
|
+
/**
|
|
5241
|
+
* List invitations
|
|
5242
|
+
*
|
|
5243
|
+
* Get a list of all of invitations matching the criteria specified.
|
|
5244
|
+
* @param options - Pagination and filter options.
|
|
5245
|
+
* @returns {Promise<AutoPaginatable<Invitation, SerializedListInvitationsOptions>>}
|
|
5246
|
+
* @throws {UnprocessableEntityException} 422
|
|
5247
|
+
*/
|
|
4345
5248
|
listInvitations(options: ListInvitationsOptions): Promise<AutoPaginatable<Invitation, SerializedListInvitationsOptions>>;
|
|
5249
|
+
/**
|
|
5250
|
+
* Send an invitation
|
|
5251
|
+
*
|
|
5252
|
+
* Sends an invitation email to the recipient.
|
|
5253
|
+
* @param payload - Object containing email.
|
|
5254
|
+
* @returns {Promise<Invitation>}
|
|
5255
|
+
* @throws {BadRequestException} 400
|
|
5256
|
+
* @throws {NotFoundException} 404
|
|
5257
|
+
* @throws {UnprocessableEntityException} 422
|
|
5258
|
+
*/
|
|
4346
5259
|
sendInvitation(payload: SendInvitationOptions): Promise<Invitation>;
|
|
5260
|
+
/**
|
|
5261
|
+
* Accept an invitation
|
|
5262
|
+
*
|
|
5263
|
+
* Accepts an invitation and, if linked to an organization, activates the user's membership in that organization.
|
|
5264
|
+
* @returns {Promise<Invitation>}
|
|
5265
|
+
* @throws {BadRequestException} 400
|
|
5266
|
+
* @throws {NotFoundException} 404
|
|
5267
|
+
*/
|
|
4347
5268
|
acceptInvitation(invitationId: string): Promise<Invitation>;
|
|
5269
|
+
/**
|
|
5270
|
+
* Revoke an invitation
|
|
5271
|
+
*
|
|
5272
|
+
* Revokes an existing invitation.
|
|
5273
|
+
* @returns {Promise<Invitation>}
|
|
5274
|
+
* @throws {BadRequestException} 400
|
|
5275
|
+
*/
|
|
4348
5276
|
revokeInvitation(invitationId: string): Promise<Invitation>;
|
|
5277
|
+
/**
|
|
5278
|
+
* Resend an invitation
|
|
5279
|
+
*
|
|
5280
|
+
* Resends an invitation email to the recipient. The invitation must be in a pending state.
|
|
5281
|
+
* @param options - The request body.
|
|
5282
|
+
* @returns {Promise<Invitation>}
|
|
5283
|
+
* @throws {BadRequestException} 400
|
|
5284
|
+
* @throws {NotFoundException} 404
|
|
5285
|
+
* @throws {UnprocessableEntityException} 422
|
|
5286
|
+
*/
|
|
4349
5287
|
resendInvitation(invitationId: string, options?: ResendInvitationOptions): Promise<Invitation>;
|
|
5288
|
+
/**
|
|
5289
|
+
* Revoke Session
|
|
5290
|
+
*
|
|
5291
|
+
* Revoke a [user session](https://workos.com/docs/reference/authkit/session).
|
|
5292
|
+
* @param payload - Object containing sessionId.
|
|
5293
|
+
* @returns {Promise<void>}
|
|
5294
|
+
* @throws {BadRequestException} 400
|
|
5295
|
+
*/
|
|
4350
5296
|
revokeSession(payload: RevokeSessionOptions): Promise<void>;
|
|
4351
5297
|
/**
|
|
4352
5298
|
* Generate an OAuth 2.0 authorization URL.
|
|
@@ -4386,375 +5332,27 @@ declare class UserManagement {
|
|
|
4386
5332
|
* ```
|
|
4387
5333
|
*/
|
|
4388
5334
|
getAuthorizationUrlWithPKCE(options: Omit<UserManagementAuthorizationURLOptions, 'codeChallenge' | 'codeChallengeMethod' | 'state'>): Promise<PKCEAuthorizationURLResult>;
|
|
5335
|
+
/**
|
|
5336
|
+
* Logout
|
|
5337
|
+
*
|
|
5338
|
+
* Logout a user from the current [session](https://workos.com/docs/reference/authkit/session).
|
|
5339
|
+
* @param options.sessionId - The ID of the session to revoke. This can be extracted from the `sid` claim of the access token.
|
|
5340
|
+
*
|
|
5341
|
+
* @example
|
|
5342
|
+
* "session_01H93ZY4F80QPBEZ1R5B2SHQG8"
|
|
5343
|
+
*
|
|
5344
|
+
* @param options.returnTo - The URL to redirect the user to after session revocation.
|
|
5345
|
+
*
|
|
5346
|
+
* @example
|
|
5347
|
+
* "https://example.com"
|
|
5348
|
+
*
|
|
5349
|
+
* @returns {string}
|
|
5350
|
+
* @throws {UnprocessableEntityException} 422
|
|
5351
|
+
*/
|
|
4389
5352
|
getLogoutUrl(options: LogoutURLOptions): string;
|
|
4390
5353
|
getJwksUrl(clientId: string): string;
|
|
4391
5354
|
}
|
|
4392
5355
|
//#endregion
|
|
4393
|
-
//#region src/fga/interfaces/check-op.enum.d.ts
|
|
4394
|
-
declare enum CheckOp {
|
|
4395
|
-
AllOf = "all_of",
|
|
4396
|
-
AnyOf = "any_of"
|
|
4397
|
-
}
|
|
4398
|
-
//#endregion
|
|
4399
|
-
//#region src/fga/interfaces/resource-op.enum.d.ts
|
|
4400
|
-
declare enum ResourceOp {
|
|
4401
|
-
Create = "create",
|
|
4402
|
-
Delete = "delete"
|
|
4403
|
-
}
|
|
4404
|
-
//#endregion
|
|
4405
|
-
//#region src/fga/interfaces/resource.interface.d.ts
|
|
4406
|
-
interface ResourceInterface {
|
|
4407
|
-
getResourceType(): string;
|
|
4408
|
-
getResourceId(): string;
|
|
4409
|
-
}
|
|
4410
|
-
interface ResourceOptions {
|
|
4411
|
-
resourceType: string;
|
|
4412
|
-
resourceId?: string;
|
|
4413
|
-
}
|
|
4414
|
-
interface SerializedResourceOptions {
|
|
4415
|
-
resource_type: string;
|
|
4416
|
-
resource_id?: string;
|
|
4417
|
-
}
|
|
4418
|
-
interface CreateResourceOptions {
|
|
4419
|
-
resource: ResourceInterface | ResourceOptions;
|
|
4420
|
-
meta?: {
|
|
4421
|
-
[key: string]: any;
|
|
4422
|
-
};
|
|
4423
|
-
}
|
|
4424
|
-
interface SerializedCreateResourceOptions {
|
|
4425
|
-
resource_type: string;
|
|
4426
|
-
resource_id?: string;
|
|
4427
|
-
meta?: {
|
|
4428
|
-
[key: string]: any;
|
|
4429
|
-
};
|
|
4430
|
-
}
|
|
4431
|
-
type GetResourceOptions = ResourceInterface | ResourceOptions;
|
|
4432
|
-
interface ListResourcesOptions extends PaginationOptions {
|
|
4433
|
-
resourceType?: string;
|
|
4434
|
-
search?: string;
|
|
4435
|
-
}
|
|
4436
|
-
interface SerializedListResourcesOptions extends PaginationOptions {
|
|
4437
|
-
resource_type?: string;
|
|
4438
|
-
search?: string;
|
|
4439
|
-
}
|
|
4440
|
-
interface UpdateResourceOptions {
|
|
4441
|
-
resource: ResourceInterface | ResourceOptions;
|
|
4442
|
-
meta: {
|
|
4443
|
-
[key: string]: any;
|
|
4444
|
-
};
|
|
4445
|
-
}
|
|
4446
|
-
type DeleteResourceOptions = ResourceInterface | ResourceOptions;
|
|
4447
|
-
interface SerializedDeleteResourceOptions {
|
|
4448
|
-
resource_type: string;
|
|
4449
|
-
resource_id: string;
|
|
4450
|
-
}
|
|
4451
|
-
interface Resource {
|
|
4452
|
-
resourceType: string;
|
|
4453
|
-
resourceId: string;
|
|
4454
|
-
meta?: {
|
|
4455
|
-
[key: string]: any;
|
|
4456
|
-
};
|
|
4457
|
-
}
|
|
4458
|
-
interface ResourceResponse {
|
|
4459
|
-
resource_type: string;
|
|
4460
|
-
resource_id: string;
|
|
4461
|
-
meta?: {
|
|
4462
|
-
[key: string]: any;
|
|
4463
|
-
};
|
|
4464
|
-
}
|
|
4465
|
-
interface BatchWriteResourcesOptions {
|
|
4466
|
-
op: ResourceOp;
|
|
4467
|
-
resources: CreateResourceOptions[] | DeleteResourceOptions[];
|
|
4468
|
-
}
|
|
4469
|
-
interface SerializedBatchWriteResourcesOptions {
|
|
4470
|
-
op: string;
|
|
4471
|
-
resources: SerializedCreateResourceOptions[] | SerializedDeleteResourceOptions[];
|
|
4472
|
-
}
|
|
4473
|
-
interface BatchWriteResourcesResponse {
|
|
4474
|
-
data: ResourceResponse[];
|
|
4475
|
-
}
|
|
4476
|
-
//#endregion
|
|
4477
|
-
//#region src/fga/interfaces/warrant-op.enum.d.ts
|
|
4478
|
-
declare enum WarrantOp {
|
|
4479
|
-
Create = "create",
|
|
4480
|
-
Delete = "delete"
|
|
4481
|
-
}
|
|
4482
|
-
//#endregion
|
|
4483
|
-
//#region src/fga/interfaces/warrant.interface.d.ts
|
|
4484
|
-
interface ListWarrantsOptions {
|
|
4485
|
-
resourceType?: string;
|
|
4486
|
-
resourceId?: string;
|
|
4487
|
-
relation?: string;
|
|
4488
|
-
subjectType?: string;
|
|
4489
|
-
subjectId?: string;
|
|
4490
|
-
subjectRelation?: string;
|
|
4491
|
-
limit?: number;
|
|
4492
|
-
after?: string | null;
|
|
4493
|
-
}
|
|
4494
|
-
interface SerializedListWarrantsOptions {
|
|
4495
|
-
resource_type?: string;
|
|
4496
|
-
resource_id?: string;
|
|
4497
|
-
relation?: string;
|
|
4498
|
-
subject_type?: string;
|
|
4499
|
-
subject_id?: string;
|
|
4500
|
-
subject_relation?: string;
|
|
4501
|
-
limit?: number;
|
|
4502
|
-
after?: string | null;
|
|
4503
|
-
}
|
|
4504
|
-
interface PolicyContext {
|
|
4505
|
-
[key: string]: any;
|
|
4506
|
-
}
|
|
4507
|
-
interface Subject {
|
|
4508
|
-
resourceType: string;
|
|
4509
|
-
resourceId: string;
|
|
4510
|
-
relation?: string;
|
|
4511
|
-
}
|
|
4512
|
-
interface SerializedSubject {
|
|
4513
|
-
resource_type: string;
|
|
4514
|
-
resource_id: string;
|
|
4515
|
-
relation?: string;
|
|
4516
|
-
}
|
|
4517
|
-
interface Warrant {
|
|
4518
|
-
resourceType: string;
|
|
4519
|
-
resourceId: string;
|
|
4520
|
-
relation: string;
|
|
4521
|
-
subject: Subject;
|
|
4522
|
-
policy?: string;
|
|
4523
|
-
}
|
|
4524
|
-
interface WriteWarrantOptions {
|
|
4525
|
-
op?: WarrantOp;
|
|
4526
|
-
resource: ResourceInterface | ResourceOptions;
|
|
4527
|
-
relation: string;
|
|
4528
|
-
subject: ResourceInterface | Subject;
|
|
4529
|
-
policy?: string;
|
|
4530
|
-
}
|
|
4531
|
-
interface SerializedWriteWarrantOptions {
|
|
4532
|
-
op?: WarrantOp;
|
|
4533
|
-
resource_type: string;
|
|
4534
|
-
resource_id: string;
|
|
4535
|
-
relation: string;
|
|
4536
|
-
subject: SerializedSubject;
|
|
4537
|
-
policy?: string;
|
|
4538
|
-
}
|
|
4539
|
-
type ListWarrantsRequestOptions = Pick<GetOptions, 'warrantToken'>;
|
|
4540
|
-
interface WarrantResponse {
|
|
4541
|
-
resource_type: string;
|
|
4542
|
-
resource_id: string;
|
|
4543
|
-
relation: string;
|
|
4544
|
-
subject: SerializedSubject;
|
|
4545
|
-
policy?: string;
|
|
4546
|
-
}
|
|
4547
|
-
//#endregion
|
|
4548
|
-
//#region src/fga/interfaces/warning.interface.d.ts
|
|
4549
|
-
interface BaseWarning {
|
|
4550
|
-
code: string;
|
|
4551
|
-
message: string;
|
|
4552
|
-
}
|
|
4553
|
-
interface MissingContextKeysWarning extends BaseWarning {
|
|
4554
|
-
code: 'missing_context_keys';
|
|
4555
|
-
keys: string[];
|
|
4556
|
-
}
|
|
4557
|
-
type Warning = BaseWarning | MissingContextKeysWarning;
|
|
4558
|
-
//#endregion
|
|
4559
|
-
//#region src/fga/interfaces/check.interface.d.ts
|
|
4560
|
-
interface CheckWarrantOptions {
|
|
4561
|
-
resource: ResourceInterface | ResourceOptions;
|
|
4562
|
-
relation: string;
|
|
4563
|
-
subject: ResourceInterface | Subject;
|
|
4564
|
-
context?: PolicyContext;
|
|
4565
|
-
}
|
|
4566
|
-
interface SerializedCheckWarrantOptions {
|
|
4567
|
-
resource_type: string;
|
|
4568
|
-
resource_id: string;
|
|
4569
|
-
relation: string;
|
|
4570
|
-
subject: SerializedSubject;
|
|
4571
|
-
context: PolicyContext;
|
|
4572
|
-
}
|
|
4573
|
-
interface CheckOptions {
|
|
4574
|
-
op?: CheckOp;
|
|
4575
|
-
checks: CheckWarrantOptions[];
|
|
4576
|
-
debug?: boolean;
|
|
4577
|
-
}
|
|
4578
|
-
interface CheckBatchOptions {
|
|
4579
|
-
checks: CheckWarrantOptions[];
|
|
4580
|
-
debug?: boolean;
|
|
4581
|
-
}
|
|
4582
|
-
interface SerializedCheckOptions {
|
|
4583
|
-
op?: CheckOp;
|
|
4584
|
-
checks: SerializedCheckWarrantOptions[];
|
|
4585
|
-
debug?: boolean;
|
|
4586
|
-
}
|
|
4587
|
-
interface SerializedCheckBatchOptions {
|
|
4588
|
-
op: 'batch';
|
|
4589
|
-
checks: SerializedCheckWarrantOptions[];
|
|
4590
|
-
debug?: boolean;
|
|
4591
|
-
}
|
|
4592
|
-
interface CheckResultResponse {
|
|
4593
|
-
result: string;
|
|
4594
|
-
is_implicit: boolean;
|
|
4595
|
-
warrant_token: string;
|
|
4596
|
-
debug_info?: DebugInfoResponse;
|
|
4597
|
-
warnings?: Warning[];
|
|
4598
|
-
}
|
|
4599
|
-
interface DebugInfo {
|
|
4600
|
-
processingTime: number;
|
|
4601
|
-
decisionTree: DecisionTreeNode;
|
|
4602
|
-
}
|
|
4603
|
-
interface DecisionTreeNode {
|
|
4604
|
-
check: CheckWarrantOptions;
|
|
4605
|
-
policy?: string;
|
|
4606
|
-
decision: string;
|
|
4607
|
-
processingTime: number;
|
|
4608
|
-
children: DecisionTreeNode[];
|
|
4609
|
-
}
|
|
4610
|
-
interface DebugInfoResponse {
|
|
4611
|
-
processing_time: number;
|
|
4612
|
-
decision_tree: DecisionTreeNodeResponse;
|
|
4613
|
-
}
|
|
4614
|
-
interface DecisionTreeNodeResponse {
|
|
4615
|
-
check: SerializedCheckWarrantOptions;
|
|
4616
|
-
policy?: string;
|
|
4617
|
-
decision: string;
|
|
4618
|
-
processing_time: number;
|
|
4619
|
-
children: DecisionTreeNodeResponse[];
|
|
4620
|
-
}
|
|
4621
|
-
interface CheckResultInterface {
|
|
4622
|
-
result: string;
|
|
4623
|
-
isImplicit: boolean;
|
|
4624
|
-
warrantToken: string;
|
|
4625
|
-
debugInfo?: DebugInfo;
|
|
4626
|
-
warnings?: Warning[];
|
|
4627
|
-
}
|
|
4628
|
-
declare class CheckResult implements CheckResultInterface {
|
|
4629
|
-
result: string;
|
|
4630
|
-
isImplicit: boolean;
|
|
4631
|
-
warrantToken: string;
|
|
4632
|
-
debugInfo?: DebugInfo;
|
|
4633
|
-
warnings?: Warning[];
|
|
4634
|
-
constructor(json: CheckResultResponse);
|
|
4635
|
-
isAuthorized(): boolean;
|
|
4636
|
-
}
|
|
4637
|
-
type CheckRequestOptions = Pick<PostOptions, 'warrantToken'>;
|
|
4638
|
-
//#endregion
|
|
4639
|
-
//#region src/fga/interfaces/query.interface.d.ts
|
|
4640
|
-
interface QueryOptions extends PaginationOptions {
|
|
4641
|
-
q: string;
|
|
4642
|
-
context?: PolicyContext;
|
|
4643
|
-
}
|
|
4644
|
-
interface SerializedQueryOptions extends PaginationOptions {
|
|
4645
|
-
q: string;
|
|
4646
|
-
context?: string;
|
|
4647
|
-
}
|
|
4648
|
-
interface QueryResult {
|
|
4649
|
-
resourceType: string;
|
|
4650
|
-
resourceId: string;
|
|
4651
|
-
relation: string;
|
|
4652
|
-
warrant: Warrant;
|
|
4653
|
-
isImplicit: boolean;
|
|
4654
|
-
meta?: {
|
|
4655
|
-
[key: string]: any;
|
|
4656
|
-
};
|
|
4657
|
-
}
|
|
4658
|
-
interface QueryResultResponse {
|
|
4659
|
-
resource_type: string;
|
|
4660
|
-
resource_id: string;
|
|
4661
|
-
relation: string;
|
|
4662
|
-
warrant: WarrantResponse;
|
|
4663
|
-
is_implicit: boolean;
|
|
4664
|
-
meta?: Record<string, any>;
|
|
4665
|
-
}
|
|
4666
|
-
type QueryRequestOptions = Pick<GetOptions, 'warrantToken'>;
|
|
4667
|
-
//#endregion
|
|
4668
|
-
//#region src/fga/interfaces/warrant-token.interface.d.ts
|
|
4669
|
-
interface WarrantToken {
|
|
4670
|
-
warrantToken: string;
|
|
4671
|
-
}
|
|
4672
|
-
interface WarrantTokenResponse {
|
|
4673
|
-
warrant_token: string;
|
|
4674
|
-
}
|
|
4675
|
-
//#endregion
|
|
4676
|
-
//#region src/fga/interfaces/list.interface.d.ts
|
|
4677
|
-
interface FGAList<T> extends List<T> {
|
|
4678
|
-
warnings?: Warning[];
|
|
4679
|
-
}
|
|
4680
|
-
//#endregion
|
|
4681
|
-
//#region src/fga/utils/fga-paginatable.d.ts
|
|
4682
|
-
declare class FgaPaginatable<T, P extends PaginationOptions = PaginationOptions> extends AutoPaginatable<T, P> {
|
|
4683
|
-
protected list: FGAList<T>;
|
|
4684
|
-
constructor(list: FGAList<T>, apiCall: (params: PaginationOptions) => Promise<FGAList<T>>, options?: P);
|
|
4685
|
-
get warnings(): Warning[] | undefined;
|
|
4686
|
-
}
|
|
4687
|
-
//#endregion
|
|
4688
|
-
//#region src/fga/fga.d.ts
|
|
4689
|
-
/**
|
|
4690
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4691
|
-
* @see src/authorization/authorization.ts
|
|
4692
|
-
*/
|
|
4693
|
-
declare class FGA {
|
|
4694
|
-
private readonly workos;
|
|
4695
|
-
constructor(workos: WorkOS);
|
|
4696
|
-
/**
|
|
4697
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4698
|
-
* @see src/authorization/authorization.ts
|
|
4699
|
-
*/
|
|
4700
|
-
check(checkOptions: CheckOptions, options?: CheckRequestOptions): Promise<CheckResult>;
|
|
4701
|
-
/**
|
|
4702
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4703
|
-
* @see src/authorization/authorization.ts
|
|
4704
|
-
*/
|
|
4705
|
-
checkBatch(checkOptions: CheckBatchOptions, options?: CheckRequestOptions): Promise<CheckResult[]>;
|
|
4706
|
-
/**
|
|
4707
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4708
|
-
* @see src/authorization/authorization.ts
|
|
4709
|
-
*/
|
|
4710
|
-
createResource(resource: CreateResourceOptions): Promise<Resource>;
|
|
4711
|
-
/**
|
|
4712
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4713
|
-
* @see src/authorization/authorization.ts
|
|
4714
|
-
*/
|
|
4715
|
-
getResource(resource: ResourceInterface | ResourceOptions): Promise<Resource>;
|
|
4716
|
-
/**
|
|
4717
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4718
|
-
* @see src/authorization/authorization.ts
|
|
4719
|
-
*/
|
|
4720
|
-
listResources(options?: ListResourcesOptions): Promise<AutoPaginatable<Resource, SerializedListResourcesOptions>>;
|
|
4721
|
-
/**
|
|
4722
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4723
|
-
* @see src/authorization/authorization.ts
|
|
4724
|
-
*/
|
|
4725
|
-
updateResource(options: UpdateResourceOptions): Promise<Resource>;
|
|
4726
|
-
/**
|
|
4727
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4728
|
-
* @see src/authorization/authorization.ts
|
|
4729
|
-
*/
|
|
4730
|
-
deleteResource(resource: DeleteResourceOptions): Promise<void>;
|
|
4731
|
-
/**
|
|
4732
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4733
|
-
* @see src/authorization/authorization.ts
|
|
4734
|
-
*/
|
|
4735
|
-
batchWriteResources(options: BatchWriteResourcesOptions): Promise<Resource[]>;
|
|
4736
|
-
/**
|
|
4737
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4738
|
-
* @see src/authorization/authorization.ts
|
|
4739
|
-
*/
|
|
4740
|
-
writeWarrant(options: WriteWarrantOptions): Promise<WarrantToken>;
|
|
4741
|
-
/**
|
|
4742
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4743
|
-
* @see src/authorization/authorization.ts
|
|
4744
|
-
*/
|
|
4745
|
-
batchWriteWarrants(options: WriteWarrantOptions[]): Promise<WarrantToken>;
|
|
4746
|
-
/**
|
|
4747
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4748
|
-
* @see src/authorization/authorization.ts
|
|
4749
|
-
*/
|
|
4750
|
-
listWarrants(options?: ListWarrantsOptions, requestOptions?: ListWarrantsRequestOptions): Promise<AutoPaginatable<Warrant, SerializedListWarrantsOptions>>;
|
|
4751
|
-
/**
|
|
4752
|
-
* @deprecated The FGA module is deprecated. Use the Authorization module instead.
|
|
4753
|
-
* @see src/authorization/authorization.ts
|
|
4754
|
-
*/
|
|
4755
|
-
query(options: QueryOptions, requestOptions?: QueryRequestOptions): Promise<FgaPaginatable<QueryResult, SerializedQueryOptions>>;
|
|
4756
|
-
}
|
|
4757
|
-
//#endregion
|
|
4758
5356
|
//#region src/feature-flags/runtime-client.d.ts
|
|
4759
5357
|
declare class FeatureFlagsRuntimeClient extends EventEmitter {
|
|
4760
5358
|
private readonly workos;
|
|
@@ -4794,15 +5392,112 @@ declare class FeatureFlagsRuntimeClient extends EventEmitter {
|
|
|
4794
5392
|
declare class FeatureFlags {
|
|
4795
5393
|
private readonly workos;
|
|
4796
5394
|
constructor(workos: WorkOS);
|
|
5395
|
+
/**
|
|
5396
|
+
* List feature flags
|
|
5397
|
+
*
|
|
5398
|
+
* Get a list of all of your existing feature flags matching the criteria specified.
|
|
5399
|
+
* @param options - Pagination and filter options.
|
|
5400
|
+
* @returns {Promise<AutoPaginatable<FeatureFlag>>}
|
|
5401
|
+
* @throws {BadRequestException} 400
|
|
5402
|
+
* @throws {NotFoundException} 404
|
|
5403
|
+
* @throws {UnprocessableEntityException} 422
|
|
5404
|
+
*/
|
|
4797
5405
|
listFeatureFlags(options?: ListFeatureFlagsOptions): Promise<AutoPaginatable<FeatureFlag>>;
|
|
5406
|
+
/**
|
|
5407
|
+
* Get a feature flag
|
|
5408
|
+
*
|
|
5409
|
+
* Get the details of an existing feature flag by its slug.
|
|
5410
|
+
* @param slug - A unique key to reference the Feature Flag.
|
|
5411
|
+
*
|
|
5412
|
+
* @example
|
|
5413
|
+
* "advanced-analytics"
|
|
5414
|
+
*
|
|
5415
|
+
* @returns {Promise<FeatureFlag>}
|
|
5416
|
+
* @throws {NotFoundException} 404
|
|
5417
|
+
*/
|
|
4798
5418
|
getFeatureFlag(slug: string): Promise<FeatureFlag>;
|
|
5419
|
+
/**
|
|
5420
|
+
* Enable a feature flag
|
|
5421
|
+
*
|
|
5422
|
+
* Enables a feature flag in the current environment.
|
|
5423
|
+
* @param slug - A unique key to reference the Feature Flag.
|
|
5424
|
+
*
|
|
5425
|
+
* @example
|
|
5426
|
+
* "advanced-analytics"
|
|
5427
|
+
*
|
|
5428
|
+
* @returns {Promise<FeatureFlag>}
|
|
5429
|
+
* @throws {NotFoundException} 404
|
|
5430
|
+
*/
|
|
4799
5431
|
enableFeatureFlag(slug: string): Promise<FeatureFlag>;
|
|
5432
|
+
/**
|
|
5433
|
+
* Disable a feature flag
|
|
5434
|
+
*
|
|
5435
|
+
* Disables a feature flag in the current environment.
|
|
5436
|
+
* @param slug - A unique key to reference the Feature Flag.
|
|
5437
|
+
*
|
|
5438
|
+
* @example
|
|
5439
|
+
* "advanced-analytics"
|
|
5440
|
+
*
|
|
5441
|
+
* @returns {Promise<FeatureFlag>}
|
|
5442
|
+
* @throws {NotFoundException} 404
|
|
5443
|
+
*/
|
|
4800
5444
|
disableFeatureFlag(slug: string): Promise<FeatureFlag>;
|
|
5445
|
+
/**
|
|
5446
|
+
* Add a feature flag target
|
|
5447
|
+
*
|
|
5448
|
+
* Enables a feature flag for a specific target in the current environment. Currently, supported targets include users and organizations.
|
|
5449
|
+
* @params options - Object containing slug and targetId.
|
|
5450
|
+
* @returns {Promise<void>}
|
|
5451
|
+
* @throws {BadRequestException} 400
|
|
5452
|
+
* @throws 403 response from the API.
|
|
5453
|
+
* @throws {NotFoundException} 404
|
|
5454
|
+
*/
|
|
4801
5455
|
addFlagTarget(options: AddFlagTargetOptions): Promise<void>;
|
|
5456
|
+
/**
|
|
5457
|
+
* Remove a feature flag target
|
|
5458
|
+
*
|
|
5459
|
+
* Removes a target from the feature flag's target list in the current environment. Currently, supported targets include users and organizations.
|
|
5460
|
+
* @params options - Object containing slug and targetId.
|
|
5461
|
+
* @returns {Promise<void>}
|
|
5462
|
+
* @throws {BadRequestException} 400
|
|
5463
|
+
* @throws 403 response from the API.
|
|
5464
|
+
* @throws {NotFoundException} 404
|
|
5465
|
+
*/
|
|
4802
5466
|
removeFlagTarget(options: RemoveFlagTargetOptions): Promise<void>;
|
|
5467
|
+
/**
|
|
5468
|
+
* List enabled feature flags for an organization
|
|
5469
|
+
*
|
|
5470
|
+
* Get a list of all enabled feature flags for an organization.
|
|
5471
|
+
* @param options - Pagination and filter options.
|
|
5472
|
+
* @returns {Promise<AutoPaginatable<FeatureFlag>>}
|
|
5473
|
+
* @throws {NotFoundException} 404
|
|
5474
|
+
*/
|
|
5475
|
+
listOrganizationFeatureFlags(options: ListOrganizationFeatureFlagsOptions): Promise<AutoPaginatable<FeatureFlag>>;
|
|
5476
|
+
/**
|
|
5477
|
+
* List enabled feature flags for a user
|
|
5478
|
+
*
|
|
5479
|
+
* @param options - Pagination and filter options.
|
|
5480
|
+
* @returns {Promise<AutoPaginatable<Flag>>}
|
|
5481
|
+
* @throws {NotFoundException} 404
|
|
5482
|
+
*/
|
|
5483
|
+
listUserFeatureFlags(options: ListUserFeatureFlagsOptions): Promise<AutoPaginatable<FeatureFlag>>;
|
|
4803
5484
|
createRuntimeClient(options?: RuntimeClientOptions): FeatureFlagsRuntimeClient;
|
|
4804
5485
|
}
|
|
4805
5486
|
//#endregion
|
|
5487
|
+
//#region src/groups/groups.d.ts
|
|
5488
|
+
declare class Groups {
|
|
5489
|
+
private readonly workos;
|
|
5490
|
+
constructor(workos: WorkOS);
|
|
5491
|
+
createGroup(options: CreateGroupOptions): Promise<Group>;
|
|
5492
|
+
listGroups(options: ListGroupsOptions): Promise<AutoPaginatable<Group>>;
|
|
5493
|
+
getGroup(options: GetGroupOptions): Promise<Group>;
|
|
5494
|
+
updateGroup(options: UpdateGroupOptions): Promise<Group>;
|
|
5495
|
+
deleteGroup(options: DeleteGroupOptions): Promise<void>;
|
|
5496
|
+
addOrganizationMembership(options: AddGroupOrganizationMembershipOptions): Promise<Group>;
|
|
5497
|
+
listOrganizationMemberships(options: ListGroupOrganizationMembershipsOptions): Promise<AutoPaginatable<AuthorizationOrganizationMembership>>;
|
|
5498
|
+
removeOrganizationMembership(options: RemoveGroupOrganizationMembershipOptions): Promise<void>;
|
|
5499
|
+
}
|
|
5500
|
+
//#endregion
|
|
4806
5501
|
//#region src/widgets/interfaces/get-token.d.ts
|
|
4807
5502
|
type WidgetScope = 'widgets:users-table:manage' | 'widgets:sso:manage' | 'widgets:domain-verification:manage' | 'widgets:dsync:manage' | 'widgets:api-keys:manage' | 'widgets:audit-log-streaming:manage';
|
|
4808
5503
|
interface GetTokenOptions {
|
|
@@ -4810,53 +5505,643 @@ interface GetTokenOptions {
|
|
|
4810
5505
|
userId?: string;
|
|
4811
5506
|
scopes?: WidgetScope[];
|
|
4812
5507
|
}
|
|
5508
|
+
interface GetTokenResponse {
|
|
5509
|
+
token: string;
|
|
5510
|
+
}
|
|
4813
5511
|
//#endregion
|
|
4814
5512
|
//#region src/widgets/widgets.d.ts
|
|
4815
5513
|
declare class Widgets {
|
|
4816
5514
|
private readonly workos;
|
|
4817
5515
|
constructor(workos: WorkOS);
|
|
4818
|
-
|
|
5516
|
+
/**
|
|
5517
|
+
* Generate a widget token
|
|
5518
|
+
*
|
|
5519
|
+
* Generate a widget token scoped to an organization and user with the specified scopes.
|
|
5520
|
+
* @param payload - Object containing organizationId.
|
|
5521
|
+
* @returns {Promise<GetTokenResponse>}
|
|
5522
|
+
* @throws {BadRequestException} 400
|
|
5523
|
+
* @throws {NotFoundException} 404
|
|
5524
|
+
* @throws {UnprocessableEntityException} 422
|
|
5525
|
+
*/
|
|
5526
|
+
createToken(payload: GetTokenOptions): Promise<GetTokenResponse>;
|
|
4819
5527
|
}
|
|
4820
5528
|
//#endregion
|
|
4821
5529
|
//#region src/authorization/authorization.d.ts
|
|
4822
5530
|
declare class Authorization {
|
|
4823
5531
|
private readonly workos;
|
|
4824
5532
|
constructor(workos: WorkOS);
|
|
5533
|
+
/**
|
|
5534
|
+
* Create an environment role
|
|
5535
|
+
*
|
|
5536
|
+
* Create a new environment role.
|
|
5537
|
+
* @param options - Object containing slug, name.
|
|
5538
|
+
* @returns {Promise<EnvironmentRole>}
|
|
5539
|
+
* @throws {BadRequestException} 400
|
|
5540
|
+
* @throws 403 response from the API.
|
|
5541
|
+
* @throws {NotFoundException} 404
|
|
5542
|
+
* @throws {ConflictException} 409
|
|
5543
|
+
* @throws {UnprocessableEntityException} 422
|
|
5544
|
+
*/
|
|
4825
5545
|
createEnvironmentRole(options: CreateEnvironmentRoleOptions): Promise<EnvironmentRole>;
|
|
5546
|
+
/**
|
|
5547
|
+
* List environment roles
|
|
5548
|
+
*
|
|
5549
|
+
* List all environment roles in priority order.
|
|
5550
|
+
* @returns {Promise<EnvironmentRoleList>}
|
|
5551
|
+
* @throws 403 response from the API.
|
|
5552
|
+
*/
|
|
4826
5553
|
listEnvironmentRoles(): Promise<EnvironmentRoleList>;
|
|
5554
|
+
/**
|
|
5555
|
+
* Get an environment role
|
|
5556
|
+
*
|
|
5557
|
+
* Get an environment role by its slug.
|
|
5558
|
+
* @param slug - The slug of the environment role.
|
|
5559
|
+
*
|
|
5560
|
+
* @example
|
|
5561
|
+
* "admin"
|
|
5562
|
+
*
|
|
5563
|
+
* @returns {Promise<EnvironmentRole>}
|
|
5564
|
+
* @throws 403 response from the API.
|
|
5565
|
+
* @throws {NotFoundException} 404
|
|
5566
|
+
*/
|
|
4827
5567
|
getEnvironmentRole(slug: string): Promise<EnvironmentRole>;
|
|
5568
|
+
/**
|
|
5569
|
+
* Update an environment role
|
|
5570
|
+
*
|
|
5571
|
+
* Update an existing environment role.
|
|
5572
|
+
* @param slug - The slug of the environment role.
|
|
5573
|
+
*
|
|
5574
|
+
* @example
|
|
5575
|
+
* "admin"
|
|
5576
|
+
*
|
|
5577
|
+
* @param options - The request body.
|
|
5578
|
+
* @returns {Promise<EnvironmentRole>}
|
|
5579
|
+
* @throws {BadRequestException} 400
|
|
5580
|
+
* @throws 403 response from the API.
|
|
5581
|
+
* @throws {NotFoundException} 404
|
|
5582
|
+
* @throws {UnprocessableEntityException} 422
|
|
5583
|
+
*/
|
|
4828
5584
|
updateEnvironmentRole(slug: string, options: UpdateEnvironmentRoleOptions): Promise<EnvironmentRole>;
|
|
5585
|
+
/**
|
|
5586
|
+
* Set permissions for an environment role
|
|
5587
|
+
*
|
|
5588
|
+
* Replace all permissions on an environment role with the provided list.
|
|
5589
|
+
* @param slug - The slug of the environment role.
|
|
5590
|
+
*
|
|
5591
|
+
* @example
|
|
5592
|
+
* "admin"
|
|
5593
|
+
*
|
|
5594
|
+
* @param options - Object containing permissions.
|
|
5595
|
+
* @returns {Promise<EnvironmentRole>}
|
|
5596
|
+
* @throws {BadRequestException} 400
|
|
5597
|
+
* @throws 403 response from the API.
|
|
5598
|
+
* @throws {NotFoundException} 404
|
|
5599
|
+
* @throws {UnprocessableEntityException} 422
|
|
5600
|
+
*/
|
|
4829
5601
|
setEnvironmentRolePermissions(slug: string, options: SetEnvironmentRolePermissionsOptions): Promise<EnvironmentRole>;
|
|
5602
|
+
/**
|
|
5603
|
+
* Add a permission to an environment role
|
|
5604
|
+
*
|
|
5605
|
+
* Add a single permission to an environment role. If the permission is already assigned to the role, this operation has no effect.
|
|
5606
|
+
* @param slug - The slug of the environment role.
|
|
5607
|
+
*
|
|
5608
|
+
* @example
|
|
5609
|
+
* "admin"
|
|
5610
|
+
*
|
|
5611
|
+
* @param options - Object containing slug.
|
|
5612
|
+
* @returns {Promise<EnvironmentRole>}
|
|
5613
|
+
* @throws {BadRequestException} 400
|
|
5614
|
+
* @throws 403 response from the API.
|
|
5615
|
+
* @throws {NotFoundException} 404
|
|
5616
|
+
* @throws {UnprocessableEntityException} 422
|
|
5617
|
+
*/
|
|
4830
5618
|
addEnvironmentRolePermission(slug: string, options: AddEnvironmentRolePermissionOptions): Promise<EnvironmentRole>;
|
|
5619
|
+
/**
|
|
5620
|
+
* Create a custom role
|
|
5621
|
+
*
|
|
5622
|
+
* Create a new custom role for this organization.
|
|
5623
|
+
* @param organizationId - The ID of the organization.
|
|
5624
|
+
*
|
|
5625
|
+
* @example
|
|
5626
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5627
|
+
*
|
|
5628
|
+
* @param options - Object containing name.
|
|
5629
|
+
* @returns {Promise<OrganizationRole>}
|
|
5630
|
+
* @throws {BadRequestException} 400
|
|
5631
|
+
* @throws 403 response from the API.
|
|
5632
|
+
* @throws {NotFoundException} 404
|
|
5633
|
+
* @throws {ConflictException} 409
|
|
5634
|
+
* @throws {UnprocessableEntityException} 422
|
|
5635
|
+
*/
|
|
4831
5636
|
createOrganizationRole(organizationId: string, options: CreateOrganizationRoleOptions): Promise<OrganizationRole>;
|
|
5637
|
+
/**
|
|
5638
|
+
* List custom roles
|
|
5639
|
+
*
|
|
5640
|
+
* Get a list of all roles that apply to an organization. This includes both environment roles and custom roles, returned in priority order.
|
|
5641
|
+
* @param organizationId - The ID of the organization.
|
|
5642
|
+
*
|
|
5643
|
+
* @example
|
|
5644
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5645
|
+
*
|
|
5646
|
+
* @returns {Promise<RoleList>}
|
|
5647
|
+
* @throws 403 response from the API.
|
|
5648
|
+
* @throws {NotFoundException} 404
|
|
5649
|
+
*/
|
|
4832
5650
|
listOrganizationRoles(organizationId: string): Promise<RoleList>;
|
|
5651
|
+
/**
|
|
5652
|
+
* Get a custom role
|
|
5653
|
+
*
|
|
5654
|
+
* Retrieve a role that applies to an organization by its slug. This can return either an environment role or a custom role.
|
|
5655
|
+
* @param organizationId - The ID of the organization.
|
|
5656
|
+
*
|
|
5657
|
+
* @example
|
|
5658
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5659
|
+
*
|
|
5660
|
+
* @param slug - The slug of the role.
|
|
5661
|
+
*
|
|
5662
|
+
* @example
|
|
5663
|
+
* "org-billing-admin"
|
|
5664
|
+
*
|
|
5665
|
+
* @returns {Promise<Role>}
|
|
5666
|
+
* @throws 403 response from the API.
|
|
5667
|
+
* @throws {NotFoundException} 404
|
|
5668
|
+
*/
|
|
4833
5669
|
getOrganizationRole(organizationId: string, slug: string): Promise<Role>;
|
|
5670
|
+
/**
|
|
5671
|
+
* Update a custom role
|
|
5672
|
+
*
|
|
5673
|
+
* Update an existing custom role. Only the fields provided in the request body will be updated.
|
|
5674
|
+
* @param organizationId - The ID of the organization.
|
|
5675
|
+
*
|
|
5676
|
+
* @example
|
|
5677
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5678
|
+
*
|
|
5679
|
+
* @param slug - The slug of the role.
|
|
5680
|
+
*
|
|
5681
|
+
* @example
|
|
5682
|
+
* "org-billing-admin"
|
|
5683
|
+
*
|
|
5684
|
+
* @param options - The request body.
|
|
5685
|
+
* @returns {Promise<OrganizationRole>}
|
|
5686
|
+
* @throws {BadRequestException} 400
|
|
5687
|
+
* @throws 403 response from the API.
|
|
5688
|
+
* @throws {NotFoundException} 404
|
|
5689
|
+
* @throws {UnprocessableEntityException} 422
|
|
5690
|
+
*/
|
|
4834
5691
|
updateOrganizationRole(organizationId: string, slug: string, options: UpdateOrganizationRoleOptions): Promise<OrganizationRole>;
|
|
5692
|
+
/**
|
|
5693
|
+
* Delete a custom role
|
|
5694
|
+
*
|
|
5695
|
+
* Delete an existing custom role.
|
|
5696
|
+
* @param organizationId - The ID of the organization.
|
|
5697
|
+
*
|
|
5698
|
+
* @example
|
|
5699
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5700
|
+
*
|
|
5701
|
+
* @param slug - The slug of the role.
|
|
5702
|
+
*
|
|
5703
|
+
* @example
|
|
5704
|
+
* "org-admin"
|
|
5705
|
+
*
|
|
5706
|
+
* @returns {Promise<void>}
|
|
5707
|
+
* @throws {BadRequestException} 400
|
|
5708
|
+
* @throws 403 response from the API.
|
|
5709
|
+
* @throws {NotFoundException} 404
|
|
5710
|
+
* @throws {ConflictException} 409
|
|
5711
|
+
*/
|
|
4835
5712
|
deleteOrganizationRole(organizationId: string, slug: string): Promise<void>;
|
|
4836
|
-
|
|
4837
|
-
|
|
4838
|
-
|
|
5713
|
+
/**
|
|
5714
|
+
* Set permissions for a custom role
|
|
5715
|
+
*
|
|
5716
|
+
* Replace all permissions on a custom role with the provided list.
|
|
5717
|
+
* @param organizationId - The ID of the organization.
|
|
5718
|
+
*
|
|
5719
|
+
* @example
|
|
5720
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5721
|
+
*
|
|
5722
|
+
* @param slug - The slug of the role.
|
|
5723
|
+
*
|
|
5724
|
+
* @example
|
|
5725
|
+
* "org-admin"
|
|
5726
|
+
*
|
|
5727
|
+
* @param options - Object containing permissions.
|
|
5728
|
+
* @returns {Promise<Role>}
|
|
5729
|
+
* @throws 403 response from the API.
|
|
5730
|
+
* @throws {NotFoundException} 404
|
|
5731
|
+
* @throws {UnprocessableEntityException} 422
|
|
5732
|
+
*/
|
|
5733
|
+
updateRolePermissions(organizationId: string, slug: string, options: SetOrganizationRolePermissionsOptions): Promise<OrganizationRole>;
|
|
5734
|
+
/**
|
|
5735
|
+
* Add a permission to a custom role
|
|
5736
|
+
*
|
|
5737
|
+
* Add a single permission to a custom role. If the permission is already assigned to the role, this operation has no effect.
|
|
5738
|
+
* @param organizationId - The ID of the organization.
|
|
5739
|
+
*
|
|
5740
|
+
* @example
|
|
5741
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5742
|
+
*
|
|
5743
|
+
* @param slug - The slug of the role.
|
|
5744
|
+
*
|
|
5745
|
+
* @example
|
|
5746
|
+
* "org-admin"
|
|
5747
|
+
*
|
|
5748
|
+
* @param options - Object containing slug.
|
|
5749
|
+
* @returns {Promise<Role>}
|
|
5750
|
+
* @throws {BadRequestException} 400
|
|
5751
|
+
* @throws 403 response from the API.
|
|
5752
|
+
* @throws {NotFoundException} 404
|
|
5753
|
+
* @throws {UnprocessableEntityException} 422
|
|
5754
|
+
*/
|
|
5755
|
+
createRolePermission(organizationId: string, slug: string, options: AddOrganizationRolePermissionOptions): Promise<OrganizationRole>;
|
|
5756
|
+
/**
|
|
5757
|
+
* Remove a permission from a custom role
|
|
5758
|
+
*
|
|
5759
|
+
* Remove a single permission from a custom role by its slug.
|
|
5760
|
+
* @param organizationId - The ID of the organization.
|
|
5761
|
+
*
|
|
5762
|
+
* @example
|
|
5763
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5764
|
+
*
|
|
5765
|
+
* @param slug - The slug of the role.
|
|
5766
|
+
*
|
|
5767
|
+
* @example
|
|
5768
|
+
* "org-admin"
|
|
5769
|
+
*
|
|
5770
|
+
* @param permissionSlug - The slug of the permission to remove.
|
|
5771
|
+
*
|
|
5772
|
+
* @example
|
|
5773
|
+
* "documents:read"
|
|
5774
|
+
*
|
|
5775
|
+
* @returns {Promise<void>}
|
|
5776
|
+
* @throws 403 response from the API.
|
|
5777
|
+
* @throws {NotFoundException} 404
|
|
5778
|
+
*/
|
|
5779
|
+
deleteRolePermission(organizationId: string, slug: string, options: RemoveOrganizationRolePermissionOptions): Promise<void>;
|
|
5780
|
+
/**
|
|
5781
|
+
* Create a permission
|
|
5782
|
+
*
|
|
5783
|
+
* Create a new permission in your WorkOS environment. The permission can then be assigned to environment roles and custom roles.
|
|
5784
|
+
* @param options - Object containing slug, name.
|
|
5785
|
+
* @returns {Promise<Permission>}
|
|
5786
|
+
* @throws {BadRequestException} 400
|
|
5787
|
+
* @throws {NotFoundException} 404
|
|
5788
|
+
* @throws {ConflictException} 409
|
|
5789
|
+
* @throws {UnprocessableEntityException} 422
|
|
5790
|
+
*/
|
|
4839
5791
|
createPermission(options: CreatePermissionOptions): Promise<Permission>;
|
|
4840
|
-
|
|
5792
|
+
/**
|
|
5793
|
+
* List permissions
|
|
5794
|
+
*
|
|
5795
|
+
* Get a list of all permissions in your WorkOS environment.
|
|
5796
|
+
* @param options - Pagination and filter options.
|
|
5797
|
+
* @returns {Promise<AutoPaginatable<Permission, PaginationOptions>>}
|
|
5798
|
+
* @throws {NotFoundException} 404
|
|
5799
|
+
*/
|
|
5800
|
+
listPermissions(options?: ListPermissionsOptions): Promise<AutoPaginatable<Permission>>;
|
|
5801
|
+
/**
|
|
5802
|
+
* Get a permission
|
|
5803
|
+
*
|
|
5804
|
+
* Retrieve a permission by its unique slug.
|
|
5805
|
+
* @param slug - A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
|
|
5806
|
+
*
|
|
5807
|
+
* @example
|
|
5808
|
+
* "documents:read"
|
|
5809
|
+
*
|
|
5810
|
+
* @returns {Promise<Permission>}
|
|
5811
|
+
* @throws {NotFoundException} 404
|
|
5812
|
+
*/
|
|
4841
5813
|
getPermission(slug: string): Promise<Permission>;
|
|
5814
|
+
/**
|
|
5815
|
+
* Update a permission
|
|
5816
|
+
*
|
|
5817
|
+
* Update an existing permission. Only the fields provided in the request body will be updated.
|
|
5818
|
+
* @param slug - A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
|
|
5819
|
+
*
|
|
5820
|
+
* @example
|
|
5821
|
+
* "documents:read"
|
|
5822
|
+
*
|
|
5823
|
+
* @param options - The request body.
|
|
5824
|
+
* @returns {Promise<Permission>}
|
|
5825
|
+
* @throws 403 response from the API.
|
|
5826
|
+
* @throws {NotFoundException} 404
|
|
5827
|
+
* @throws {UnprocessableEntityException} 422
|
|
5828
|
+
*/
|
|
4842
5829
|
updatePermission(slug: string, options: UpdatePermissionOptions): Promise<Permission>;
|
|
5830
|
+
/**
|
|
5831
|
+
* Delete a permission
|
|
5832
|
+
*
|
|
5833
|
+
* Delete an existing permission. System permissions cannot be deleted.
|
|
5834
|
+
* @param slug - A unique key to reference the permission. Must be lowercase and contain only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
|
|
5835
|
+
*
|
|
5836
|
+
* @example
|
|
5837
|
+
* "documents:read"
|
|
5838
|
+
*
|
|
5839
|
+
* @returns {Promise<void>}
|
|
5840
|
+
* @throws 403 response from the API.
|
|
5841
|
+
* @throws {NotFoundException} 404
|
|
5842
|
+
*/
|
|
4843
5843
|
deletePermission(slug: string): Promise<void>;
|
|
5844
|
+
/**
|
|
5845
|
+
* Get a resource
|
|
5846
|
+
*
|
|
5847
|
+
* Retrieve the details of an authorization resource by its ID.
|
|
5848
|
+
* @param resourceId - The ID of the authorization resource.
|
|
5849
|
+
*
|
|
5850
|
+
* @example
|
|
5851
|
+
* "authz_resource_01HXYZ123456789ABCDEFGHIJ"
|
|
5852
|
+
*
|
|
5853
|
+
* @returns {Promise<AuthorizationResource>}
|
|
5854
|
+
* @throws 403 response from the API.
|
|
5855
|
+
* @throws {NotFoundException} 404
|
|
5856
|
+
* @throws {UnprocessableEntityException} 422
|
|
5857
|
+
*/
|
|
4844
5858
|
getResource(resourceId: string): Promise<AuthorizationResource>;
|
|
5859
|
+
/**
|
|
5860
|
+
* Create an authorization resource
|
|
5861
|
+
*
|
|
5862
|
+
* Create a new authorization resource.
|
|
5863
|
+
* @param options - Object containing externalId, name, resourceTypeSlug, organizationId.
|
|
5864
|
+
* @returns {Promise<AuthorizationResource>}
|
|
5865
|
+
* @throws {BadRequestException} 400
|
|
5866
|
+
* @throws 403 response from the API.
|
|
5867
|
+
* @throws {NotFoundException} 404
|
|
5868
|
+
* @throws {ConflictException} 409
|
|
5869
|
+
* @throws {UnprocessableEntityException} 422
|
|
5870
|
+
*/
|
|
4845
5871
|
createResource(options: CreateAuthorizationResourceOptions): Promise<AuthorizationResource>;
|
|
5872
|
+
/**
|
|
5873
|
+
* Update a resource
|
|
5874
|
+
*
|
|
5875
|
+
* Update an existing authorization resource.
|
|
5876
|
+
* @param options - The request body.
|
|
5877
|
+
* @returns {Promise<AuthorizationResource>}
|
|
5878
|
+
* @throws {BadRequestException} 400
|
|
5879
|
+
* @throws 403 response from the API.
|
|
5880
|
+
* @throws {NotFoundException} 404
|
|
5881
|
+
* @throws {ConflictException} 409
|
|
5882
|
+
* @throws {UnprocessableEntityException} 422
|
|
5883
|
+
*/
|
|
4846
5884
|
updateResource(options: UpdateAuthorizationResourceOptions): Promise<AuthorizationResource>;
|
|
5885
|
+
/**
|
|
5886
|
+
* Delete an authorization resource
|
|
5887
|
+
*
|
|
5888
|
+
* Delete an authorization resource and all its descendants.
|
|
5889
|
+
* @param options.cascadeDelete - If true, deletes all descendant resources and role assignments. If not set and the resource has children or assignments, the request will fail.
|
|
5890
|
+
* @default false
|
|
5891
|
+
* @param options - Additional query options.
|
|
5892
|
+
* @returns {Promise<void>}
|
|
5893
|
+
* @throws {BadRequestException} 400
|
|
5894
|
+
* @throws 403 response from the API.
|
|
5895
|
+
* @throws {NotFoundException} 404
|
|
5896
|
+
* @throws {ConflictException} 409
|
|
5897
|
+
*/
|
|
4847
5898
|
deleteResource(options: DeleteAuthorizationResourceOptions): Promise<void>;
|
|
4848
|
-
|
|
4849
|
-
|
|
4850
|
-
|
|
4851
|
-
|
|
5899
|
+
/**
|
|
5900
|
+
* List resources
|
|
5901
|
+
*
|
|
5902
|
+
* Get a paginated list of authorization resources.
|
|
5903
|
+
* @param options - Pagination and filter options.
|
|
5904
|
+
* @returns {Promise<AutoPaginatable<AuthorizationResource, PaginationOptions>>}
|
|
5905
|
+
* @throws 403 response from the API.
|
|
5906
|
+
* @throws {UnprocessableEntityException} 422
|
|
5907
|
+
*/
|
|
5908
|
+
listResources(options?: ListAuthorizationResourcesOptions): Promise<AutoPaginatable<AuthorizationResource>>;
|
|
5909
|
+
/**
|
|
5910
|
+
* Get a resource by external ID
|
|
5911
|
+
*
|
|
5912
|
+
* Retrieve the details of an authorization resource by its external ID, organization, and resource type. This is useful when you only have the external ID from your system and need to fetch the full resource details.
|
|
5913
|
+
* @param organizationId - The ID of the organization that owns the resource.
|
|
5914
|
+
*
|
|
5915
|
+
* @example
|
|
5916
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5917
|
+
*
|
|
5918
|
+
* @param resourceTypeSlug - The slug of the resource type.
|
|
5919
|
+
*
|
|
5920
|
+
* @example
|
|
5921
|
+
* "project"
|
|
5922
|
+
*
|
|
5923
|
+
* @param externalId - An identifier you provide to reference the resource in your system.
|
|
5924
|
+
*
|
|
5925
|
+
* @example
|
|
5926
|
+
* "proj-456"
|
|
5927
|
+
*
|
|
5928
|
+
* @returns {Promise<AuthorizationResource>}
|
|
5929
|
+
* @throws 403 response from the API.
|
|
5930
|
+
* @throws {NotFoundException} 404
|
|
5931
|
+
*/
|
|
5932
|
+
getOrganizationResource(options: GetAuthorizationResourceByExternalIdOptions): Promise<AuthorizationResource>;
|
|
5933
|
+
/**
|
|
5934
|
+
* Update a resource by external ID
|
|
5935
|
+
*
|
|
5936
|
+
* Update an existing authorization resource using its external ID.
|
|
5937
|
+
* @param organizationId - The ID of the organization that owns the resource.
|
|
5938
|
+
*
|
|
5939
|
+
* @example
|
|
5940
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5941
|
+
*
|
|
5942
|
+
* @param resourceTypeSlug - The slug of the resource type.
|
|
5943
|
+
*
|
|
5944
|
+
* @example
|
|
5945
|
+
* "project"
|
|
5946
|
+
*
|
|
5947
|
+
* @param externalId - An identifier you provide to reference the resource in your system.
|
|
5948
|
+
*
|
|
5949
|
+
* @example
|
|
5950
|
+
* "proj-456"
|
|
5951
|
+
*
|
|
5952
|
+
* @param options - The request body.
|
|
5953
|
+
* @returns {Promise<AuthorizationResource>}
|
|
5954
|
+
* @throws {BadRequestException} 400
|
|
5955
|
+
* @throws 403 response from the API.
|
|
5956
|
+
* @throws {NotFoundException} 404
|
|
5957
|
+
* @throws {ConflictException} 409
|
|
5958
|
+
* @throws {UnprocessableEntityException} 422
|
|
5959
|
+
*/
|
|
5960
|
+
updateOrganizationResource(options: UpdateAuthorizationResourceByExternalIdOptions): Promise<AuthorizationResource>;
|
|
5961
|
+
/**
|
|
5962
|
+
* Delete an authorization resource by external ID
|
|
5963
|
+
*
|
|
5964
|
+
* Delete an authorization resource by organization, resource type, and external ID. This also deletes all descendant resources.
|
|
5965
|
+
* @param organizationId - The ID of the organization that owns the resource.
|
|
5966
|
+
*
|
|
5967
|
+
* @example
|
|
5968
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5969
|
+
*
|
|
5970
|
+
* @param resourceTypeSlug - The slug of the resource type.
|
|
5971
|
+
*
|
|
5972
|
+
* @example
|
|
5973
|
+
* "project"
|
|
5974
|
+
*
|
|
5975
|
+
* @param externalId - An identifier you provide to reference the resource in your system.
|
|
5976
|
+
*
|
|
5977
|
+
* @example
|
|
5978
|
+
* "proj-456"
|
|
5979
|
+
*
|
|
5980
|
+
* @param options - Additional query options.
|
|
5981
|
+
* @returns {Promise<void>}
|
|
5982
|
+
* @throws {BadRequestException} 400
|
|
5983
|
+
* @throws 403 response from the API.
|
|
5984
|
+
* @throws {NotFoundException} 404
|
|
5985
|
+
* @throws {ConflictException} 409
|
|
5986
|
+
*/
|
|
5987
|
+
deleteOrganizationResource(options: DeleteAuthorizationResourceByExternalIdOptions): Promise<void>;
|
|
5988
|
+
/**
|
|
5989
|
+
* Check authorization
|
|
5990
|
+
*
|
|
5991
|
+
* Check if an organization membership has a specific permission on a resource. Supports identification by resource_id OR by resource_external_id + resource_type_slug.
|
|
5992
|
+
* @param options - Object containing permissionSlug.
|
|
5993
|
+
* @returns {Promise<AuthorizationCheckResult>}
|
|
5994
|
+
* @throws 403 response from the API.
|
|
5995
|
+
* @throws {NotFoundException} 404
|
|
5996
|
+
* @throws {UnprocessableEntityException} 422
|
|
5997
|
+
*/
|
|
4852
5998
|
check(options: AuthorizationCheckOptions): Promise<AuthorizationCheckResult>;
|
|
4853
|
-
|
|
5999
|
+
/**
|
|
6000
|
+
* List role assignments
|
|
6001
|
+
*
|
|
6002
|
+
* List all role assignments for an organization membership. This returns all roles that have been assigned to the user on resources, including organization-level and sub-resource roles.
|
|
6003
|
+
* @param organizationMembershipId - The ID of the organization membership.
|
|
6004
|
+
*
|
|
6005
|
+
* @example
|
|
6006
|
+
* "om_01HXYZ123456789ABCDEFGHIJ"
|
|
6007
|
+
*
|
|
6008
|
+
* @param options - Pagination and filter options.
|
|
6009
|
+
* @returns {Promise<AutoPaginatable<RoleAssignment>>}
|
|
6010
|
+
* @throws 403 response from the API.
|
|
6011
|
+
* @throws {NotFoundException} 404
|
|
6012
|
+
*/
|
|
6013
|
+
listOrganizationMembershipRoleAssignments(options: ListRoleAssignmentsOptions): Promise<AutoPaginatable<RoleAssignment>>;
|
|
6014
|
+
/**
|
|
6015
|
+
* Assign a role
|
|
6016
|
+
*
|
|
6017
|
+
* Assign a role to an organization membership on a specific resource.
|
|
6018
|
+
* @param options - Object containing roleSlug.
|
|
6019
|
+
* @returns {Promise<RoleAssignment>}
|
|
6020
|
+
* @throws 403 response from the API.
|
|
6021
|
+
* @throws {NotFoundException} 404
|
|
6022
|
+
* @throws {UnprocessableEntityException} 422
|
|
6023
|
+
*/
|
|
4854
6024
|
assignRole(options: AssignRoleOptions): Promise<RoleAssignment>;
|
|
6025
|
+
/**
|
|
6026
|
+
* Remove a role assignment
|
|
6027
|
+
*
|
|
6028
|
+
* Remove a role assignment by role slug and resource.
|
|
6029
|
+
* @param options - Object containing roleSlug.
|
|
6030
|
+
* @returns {Promise<void>}
|
|
6031
|
+
* @throws 403 response from the API.
|
|
6032
|
+
* @throws {NotFoundException} 404
|
|
6033
|
+
* @throws {UnprocessableEntityException} 422
|
|
6034
|
+
*/
|
|
4855
6035
|
removeRole(options: RemoveRoleOptions): Promise<void>;
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
|
|
6036
|
+
/**
|
|
6037
|
+
* Remove a role assignment by ID
|
|
6038
|
+
*
|
|
6039
|
+
* Remove a role assignment using its ID.
|
|
6040
|
+
* @param organizationMembershipId - The ID of the organization membership.
|
|
6041
|
+
*
|
|
6042
|
+
* @example
|
|
6043
|
+
* "om_01HXYZ123456789ABCDEFGHIJ"
|
|
6044
|
+
*
|
|
6045
|
+
* @param roleAssignmentId - The ID of the role assignment to remove.
|
|
6046
|
+
*
|
|
6047
|
+
* @example
|
|
6048
|
+
* "role_assignment_01HXYZ123456789ABCDEFGH"
|
|
6049
|
+
*
|
|
6050
|
+
* @returns {Promise<void>}
|
|
6051
|
+
* @throws 403 response from the API.
|
|
6052
|
+
* @throws {NotFoundException} 404
|
|
6053
|
+
*/
|
|
6054
|
+
deleteOrganizationMembershipRoleAssignment(options: RemoveRoleAssignmentOptions): Promise<void>;
|
|
6055
|
+
/**
|
|
6056
|
+
* List resources for organization membership
|
|
6057
|
+
*
|
|
6058
|
+
* Returns all child resources of a parent resource where the organization membership has a specific permission. This is useful for resource discovery—answering "What projects can this user access in this workspace?"
|
|
6059
|
+
*
|
|
6060
|
+
* You must provide either `parent_resource_id` or both `parent_resource_external_id` and `parent_resource_type_slug` to identify the parent resource.
|
|
6061
|
+
* @param organizationMembershipId - The ID of the organization membership.
|
|
6062
|
+
*
|
|
6063
|
+
* @example
|
|
6064
|
+
* "om_01HXYZ123456789ABCDEFGHIJ"
|
|
6065
|
+
*
|
|
6066
|
+
* @param options - Pagination and filter options.
|
|
6067
|
+
* @returns {Promise<AutoPaginatable<AuthorizationResource>>}
|
|
6068
|
+
* @throws {BadRequestException} 400
|
|
6069
|
+
* @throws 403 response from the API.
|
|
6070
|
+
* @throws {NotFoundException} 404
|
|
6071
|
+
* @throws {UnprocessableEntityException} 422
|
|
6072
|
+
*/
|
|
6073
|
+
listOrganizationMembershipResources(options: ListResourcesForMembershipOptions): Promise<AutoPaginatable<AuthorizationResource>>;
|
|
6074
|
+
/**
|
|
6075
|
+
* List organization memberships for resource
|
|
6076
|
+
*
|
|
6077
|
+
* Returns all organization memberships that have a specific permission on a resource instance. This is useful for answering "Who can access this resource?".
|
|
6078
|
+
* @param options - Pagination and filter options.
|
|
6079
|
+
* @returns {Promise<AutoPaginatable<BaseOrganizationMembership, PaginationOptions>>}
|
|
6080
|
+
* @throws {BadRequestException} 400
|
|
6081
|
+
* @throws 403 response from the API.
|
|
6082
|
+
* @throws {NotFoundException} 404
|
|
6083
|
+
* @throws {UnprocessableEntityException} 422
|
|
6084
|
+
*/
|
|
6085
|
+
listMembershipsForResource(options: ListMembershipsForResourceOptions): Promise<AutoPaginatable<AuthorizationOrganizationMembership>>;
|
|
6086
|
+
/**
|
|
6087
|
+
* List memberships for a resource by external ID
|
|
6088
|
+
*
|
|
6089
|
+
* Returns all organization memberships that have a specific permission on a resource, using the resource's external ID. This is useful for answering "Who can access this resource?" when you only have the external ID.
|
|
6090
|
+
* @param organizationId - The ID of the organization that owns the resource.
|
|
6091
|
+
*
|
|
6092
|
+
* @example
|
|
6093
|
+
* "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6094
|
+
*
|
|
6095
|
+
* @param resourceTypeSlug - The slug of the resource type this resource belongs to.
|
|
6096
|
+
*
|
|
6097
|
+
* @example
|
|
6098
|
+
* "project"
|
|
6099
|
+
*
|
|
6100
|
+
* @param externalId - An identifier you provide to reference the resource in your system.
|
|
6101
|
+
*
|
|
6102
|
+
* @example
|
|
6103
|
+
* "proj-456"
|
|
6104
|
+
*
|
|
6105
|
+
* @param options - Pagination and filter options.
|
|
6106
|
+
* @returns {Promise<AutoPaginatable<UserOrganizationMembershipBaseListData>>}
|
|
6107
|
+
* @throws {BadRequestException} 400
|
|
6108
|
+
* @throws 403 response from the API.
|
|
6109
|
+
* @throws {NotFoundException} 404
|
|
6110
|
+
* @throws {UnprocessableEntityException} 422
|
|
6111
|
+
*/
|
|
6112
|
+
listResourceOrganizationMemberships(options: ListMembershipsForResourceByExternalIdOptions): Promise<AutoPaginatable<AuthorizationOrganizationMembership>>;
|
|
6113
|
+
/**
|
|
6114
|
+
* List effective permissions for an organization membership on a resource
|
|
6115
|
+
*
|
|
6116
|
+
* Returns all permissions the organization membership effectively has on a resource, including permissions inherited through roles assigned to ancestor resources.
|
|
6117
|
+
* @param organizationMembershipId - The ID of the organization membership.
|
|
6118
|
+
*
|
|
6119
|
+
* @example
|
|
6120
|
+
* "om_01HXYZ123456789ABCDEFGHIJ"
|
|
6121
|
+
*
|
|
6122
|
+
* @param resourceId - The ID of the authorization resource.
|
|
6123
|
+
*
|
|
6124
|
+
* @example
|
|
6125
|
+
* "authz_resource_01HXYZ123456789ABCDEFGHIJ"
|
|
6126
|
+
*
|
|
6127
|
+
* @param options - Pagination and filter options.
|
|
6128
|
+
* @returns {Promise<AutoPaginatable<AuthorizationPermission>>}
|
|
6129
|
+
* @throws 403 response from the API.
|
|
6130
|
+
* @throws {NotFoundException} 404
|
|
6131
|
+
* @throws {UnprocessableEntityException} 422
|
|
6132
|
+
*/
|
|
6133
|
+
listResourcePermissions(options: ListEffectivePermissionsOptions): Promise<AutoPaginatable<Permission>>;
|
|
6134
|
+
/**
|
|
6135
|
+
* List effective permissions for an organization membership on a resource by external ID
|
|
6136
|
+
*
|
|
6137
|
+
* Returns all permissions the organization membership effectively has on a resource identified by its external ID, including permissions inherited through roles assigned to ancestor resources.
|
|
6138
|
+
* @param options - Pagination and filter options.
|
|
6139
|
+
* @returns {Promise<AutoPaginatable<Permission, PaginationOptions>>}
|
|
6140
|
+
* @throws 403 response from the API.
|
|
6141
|
+
* @throws {NotFoundException} 404
|
|
6142
|
+
* @throws {UnprocessableEntityException} 422
|
|
6143
|
+
*/
|
|
6144
|
+
listEffectivePermissionsByExternalId(options: ListEffectivePermissionsByExternalIdOptions): Promise<AutoPaginatable<Permission>>;
|
|
4860
6145
|
}
|
|
4861
6146
|
//#endregion
|
|
4862
6147
|
//#region src/common/exceptions/api-key-required.exception.d.ts
|
|
@@ -4875,13 +6160,38 @@ interface RequestException {
|
|
|
4875
6160
|
}
|
|
4876
6161
|
//#endregion
|
|
4877
6162
|
//#region src/common/exceptions/generic-server.exception.d.ts
|
|
6163
|
+
interface WorkOSErrorData {
|
|
6164
|
+
code?: string;
|
|
6165
|
+
message?: string;
|
|
6166
|
+
[key: string]: unknown;
|
|
6167
|
+
}
|
|
4878
6168
|
declare class GenericServerException extends Error implements RequestException {
|
|
4879
6169
|
readonly status: number;
|
|
4880
|
-
readonly rawData:
|
|
6170
|
+
readonly rawData: WorkOSErrorData;
|
|
4881
6171
|
readonly requestID: string;
|
|
4882
6172
|
readonly name: string;
|
|
4883
6173
|
readonly message: string;
|
|
4884
|
-
|
|
6174
|
+
readonly code: string | undefined;
|
|
6175
|
+
constructor(status: number, message: string | undefined, rawData: WorkOSErrorData, requestID: string);
|
|
6176
|
+
}
|
|
6177
|
+
//#endregion
|
|
6178
|
+
//#region src/common/exceptions/authentication.exception.d.ts
|
|
6179
|
+
type AuthenticationErrorCode = 'email_verification_required' | 'organization_selection_required' | 'mfa_enrollment' | 'mfa_challenge' | 'mfa_verification' | 'sso_required';
|
|
6180
|
+
interface AuthenticationErrorData extends WorkOSErrorData {
|
|
6181
|
+
code: AuthenticationErrorCode;
|
|
6182
|
+
pending_authentication_token?: string;
|
|
6183
|
+
user?: Record<string, unknown>;
|
|
6184
|
+
organizations?: Array<{
|
|
6185
|
+
id: string;
|
|
6186
|
+
name: string;
|
|
6187
|
+
}>;
|
|
6188
|
+
}
|
|
6189
|
+
declare function isAuthenticationErrorData(data: WorkOSErrorData): data is AuthenticationErrorData;
|
|
6190
|
+
declare class AuthenticationException extends GenericServerException {
|
|
6191
|
+
readonly rawData: AuthenticationErrorData;
|
|
6192
|
+
readonly name = "AuthenticationException";
|
|
6193
|
+
readonly pendingAuthenticationToken: string | undefined;
|
|
6194
|
+
constructor(status: number, rawData: AuthenticationErrorData, requestID: string);
|
|
4885
6195
|
}
|
|
4886
6196
|
//#endregion
|
|
4887
6197
|
//#region src/common/exceptions/bad-request.exception.d.ts
|
|
@@ -4905,6 +6215,25 @@ declare class BadRequestException extends Error implements RequestException {
|
|
|
4905
6215
|
});
|
|
4906
6216
|
}
|
|
4907
6217
|
//#endregion
|
|
6218
|
+
//#region src/common/exceptions/conflict.exception.d.ts
|
|
6219
|
+
declare class ConflictException extends Error implements RequestException {
|
|
6220
|
+
readonly status = 409;
|
|
6221
|
+
readonly name = "ConflictException";
|
|
6222
|
+
readonly requestID: string;
|
|
6223
|
+
readonly code?: string;
|
|
6224
|
+
constructor({
|
|
6225
|
+
error,
|
|
6226
|
+
message,
|
|
6227
|
+
requestID,
|
|
6228
|
+
code
|
|
6229
|
+
}: {
|
|
6230
|
+
error?: string;
|
|
6231
|
+
message?: string;
|
|
6232
|
+
requestID: string;
|
|
6233
|
+
code?: string;
|
|
6234
|
+
});
|
|
6235
|
+
}
|
|
6236
|
+
//#endregion
|
|
4908
6237
|
//#region src/common/exceptions/no-api-key-provided.exception.d.ts
|
|
4909
6238
|
declare class NoApiKeyProvidedException extends Error {
|
|
4910
6239
|
readonly status = 500;
|
|
@@ -4993,6 +6322,70 @@ declare class UnprocessableEntityException extends Error implements RequestExcep
|
|
|
4993
6322
|
});
|
|
4994
6323
|
}
|
|
4995
6324
|
//#endregion
|
|
6325
|
+
//#region src/admin-portal/interfaces/sso-intent-options.interface.d.ts
|
|
6326
|
+
interface SSOIntentOptions {
|
|
6327
|
+
/** The bookmark slug to use for SSO. */
|
|
6328
|
+
bookmarkSlug?: string;
|
|
6329
|
+
/** The SSO provider type to configure. */
|
|
6330
|
+
providerType?: 'GoogleSAML';
|
|
6331
|
+
}
|
|
6332
|
+
interface SSOIntentOptionsResponse {
|
|
6333
|
+
bookmark_slug?: string;
|
|
6334
|
+
provider_type?: 'GoogleSAML';
|
|
6335
|
+
}
|
|
6336
|
+
//#endregion
|
|
6337
|
+
//#region src/admin-portal/interfaces/intent-options.interface.d.ts
|
|
6338
|
+
interface IntentOptions {
|
|
6339
|
+
/** SSO-specific options for the Admin Portal. */
|
|
6340
|
+
sso: SSOIntentOptions;
|
|
6341
|
+
}
|
|
6342
|
+
interface IntentOptionsResponse {
|
|
6343
|
+
sso: SSOIntentOptionsResponse;
|
|
6344
|
+
}
|
|
6345
|
+
//#endregion
|
|
6346
|
+
//#region src/admin-portal/interfaces/generate-link.interface.d.ts
|
|
6347
|
+
interface GenerateLink {
|
|
6348
|
+
/** The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used. */
|
|
6349
|
+
returnUrl?: string;
|
|
6350
|
+
/** The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used. */
|
|
6351
|
+
successUrl?: string;
|
|
6352
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. */
|
|
6353
|
+
organization: string;
|
|
6354
|
+
/**
|
|
6355
|
+
*
|
|
6356
|
+
* The intent of the Admin Portal.
|
|
6357
|
+
* - `sso` - Launch Admin Portal for creating SSO connections
|
|
6358
|
+
* - `dsync` - Launch Admin Portal for creating Directory Sync connections
|
|
6359
|
+
* - `audit_logs` - Launch Admin Portal for viewing Audit Logs
|
|
6360
|
+
* - `log_streams` - Launch Admin Portal for creating Log Streams
|
|
6361
|
+
* - `domain_verification` - Launch Admin Portal for Domain Verification
|
|
6362
|
+
* - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
|
|
6363
|
+
* - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
|
|
6364
|
+
*/
|
|
6365
|
+
intent?: GenerateLinkIntent;
|
|
6366
|
+
/** Options to configure the Admin Portal based on the intent. */
|
|
6367
|
+
intentOptions?: IntentOptions;
|
|
6368
|
+
/** The email addresses of the IT admins to grant access to the Admin Portal for the given organization. Accepts up to 20 emails. */
|
|
6369
|
+
adminEmails?: string[];
|
|
6370
|
+
}
|
|
6371
|
+
interface GenerateLinkResponse {
|
|
6372
|
+
return_url?: string;
|
|
6373
|
+
success_url?: string;
|
|
6374
|
+
organization: string;
|
|
6375
|
+
intent?: GenerateLinkIntent;
|
|
6376
|
+
intent_options?: IntentOptionsResponse;
|
|
6377
|
+
admin_emails?: string[];
|
|
6378
|
+
}
|
|
6379
|
+
//#endregion
|
|
6380
|
+
//#region src/admin-portal/interfaces/portal-link-response.interface.d.ts
|
|
6381
|
+
interface PortalLinkResponse {
|
|
6382
|
+
/** An ephemeral link to initiate the Admin Portal. */
|
|
6383
|
+
link: string;
|
|
6384
|
+
}
|
|
6385
|
+
interface PortalLinkResponseWire {
|
|
6386
|
+
link: string;
|
|
6387
|
+
}
|
|
6388
|
+
//#endregion
|
|
4996
6389
|
//#region src/factory.d.ts
|
|
4997
6390
|
/**
|
|
4998
6391
|
* Method names available without API key - single source of truth.
|
|
@@ -5200,6 +6593,7 @@ declare class Vault {
|
|
|
5200
6593
|
}
|
|
5201
6594
|
//#endregion
|
|
5202
6595
|
//#region src/workos.d.ts
|
|
6596
|
+
/** WorkOS REST API */
|
|
5203
6597
|
declare class WorkOS {
|
|
5204
6598
|
readonly baseURL: string;
|
|
5205
6599
|
readonly client: HttpClient;
|
|
@@ -5215,13 +6609,13 @@ declare class WorkOS {
|
|
|
5215
6609
|
readonly directorySync: DirectorySync;
|
|
5216
6610
|
readonly events: Events;
|
|
5217
6611
|
readonly featureFlags: FeatureFlags;
|
|
5218
|
-
readonly
|
|
5219
|
-
readonly
|
|
6612
|
+
readonly groups: Groups;
|
|
6613
|
+
readonly multiFactorAuth: MultiFactorAuth;
|
|
5220
6614
|
readonly organizations: Organizations;
|
|
5221
6615
|
readonly organizationDomains: OrganizationDomains;
|
|
5222
6616
|
readonly passwordless: Passwordless;
|
|
5223
6617
|
readonly pipes: Pipes;
|
|
5224
|
-
readonly
|
|
6618
|
+
readonly adminPortal: AdminPortal;
|
|
5225
6619
|
readonly sso: SSO;
|
|
5226
6620
|
readonly userManagement: UserManagement;
|
|
5227
6621
|
readonly vault: Vault;
|
|
@@ -5277,5 +6671,5 @@ declare class WorkOS {
|
|
|
5277
6671
|
private handleHttpError;
|
|
5278
6672
|
}
|
|
5279
6673
|
//#endregion
|
|
5280
|
-
export { DecisionTreeNode as $, VaultNamesListedEventResponseData as $a, ProfileAndToken as $c, RoleUpdatedEventResponse as $i, SerializedListResourcesForMembershipOptions as $l, AuthenticationOAuthSucceededEventResponse as $n, SerializedResetPasswordOptions as $o, FlagUpdatedEventResponse as $r, CreateOrganizationMembershipOptions as $s, CreatePasswordlessSessionOptions as $t, DirectoryGroup as $u, OauthException as A, VaultActor as Aa, SerializedAuthenticateWithRefreshTokenOptions as Ac, OrganizationRoleCreatedEvent as Ai, BaseRemoveRoleOptions as Al, WorkOSOptions as An, OrganizationDomainState as Ao, DsyncGroupUserAddedEvent as Ar, ListInvitationsOptions as As, UpdateResourceOptions as At, RemoveOrganizationRolePermissionOptions as Au, QueryRequestOptions as B, VaultDataReadEventData as Ba, AuthenticateUserWithEmailVerificationCredentials as Bc, PasswordResetSucceededEvent as Bi, ListRoleAssignmentsOptions as Bl, ApiKeyRevokedEvent as Bn, SerializedUpdateOrganizationMembershipOptions as Bo, EmailVerificationCreatedEvent as Br, FactorResponse as Bs, CreateAuditLogSchemaResponse as Bt, SerializedUpdateEnvironmentRoleOptions as Bu, PublicUserManagement as C, VaultDekReadEventResponse as Ca, UserResponse as Cc, OrganizationDomainVerifiedEventResponse as Ci, OrganizationRoleResponse as Cl, ListOrganizationFeatureFlagsOptions as Cn, SerializedCreateOrganizationApiKeyOptions as Co, DsyncDeletedEventResponse as Cr, AuthorizationOrganizationMembershipListResponse as Cs, ResourceOptions as Ct, UpdatePermissionOptions as Cu, UnauthorizedException as D, VaultMetadataReadEventResponse as Da, SerializedAuthenticateWithRefreshTokenPublicClientOptions as Dc, OrganizationMembershipDeletedResponse as Di, RoleList as Dl, DomainData as Dn, OrganizationDomainVerificationFailedResponse as Do, DsyncGroupDeletedEventResponse as Dr, OrganizationMembership as Ds, SerializedDeleteResourceOptions as Dt, PermissionList as Du, UnprocessableEntityException as E, VaultMetadataReadEvent as Ea, AuthenticateWithRefreshTokenPublicClientOptions as Ec, OrganizationMembershipDeleted as Ei, RoleEventResponse as El, SerializedCreateOrganizationOptions as En, OrganizationDomainVerificationFailed as Eo, DsyncGroupDeletedEvent as Er, BaseOrganizationMembershipResponse as Es, SerializedCreateResourceOptions as Et, Permission as Eu, ApiKeyRequiredException as F, VaultByokKeyVerificationCompletedEventResponseData as Fa, AuthenticateWithOrganizationSelectionOptions as Fc, OrganizationRoleUpdatedEventResponse as Fi, AssignRoleOptions as Fl, List as Fn, VerifyEmailOptions as Fo, DsyncUserCreatedEventResponse as Fr, InvitationEventResponse as Fs, AuditLogSchema as Ft, CreateOrganizationRoleOptions as Fu, CheckOptions as G, VaultDekDecryptedEventResponseData as Ga, AuthenticateUserWithCodeCredentials as Gc, PermissionDeletedEventResponse as Gi, RoleAssignmentResourceResponse as Gl, AuthenticationMagicAuthFailedEventResponse as Gn, SessionStatus as Go, EventResponse as Gr, EmailVerification as Gs, CreateAuditLogEventRequestOptions as Gt, EnvironmentRoleList as Gu, QueryResultResponse as H, VaultDataUpdatedEventData as Ha, SerializedAuthenticateWithEmailVerificationOptions as Hc, PermissionCreatedEvent as Hi, RoleAssignmentList as Hl, AuthenticationEmailVerificationSucceededEvent as Hn, AuthMethod as Ho, Event as Hr, FactorWithSecretsResponse as Hs, AuditLogActor as Ht, CreateEnvironmentRoleOptions as Hu, FeatureFlagsRuntimeClient as I, VaultDataCreatedEventData as Ia, SerializedAuthenticateWithOrganizationSelectionOptions as Ic, OrganizationUpdatedEvent as Ii, AssignRoleOptionsWithResourceExternalId as Il, ListResponse as In, SerializedUpdateUserPasswordOptions as Io, DsyncUserDeletedEvent as Ir, InvitationResponse as Is, AuditLogSchemaMetadata as It, SerializedCreateOrganizationRoleOptions as Iu, CheckResultInterface as J, VaultKekCreatedEventData as Ja, AuthenticateWithOptionsBase as Jc, RoleCreatedEvent as Ji, ListMembershipsForResourceByExternalIdOptions as Jl, AuthenticationMfaSucceededEvent as Jn, SerializedSendInvitationOptions as Jo, FlagDeletedEvent as Jr, EmailVerificationResponse as Js, AuditLogExportResponse as Jt, ListDirectoryUsersOptions as Ju, CheckRequestOptions as K, VaultDekReadEventData as Ka, AuthenticateWithCodeOptions as Kc, PermissionUpdatedEvent as Ki, RoleAssignmentResponse as Kl, AuthenticationMagicAuthSucceededEvent as Kn, SendVerificationEmailOptions as Ko, FlagCreatedEvent as Kr, EmailVerificationEvent as Ks, SerializedCreateAuditLogEventOptions as Kt, EnvironmentRoleListResponse as Ku, WarrantToken as L, VaultDataCreatedEventResponseData as La, AuthenticateUserWithMagicAuthCredentials as Lc, OrganizationUpdatedResponse as Li, AssignRoleOptionsWithResourceId as Ll, GetOptions as Ln, UpdateUserPasswordOptions as Lo, DsyncUserDeletedEventResponse as Lr, Identity as Ls, AuditLogTargetSchema as Lt, OrganizationRole as Lu, NoApiKeyProvidedException as M, VaultActorSource as Ma, AuthenticateWithPasswordOptions as Mc, OrganizationRoleDeletedEvent as Mi, RemoveRoleOptionsWithResourceExternalId as Ml, PutOptions as Mn, CreateOrganizationDomainOptions as Mo, DsyncGroupUserRemovedEvent as Mr, ListAuthFactorsOptions as Ms, CheckOp as Mt, SetOrganizationRolePermissionsOptions as Mu, BadRequestException as N, VaultByokKeyProvider as Na, SerializedAuthenticateWithPasswordOptions as Nc, OrganizationRoleDeletedEventResponse as Ni, RemoveRoleOptionsWithResourceId as Nl, PostOptions as Nn, SerializedCreateOrganizationDomainOptions as No, DsyncGroupUserRemovedEventResponse as Nr, Invitation as Ns, CookieSession as Nt, SerializedUpdateOrganizationRoleOptions as Nu, SignatureVerificationException as O, VaultNamesListedEvent as Oa, AuthenticateUserWithRefreshTokenCredentials as Oc, OrganizationMembershipUpdated as Oi, RoleResponse as Ol, DomainDataState as On, OrganizationDomain as Oo, DsyncGroupUpdatedEvent as Or, OrganizationMembershipResponse as Os, SerializedListResourcesOptions as Ot, PermissionListResponse as Ou, GenericServerException as P, VaultByokKeyVerificationCompletedEventData as Pa, AuthenticateUserWithOrganizationSelectionCredentials as Pc, OrganizationRoleUpdatedEvent as Pi, SerializedRemoveRoleOptions as Pl, PatchOptions as Pn, SerializedVerifyEmailOptions as Po, DsyncUserCreatedEvent as Pr, InvitationEvent as Ps, AuditLogActorSchema as Pt, UpdateOrganizationRoleOptions as Pu, DebugInfoResponse as Q, VaultNamesListedEventData as Qa, WithResolvedClientId as Qc, RoleUpdatedEvent as Qi, ListResourcesForMembershipOptionsWithParentId as Ql, AuthenticationOAuthSucceededEvent as Qn, ResetPasswordOptions as Qo, FlagUpdatedEvent as Qr, SerializedCreatePasswordResetOptions as Qs, SendSessionResponse as Qt, PaginationOptions as Qu, WarrantTokenResponse as R, VaultDataDeletedEventData as Ra, AuthenticateWithMagicAuthOptions as Rc, PasswordResetCreatedEvent as Ri, BaseAssignRoleOptions as Rl, ApiKeyCreatedEvent as Rn, SerializedUpdateUserOptions as Ro, DsyncUserUpdatedEvent as Rr, IdentityResponse as Rs, CreateAuditLogSchemaOptions as Rt, AddEnvironmentRolePermissionOptions as Ru, PublicSSO as S, VaultDekReadEvent as Sa, User as Sc, OrganizationDomainVerifiedEvent as Si, OrganizationRoleEventResponse as Sl, ListOrganizationsOptions as Sn, CreateOrganizationApiKeyRequestOptions as So, DsyncDeletedEvent as Sr, AuthorizationOrganizationMembershipList as Ss, ResourceInterface as St, SerializedUpdatePermissionOptions as Su, createWorkOS as T, VaultKekCreatedEventResponse as Ta, ImpersonatorResponse as Tc, OrganizationMembershipCreatedResponse as Ti, RoleEvent as Tl, CreateOrganizationRequestOptions as Tn, SerializedApiKey as To, DsyncGroupCreatedEventResponse as Tr, BaseOrganizationMembership as Ts, SerializedBatchWriteResourcesOptions as Tt, SerializedCreatePermissionOptions as Tu, SerializedQueryOptions as U, VaultDataUpdatedEventResponseData as Ua, AuthenticateWithCodeAndVerifierOptions as Uc, PermissionCreatedEventResponse as Ui, RoleAssignmentListResponse as Ul, AuthenticationEmailVerificationSucceededEventResponse as Un, Session as Uo, EventBase as Ur, EnrollAuthFactorOptions as Us, AuditLogTarget as Ut, SerializedCreateEnvironmentRoleOptions as Uu, QueryResult as V, VaultDataReadEventResponseData as Va, AuthenticateWithEmailVerificationOptions as Vc, PasswordResetSucceededEventResponse as Vi, RoleAssignment as Vl, ApiKeyRevokedEventResponse as Vn, UpdateOrganizationMembershipOptions as Vo, EmailVerificationCreatedEventResponse as Vr, FactorWithSecrets$1 as Vs, SerializedCreateAuditLogSchemaOptions as Vt, UpdateEnvironmentRoleOptions as Vu, CheckBatchOptions as W, VaultDekDecryptedEventData as Wa, SerializedAuthenticateWithCodeAndVerifierOptions as Wc, PermissionDeletedEvent as Wi, RoleAssignmentResource as Wl, AuthenticationMagicAuthFailedEvent as Wn, SessionResponse as Wo, EventName as Wr, SerializedEnrollUserInMfaFactorOptions as Ws, CreateAuditLogEventOptions as Wt, EnvironmentRole as Wu, CheckWarrantOptions as X, VaultMetadataReadEventData as Xa, SerializedAuthenticatePublicClientBase as Xc, RoleDeletedEvent as Xi, ListResourcesForMembershipOptions as Xl, AuthenticationOAuthFailedEvent as Xn, SerializedRevokeSessionOptions as Xo, FlagRuleUpdatedEvent as Xr, SerializedCreateUserOptions as Xs, SerializedAuditLogExportOptions as Xt, ListDirectoriesOptions as Xu, CheckResultResponse as Y, VaultKekCreatedEventResponseData as Ya, AuthenticateWithSessionOptions as Yc, RoleCreatedEventResponse as Yi, ListMembershipsForResourceOptions as Yl, AuthenticationMfaSucceededEventResponse as Yn, RevokeSessionOptions as Yo, FlagDeletedEventResponse as Yr, CreateUserOptions as Ys, AuditLogExportOptions as Yt, ListDirectoryGroupsOptions as Yu, DebugInfo as Z, VaultMetadataReadEventResponseData as Za, SerializedAuthenticateWithOptionsBase as Zc, RoleDeletedEventResponse as Zi, ListResourcesForMembershipOptionsWithParentExternalId as Zl, AuthenticationOAuthFailedEventResponse as Zn, serializeRevokeSessionOptions as Zo, FlagRuleUpdatedEventResponse as Zr, CreatePasswordResetOptions as Zs, GeneratePortalLinkIntent as Zt, SerializedListDirectoriesOptions as Zu, CreateDataKeyOptions as _, VaultDataReadEventResponse as _a, AuthenticateWithSessionCookieOptions as _c, OrganizationDomainDeletedEventResponse as _i, DirectoryUserResponse as _l, UserRegistrationActionPayload as _n, ValidateApiKeyResponse as _o, ConnectionDeactivatedEventResponse as _r, ListSessionsOptions as _s, CreateResourceOptions as _t, CreateOptionsWithParentResourceId as _u, ReadObjectOptions as a, UserCreatedEventResponse as aa, AuthenticationRadarRiskDetectedEventData as ac, DirectoryType as ad, InvitationResentEventResponse as ai, ListConnectionsOptions as al, AutoPaginatable as an, RuntimeClientOptions as ao, AuthenticationPasswordFailedEventResponse as ar, PasswordResetEvent as as, ListWarrantsRequestOptions as at, DeleteAuthorizationResourceOptions as au, ConfidentialClientOptions as b, VaultDekDecryptedEvent as ba, AuthenticationResponse as bc, OrganizationDomainVerificationFailedEvent as bi, ListOrganizationRolesResponse as bl, Organization as bn, SerializedCreatedApiKey as bo, DsyncActivatedEvent as br, SerializedListOrganizationMembershipsOptions as bs, ListResourcesOptions as bt, UpdateAuthorizationResourceOptions as bu, ObjectMetadata as c, UserUpdatedEvent as ca, AuthenticationEventResponse as cc, HttpClient as cd, MagicAuthCreatedEvent as ci, GetProfileOptions as cl, Webhooks as cn, FlagPollEntry as co, AuthenticationRadarRiskDetectedEvent as cr, MagicAuth as cs, SerializedSubject as ct, GetAuthorizationResourceByExternalIdOptions as cu, VaultObject as d, VaultByokKeyVerificationCompletedEventResponse as da, AuthenticateUserWithTotpCredentials as dc, RequestHeaders as dd, OrganizationCreatedResponse as di, ConnectionResponse as dl, ResponsePayload as dn, FeatureFlag as do, AuthenticationSSOFailedEventResponse as dr, MagicAuthResponse as ds, Warrant as dt, AuthorizationResource as du, SessionCreatedEvent as ea, SerializedCreateOrganizationMembershipOptions as ec, DirectoryGroupResponse as ed, InvitationAcceptedEvent as ei, ProfileAndTokenResponse as el, SerializedCreatePasswordlessSessionOptions as en, DataKey as eo, AuthenticationPasskeyFailedEvent as er, ResendInvitationOptions as es, DecisionTreeNodeResponse as et, AuthorizationCheckOptions as eu, DeleteObjectOptions as f, VaultDataCreatedEvent as fa, AuthenticateWithTotpOptions as fc, RequestOptions as fd, OrganizationDeletedEvent as fi, ConnectionType as fl, UserRegistrationActionResponseData as fn, FeatureFlagResponse as fo, AuthenticationSSOSucceededEvent as fr, LogoutURLOptions as fs, WarrantResponse as ft, AuthorizationResourceList as fu, DecryptDataKeyResponse as g, VaultDataReadEvent as ga, AuthenticateWithSessionCookieFailureReason as gc, OrganizationDomainDeletedEvent as gi, DirectoryUser as gl, UserDataPayload as gn, ValidateApiKeyOptions as go, ConnectionDeactivatedEvent as gr, ListUserFeatureFlagsOptions as gs, BatchWriteResourcesResponse as gt, CreateOptionsWithParentExternalId as gu, DecryptDataKeyOptions as h, VaultDataDeletedEventResponse as ha, AuthenticateWithSessionCookieFailedResponse as hc, CryptoProvider as hd, OrganizationDomainCreatedEventResponse as hi, DefaultCustomAttributes as hl, UserData as hn, SerializedValidateApiKeyResponse as ho, ConnectionActivatedEventResponse as hr, SerializedListUsersOptions as hs, BatchWriteResourcesOptions as ht, CreateAuthorizationResourceOptions as hu, ReadObjectMetadataResponse as i, UserCreatedEvent as ia, UserManagementAuthorizationURLOptions as ic, DirectoryStateResponse as id, InvitationResentEvent as ii, OauthTokensResponse as il, SerializedListEventOptions as in, RuntimeClientLogger as io, AuthenticationPasswordFailedEvent as ir, PasswordReset as is, ListWarrantsOptions as it, SerializedAuthorizationCheckOptions as iu, NotFoundException as j, VaultActorResponse as ja, AuthenticateUserWithPasswordCredentials as jc, OrganizationRoleCreatedEventResponse as ji, RemoveRoleOptions as jl, UnprocessableEntityError as jn, OrganizationDomainVerificationStrategy as jo, DsyncGroupUserAddedEventResponse as jr, SerializedListInvitationsOptions as js, ResourceOp as jt, AddOrganizationRolePermissionOptions as ju, RateLimitExceededException as k, VaultNamesListedEventResponse as ka, AuthenticateWithRefreshTokenOptions as kc, OrganizationMembershipUpdatedResponse as ki, RemoveRoleAssignmentOptions as kl, WorkOSResponseError as kn, OrganizationDomainResponse as ko, DsyncGroupUpdatedEventResponse as kr, OrganizationMembershipStatus as ks, SerializedResourceOptions as kt, PermissionResponse as ku, ObjectUpdateBy as l, UserUpdatedEventResponse as la, AuthenticationEventSso as lc, HttpClientInterface as ld, MagicAuthCreatedEventResponse as li, Connection as ll, Actions as ln, FlagPollResponse as lo, AuthenticationRadarRiskDetectedEventResponse as lr, MagicAuthEvent as ls, SerializedWriteWarrantOptions as lt, ListAuthorizationResourcesOptions as lu, CreateObjectOptions as m, VaultDataDeletedEvent as ma, AccessToken$1 as mc, ResponseHeaders as md, OrganizationDomainCreatedEvent as mi, SSOPKCEAuthorizationURLResult as ml, ActionPayload as mn, AddFlagTargetOptions as mo, ConnectionActivatedEvent as mr, ListUsersOptions as ms, WarrantOp as mt, AuthorizationResourceResponse as mu, UpdateObjectEntity as n, SessionRevokedEvent as na, SerializedCreateMagicAuthOptions as nc, DirectoryResponse as nd, InvitationCreatedEvent as ni, ProfileResponse as nl, PasswordlessSessionResponse as nn, KeyContext as no, AuthenticationPasskeySucceededEvent as nr, RefreshSessionFailureReason as ns, SerializedCheckOptions as nt, AuthorizationCheckOptionsWithResourceId as nu, ReadObjectResponse as o, UserDeletedEvent as oa, AuthenticationRadarRiskDetectedEventResponseData as oc, EventDirectory as od, InvitationRevokedEvent as oi, SerializedListConnectionsOptions as ol, PKCE as on, RemoveFlagTargetOptions as oo, AuthenticationPasswordSucceededEvent as or, PasswordResetEventResponse as os, PolicyContext as ot, DeleteAuthorizationResourceByExternalIdOptions as ou, CreateObjectEntity as p, VaultDataCreatedEventResponse as pa, SerializedAuthenticateWithTotpOptions as pc, ResponseHeaderValue as pd, OrganizationDeletedResponse as pi, SSOAuthorizationURLOptions as pl, ActionContext as pn, EvaluationContext as po, AuthenticationSSOSucceededEventResponse as pr, Locale as ps, WriteWarrantOptions as pt, AuthorizationResourceListResponse as pu, CheckResult as q, VaultDekReadEventResponseData as qa, SerializedAuthenticateWithCodeOptions as qc, PermissionUpdatedEventResponse as qi, RoleAssignmentRole as ql, AuthenticationMagicAuthSucceededEventResponse as qn, SendInvitationOptions as qo, FlagCreatedEventResponse as qr, EmailVerificationEventResponse as qs, AuditLogExport as qt, EnvironmentRoleResponse as qu, UpdateObjectOptions as r, SessionRevokedEventResponse as ra, PKCEAuthorizationURLResult as rc, DirectoryState as rd, InvitationCreatedEventResponse as ri, OauthTokens as rl, ListEventOptions as rn, RuntimeClientStats as ro, AuthenticationPasskeySucceededEventResponse as rr, RefreshSessionResponse as rs, SerializedCheckWarrantOptions as rt, AuthorizationCheckResult as ru, ObjectDigest as s, UserDeletedEventResponse as sa, AuthenticationEvent as sc, EventDirectoryResponse as sd, InvitationRevokedEventResponse as si, GetProfileAndTokenOptions as sl, PKCEPair as sn, ListFeatureFlagsOptions as so, AuthenticationPasswordSucceededEventResponse as sr, PasswordResetResponse as ss, SerializedListWarrantsOptions as st, UpdateAuthorizationResourceByExternalIdOptions as su, WorkOS as t, SessionCreatedEventResponse as ta, CreateMagicAuthOptions as tc, Directory as td, InvitationAcceptedEventResponse as ti, Profile as tl, PasswordlessSession as tn, DataKeyPair as to, AuthenticationPasskeyFailedEventResponse as tr, SerializedResendInvitationOptions as ts, SerializedCheckBatchOptions as tt, AuthorizationCheckOptionsWithResourceExternalId as tu, ObjectVersion as u, VaultByokKeyVerificationCompletedEvent as ua, AuthenticationEventSsoResponse as uc, HttpClientResponseInterface as ud, OrganizationCreatedEvent as ui, ConnectionDomain as ul, AuthenticationActionResponseData as un, FlagTarget as uo, AuthenticationSSOFailedEvent as ur, MagicAuthEventResponse as us, Subject as ut, SerializedListAuthorizationResourcesOptions as uu, CreateDataKeyResponse as v, VaultDataUpdatedEvent as va, AuthenticateWithSessionCookieSuccessResponse as vc, OrganizationDomainUpdatedEvent as vi, DirectoryUserWithGroups as vl, SerializedUpdateOrganizationOptions as vn, ListOrganizationApiKeysOptions as vo, ConnectionDeletedEvent as vr, SerializedListSessionsOptions as vs, DeleteResourceOptions as vt, SerializedCreateAuthorizationResourceOptions as vu, PublicWorkOS as w, VaultKekCreatedEvent as wa, Impersonator as wc, OrganizationMembershipCreated as wi, Role as wl, CreateOrganizationOptions as wn, ApiKey as wo, DsyncGroupCreatedEvent as wr, AuthorizationOrganizationMembershipResponse as ws, ResourceResponse as wt, CreatePermissionOptions as wu, PublicClientOptions as x, VaultDekDecryptedEventResponse as xa, AuthenticationResponseResponse as xc, OrganizationDomainVerificationFailedEventResponse as xi, OrganizationRoleEvent as xl, OrganizationResponse as xn, CreateOrganizationApiKeyOptions as xo, DsyncActivatedEventResponse as xr, AuthorizationOrganizationMembership as xs, Resource as xt, ListPermissionsOptions as xu, WorkOSWorker as y, VaultDataUpdatedEventResponse as ya, SessionCookieData as yc, OrganizationDomainUpdatedEventResponse as yi, DirectoryUserWithGroupsResponse as yl, UpdateOrganizationOptions as yn, CreatedApiKey as yo, ConnectionDeletedEventResponse as yr, ListOrganizationMembershipsOptions as ys, GetResourceOptions as yt, SerializedUpdateAuthorizationResourceOptions as yu, QueryOptions as z, VaultDataDeletedEventResponseData as za, SerializedAuthenticateWithMagicAuthOptions as zc, PasswordResetCreatedEventResponse as zi, SerializedAssignRoleOptions as zl, ApiKeyCreatedEventResponse as zn, UpdateUserOptions as zo, DsyncUserUpdatedEventResponse as zr, Factor$1 as zs, CreateAuditLogSchemaRequestOptions as zt, SetEnvironmentRolePermissionsOptions as zu };
|
|
5281
|
-
//# sourceMappingURL=workos-
|
|
6674
|
+
export { CreateAuditLogSchemaRequestOptions as $, FlagPollEntry as $a, ConnectionDomain as $c, VaultDekDecryptedEventResponse as $i, SerializedListAuthorizationResourcesOptions as $l, DsyncUserCreatedEvent as $n, MagicAuth as $o, OrganizationDomainVerifiedEvent as $r, AuthenticationEventSsoResponse as $s, List as $t, ResponseHeaders as $u, IntentOptions as A, VaultNamesListedEventData as Aa, AuthenticateWithEmailVerificationOptions as Ac, RoleUpdatedEventResponse as Ai, SerializedAssignRoleOptions as Al, AuthenticationSSOFailedEventResponse as An, UpdateUserOptions as Ao, GroupUpdatedEventResponse as Ar, FactorWithSecrets$1 as As, UserRegistrationActionResponseData as At, EnvironmentRoleList as Au, NoApiKeyProvidedException as B, Group as Ba, SerializedAuthenticateWithOptionsBase as Bc, UserUpdatedEvent as Bi, ListResourcesForMembershipOptionsWithParentExternalId as Bl, DsyncActivatedEventResponse as Bn, RevokeSessionOptions as Bo, MagicAuthCreatedEventResponse as Br, CreatePasswordResetOptions as Bs, ListOrganizationsOptions as Bt, Directory as Bu, PublicUserManagement as C, VaultDekDecryptedEventResponseData as Ca, AuthenticateUserWithOrganizationSelectionCredentials as Cc, PermissionUpdatedEvent as Ci, RemoveRoleOptionsWithResourceExternalId as Cl, AuthenticationPasswordFailedEvent as Cn, CreateOrganizationDomainOptions as Co, GroupMemberAddedEvent as Cr, Invitation as Cs, AutoPaginatable as Ct, AddEnvironmentRolePermissionOptions as Cu, PortalLinkResponseWire as D, VaultKekCreatedEventResponseData as Da, AuthenticateWithMagicAuthOptions as Dc, RoleDeletedEvent as Di, AssignRoleOptionsWithResourceExternalId as Dl, AuthenticationRadarRiskDetectedEvent as Dn, SerializedUpdateUserPasswordOptions as Do, GroupMemberRemovedEvent as Dr, Identity as Ds, Actions as Dt, CreateEnvironmentRoleOptions as Du, PortalLinkResponse as E, VaultKekCreatedEventData as Ea, AuthenticateUserWithMagicAuthCredentials as Ec, RoleCreatedEventResponse as Ei, AssignRoleOptions as El, AuthenticationPasswordSucceededEventResponse as En, VerifyEmailOptions as Eo, GroupMemberEventResponseData as Er, InvitationResponse as Es, Webhooks as Et, UpdateEnvironmentRoleOptions as Eu, UnauthorizedException as F, SerializedUpdateGroupOptions as Fa, AuthenticateWithCodeOptions as Fc, UnknownEvent as Fi, RoleAssignmentResponse as Fl, ConnectionDeactivatedEvent as Fn, SessionResponse as Fo, InvitationResentEvent as Fr, EmailVerificationEvent as Fs, UserRegistrationActionPayload as Ft, ListDirectoriesOptions as Fu, AuthenticationException as G, SerializedCreateGroupOptions as Ga, ProfileResponse as Gc, VaultDataCreatedEventResponse as Gi, AuthorizationCheckOptionsWithResourceId as Gl, DsyncGroupDeletedEvent as Gn, ResendInvitationOptions as Go, OrganizationDomainCreatedEvent as Gr, SerializedCreateMagicAuthOptions as Gs, DomainData as Gt, EventDirectory as Gu, BadRequestException as H, GetGroupOptions as Ha, ProfileAndToken as Hc, VaultByokKeyVerificationCompletedEvent as Hi, SerializedListResourcesForMembershipOptions as Hl, DsyncDeletedEventResponse as Hn, serializeRevokeSessionOptions as Ho, OrganizationCreatedResponse as Hr, CreateOrganizationMembershipOptions as Hs, CreateOrganizationOptions as Ht, DirectoryState as Hu, SignatureVerificationException as I, UpdateGroupOptions as Ia, SerializedAuthenticateWithCodeOptions as Ic, UserCreatedEvent as Ii, RoleAssignmentRole as Il, ConnectionDeactivatedEventResponse as In, SessionStatus as Io, InvitationResentEventResponse as Ir, EmailVerificationEventResponse as Is, SerializedUpdateOrganizationOptions as It, SerializedListDirectoriesOptions as Iu, WorkOSErrorData as J, RuntimeClientStats as Ja, ListConnectionsOptions as Jc, VaultDataReadEvent as Ji, DeleteAuthorizationResourceOptions as Jl, DsyncGroupUpdatedEventResponse as Jn, RefreshSessionResponse as Jo, OrganizationDomainDeletedEventResponse as Jr, AuthenticationRadarRiskDetectedEventData as Js, WorkOSOptions as Jt, HttpClientInterface as Ju, isAuthenticationErrorData as K, AddGroupOrganizationMembershipOptions as Ka, OauthTokens as Kc, VaultDataDeletedEvent as Ki, AuthorizationCheckResult as Kl, DsyncGroupDeletedEventResponse as Kn, SerializedResendInvitationOptions as Ko, OrganizationDomainCreatedEventResponse as Kr, PKCEAuthorizationURLResult as Ks, DomainDataState as Kt, EventDirectoryResponse as Ku, RateLimitExceededException as L, RemoveGroupOrganizationMembershipOptions as La, AuthenticateWithOptionsBase as Lc, UserCreatedEventResponse as Li, ListMembershipsForResourceByExternalIdOptions as Ll, ConnectionDeletedEvent as Ln, SendVerificationEmailOptions as Lo, InvitationRevokedEvent as Lr, EmailVerificationResponse as Ls, UpdateOrganizationOptions as Lt, PaginationOptions as Lu, SSOIntentOptions as M, DataKey as Ma, AuthenticateWithCodeAndVerifierOptions as Mc, SessionCreatedEventResponse as Mi, RoleAssignment as Ml, AuthenticationSSOSucceededEventResponse as Mn, UpdateOrganizationMembershipOptions as Mo, InvitationAcceptedEventResponse as Mr, EnrollAuthFactorOptions as Ms, ActionPayload as Mt, EnvironmentRoleResponse as Mu, SSOIntentOptionsResponse as N, DataKeyPair as Na, SerializedAuthenticateWithCodeAndVerifierOptions as Nc, SessionRevokedEvent as Ni, RoleAssignmentResource as Nl, ConnectionActivatedEvent as Nn, AuthMethod as No, InvitationCreatedEvent as Nr, SerializedEnrollUserInMfaFactorOptions as Ns, UserData as Nt, ListDirectoryUsersOptions as Nu, GenerateLink as O, VaultMetadataReadEventData as Oa, SerializedAuthenticateWithMagicAuthOptions as Oc, RoleDeletedEventResponse as Oi, AssignRoleOptionsWithResourceId as Ol, AuthenticationRadarRiskDetectedEventResponse as On, UpdateUserPasswordOptions as Oo, GroupMemberRemovedEventResponse as Or, Factor$1 as Os, AuthenticationActionResponseData as Ot, SerializedCreateEnvironmentRoleOptions as Ou, UnprocessableEntityException as P, KeyContext as Pa, AuthenticateUserWithCodeCredentials as Pc, SessionRevokedEventResponse as Pi, RoleAssignmentResourceResponse as Pl, ConnectionActivatedEventResponse as Pn, Session as Po, InvitationCreatedEventResponse as Pr, EmailVerification as Ps, UserDataPayload as Pt, ListDirectoryGroupsOptions as Pu, CreateAuditLogSchemaOptions as Q, ListFeatureFlagsOptions as Qa, Connection as Qc, VaultDekDecryptedEvent as Qi, ListAuthorizationResourcesOptions as Ql, DsyncGroupUserRemovedEventResponse as Qn, PasswordResetResponse as Qo, OrganizationDomainVerificationFailedEventResponse as Qr, AuthenticationEventSso as Qs, PatchOptions as Qt, ResponseHeaderValue as Qu, OauthException as R, ListGroupsOptions as Ra, AuthenticateWithSessionOptions as Rc, UserDeletedEvent as Ri, ListMembershipsForResourceOptions as Rl, ConnectionDeletedEventResponse as Rn, SendInvitationOptions as Ro, InvitationRevokedEventResponse as Rr, CreateUserOptions as Rs, Organization as Rt, DirectoryGroup as Ru, PublicSSO as S, VaultDekDecryptedEventData as Sa, SerializedAuthenticateWithPasswordOptions as Sc, PermissionDeletedEventResponse as Si, RemoveRoleOptions as Sl, AuthenticationPasskeySucceededEventResponse as Sn, OrganizationDomainVerificationStrategy as So, GroupDeletedEventResponse as Sr, ListAuthFactorsOptions as Ss, SerializedListEventOptions as St, OrganizationRole as Su, createWorkOS as T, VaultDekReadEventResponseData as Ta, SerializedAuthenticateWithOrganizationSelectionOptions as Tc, RoleCreatedEvent as Ti, SerializedRemoveRoleOptions as Tl, AuthenticationPasswordSucceededEvent as Tn, SerializedVerifyEmailOptions as To, GroupMemberEventData as Tr, InvitationEventResponse as Ts, PKCEPair as Tt, SerializedUpdateEnvironmentRoleOptions as Tu, AuthenticationErrorCode as U, DeleteGroupOptions as Ua, ProfileAndTokenResponse as Uc, VaultByokKeyVerificationCompletedEventResponse as Ui, AuthorizationCheckOptions as Ul, DsyncGroupCreatedEvent as Un, ResetPasswordOptions as Uo, OrganizationDeletedEvent as Ur, SerializedCreateOrganizationMembershipOptions as Us, CreateOrganizationRequestOptions as Ut, DirectoryStateResponse as Uu, ConflictException as V, GroupResponse as Va, WithResolvedClientId as Vc, UserUpdatedEventResponse as Vi, ListResourcesForMembershipOptionsWithParentId as Vl, DsyncDeletedEvent as Vn, SerializedRevokeSessionOptions as Vo, OrganizationCreatedEvent as Vr, SerializedCreatePasswordResetOptions as Vs, ListOrganizationFeatureFlagsOptions as Vt, DirectoryResponse as Vu, AuthenticationErrorData as W, CreateGroupOptions as Wa, Profile as Wc, VaultDataCreatedEvent as Wi, AuthorizationCheckOptionsWithResourceExternalId as Wl, DsyncGroupCreatedEventResponse as Wn, SerializedResetPasswordOptions as Wo, OrganizationDeletedResponse as Wr, CreateMagicAuthOptions as Ws, SerializedCreateOrganizationOptions as Wt, DirectoryType as Wu, FeatureFlagsRuntimeClient as X, RuntimeClientOptions as Xa, GetProfileAndTokenOptions as Xc, VaultDataUpdatedEvent as Xi, UpdateAuthorizationResourceByExternalIdOptions as Xl, DsyncGroupUserAddedEventResponse as Xn, PasswordResetEvent as Xo, OrganizationDomainUpdatedEventResponse as Xr, AuthenticationEvent as Xs, PutOptions as Xt, RequestHeaders as Xu, ApiKeyRequiredException as Y, RuntimeClientLogger as Ya, SerializedListConnectionsOptions as Yc, VaultDataReadEventResponse as Yi, DeleteAuthorizationResourceByExternalIdOptions as Yl, DsyncGroupUserAddedEvent as Yn, PasswordReset as Yo, OrganizationDomainUpdatedEvent as Yr, AuthenticationRadarRiskDetectedEventResponseData as Ys, UnprocessableEntityError as Yt, HttpClientResponseInterface as Yu, CookieSession as Z, RemoveFlagTargetOptions as Za, GetProfileOptions as Zc, VaultDataUpdatedEventResponse as Zi, GetAuthorizationResourceByExternalIdOptions as Zl, DsyncGroupUserRemovedEvent as Zn, PasswordResetEventResponse as Zo, OrganizationDomainVerificationFailedEvent as Zr, AuthenticationEventResponse as Zs, PostOptions as Zt, RequestOptions as Zu, CreateDataKeyOptions as _, VaultDataDeletedEventResponseData as _a, AuthenticateUserWithRefreshTokenCredentials as _c, PasswordResetSucceededEvent as _i, RoleResponse as _l, AuthenticationOAuthSucceededEvent as _n, OrganizationDomainVerificationFailed as _o, FlagUpdatedEvent as _r, OrganizationMembershipResponse as _s, CreatePasswordlessSessionOptions as _t, SetOrganizationRolePermissionsOptions as _u, ReadObjectOptions as a, VaultMetadataReadEventResponse as aa, AuthenticateWithSessionCookieFailureReason as ac, OrganizationMembershipUpdated as ai, DirectoryUser as al, ApiKeyRevokedEvent as an, AddFlagTargetOptions as ao, EmailVerificationCreatedEvent as ar, ListUsersOptions as as, CreateAuditLogEventRequestOptions as at, SerializedCreateAuthorizationResourceOptions as au, ConfidentialClientOptions as b, VaultDataUpdatedEventData as ba, AuthenticateUserWithPasswordCredentials as bc, PermissionCreatedEventResponse as bi, RemoveRoleAssignmentOptions as bl, AuthenticationPasskeyFailedEventResponse as bn, OrganizationDomainResponse as bo, GroupCreatedEventResponse as br, SerializedListInvitationsOptions as bs, PasswordlessSessionResponse as bt, CreateOrganizationRoleOptions as bu, ObjectMetadata as c, VaultActor as ca, SessionCookieData as cc, OrganizationRoleCreatedEventResponse as ci, DirectoryUserWithGroupsResponse as cl, AuthenticationEmailVerificationSucceededEventResponse as cn, ValidateApiKeyResponse as co, EventBase as cr, ListSessionsOptions as cs, AuditLogSchema as ct, ListPermissionsOptions as cu, VaultObject as d, VaultByokKeyProvider as da, User as dc, OrganizationRoleUpdatedEvent as di, OrganizationRoleEventResponse as dl, AuthenticationMagicAuthSucceededEvent as dn, SerializedCreatedApiKey as do, FlagCreatedEvent as dr, SerializedListOrganizationMembershipsOptions as ds, AuditLogTargetSchema as dt, CreatePermissionOptions as du, VaultDekReadEvent as ea, AuthenticateUserWithTotpCredentials as ec, CryptoProvider as ed, OrganizationDomainVerifiedEventResponse as ei, ConnectionResponse as el, ListResponse as en, FlagPollResponse as eo, DsyncUserCreatedEventResponse as er, MagicAuthEvent as es, CreateAuditLogSchemaResponse as et, AuthorizationResource as eu, DeleteObjectOptions as f, VaultByokKeyVerificationCompletedEventData as fa, UserResponse as fc, OrganizationRoleUpdatedEventResponse as fi, OrganizationRoleResponse as fl, AuthenticationMagicAuthSucceededEventResponse as fn, CreateOrganizationApiKeyOptions as fo, FlagCreatedEventResponse as fr, AuthorizationOrganizationMembership as fs, AuditLogExport as ft, SerializedCreatePermissionOptions as fu, DecryptDataKeyResponse as g, VaultDataDeletedEventData as ga, SerializedAuthenticateWithRefreshTokenPublicClientOptions as gc, PasswordResetCreatedEventResponse as gi, RoleList as gl, AuthenticationOAuthFailedEventResponse as gn, SerializedApiKey as go, FlagRuleUpdatedEventResponse as gr, OrganizationMembership as gs, SendSessionResponse as gt, AddOrganizationRolePermissionOptions as gu, DecryptDataKeyOptions as h, VaultDataCreatedEventResponseData as ha, AuthenticateWithRefreshTokenPublicClientOptions as hc, PasswordResetCreatedEvent as hi, RoleEventResponse as hl, AuthenticationOAuthFailedEvent as hn, ApiKey as ho, FlagRuleUpdatedEvent as hr, BaseOrganizationMembershipResponse as hs, SerializedAuditLogExportOptions as ht, RemoveOrganizationRolePermissionOptions as hu, ReadObjectMetadataResponse as i, VaultMetadataReadEvent as ia, AuthenticateWithSessionCookieFailedResponse as ic, OrganizationMembershipDeletedResponse as ii, DefaultCustomAttributes as il, ApiKeyCreatedEventResponse as in, EvaluationContext as io, DsyncUserUpdatedEventResponse as ir, Locale as is, CreateAuditLogEventOptions as it, CreateOptionsWithParentResourceId as iu, IntentOptionsResponse as j, VaultNamesListedEventResponseData as ja, SerializedAuthenticateWithEmailVerificationOptions as jc, SessionCreatedEvent as ji, ListRoleAssignmentsOptions as jl, AuthenticationSSOSucceededEvent as jn, SerializedUpdateOrganizationMembershipOptions as jo, InvitationAcceptedEvent as jr, FactorWithSecretsResponse as js, ActionContext as jt, EnvironmentRoleListResponse as ju, GenerateLinkResponse as k, VaultMetadataReadEventResponseData as ka, AuthenticateUserWithEmailVerificationCredentials as kc, RoleUpdatedEvent as ki, BaseAssignRoleOptions as kl, AuthenticationSSOFailedEvent as kn, SerializedUpdateUserOptions as ko, GroupUpdatedEvent as kr, FactorResponse as ks, ResponsePayload as kt, EnvironmentRole as ku, ObjectUpdateBy as l, VaultActorResponse as la, AuthenticationResponse as lc, OrganizationRoleDeletedEvent as li, ListOrganizationRolesResponse as ll, AuthenticationMagicAuthFailedEvent as ln, ListOrganizationApiKeysOptions as lo, EventName as lr, SerializedListSessionsOptions as ls, AuditLogSchemaMetadata as lt, SerializedUpdatePermissionOptions as lu, CreateObjectOptions as m, VaultDataCreatedEventData as ma, ImpersonatorResponse as mc, OrganizationUpdatedResponse as mi, RoleEvent as ml, AuthenticationMfaSucceededEventResponse as mn, SerializedCreateOrganizationApiKeyOptions as mo, FlagDeletedEventResponse as mr, BaseOrganizationMembership as ms, AuditLogExportOptions as mt, PermissionResponse as mu, UpdateObjectEntity as n, VaultKekCreatedEvent as na, SerializedAuthenticateWithTotpOptions as nc, OrganizationMembershipCreatedResponse as ni, SSOAuthorizationURLOptions as nl, GenerateLinkIntent as nn, FeatureFlag as no, DsyncUserDeletedEventResponse as nr, MagicAuthResponse as ns, AuditLogActor as nt, CreateAuthorizationResourceOptions as nu, ReadObjectResponse as o, VaultNamesListedEvent as oa, AuthenticateWithSessionCookieOptions as oc, OrganizationMembershipUpdatedResponse as oi, DirectoryUserResponse as ol, ApiKeyRevokedEventResponse as on, SerializedValidateApiKeyResponse as oo, EmailVerificationCreatedEventResponse as or, SerializedListUsersOptions as os, SerializedCreateAuditLogEventOptions as ot, SerializedUpdateAuthorizationResourceOptions as ou, CreateObjectEntity as p, VaultByokKeyVerificationCompletedEventResponseData as pa, Impersonator as pc, OrganizationUpdatedEvent as pi, Role as pl, AuthenticationMfaSucceededEvent as pn, CreateOrganizationApiKeyRequestOptions as po, FlagDeletedEvent as pr, AuthorizationOrganizationMembershipResponse as ps, AuditLogExportResponse as pt, Permission as pu, GenericServerException as q, SerializedAddGroupOrganizationMembershipOptions as qa, OauthTokensResponse as qc, VaultDataDeletedEventResponse as qi, SerializedAuthorizationCheckOptions as ql, DsyncGroupUpdatedEvent as qn, RefreshSessionFailureReason as qo, OrganizationDomainDeletedEvent as qr, UserManagementAuthorizationURLOptions as qs, WorkOSResponseError as qt, HttpClient as qu, UpdateObjectOptions as r, VaultKekCreatedEventResponse as ra, AccessToken$1 as rc, OrganizationMembershipDeleted as ri, SSOPKCEAuthorizationURLResult as rl, ApiKeyCreatedEvent as rn, FeatureFlagResponse as ro, DsyncUserUpdatedEvent as rr, LogoutURLOptions as rs, AuditLogTarget as rt, CreateOptionsWithParentExternalId as ru, ObjectDigest as s, VaultNamesListedEventResponse as sa, AuthenticateWithSessionCookieSuccessResponse as sc, OrganizationRoleCreatedEvent as si, DirectoryUserWithGroups as sl, AuthenticationEmailVerificationSucceededEvent as sn, ValidateApiKeyOptions as so, Event as sr, ListUserFeatureFlagsOptions as ss, AuditLogActorSchema as st, UpdateAuthorizationResourceOptions as su, WorkOS as t, VaultDekReadEventResponse as ta, AuthenticateWithTotpOptions as tc, OrganizationMembershipCreated as ti, ConnectionType as tl, GetOptions as tn, FlagTarget as to, DsyncUserDeletedEvent as tr, MagicAuthEventResponse as ts, SerializedCreateAuditLogSchemaOptions as tt, AuthorizationResourceResponse as tu, ObjectVersion as u, VaultActorSource as ua, AuthenticationResponseResponse as uc, OrganizationRoleDeletedEventResponse as ui, OrganizationRoleEvent as ul, AuthenticationMagicAuthFailedEventResponse as un, CreatedApiKey as uo, EventResponse as ur, ListOrganizationMembershipsOptions as us, AuditLogSchemaResponse as ut, UpdatePermissionOptions as uu, CreateDataKeyResponse as v, VaultDataReadEventData as va, AuthenticateWithRefreshTokenOptions as vc, PasswordResetSucceededEventResponse as vi, ListEffectivePermissionsByExternalIdOptions as vl, AuthenticationOAuthSucceededEventResponse as vn, OrganizationDomainVerificationFailedResponse as vo, FlagUpdatedEventResponse as vr, OrganizationMembershipStatus as vs, SerializedCreatePasswordlessSessionOptions as vt, SerializedUpdateOrganizationRoleOptions as vu, PublicWorkOS as w, VaultDekReadEventData as wa, AuthenticateWithOrganizationSelectionOptions as wc, PermissionUpdatedEventResponse as wi, RemoveRoleOptionsWithResourceId as wl, AuthenticationPasswordFailedEventResponse as wn, SerializedCreateOrganizationDomainOptions as wo, GroupMemberAddedEventResponse as wr, InvitationEvent as ws, PKCE as wt, SetEnvironmentRolePermissionsOptions as wu, PublicClientOptions as x, VaultDataUpdatedEventResponseData as xa, AuthenticateWithPasswordOptions as xc, PermissionDeletedEvent as xi, BaseRemoveRoleOptions as xl, AuthenticationPasskeySucceededEvent as xn, OrganizationDomainState as xo, GroupDeletedEvent as xr, ListGroupsForOrganizationMembershipOptions as xs, ListEventOptions as xt, SerializedCreateOrganizationRoleOptions as xu, WorkOSWorker as y, VaultDataReadEventResponseData as ya, SerializedAuthenticateWithRefreshTokenOptions as yc, PermissionCreatedEvent as yi, ListEffectivePermissionsOptions as yl, AuthenticationPasskeyFailedEvent as yn, OrganizationDomain as yo, GroupCreatedEvent as yr, ListInvitationsOptions as ys, PasswordlessSession as yt, UpdateOrganizationRoleOptions as yu, NotFoundException as z, ListGroupOrganizationMembershipsOptions as za, SerializedAuthenticatePublicClientBase as zc, UserDeletedEventResponse as zi, ListResourcesForMembershipOptions as zl, DsyncActivatedEvent as zn, SerializedSendInvitationOptions as zo, MagicAuthCreatedEvent as zr, SerializedCreateUserOptions as zs, OrganizationResponse as zt, DirectoryGroupResponse as zu };
|
|
6675
|
+
//# sourceMappingURL=workos-C0YAqze0.d.cts.map
|