@workos-inc/node 10.7.0 → 10.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/lib/{factory-DwW2quUn.cjs → factory-Bd19upQB.cjs} +1034 -113
- package/lib/factory-Bd19upQB.cjs.map +1 -0
- package/lib/{factory-BjWO1KkE.mjs → factory-BdXIrbcU.mjs} +1034 -113
- package/lib/factory-BdXIrbcU.mjs.map +1 -0
- package/lib/{factory-7zoKcOC2.d.cts → factory-DmBBe791.d.cts} +1514 -199
- package/lib/{factory-7zoKcOC2.d.mts → factory-DmBBe791.d.mts} +1514 -199
- package/lib/index.cjs +102 -1
- package/lib/index.cjs.map +1 -1
- package/lib/index.d.cts +158 -3
- package/lib/index.d.mts +158 -3
- package/lib/index.mjs +89 -2
- package/lib/index.mjs.map +1 -1
- package/lib/index.worker.cjs +2 -1
- package/lib/index.worker.cjs.map +1 -1
- package/lib/index.worker.d.cts +2 -3
- package/lib/index.worker.d.mts +2 -3
- package/lib/index.worker.mjs +2 -1
- package/lib/index.worker.mjs.map +1 -1
- package/lib/{webapi-S8D5YgJz.mjs → webapi-BgpV54gi.mjs} +22 -19
- package/lib/{webapi-S8D5YgJz.mjs.map → webapi-BgpV54gi.mjs.map} +1 -1
- package/lib/{webapi-CVu-Hjaz.cjs → webapi-BzGFatFp.cjs} +22 -19
- package/lib/{webapi-CVu-Hjaz.cjs.map → webapi-BzGFatFp.cjs.map} +1 -1
- package/package.json +1 -1
- package/lib/factory-BjWO1KkE.mjs.map +0 -1
- package/lib/factory-DwW2quUn.cjs.map +0 -1
|
@@ -76,6 +76,11 @@ type RequestHeaders = Record<string, string | number | string[]>;
|
|
|
76
76
|
type RequestOptions = {
|
|
77
77
|
params?: Record<string, any>;
|
|
78
78
|
headers?: RequestHeaders;
|
|
79
|
+
/**
|
|
80
|
+
* Maximum number of retries for this request, overriding the client-wide
|
|
81
|
+
* `maxRetries`. Set to `0` to disable retries for this request.
|
|
82
|
+
*/
|
|
83
|
+
maxRetries?: number;
|
|
79
84
|
};
|
|
80
85
|
type ResponseHeaderValue = string | string[];
|
|
81
86
|
type ResponseHeaders = Record<string, ResponseHeaderValue>;
|
|
@@ -93,14 +98,24 @@ interface HttpClientResponseInterface {
|
|
|
93
98
|
}
|
|
94
99
|
//#endregion
|
|
95
100
|
//#region src/common/net/http-client.d.ts
|
|
101
|
+
interface HttpClientOptions extends RequestInit {
|
|
102
|
+
/** Per-request timeout in milliseconds. */
|
|
103
|
+
timeout?: number;
|
|
104
|
+
/**
|
|
105
|
+
* Maximum number of retries for transient failures. Set to `0` to disable
|
|
106
|
+
* automatic retries entirely. Defaults to {@link DEFAULT_MAX_RETRY_ATTEMPTS}.
|
|
107
|
+
*/
|
|
108
|
+
maxRetries?: number;
|
|
109
|
+
}
|
|
96
110
|
declare abstract class HttpClient implements HttpClientInterface {
|
|
97
111
|
readonly baseURL: string;
|
|
98
|
-
readonly options?:
|
|
99
|
-
readonly MAX_RETRY_ATTEMPTS
|
|
112
|
+
readonly options?: HttpClientOptions | undefined;
|
|
113
|
+
readonly MAX_RETRY_ATTEMPTS: number;
|
|
100
114
|
readonly BACKOFF_MULTIPLIER = 1.5;
|
|
101
115
|
readonly MINIMUM_SLEEP_TIME_IN_MILLISECONDS = 500;
|
|
116
|
+
readonly MAXIMUM_SLEEP_TIME_IN_MILLISECONDS = 8000;
|
|
102
117
|
readonly RETRY_STATUS_CODES: number[];
|
|
103
|
-
constructor(baseURL: string, options?:
|
|
118
|
+
constructor(baseURL: string, options?: HttpClientOptions | undefined);
|
|
104
119
|
abstract get(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
105
120
|
abstract post<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
106
121
|
abstract put<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
@@ -111,9 +126,23 @@ declare abstract class HttpClient implements HttpClientInterface {
|
|
|
111
126
|
static getQueryString(queryObj?: Record<string, any>): string | undefined;
|
|
112
127
|
static getContentTypeHeader(entity: any): RequestHeaders | undefined;
|
|
113
128
|
static getBody(entity: any): BodyInit | null | undefined;
|
|
114
|
-
|
|
129
|
+
/**
|
|
130
|
+
* Generate a random idempotency key used to make retried write requests
|
|
131
|
+
* safe. Mirrors the behavior of the other WorkOS SDKs (Kotlin, Go), which
|
|
132
|
+
* attach an `Idempotency-Key` header to POST requests that did not already
|
|
133
|
+
* specify one, so a retried request is not applied more than once.
|
|
134
|
+
*/
|
|
135
|
+
static generateIdempotencyKey(): string;
|
|
136
|
+
/**
|
|
137
|
+
* Parse a `Retry-After` header value into milliseconds. Supports both the
|
|
138
|
+
* delay-seconds form (e.g. `120`) and the HTTP-date form. The result is
|
|
139
|
+
* capped at {@link MAXIMUM_RETRY_AFTER_TIME_IN_MILLISECONDS}. Returns
|
|
140
|
+
* `null` when the value is absent or unparseable so the caller falls back
|
|
141
|
+
* to the computed exponential backoff.
|
|
142
|
+
*/
|
|
143
|
+
static parseRetryAfter(headerValue: string | null | undefined): number | null;
|
|
115
144
|
private getSleepTimeInMilliseconds;
|
|
116
|
-
sleep: (retryAttempt: number) => Promise<unknown>;
|
|
145
|
+
sleep: (retryAttempt: number, retryAfterMs?: number | null) => Promise<unknown>;
|
|
117
146
|
}
|
|
118
147
|
//#endregion
|
|
119
148
|
//#region src/common/crypto/decode-payload.d.ts
|
|
@@ -1588,6 +1617,14 @@ interface AuthenticationEventResponse {
|
|
|
1588
1617
|
user_id: string | null;
|
|
1589
1618
|
}
|
|
1590
1619
|
//#endregion
|
|
1620
|
+
//#region src/multi-factor-auth/interfaces/sms.interface.d.ts
|
|
1621
|
+
interface Sms {
|
|
1622
|
+
phoneNumber: string;
|
|
1623
|
+
}
|
|
1624
|
+
interface SmsResponse {
|
|
1625
|
+
phone_number: string;
|
|
1626
|
+
}
|
|
1627
|
+
//#endregion
|
|
1591
1628
|
//#region src/multi-factor-auth/interfaces/totp.interface.d.ts
|
|
1592
1629
|
interface Totp {
|
|
1593
1630
|
issuer: string;
|
|
@@ -1608,14 +1645,55 @@ interface TotpWithSecretsResponse extends TotpResponse {
|
|
|
1608
1645
|
uri: string;
|
|
1609
1646
|
}
|
|
1610
1647
|
//#endregion
|
|
1648
|
+
//#region src/multi-factor-auth/interfaces/factor.interface.d.ts
|
|
1649
|
+
type FactorType = 'sms' | 'totp' | 'generic_otp';
|
|
1650
|
+
interface Factor {
|
|
1651
|
+
object: 'authentication_factor';
|
|
1652
|
+
id: string;
|
|
1653
|
+
createdAt: string;
|
|
1654
|
+
updatedAt: string;
|
|
1655
|
+
type: FactorType;
|
|
1656
|
+
sms?: Sms;
|
|
1657
|
+
totp?: Totp;
|
|
1658
|
+
}
|
|
1659
|
+
interface FactorWithSecrets {
|
|
1660
|
+
object: 'authentication_factor';
|
|
1661
|
+
id: string;
|
|
1662
|
+
createdAt: string;
|
|
1663
|
+
updatedAt: string;
|
|
1664
|
+
type: FactorType;
|
|
1665
|
+
sms?: Sms;
|
|
1666
|
+
totp?: TotpWithSecrets;
|
|
1667
|
+
}
|
|
1668
|
+
interface FactorResponse {
|
|
1669
|
+
object: 'authentication_factor';
|
|
1670
|
+
id: string;
|
|
1671
|
+
created_at: string;
|
|
1672
|
+
updated_at: string;
|
|
1673
|
+
type: FactorType;
|
|
1674
|
+
sms?: SmsResponse;
|
|
1675
|
+
totp?: TotpResponse;
|
|
1676
|
+
}
|
|
1677
|
+
interface FactorWithSecretsResponse {
|
|
1678
|
+
object: 'authentication_factor';
|
|
1679
|
+
id: string;
|
|
1680
|
+
created_at: string;
|
|
1681
|
+
updated_at: string;
|
|
1682
|
+
type: FactorType;
|
|
1683
|
+
sms?: SmsResponse;
|
|
1684
|
+
totp?: TotpWithSecretsResponse;
|
|
1685
|
+
}
|
|
1686
|
+
//#endregion
|
|
1611
1687
|
//#region src/user-management/interfaces/authentication-factor.interface.d.ts
|
|
1688
|
+
type AuthenticationFactorType = FactorType;
|
|
1612
1689
|
interface AuthenticationFactor {
|
|
1613
1690
|
object: 'authentication_factor';
|
|
1614
1691
|
id: string;
|
|
1615
1692
|
createdAt: string;
|
|
1616
1693
|
updatedAt: string;
|
|
1617
|
-
type:
|
|
1618
|
-
|
|
1694
|
+
type: AuthenticationFactorType;
|
|
1695
|
+
sms?: Sms;
|
|
1696
|
+
totp?: Totp;
|
|
1619
1697
|
userId: string;
|
|
1620
1698
|
}
|
|
1621
1699
|
interface AuthenticationFactorWithSecrets {
|
|
@@ -1632,8 +1710,9 @@ interface AuthenticationFactorResponse {
|
|
|
1632
1710
|
id: string;
|
|
1633
1711
|
created_at: string;
|
|
1634
1712
|
updated_at: string;
|
|
1635
|
-
type:
|
|
1636
|
-
|
|
1713
|
+
type: AuthenticationFactorType;
|
|
1714
|
+
sms?: SmsResponse;
|
|
1715
|
+
totp?: TotpResponse;
|
|
1637
1716
|
user_id: string;
|
|
1638
1717
|
}
|
|
1639
1718
|
interface AuthenticationFactorWithSecretsResponse {
|
|
@@ -1757,6 +1836,21 @@ interface SerializedCreatePasswordResetOptions {
|
|
|
1757
1836
|
email: string;
|
|
1758
1837
|
}
|
|
1759
1838
|
//#endregion
|
|
1839
|
+
//#region src/user-management/interfaces/create-user-api-key-options.interface.d.ts
|
|
1840
|
+
interface CreateUserApiKeyOptions {
|
|
1841
|
+
name: string;
|
|
1842
|
+
organizationId: string;
|
|
1843
|
+
permissions?: string[];
|
|
1844
|
+
expiresAt?: Date;
|
|
1845
|
+
}
|
|
1846
|
+
interface SerializedCreateUserApiKeyOptions {
|
|
1847
|
+
name: string;
|
|
1848
|
+
organization_id: string;
|
|
1849
|
+
permissions?: string[];
|
|
1850
|
+
expires_at?: string;
|
|
1851
|
+
}
|
|
1852
|
+
interface CreateUserApiKeyRequestOptions extends Pick<PostOptions, 'idempotencyKey'> {}
|
|
1853
|
+
//#endregion
|
|
1760
1854
|
//#region src/user-management/interfaces/password-hash-type.interface.d.ts
|
|
1761
1855
|
type PasswordHashType = 'bcrypt' | 'firebase-scrypt' | 'ssha' | 'scrypt' | 'argon2';
|
|
1762
1856
|
//#endregion
|
|
@@ -2029,6 +2123,14 @@ interface ListUserFeatureFlagsOptions extends PaginationOptions {
|
|
|
2029
2123
|
userId: string;
|
|
2030
2124
|
}
|
|
2031
2125
|
//#endregion
|
|
2126
|
+
//#region src/user-management/interfaces/list-user-api-keys-options.interface.d.ts
|
|
2127
|
+
interface ListUserApiKeysOptions extends PaginationOptions {
|
|
2128
|
+
organizationId?: string;
|
|
2129
|
+
}
|
|
2130
|
+
interface SerializedListUserApiKeysOptions extends PaginationOptions {
|
|
2131
|
+
organization_id?: string;
|
|
2132
|
+
}
|
|
2133
|
+
//#endregion
|
|
2032
2134
|
//#region src/user-management/interfaces/list-users-options.interface.d.ts
|
|
2033
2135
|
interface ListUsersOptions extends PaginationOptions {
|
|
2034
2136
|
/** Filter users by their email address. */
|
|
@@ -2156,12 +2258,43 @@ declare enum RefreshSessionFailureReason {
|
|
|
2156
2258
|
NO_SESSION_COOKIE_PROVIDED = "no_session_cookie_provided",
|
|
2157
2259
|
INVALID_GRANT = "invalid_grant",
|
|
2158
2260
|
MFA_ENROLLMENT = "mfa_enrollment",
|
|
2159
|
-
SSO_REQUIRED = "sso_required"
|
|
2160
|
-
|
|
2161
|
-
|
|
2261
|
+
SSO_REQUIRED = "sso_required",
|
|
2262
|
+
RATE_LIMIT_EXCEEDED = "rate_limit_exceeded",
|
|
2263
|
+
TIMEOUT = "timeout",
|
|
2264
|
+
SERVER_ERROR = "server_error",
|
|
2265
|
+
NETWORK_ERROR = "network_error"
|
|
2266
|
+
}
|
|
2267
|
+
type TerminalRefreshSessionFailureReason = RefreshSessionFailureReason.INVALID_SESSION_COOKIE | RefreshSessionFailureReason.NO_SESSION_COOKIE_PROVIDED | RefreshSessionFailureReason.INVALID_GRANT | RefreshSessionFailureReason.MFA_ENROLLMENT | RefreshSessionFailureReason.SSO_REQUIRED;
|
|
2268
|
+
type RetryableRefreshSessionFailureReason = RefreshSessionFailureReason.RATE_LIMIT_EXCEEDED | RefreshSessionFailureReason.TIMEOUT | RefreshSessionFailureReason.SERVER_ERROR | RefreshSessionFailureReason.NETWORK_ERROR;
|
|
2269
|
+
/**
|
|
2270
|
+
* A terminal refresh failure: the session is over (e.g. `invalid_grant`) and
|
|
2271
|
+
* the user should be redirected to sign in.
|
|
2272
|
+
*/
|
|
2273
|
+
type RefreshSessionTerminalFailedResponse = {
|
|
2274
|
+
authenticated: false;
|
|
2275
|
+
reason: TerminalRefreshSessionFailureReason;
|
|
2276
|
+
retryable: false;
|
|
2277
|
+
};
|
|
2278
|
+
/**
|
|
2279
|
+
* A transient refresh failure: the refresh token is likely still valid (e.g. a
|
|
2280
|
+
* timeout, `5xx`, or `429`), so keep the existing session and retry later.
|
|
2281
|
+
*/
|
|
2282
|
+
type RefreshSessionRetryableFailedResponse = {
|
|
2162
2283
|
authenticated: false;
|
|
2163
|
-
reason:
|
|
2284
|
+
reason: RetryableRefreshSessionFailureReason;
|
|
2285
|
+
retryable: true;
|
|
2286
|
+
/**
|
|
2287
|
+
* Seconds the server asked the client to wait before retrying, parsed from
|
|
2288
|
+
* the `Retry-After` response header. Only present for some retryable
|
|
2289
|
+
* failures (e.g. a `429`).
|
|
2290
|
+
*/
|
|
2291
|
+
retryAfter?: number;
|
|
2292
|
+
/**
|
|
2293
|
+
* The underlying error, exposed for logging.
|
|
2294
|
+
*/
|
|
2295
|
+
error?: unknown;
|
|
2164
2296
|
};
|
|
2297
|
+
type RefreshSessionFailedResponse = RefreshSessionTerminalFailedResponse | RefreshSessionRetryableFailedResponse;
|
|
2165
2298
|
type RefreshSessionSuccessResponse = Omit<AuthenticateWithSessionCookieSuccessResponse, 'accessToken'> & {
|
|
2166
2299
|
authenticated: true;
|
|
2167
2300
|
session?: AuthenticationResponse;
|
|
@@ -2325,6 +2458,48 @@ interface SerializedUpdateUserPasswordOptions {
|
|
|
2325
2458
|
password: string;
|
|
2326
2459
|
}
|
|
2327
2460
|
//#endregion
|
|
2461
|
+
//#region src/user-management/interfaces/user-api-key.interface.d.ts
|
|
2462
|
+
interface UserApiKey {
|
|
2463
|
+
object: 'api_key';
|
|
2464
|
+
id: string;
|
|
2465
|
+
owner: {
|
|
2466
|
+
type: 'user';
|
|
2467
|
+
id: string;
|
|
2468
|
+
organizationId: string;
|
|
2469
|
+
};
|
|
2470
|
+
name: string;
|
|
2471
|
+
obfuscatedValue: string;
|
|
2472
|
+
lastUsedAt: string | null;
|
|
2473
|
+
expiresAt: string | null;
|
|
2474
|
+
permissions: string[];
|
|
2475
|
+
createdAt: string;
|
|
2476
|
+
updatedAt: string;
|
|
2477
|
+
}
|
|
2478
|
+
interface SerializedUserApiKey {
|
|
2479
|
+
object: 'api_key';
|
|
2480
|
+
id: string;
|
|
2481
|
+
owner: {
|
|
2482
|
+
type: 'user';
|
|
2483
|
+
id: string;
|
|
2484
|
+
organization_id: string;
|
|
2485
|
+
};
|
|
2486
|
+
name: string;
|
|
2487
|
+
obfuscated_value: string;
|
|
2488
|
+
last_used_at: string | null;
|
|
2489
|
+
expires_at: string | null;
|
|
2490
|
+
permissions: string[];
|
|
2491
|
+
created_at: string;
|
|
2492
|
+
updated_at: string;
|
|
2493
|
+
}
|
|
2494
|
+
//#endregion
|
|
2495
|
+
//#region src/user-management/interfaces/user-api-key-with-value.interface.d.ts
|
|
2496
|
+
interface UserApiKeyWithValue extends UserApiKey {
|
|
2497
|
+
value: string;
|
|
2498
|
+
}
|
|
2499
|
+
interface SerializedUserApiKeyWithValue extends SerializedUserApiKey {
|
|
2500
|
+
value: string;
|
|
2501
|
+
}
|
|
2502
|
+
//#endregion
|
|
2328
2503
|
//#region src/user-management/interfaces/verify-email-options.interface.d.ts
|
|
2329
2504
|
interface VerifyEmailOptions {
|
|
2330
2505
|
code: string;
|
|
@@ -2410,6 +2585,10 @@ interface ApiKey {
|
|
|
2410
2585
|
owner: {
|
|
2411
2586
|
type: 'organization';
|
|
2412
2587
|
id: string;
|
|
2588
|
+
} | {
|
|
2589
|
+
type: 'user';
|
|
2590
|
+
id: string;
|
|
2591
|
+
organizationId: string;
|
|
2413
2592
|
};
|
|
2414
2593
|
/** A descriptive name for the API Key. */
|
|
2415
2594
|
name: string;
|
|
@@ -2430,6 +2609,10 @@ interface SerializedApiKey {
|
|
|
2430
2609
|
owner: {
|
|
2431
2610
|
type: 'organization';
|
|
2432
2611
|
id: string;
|
|
2612
|
+
} | {
|
|
2613
|
+
type: 'user';
|
|
2614
|
+
id: string;
|
|
2615
|
+
organization_id: string;
|
|
2433
2616
|
};
|
|
2434
2617
|
name: string;
|
|
2435
2618
|
obfuscated_value: string;
|
|
@@ -2494,9 +2677,15 @@ interface ValidateApiKeyOptions {
|
|
|
2494
2677
|
}
|
|
2495
2678
|
interface ValidateApiKeyResponse {
|
|
2496
2679
|
apiKey: ApiKey | null;
|
|
2680
|
+
/**
|
|
2681
|
+
* The ID of the agent registration this API key was issued for. Present only
|
|
2682
|
+
* when the API key is assigned to an agent registration.
|
|
2683
|
+
*/
|
|
2684
|
+
agentRegistrationId?: string;
|
|
2497
2685
|
}
|
|
2498
2686
|
interface SerializedValidateApiKeyResponse {
|
|
2499
2687
|
api_key: SerializedApiKey | null;
|
|
2688
|
+
agent_registration_id?: string;
|
|
2500
2689
|
}
|
|
2501
2690
|
//#endregion
|
|
2502
2691
|
//#region src/feature-flags/interfaces/add-flag-target-options.interface.d.ts
|
|
@@ -3491,6 +3680,8 @@ interface GetOptions {
|
|
|
3491
3680
|
warrantToken?: string;
|
|
3492
3681
|
/** Skip API key requirement check (for PKCE-safe methods) */
|
|
3493
3682
|
skipApiKeyCheck?: boolean;
|
|
3683
|
+
/** Maximum number of retries for this request, overriding the client-wide `maxRetries`. */
|
|
3684
|
+
maxRetries?: number;
|
|
3494
3685
|
}
|
|
3495
3686
|
//#endregion
|
|
3496
3687
|
//#region src/common/interfaces/list.interface.d.ts
|
|
@@ -3519,6 +3710,8 @@ interface PatchOptions {
|
|
|
3519
3710
|
idempotencyKey?: string;
|
|
3520
3711
|
/** Skip API key requirement check (for PKCE-safe methods) */
|
|
3521
3712
|
skipApiKeyCheck?: boolean;
|
|
3713
|
+
/** Maximum number of retries for this request, overriding the client-wide `maxRetries`. */
|
|
3714
|
+
maxRetries?: number;
|
|
3522
3715
|
}
|
|
3523
3716
|
//#endregion
|
|
3524
3717
|
//#region src/common/interfaces/post-options.interface.d.ts
|
|
@@ -3530,6 +3723,8 @@ interface PostOptions {
|
|
|
3530
3723
|
warrantToken?: string;
|
|
3531
3724
|
/** Skip API key requirement check (for PKCE-safe methods) */
|
|
3532
3725
|
skipApiKeyCheck?: boolean;
|
|
3726
|
+
/** Maximum number of retries for this request, overriding the client-wide `maxRetries`. */
|
|
3727
|
+
maxRetries?: number;
|
|
3533
3728
|
}
|
|
3534
3729
|
//#endregion
|
|
3535
3730
|
//#region src/common/interfaces/put-options.interface.d.ts
|
|
@@ -3540,6 +3735,8 @@ interface PutOptions {
|
|
|
3540
3735
|
idempotencyKey?: string;
|
|
3541
3736
|
/** Skip API key requirement check (for PKCE-safe methods) */
|
|
3542
3737
|
skipApiKeyCheck?: boolean;
|
|
3738
|
+
/** Maximum number of retries for this request, overriding the client-wide `maxRetries`. */
|
|
3739
|
+
maxRetries?: number;
|
|
3543
3740
|
}
|
|
3544
3741
|
//#endregion
|
|
3545
3742
|
//#region src/common/interfaces/unprocessable-entity-error.interface.d.ts
|
|
@@ -3565,6 +3762,13 @@ interface WorkOSOptions {
|
|
|
3565
3762
|
fetchFn?: typeof fetch;
|
|
3566
3763
|
clientId?: string;
|
|
3567
3764
|
timeout?: number;
|
|
3765
|
+
/**
|
|
3766
|
+
* Maximum number of automatic retries for transient failures (network
|
|
3767
|
+
* errors and 408/429/5xx responses). Retries use exponential backoff with
|
|
3768
|
+
* jitter and honor the `Retry-After` header (capped at 60 seconds).
|
|
3769
|
+
* Defaults to 3. Set to `0` to disable automatic retries.
|
|
3770
|
+
*/
|
|
3771
|
+
maxRetries?: number;
|
|
3568
3772
|
}
|
|
3569
3773
|
//#endregion
|
|
3570
3774
|
//#region src/common/interfaces/workos-response-error.interface.d.ts
|
|
@@ -3756,12 +3960,7 @@ declare class Actions {
|
|
|
3756
3960
|
private signatureProvider;
|
|
3757
3961
|
constructor(cryptoProvider: CryptoProvider);
|
|
3758
3962
|
private get computeSignature();
|
|
3759
|
-
get verifyHeader(): ({
|
|
3760
|
-
payload,
|
|
3761
|
-
sigHeader,
|
|
3762
|
-
secret,
|
|
3763
|
-
tolerance
|
|
3764
|
-
}: {
|
|
3963
|
+
get verifyHeader(): ({ payload, sigHeader, secret, tolerance }: {
|
|
3765
3964
|
payload: WebhookPayload;
|
|
3766
3965
|
sigHeader: string;
|
|
3767
3966
|
secret: string;
|
|
@@ -3773,12 +3972,7 @@ declare class Actions {
|
|
|
3773
3972
|
payload: ResponsePayload;
|
|
3774
3973
|
signature: string;
|
|
3775
3974
|
}>;
|
|
3776
|
-
constructAction({
|
|
3777
|
-
payload,
|
|
3778
|
-
sigHeader,
|
|
3779
|
-
secret,
|
|
3780
|
-
tolerance
|
|
3781
|
-
}: {
|
|
3975
|
+
constructAction({ payload, sigHeader, secret, tolerance }: {
|
|
3782
3976
|
payload: WebhookPayload;
|
|
3783
3977
|
sigHeader: string;
|
|
3784
3978
|
secret: string;
|
|
@@ -3822,6 +4016,328 @@ declare class PKCE {
|
|
|
3822
4016
|
private base64UrlEncode;
|
|
3823
4017
|
}
|
|
3824
4018
|
//#endregion
|
|
4019
|
+
//#region src/agents/interfaces/agent-registration.interface.d.ts
|
|
4020
|
+
/** The lifecycle status of an agent registration. */
|
|
4021
|
+
type AgentRegistrationStatus = 'unverified' | 'verified' | 'expired' | 'revoked';
|
|
4022
|
+
/** The kind of agent registration, derived from its authentication method. */
|
|
4023
|
+
type AgentRegistrationKind = 'anonymous' | 'service_auth' | 'identity_assertion';
|
|
4024
|
+
/** The agent identity an agent registration belongs to. */
|
|
4025
|
+
interface AgentIdentity {
|
|
4026
|
+
/** Unique identifier of the agent identity. */
|
|
4027
|
+
id: string;
|
|
4028
|
+
/** The Userland user the agent identity is associated with, if any. */
|
|
4029
|
+
userlandUserId: string | null;
|
|
4030
|
+
/** An ISO 8601 timestamp. */
|
|
4031
|
+
createdAt: string;
|
|
4032
|
+
/** An ISO 8601 timestamp. */
|
|
4033
|
+
updatedAt: string;
|
|
4034
|
+
}
|
|
4035
|
+
interface SerializedAgentIdentity {
|
|
4036
|
+
id: string;
|
|
4037
|
+
userland_user_id: string | null;
|
|
4038
|
+
created_at: string;
|
|
4039
|
+
updated_at: string;
|
|
4040
|
+
}
|
|
4041
|
+
/** The completion of an agent registration claim. */
|
|
4042
|
+
interface AgentRegistrationClaimCompletion {
|
|
4043
|
+
/** Unique identifier of the claim completion. */
|
|
4044
|
+
id: string;
|
|
4045
|
+
/** An ISO 8601 timestamp. */
|
|
4046
|
+
createdAt: string;
|
|
4047
|
+
/** An ISO 8601 timestamp. */
|
|
4048
|
+
updatedAt: string;
|
|
4049
|
+
/** An ISO 8601 timestamp. */
|
|
4050
|
+
expiresAt: string;
|
|
4051
|
+
/** An ISO 8601 timestamp of when the registration was claimed. */
|
|
4052
|
+
claimedAt: string;
|
|
4053
|
+
}
|
|
4054
|
+
interface SerializedAgentRegistrationClaimCompletion {
|
|
4055
|
+
id: string;
|
|
4056
|
+
created_at: string;
|
|
4057
|
+
updated_at: string;
|
|
4058
|
+
expires_at: string;
|
|
4059
|
+
claimed_at: string;
|
|
4060
|
+
}
|
|
4061
|
+
/** The claim state of an agent registration. */
|
|
4062
|
+
interface AgentRegistrationClaim {
|
|
4063
|
+
/** Unique identifier of the claim. */
|
|
4064
|
+
id: string;
|
|
4065
|
+
/** The completion of the claim, or `null` if it has not been claimed. */
|
|
4066
|
+
claimCompletion: AgentRegistrationClaimCompletion | null;
|
|
4067
|
+
/** An ISO 8601 timestamp. */
|
|
4068
|
+
createdAt: string;
|
|
4069
|
+
/** An ISO 8601 timestamp. */
|
|
4070
|
+
updatedAt: string;
|
|
4071
|
+
/** An ISO 8601 timestamp. */
|
|
4072
|
+
expiresAt: string;
|
|
4073
|
+
}
|
|
4074
|
+
interface SerializedAgentRegistrationClaim {
|
|
4075
|
+
id: string;
|
|
4076
|
+
claim_completion: SerializedAgentRegistrationClaimCompletion | null;
|
|
4077
|
+
created_at: string;
|
|
4078
|
+
updated_at: string;
|
|
4079
|
+
expires_at: string;
|
|
4080
|
+
}
|
|
4081
|
+
/** A single agent registration. */
|
|
4082
|
+
interface AgentRegistration {
|
|
4083
|
+
/** Unique identifier of the agent registration. */
|
|
4084
|
+
id: string;
|
|
4085
|
+
/** The agent identity the registration belongs to. */
|
|
4086
|
+
agentIdentity: AgentIdentity;
|
|
4087
|
+
/** Unique identifier of the Organization the registration belongs to. */
|
|
4088
|
+
organizationId: string;
|
|
4089
|
+
/** The lifecycle status of the registration. */
|
|
4090
|
+
status: AgentRegistrationStatus;
|
|
4091
|
+
/** The kind of registration. */
|
|
4092
|
+
kind: AgentRegistrationKind;
|
|
4093
|
+
/** The claim state of the registration, or `null` if it has none. */
|
|
4094
|
+
claim: AgentRegistrationClaim | null;
|
|
4095
|
+
/** An ISO 8601 timestamp. */
|
|
4096
|
+
createdAt: string;
|
|
4097
|
+
/** An ISO 8601 timestamp. */
|
|
4098
|
+
updatedAt: string;
|
|
4099
|
+
}
|
|
4100
|
+
interface SerializedAgentRegistration {
|
|
4101
|
+
id: string;
|
|
4102
|
+
agent_identity: SerializedAgentIdentity;
|
|
4103
|
+
organization_id: string;
|
|
4104
|
+
status: AgentRegistrationStatus;
|
|
4105
|
+
kind: AgentRegistrationKind;
|
|
4106
|
+
claim: SerializedAgentRegistrationClaim | null;
|
|
4107
|
+
created_at: string;
|
|
4108
|
+
updated_at: string;
|
|
4109
|
+
}
|
|
4110
|
+
//#endregion
|
|
4111
|
+
//#region src/agents/interfaces/claim-attempt.interface.d.ts
|
|
4112
|
+
/** Options for linking an external user to a claim attempt via the admin API. */
|
|
4113
|
+
interface LinkClaimAttemptToExternalUserOptions {
|
|
4114
|
+
/** The claim attempt token identifying the pending claim. */
|
|
4115
|
+
claimAttemptToken: string;
|
|
4116
|
+
/** The user to attach to the claim attempt. */
|
|
4117
|
+
user: {
|
|
4118
|
+
/** The email address of the user. */
|
|
4119
|
+
email: string;
|
|
4120
|
+
/** The external ID of the user. */
|
|
4121
|
+
externalId: string;
|
|
4122
|
+
};
|
|
4123
|
+
/** The organization to place the agent in. Required when the user belongs to multiple organizations. */
|
|
4124
|
+
organizationId?: string;
|
|
4125
|
+
}
|
|
4126
|
+
interface SerializedLinkClaimAttemptToExternalUserOptions {
|
|
4127
|
+
type: 'link_external_user';
|
|
4128
|
+
claim_attempt_token: string;
|
|
4129
|
+
user: {
|
|
4130
|
+
email: string;
|
|
4131
|
+
external_id: string;
|
|
4132
|
+
};
|
|
4133
|
+
organization_id?: string;
|
|
4134
|
+
}
|
|
4135
|
+
/** An organization the confirming user belongs to, offered as a placement choice. */
|
|
4136
|
+
interface ClaimAttemptOrganization {
|
|
4137
|
+
/** The organization ID. */
|
|
4138
|
+
id: string;
|
|
4139
|
+
/** The organization name. */
|
|
4140
|
+
name: string;
|
|
4141
|
+
}
|
|
4142
|
+
/** The result of linking an external user to a claim attempt. */
|
|
4143
|
+
interface ClaimAttemptResponse {
|
|
4144
|
+
/** The agent registration ID. */
|
|
4145
|
+
id: string;
|
|
4146
|
+
/** Current status of the agent registration. */
|
|
4147
|
+
status: AgentRegistrationStatus;
|
|
4148
|
+
/** The user code the agent needs to complete the claim. */
|
|
4149
|
+
userCode: string;
|
|
4150
|
+
/** Organizations the user belongs to, offered as placement choices. */
|
|
4151
|
+
organizations: ClaimAttemptOrganization[];
|
|
4152
|
+
}
|
|
4153
|
+
interface SerializedClaimAttemptResponse {
|
|
4154
|
+
id: string;
|
|
4155
|
+
status: AgentRegistrationStatus;
|
|
4156
|
+
user_code: string;
|
|
4157
|
+
organizations: ClaimAttemptOrganization[];
|
|
4158
|
+
}
|
|
4159
|
+
//#endregion
|
|
4160
|
+
//#region src/agents/interfaces/validate-agent-credential.interface.d.ts
|
|
4161
|
+
/** The type of agent credential to validate. */
|
|
4162
|
+
type AgentCredentialType = 'api_key' | 'access_token';
|
|
4163
|
+
interface ValidateAgentApiKeyOptions {
|
|
4164
|
+
type: 'api_key';
|
|
4165
|
+
/** The opaque API key value to validate. */
|
|
4166
|
+
credential: string;
|
|
4167
|
+
}
|
|
4168
|
+
interface ValidateAgentAccessTokenOptions {
|
|
4169
|
+
type: 'access_token';
|
|
4170
|
+
/** The access token (JWT) to validate. */
|
|
4171
|
+
credential: string;
|
|
4172
|
+
/**
|
|
4173
|
+
* When `true`, additionally calls the WorkOS API to check whether the token
|
|
4174
|
+
* has been revoked. When `false` or omitted, the token is only decoded and
|
|
4175
|
+
* verified locally against the environment's JWKS — a revoked but
|
|
4176
|
+
* not-yet-expired token will still report as valid.
|
|
4177
|
+
*/
|
|
4178
|
+
checkForRevoked?: boolean;
|
|
4179
|
+
/**
|
|
4180
|
+
* The expected token audience (`aud`). Defaults to the client ID the WorkOS
|
|
4181
|
+
* client was initialized with. Pass the resource indicator for
|
|
4182
|
+
* resource-scoped tokens, whose audience is the resource rather than the
|
|
4183
|
+
* client ID. When `checkForRevoked` is set, this is also forwarded to the
|
|
4184
|
+
* WorkOS API so the server verifies the `aud` claim against the same value.
|
|
4185
|
+
*/
|
|
4186
|
+
audience?: string;
|
|
4187
|
+
}
|
|
4188
|
+
/**
|
|
4189
|
+
* Options for validating an agent credential. `checkForRevoked` and `audience`
|
|
4190
|
+
* are only available for `access_token` credentials.
|
|
4191
|
+
*/
|
|
4192
|
+
type ValidateAgentCredentialOptions = ValidateAgentApiKeyOptions | ValidateAgentAccessTokenOptions;
|
|
4193
|
+
interface SerializedValidateAgentCredentialOptions {
|
|
4194
|
+
type: AgentCredentialType;
|
|
4195
|
+
credential: string;
|
|
4196
|
+
audience?: string;
|
|
4197
|
+
}
|
|
4198
|
+
/**
|
|
4199
|
+
* The decoded claims of an agent access token. The required fields are
|
|
4200
|
+
* guaranteed present: the SDK rejects a token that is missing any of them
|
|
4201
|
+
* rather than returning a partial result.
|
|
4202
|
+
*/
|
|
4203
|
+
interface AgentAccessTokenClaims {
|
|
4204
|
+
/** The token issuer (`iss`). */
|
|
4205
|
+
issuer: string;
|
|
4206
|
+
/** The token audience (`aud`). */
|
|
4207
|
+
audience: string | string[];
|
|
4208
|
+
/** Unique identifier of the agent registration the token was issued for (`sub`). */
|
|
4209
|
+
registrationId: string;
|
|
4210
|
+
/** The token's unique identifier (`jti`). */
|
|
4211
|
+
jti: string;
|
|
4212
|
+
/** Unique identifier of the Organization the registration belongs to. */
|
|
4213
|
+
organizationId: string;
|
|
4214
|
+
/** The space-separated scopes granted to the token, if any (`scope`). */
|
|
4215
|
+
scope?: string;
|
|
4216
|
+
/** The actor the token acts on behalf of, if any (`act`). */
|
|
4217
|
+
actor?: {
|
|
4218
|
+
sub: string;
|
|
4219
|
+
};
|
|
4220
|
+
/** The time the token expires, in seconds since the epoch (`exp`). */
|
|
4221
|
+
expiresAt: number;
|
|
4222
|
+
/** The time the token was issued, in seconds since the epoch (`iat`). */
|
|
4223
|
+
issuedAt: number;
|
|
4224
|
+
}
|
|
4225
|
+
/**
|
|
4226
|
+
* A verified agent access token payload. The required claims are the ones the
|
|
4227
|
+
* SDK guarantees on a valid agent credential; `scope` and `act` are genuinely
|
|
4228
|
+
* optional on the token. A decoded payload missing any required claim is
|
|
4229
|
+
* rejected as invalid before it reaches this shape.
|
|
4230
|
+
*/
|
|
4231
|
+
interface SerializedAgentAccessTokenClaims {
|
|
4232
|
+
iss: string;
|
|
4233
|
+
aud: string | string[];
|
|
4234
|
+
sub: string;
|
|
4235
|
+
jti: string;
|
|
4236
|
+
org_id: string;
|
|
4237
|
+
exp: number;
|
|
4238
|
+
iat: number;
|
|
4239
|
+
scope?: string;
|
|
4240
|
+
act?: {
|
|
4241
|
+
sub: string;
|
|
4242
|
+
};
|
|
4243
|
+
[claim: string]: unknown;
|
|
4244
|
+
}
|
|
4245
|
+
/** A valid agent credential. */
|
|
4246
|
+
interface ValidAgentCredential {
|
|
4247
|
+
valid: true;
|
|
4248
|
+
/** Unique identifier of the agent registration the credential was issued for. */
|
|
4249
|
+
registrationId: string;
|
|
4250
|
+
/**
|
|
4251
|
+
* An ISO 8601 timestamp of when the credential expires, or `null` when it
|
|
4252
|
+
* does not expire.
|
|
4253
|
+
*/
|
|
4254
|
+
expiresAt: string | null;
|
|
4255
|
+
/**
|
|
4256
|
+
* The decoded claims of the access token. Populated for `access_token`
|
|
4257
|
+
* credentials; `null` for API keys.
|
|
4258
|
+
*/
|
|
4259
|
+
claims: AgentAccessTokenClaims | null;
|
|
4260
|
+
}
|
|
4261
|
+
/** An invalid agent credential. */
|
|
4262
|
+
interface InvalidAgentCredential {
|
|
4263
|
+
valid: false;
|
|
4264
|
+
registrationId: null;
|
|
4265
|
+
expiresAt: null;
|
|
4266
|
+
claims: null;
|
|
4267
|
+
}
|
|
4268
|
+
/** The result of validating an agent credential. */
|
|
4269
|
+
type AgentCredentialValidation = ValidAgentCredential | InvalidAgentCredential;
|
|
4270
|
+
interface SerializedAgentCredentialValidation {
|
|
4271
|
+
valid: boolean;
|
|
4272
|
+
registration_id: string | null;
|
|
4273
|
+
expires_at: string | null;
|
|
4274
|
+
}
|
|
4275
|
+
//#endregion
|
|
4276
|
+
//#region src/agents/agents.d.ts
|
|
4277
|
+
declare class Agents {
|
|
4278
|
+
private readonly workos;
|
|
4279
|
+
private _jwks?;
|
|
4280
|
+
constructor(workos: WorkOS);
|
|
4281
|
+
/**
|
|
4282
|
+
* Link a claim attempt to an external user
|
|
4283
|
+
*
|
|
4284
|
+
* Link an external user to a claim attempt and retrieve the code needed
|
|
4285
|
+
* for the agent to complete the claim. The user is looked up by external
|
|
4286
|
+
* ID; if no user exists, one is created. When the user belongs to multiple
|
|
4287
|
+
* organizations, an explicit organization must be provided.
|
|
4288
|
+
*
|
|
4289
|
+
* @param options - Object containing the claim attempt token, user details, and optional organization ID.
|
|
4290
|
+
* @returns {Promise<ClaimAttemptResponse>}
|
|
4291
|
+
* @throws {BadRequestException} 400 - Invalid request, email mismatch, or wrong account.
|
|
4292
|
+
* @throws {ForbiddenException} 403 - Claim denied or auth method disabled.
|
|
4293
|
+
* @throws {ConflictException} 409 - Organization selection required, external ID conflict, or already claimed.
|
|
4294
|
+
* @throws {GoneException} 410 - Claim or user code expired.
|
|
4295
|
+
*/
|
|
4296
|
+
linkClaimAttemptToExternalUser(options: LinkClaimAttemptToExternalUserOptions): Promise<ClaimAttemptResponse>;
|
|
4297
|
+
/**
|
|
4298
|
+
* Get an agent registration
|
|
4299
|
+
*
|
|
4300
|
+
* Retrieve a single agent registration scoped to the API key's environment.
|
|
4301
|
+
* @param id - Unique identifier of the agent registration.
|
|
4302
|
+
*
|
|
4303
|
+
* @example
|
|
4304
|
+
* "agent_reg_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
4305
|
+
*
|
|
4306
|
+
* @returns {Promise<AgentRegistration>}
|
|
4307
|
+
* @throws {NotFoundException} 404
|
|
4308
|
+
*/
|
|
4309
|
+
getRegistration(id: string): Promise<AgentRegistration>;
|
|
4310
|
+
/**
|
|
4311
|
+
* Validate an agent credential
|
|
4312
|
+
*
|
|
4313
|
+
* For `access_token` credentials, the token is decoded and verified locally
|
|
4314
|
+
* against the environment's JWKS and its claims are returned — no network
|
|
4315
|
+
* request is made unless `checkForRevoked` is set, in which case the WorkOS
|
|
4316
|
+
* API is also called to confirm the token has not been revoked.
|
|
4317
|
+
*
|
|
4318
|
+
* For `api_key` credentials, the WorkOS API is always called to validate the
|
|
4319
|
+
* key against the environment.
|
|
4320
|
+
*
|
|
4321
|
+
* @param options - Object containing the credential type and value.
|
|
4322
|
+
* @returns {Promise<AgentCredentialValidation>}
|
|
4323
|
+
*/
|
|
4324
|
+
validateCredential(options: ValidateAgentCredentialOptions): Promise<AgentCredentialValidation>;
|
|
4325
|
+
private validateAccessToken;
|
|
4326
|
+
private validateCredentialRemotely;
|
|
4327
|
+
/**
|
|
4328
|
+
* Verifies an access token's signature, audience, and time claims against the
|
|
4329
|
+
* environment's JWKS and returns its decoded claims, or `null` when the token
|
|
4330
|
+
* is invalid (bad signature, wrong audience, expired, malformed, or missing
|
|
4331
|
+
* the agent identity claims). Errors that are not JWT validation failures
|
|
4332
|
+
* (e.g. network errors fetching the JWKS) propagate.
|
|
4333
|
+
*
|
|
4334
|
+
* The audience defaults to the client ID; resource-scoped tokens carry the
|
|
4335
|
+
* resource as their audience and require it to be passed explicitly.
|
|
4336
|
+
*/
|
|
4337
|
+
private verifyAccessTokenClaims;
|
|
4338
|
+
private getJWKS;
|
|
4339
|
+
}
|
|
4340
|
+
//#endregion
|
|
3825
4341
|
//#region src/common/utils/pagination.d.ts
|
|
3826
4342
|
declare class AutoPaginatable<ResourceType, ParametersType extends PaginationOptions = PaginationOptions> {
|
|
3827
4343
|
protected list: List<ResourceType>;
|
|
@@ -4707,68 +5223,940 @@ interface SendSessionResponse {
|
|
|
4707
5223
|
declare class Passwordless {
|
|
4708
5224
|
private readonly workos;
|
|
4709
5225
|
constructor(workos: WorkOS);
|
|
4710
|
-
createSession({
|
|
4711
|
-
redirectURI,
|
|
4712
|
-
expiresIn,
|
|
4713
|
-
...options
|
|
4714
|
-
}: CreatePasswordlessSessionOptions): Promise<PasswordlessSession>;
|
|
5226
|
+
createSession({ redirectURI, expiresIn, ...options }: CreatePasswordlessSessionOptions): Promise<PasswordlessSession>;
|
|
4715
5227
|
sendSession(sessionId: string): Promise<SendSessionResponse>;
|
|
4716
5228
|
}
|
|
4717
5229
|
//#endregion
|
|
4718
|
-
//#region src/pipes/interfaces/
|
|
4719
|
-
|
|
4720
|
-
|
|
4721
|
-
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
|
|
5230
|
+
//#region src/pipes/interfaces/data-integration-credentials-type.interface.d.ts
|
|
5231
|
+
declare const DataIntegrationCredentialsType: {
|
|
5232
|
+
readonly Custom: "custom";
|
|
5233
|
+
readonly Organization: "organization";
|
|
5234
|
+
};
|
|
5235
|
+
type DataIntegrationCredentialsType = (typeof DataIntegrationCredentialsType)[keyof typeof DataIntegrationCredentialsType];
|
|
5236
|
+
//#endregion
|
|
5237
|
+
//#region src/pipes/interfaces/data-integration-credentials-dto.interface.d.ts
|
|
5238
|
+
interface DataIntegrationCredentialsDto {
|
|
5239
|
+
/** The credentials type. `custom` uses your own OAuth app credentials; `organization` has each organization supply its own credentials (configured per-organization). */
|
|
5240
|
+
type: DataIntegrationCredentialsType;
|
|
5241
|
+
/** OAuth client ID for the provider app. Required when `type` is `custom`; omit for `organization`. */
|
|
5242
|
+
clientId?: string;
|
|
5243
|
+
/** OAuth client secret for the provider app. Required when `type` is `custom`; omit for `organization`. */
|
|
5244
|
+
clientSecret?: string;
|
|
4725
5245
|
}
|
|
4726
|
-
interface
|
|
4727
|
-
|
|
4728
|
-
|
|
4729
|
-
|
|
4730
|
-
scopes: string[];
|
|
4731
|
-
missing_scopes: string[];
|
|
5246
|
+
interface DataIntegrationCredentialsDtoResponse {
|
|
5247
|
+
type: DataIntegrationCredentialsType;
|
|
5248
|
+
client_id?: string;
|
|
5249
|
+
client_secret?: string;
|
|
4732
5250
|
}
|
|
4733
5251
|
//#endregion
|
|
4734
|
-
//#region src/pipes/interfaces/
|
|
4735
|
-
|
|
5252
|
+
//#region src/pipes/interfaces/custom-provider-definition-authenticate-via.interface.d.ts
|
|
5253
|
+
declare const CustomProviderDefinitionAuthenticateVia: {
|
|
5254
|
+
readonly RequestBody: "request_body";
|
|
5255
|
+
readonly BasicAuthHeader: "basic_auth_header";
|
|
5256
|
+
};
|
|
5257
|
+
type CustomProviderDefinitionAuthenticateVia = (typeof CustomProviderDefinitionAuthenticateVia)[keyof typeof CustomProviderDefinitionAuthenticateVia];
|
|
5258
|
+
//#endregion
|
|
5259
|
+
//#region src/pipes/interfaces/custom-provider-definition.interface.d.ts
|
|
5260
|
+
interface CustomProviderDefinition {
|
|
5261
|
+
/** A descriptive name for the custom provider. */
|
|
5262
|
+
name: string;
|
|
5263
|
+
/** The provider's OAuth authorization endpoint. */
|
|
5264
|
+
authorizationUrl: string;
|
|
5265
|
+
/** The provider's OAuth token endpoint. */
|
|
5266
|
+
tokenUrl: string;
|
|
5267
|
+
/** The endpoint used to refresh tokens, if different from the token endpoint. */
|
|
5268
|
+
refreshTokenUrl?: string | null;
|
|
5269
|
+
/** Whether PKCE is used during the authorization code flow. Defaults to `true`. */
|
|
5270
|
+
pkceEnabled?: boolean;
|
|
5271
|
+
/** The separator used to join requested scopes. Defaults to a space. */
|
|
5272
|
+
requestScopeSeparator?: string;
|
|
5273
|
+
/** Whether at least one scope must be selected when connecting an account. Defaults to `false`. */
|
|
5274
|
+
scopesRequired?: boolean;
|
|
5275
|
+
/** Whether a client secret is required for this provider. Defaults to `true`. */
|
|
5276
|
+
clientSecretRequired?: boolean;
|
|
5277
|
+
/** Additional static query parameters appended to the authorization request. */
|
|
5278
|
+
additionalAuthorizationParameters?: Record<string, string>;
|
|
5279
|
+
/** The Content-Type used when exchanging the token request. */
|
|
5280
|
+
tokenBodyContentType?: string;
|
|
5281
|
+
/** How client credentials are sent when exchanging authorization codes and refreshing tokens. */
|
|
5282
|
+
authenticateVia?: CustomProviderDefinitionAuthenticateVia;
|
|
5283
|
+
}
|
|
5284
|
+
interface CustomProviderDefinitionResponse {
|
|
5285
|
+
name: string;
|
|
5286
|
+
authorization_url: string;
|
|
5287
|
+
token_url: string;
|
|
5288
|
+
refresh_token_url?: string | null;
|
|
5289
|
+
pkce_enabled?: boolean;
|
|
5290
|
+
request_scope_separator?: string;
|
|
5291
|
+
scopes_required?: boolean;
|
|
5292
|
+
client_secret_required?: boolean;
|
|
5293
|
+
additional_authorization_parameters?: Record<string, string>;
|
|
5294
|
+
token_body_content_type?: string;
|
|
5295
|
+
authenticate_via?: CustomProviderDefinitionAuthenticateVia;
|
|
5296
|
+
}
|
|
5297
|
+
//#endregion
|
|
5298
|
+
//#region src/pipes/interfaces/create-data-integration-options.interface.d.ts
|
|
5299
|
+
interface CreateDataIntegrationOptions {
|
|
5300
|
+
/** The provider to create a Data Integration for. For a built-in provider use its slug (e.g. `github`, `slack`). For a custom provider, this is the new provider slug and `custom_provider` must be supplied. A custom provider slug cannot shadow an existing global provider slug. */
|
|
5301
|
+
provider: string;
|
|
5302
|
+
/** An optional description of the Data Integration. */
|
|
5303
|
+
description?: string | null;
|
|
5304
|
+
/** Whether the Data Integration is enabled. Defaults to `false`. */
|
|
5305
|
+
enabled?: boolean;
|
|
5306
|
+
/** The OAuth scopes to request for the Data Integration. Defaults to the provider's configured scopes when omitted. */
|
|
5307
|
+
scopes?: string[] | null;
|
|
5308
|
+
/** The credentials to configure for the Data Integration. Required for both built-in and custom providers. */
|
|
5309
|
+
credentials?: DataIntegrationCredentialsDto;
|
|
5310
|
+
/** The OAuth definition for a custom provider. Supply this to define a custom provider; omit it to create an integration for a built-in provider. */
|
|
5311
|
+
customProvider?: CustomProviderDefinition;
|
|
5312
|
+
}
|
|
5313
|
+
//#endregion
|
|
5314
|
+
//#region src/pipes/interfaces/get-data-integration-options.interface.d.ts
|
|
5315
|
+
interface GetDataIntegrationOptions {
|
|
5316
|
+
/** The slug identifier of the data integration. */
|
|
5317
|
+
slug: string;
|
|
5318
|
+
}
|
|
5319
|
+
//#endregion
|
|
5320
|
+
//#region src/pipes/interfaces/update-custom-provider-definition-authenticate-via.interface.d.ts
|
|
5321
|
+
declare const UpdateCustomProviderDefinitionAuthenticateVia: {
|
|
5322
|
+
readonly RequestBody: "request_body";
|
|
5323
|
+
readonly BasicAuthHeader: "basic_auth_header";
|
|
5324
|
+
};
|
|
5325
|
+
type UpdateCustomProviderDefinitionAuthenticateVia = (typeof UpdateCustomProviderDefinitionAuthenticateVia)[keyof typeof UpdateCustomProviderDefinitionAuthenticateVia];
|
|
5326
|
+
//#endregion
|
|
5327
|
+
//#region src/pipes/interfaces/update-custom-provider-definition.interface.d.ts
|
|
5328
|
+
interface UpdateCustomProviderDefinition {
|
|
5329
|
+
/** A descriptive name for the custom provider. */
|
|
5330
|
+
name?: string;
|
|
5331
|
+
/** The provider's OAuth authorization endpoint. */
|
|
5332
|
+
authorizationUrl?: string;
|
|
5333
|
+
/** The provider's OAuth token endpoint. */
|
|
5334
|
+
tokenUrl?: string;
|
|
5335
|
+
/** The endpoint used to refresh tokens, if different from the token endpoint. */
|
|
5336
|
+
refreshTokenUrl?: string | null;
|
|
5337
|
+
/** Whether PKCE is used during the authorization code flow. */
|
|
5338
|
+
pkceEnabled?: boolean;
|
|
5339
|
+
/** The separator used to join requested scopes. */
|
|
5340
|
+
requestScopeSeparator?: string;
|
|
5341
|
+
/** Whether at least one scope must be selected when connecting an account. */
|
|
5342
|
+
scopesRequired?: boolean;
|
|
5343
|
+
/** Whether a client secret is required for this provider. */
|
|
5344
|
+
clientSecretRequired?: boolean;
|
|
5345
|
+
/** Additional static query parameters appended to the authorization request. */
|
|
5346
|
+
additionalAuthorizationParameters?: Record<string, string>;
|
|
5347
|
+
/** The Content-Type used when exchanging the token request. */
|
|
5348
|
+
tokenBodyContentType?: string;
|
|
5349
|
+
/** How client credentials are sent when exchanging authorization codes and refreshing tokens. */
|
|
5350
|
+
authenticateVia?: UpdateCustomProviderDefinitionAuthenticateVia;
|
|
5351
|
+
}
|
|
5352
|
+
interface UpdateCustomProviderDefinitionResponse {
|
|
5353
|
+
name?: string;
|
|
5354
|
+
authorization_url?: string;
|
|
5355
|
+
token_url?: string;
|
|
5356
|
+
refresh_token_url?: string | null;
|
|
5357
|
+
pkce_enabled?: boolean;
|
|
5358
|
+
request_scope_separator?: string;
|
|
5359
|
+
scopes_required?: boolean;
|
|
5360
|
+
client_secret_required?: boolean;
|
|
5361
|
+
additional_authorization_parameters?: Record<string, string>;
|
|
5362
|
+
token_body_content_type?: string;
|
|
5363
|
+
authenticate_via?: UpdateCustomProviderDefinitionAuthenticateVia;
|
|
5364
|
+
}
|
|
5365
|
+
//#endregion
|
|
5366
|
+
//#region src/pipes/interfaces/update-data-integration-options.interface.d.ts
|
|
5367
|
+
interface UpdateDataIntegrationOptions {
|
|
5368
|
+
/** The slug identifier of the data integration. */
|
|
5369
|
+
slug: string;
|
|
5370
|
+
/** An optional description of the Data Integration. */
|
|
5371
|
+
description?: string | null;
|
|
5372
|
+
/** Whether the Data Integration is enabled. */
|
|
5373
|
+
enabled?: boolean;
|
|
5374
|
+
/** The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes. */
|
|
5375
|
+
scopes?: string[] | null;
|
|
5376
|
+
/** New credentials for the Data Integration. When provided, rotates the stored client secret. */
|
|
5377
|
+
credentials?: DataIntegrationCredentialsDto;
|
|
5378
|
+
/** Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations. */
|
|
5379
|
+
customProvider?: UpdateCustomProviderDefinition;
|
|
5380
|
+
}
|
|
5381
|
+
//#endregion
|
|
5382
|
+
//#region src/pipes/interfaces/delete-data-integration-options.interface.d.ts
|
|
5383
|
+
interface DeleteDataIntegrationOptions {
|
|
5384
|
+
/** The slug identifier of the data integration. */
|
|
5385
|
+
slug: string;
|
|
5386
|
+
}
|
|
5387
|
+
//#endregion
|
|
5388
|
+
//#region src/pipes/interfaces/update-data-integration-api-key-options.interface.d.ts
|
|
5389
|
+
interface UpdateDataIntegrationApiKeyOptions {
|
|
5390
|
+
/** The identifier of the integration. */
|
|
5391
|
+
slug: string;
|
|
5392
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5393
|
+
userId: string;
|
|
5394
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. */
|
|
5395
|
+
organizationId?: string;
|
|
5396
|
+
/** The API key secret to store for this integration. */
|
|
5397
|
+
secret: string;
|
|
5398
|
+
}
|
|
5399
|
+
//#endregion
|
|
5400
|
+
//#region src/pipes/interfaces/authorize-data-integration-options.interface.d.ts
|
|
5401
|
+
interface AuthorizeDataIntegrationOptions {
|
|
5402
|
+
/** The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
5403
|
+
slug: string;
|
|
5404
|
+
/** The ID of the user to authorize. */
|
|
5405
|
+
userId: string;
|
|
5406
|
+
/** An organization ID to scope the authorization to a specific organization. */
|
|
5407
|
+
organizationId?: string;
|
|
5408
|
+
/** The URL to redirect the user to after authorization. */
|
|
5409
|
+
returnTo?: string;
|
|
5410
|
+
}
|
|
5411
|
+
//#endregion
|
|
5412
|
+
//#region src/pipes/interfaces/create-data-integration-credential-options.interface.d.ts
|
|
5413
|
+
interface CreateDataIntegrationCredentialOptions {
|
|
5414
|
+
/** The identifier of the integration. */
|
|
5415
|
+
slug: string;
|
|
5416
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5417
|
+
userId: string;
|
|
5418
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. */
|
|
5419
|
+
organizationId?: string;
|
|
5420
|
+
}
|
|
5421
|
+
//#endregion
|
|
5422
|
+
//#region src/pipes/interfaces/get-access-token-options.interface.d.ts
|
|
5423
|
+
interface GetAccessTokenOptions {
|
|
5424
|
+
/** The identifier of the integration. */
|
|
5425
|
+
provider: string;
|
|
5426
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
4736
5427
|
userId: string;
|
|
5428
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization. */
|
|
4737
5429
|
organizationId?: string | null;
|
|
4738
5430
|
}
|
|
4739
|
-
|
|
4740
|
-
|
|
4741
|
-
|
|
5431
|
+
//#endregion
|
|
5432
|
+
//#region src/pipes/interfaces/get-user-connected-account-options.interface.d.ts
|
|
5433
|
+
interface GetUserConnectedAccountOptions {
|
|
5434
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5435
|
+
userId: string;
|
|
5436
|
+
/** The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
5437
|
+
slug: string;
|
|
5438
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
5439
|
+
organizationId?: string;
|
|
4742
5440
|
}
|
|
4743
|
-
|
|
4744
|
-
|
|
4745
|
-
|
|
5441
|
+
//#endregion
|
|
5442
|
+
//#region src/pipes/interfaces/connected-account-state.interface.d.ts
|
|
5443
|
+
declare const ConnectedAccountState: {
|
|
5444
|
+
readonly Connected: "connected";
|
|
5445
|
+
readonly NeedsReauthorization: "needs_reauthorization";
|
|
5446
|
+
};
|
|
5447
|
+
type ConnectedAccountState = (typeof ConnectedAccountState)[keyof typeof ConnectedAccountState];
|
|
5448
|
+
//#endregion
|
|
5449
|
+
//#region src/pipes/interfaces/create-user-connected-account-options.interface.d.ts
|
|
5450
|
+
interface CreateUserConnectedAccountOptions {
|
|
5451
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5452
|
+
userId: string;
|
|
5453
|
+
/** The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
5454
|
+
slug: string;
|
|
5455
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
5456
|
+
organizationId?: string;
|
|
5457
|
+
/** The OAuth access token for the connected account. */
|
|
5458
|
+
accessToken?: string;
|
|
5459
|
+
/** The OAuth refresh token for the connected account. */
|
|
5460
|
+
refreshToken?: string;
|
|
5461
|
+
/** The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire. */
|
|
5462
|
+
expiresAt?: Date;
|
|
5463
|
+
/** The OAuth scopes granted for this connection. */
|
|
5464
|
+
scopes?: string[];
|
|
5465
|
+
/** Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided. */
|
|
5466
|
+
state?: ConnectedAccountState;
|
|
5467
|
+
}
|
|
5468
|
+
//#endregion
|
|
5469
|
+
//#region src/pipes/interfaces/update-user-connected-account-options.interface.d.ts
|
|
5470
|
+
interface UpdateUserConnectedAccountOptions {
|
|
5471
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5472
|
+
userId: string;
|
|
5473
|
+
/** The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
5474
|
+
slug: string;
|
|
5475
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
5476
|
+
organizationId?: string;
|
|
5477
|
+
/** The OAuth access token for the connected account. */
|
|
5478
|
+
accessToken?: string;
|
|
5479
|
+
/** The OAuth refresh token for the connected account. */
|
|
5480
|
+
refreshToken?: string;
|
|
5481
|
+
/** The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire. */
|
|
5482
|
+
expiresAt?: Date;
|
|
5483
|
+
/** The OAuth scopes granted for this connection. */
|
|
5484
|
+
scopes?: string[];
|
|
5485
|
+
/** Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided. */
|
|
5486
|
+
state?: ConnectedAccountState;
|
|
5487
|
+
}
|
|
5488
|
+
//#endregion
|
|
5489
|
+
//#region src/pipes/interfaces/delete-user-connected-account-options.interface.d.ts
|
|
5490
|
+
interface DeleteUserConnectedAccountOptions {
|
|
5491
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier. */
|
|
5492
|
+
userId: string;
|
|
5493
|
+
/** The slug identifier of the provider (e.g., `github`, `slack`, `notion`). */
|
|
5494
|
+
slug: string;
|
|
5495
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization. */
|
|
5496
|
+
organizationId?: string;
|
|
4746
5497
|
}
|
|
4747
|
-
|
|
4748
|
-
|
|
4749
|
-
|
|
5498
|
+
//#endregion
|
|
5499
|
+
//#region src/pipes/interfaces/list-user-data-providers-options.interface.d.ts
|
|
5500
|
+
interface ListUserDataProvidersOptions {
|
|
5501
|
+
/** A [User](https://workos.com/docs/reference/authkit/user) identifier to list providers and connected accounts for. */
|
|
5502
|
+
userId: string;
|
|
5503
|
+
/** An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to filter connections for a specific organization. */
|
|
5504
|
+
organizationId?: string;
|
|
4750
5505
|
}
|
|
4751
|
-
|
|
4752
|
-
interface
|
|
4753
|
-
|
|
4754
|
-
|
|
5506
|
+
//#endregion
|
|
5507
|
+
//#region src/pipes/interfaces/data-integration-credential-type.interface.d.ts
|
|
5508
|
+
declare const DataIntegrationCredentialType: {
|
|
5509
|
+
readonly Custom: "custom";
|
|
5510
|
+
readonly Organization: "organization";
|
|
5511
|
+
};
|
|
5512
|
+
type DataIntegrationCredentialType = (typeof DataIntegrationCredentialType)[keyof typeof DataIntegrationCredentialType];
|
|
5513
|
+
//#endregion
|
|
5514
|
+
//#region src/pipes/interfaces/data-integration-credential.interface.d.ts
|
|
5515
|
+
/** The credentials configured for the Data Integration. */
|
|
5516
|
+
interface DataIntegrationCredential {
|
|
5517
|
+
/** The credentials type. `custom` uses your own OAuth app credentials; `organization` has each organization supply its own credentials (so `client_id`/`redacted_client_secret` are null on the integration itself). */
|
|
5518
|
+
type: DataIntegrationCredentialType;
|
|
5519
|
+
/** The OAuth client ID configured for the provider app. Null for `organization` credentials. */
|
|
5520
|
+
clientId: string | null;
|
|
5521
|
+
/** The last four characters of the OAuth client secret. The full secret is never returned. Null for `organization` credentials. */
|
|
5522
|
+
redactedClientSecret: string | null;
|
|
5523
|
+
}
|
|
5524
|
+
interface DataIntegrationCredentialResponse {
|
|
5525
|
+
type: DataIntegrationCredentialType;
|
|
5526
|
+
client_id: string | null;
|
|
5527
|
+
redacted_client_secret: string | null;
|
|
5528
|
+
}
|
|
5529
|
+
//#endregion
|
|
5530
|
+
//#region src/pipes/interfaces/data-integration-custom-provider-authenticate-via.interface.d.ts
|
|
5531
|
+
declare const DataIntegrationCustomProviderAuthenticateVia: {
|
|
5532
|
+
readonly RequestBody: "request_body";
|
|
5533
|
+
readonly BasicAuthHeader: "basic_auth_header";
|
|
5534
|
+
};
|
|
5535
|
+
type DataIntegrationCustomProviderAuthenticateVia = (typeof DataIntegrationCustomProviderAuthenticateVia)[keyof typeof DataIntegrationCustomProviderAuthenticateVia];
|
|
5536
|
+
//#endregion
|
|
5537
|
+
//#region src/pipes/interfaces/data-integration-custom-provider.interface.d.ts
|
|
5538
|
+
interface DataIntegrationCustomProvider {
|
|
5539
|
+
/** A descriptive name for the custom provider. */
|
|
5540
|
+
name: string;
|
|
5541
|
+
/** The provider's OAuth authorization endpoint. */
|
|
5542
|
+
authorizationUrl: string | null;
|
|
5543
|
+
/** The provider's OAuth token endpoint. */
|
|
5544
|
+
tokenUrl: string | null;
|
|
5545
|
+
/** The endpoint used to refresh tokens, if different from the token endpoint. */
|
|
5546
|
+
refreshTokenUrl: string | null;
|
|
5547
|
+
/** Whether PKCE is used during the authorization code flow. */
|
|
5548
|
+
pkceEnabled: boolean;
|
|
5549
|
+
/** The separator used to join requested scopes. */
|
|
5550
|
+
requestScopeSeparator: string;
|
|
5551
|
+
/** Whether at least one scope must be selected when connecting an account. */
|
|
5552
|
+
scopesRequired: boolean;
|
|
5553
|
+
/** Whether a client secret is required for this provider. */
|
|
5554
|
+
clientSecretRequired: boolean;
|
|
5555
|
+
/** Additional static query parameters appended to the authorization request. */
|
|
5556
|
+
additionalAuthorizationParameters: Record<string, string>;
|
|
5557
|
+
/** The Content-Type used when exchanging the token request. */
|
|
5558
|
+
tokenBodyContentType: string;
|
|
5559
|
+
/** How client credentials are sent when exchanging authorization codes and refreshing tokens. */
|
|
5560
|
+
authenticateVia: DataIntegrationCustomProviderAuthenticateVia;
|
|
5561
|
+
}
|
|
5562
|
+
interface DataIntegrationCustomProviderResponse {
|
|
5563
|
+
name: string;
|
|
5564
|
+
authorization_url: string | null;
|
|
5565
|
+
token_url: string | null;
|
|
5566
|
+
refresh_token_url: string | null;
|
|
5567
|
+
pkce_enabled: boolean;
|
|
5568
|
+
request_scope_separator: string;
|
|
5569
|
+
scopes_required: boolean;
|
|
5570
|
+
client_secret_required: boolean;
|
|
5571
|
+
additional_authorization_parameters: Record<string, string>;
|
|
5572
|
+
token_body_content_type: string;
|
|
5573
|
+
authenticate_via: DataIntegrationCustomProviderAuthenticateVia;
|
|
5574
|
+
}
|
|
5575
|
+
//#endregion
|
|
5576
|
+
//#region src/pipes/interfaces/data-integration-state.interface.d.ts
|
|
5577
|
+
declare const DataIntegrationState: {
|
|
5578
|
+
readonly Valid: "valid";
|
|
5579
|
+
readonly Invalid: "invalid";
|
|
5580
|
+
readonly Requested: "requested";
|
|
5581
|
+
};
|
|
5582
|
+
type DataIntegrationState = (typeof DataIntegrationState)[keyof typeof DataIntegrationState];
|
|
5583
|
+
//#endregion
|
|
5584
|
+
//#region src/pipes/interfaces/data-integration.interface.d.ts
|
|
5585
|
+
interface DataIntegration {
|
|
5586
|
+
/** Distinguishes the Data Integration object. */
|
|
5587
|
+
object: 'data_integration';
|
|
5588
|
+
/** Unique identifier of the Data Integration. */
|
|
5589
|
+
id: string;
|
|
5590
|
+
/** The provider slug for this Data Integration. */
|
|
5591
|
+
slug: string;
|
|
5592
|
+
/** The integration type derived from the provider. */
|
|
5593
|
+
integrationType: string;
|
|
5594
|
+
/** An optional description of the Data Integration. */
|
|
5595
|
+
description: string | null;
|
|
5596
|
+
/** Whether the Data Integration is enabled. */
|
|
5597
|
+
enabled: boolean;
|
|
5598
|
+
/** The state of the Data Integration. */
|
|
5599
|
+
state: DataIntegrationState;
|
|
5600
|
+
/** The OAuth scopes configured for the Data Integration. `null` when the provider's configured scopes are used. */
|
|
5601
|
+
scopes: string[] | null;
|
|
5602
|
+
/** The OAuth redirect URI to register with the provider when configuring the custom application. */
|
|
5603
|
+
redirectUri: string;
|
|
5604
|
+
/** The credentials configured for the Data Integration. */
|
|
5605
|
+
credentials: DataIntegrationCredential;
|
|
5606
|
+
/** The OAuth definition when this is a custom provider; `null` for built-in providers. */
|
|
5607
|
+
customProvider: DataIntegrationCustomProvider | null;
|
|
5608
|
+
/** An ISO 8601 timestamp. */
|
|
5609
|
+
createdAt: Date;
|
|
5610
|
+
/** An ISO 8601 timestamp. */
|
|
5611
|
+
updatedAt: Date;
|
|
4755
5612
|
}
|
|
4756
|
-
interface
|
|
5613
|
+
interface DataIntegrationResponse {
|
|
5614
|
+
object: 'data_integration';
|
|
5615
|
+
id: string;
|
|
5616
|
+
slug: string;
|
|
5617
|
+
integration_type: string;
|
|
5618
|
+
description: string | null;
|
|
5619
|
+
enabled: boolean;
|
|
5620
|
+
state: DataIntegrationState;
|
|
5621
|
+
scopes: string[] | null;
|
|
5622
|
+
redirect_uri: string;
|
|
5623
|
+
credentials: DataIntegrationCredentialResponse;
|
|
5624
|
+
custom_provider: DataIntegrationCustomProviderResponse | null;
|
|
5625
|
+
created_at: string;
|
|
5626
|
+
updated_at: string;
|
|
5627
|
+
}
|
|
5628
|
+
//#endregion
|
|
5629
|
+
//#region src/pipes/interfaces/connected-account-auth-method.interface.d.ts
|
|
5630
|
+
declare const ConnectedAccountAuthMethod: {
|
|
5631
|
+
readonly OAuth: "oauth";
|
|
5632
|
+
readonly ApiKey: "api_key";
|
|
5633
|
+
};
|
|
5634
|
+
type ConnectedAccountAuthMethod = (typeof ConnectedAccountAuthMethod)[keyof typeof ConnectedAccountAuthMethod];
|
|
5635
|
+
//#endregion
|
|
5636
|
+
//#region src/pipes/interfaces/connected-account.interface.d.ts
|
|
5637
|
+
interface ConnectedAccount {
|
|
5638
|
+
/** Distinguishes the connected account object. */
|
|
5639
|
+
object: 'connected_account';
|
|
5640
|
+
/** The unique identifier of the connected account. */
|
|
5641
|
+
id: string;
|
|
5642
|
+
/** The [User](https://workos.com/docs/reference/authkit/user) identifier associated with this connection. */
|
|
5643
|
+
userId: string | null;
|
|
5644
|
+
/** The [Organization](https://workos.com/docs/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization. */
|
|
5645
|
+
organizationId: string | null;
|
|
5646
|
+
/** The OAuth scopes granted for this connection. */
|
|
5647
|
+
scopes: string[];
|
|
5648
|
+
/** The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent. */
|
|
5649
|
+
authMethod?: ConnectedAccountAuthMethod;
|
|
5650
|
+
/** The last four characters of the API key, or `null` for OAuth connections. */
|
|
5651
|
+
apiKeyLast4?: string | null;
|
|
5652
|
+
/**
|
|
5653
|
+
* The state of the connected account:
|
|
5654
|
+
* - `connected`: The connection is active and tokens are valid.
|
|
5655
|
+
* - `needs_reauthorization`: The user needs to reauthorize the connection, typically because required scopes have changed.
|
|
5656
|
+
* - `disconnected`: The connection has been disconnected.
|
|
5657
|
+
*/
|
|
5658
|
+
state: ConnectedAccountState;
|
|
5659
|
+
/** The timestamp when the connection was created. */
|
|
5660
|
+
createdAt: string;
|
|
5661
|
+
/** The timestamp when the connection was last updated. */
|
|
5662
|
+
updatedAt: string;
|
|
5663
|
+
}
|
|
5664
|
+
interface ConnectedAccountResponse {
|
|
5665
|
+
object: 'connected_account';
|
|
5666
|
+
id: string;
|
|
5667
|
+
user_id: string | null;
|
|
5668
|
+
organization_id: string | null;
|
|
5669
|
+
scopes: string[];
|
|
5670
|
+
auth_method?: ConnectedAccountAuthMethod;
|
|
5671
|
+
api_key_last_4?: string | null;
|
|
5672
|
+
state: ConnectedAccountState;
|
|
5673
|
+
created_at: string;
|
|
5674
|
+
updated_at: string;
|
|
5675
|
+
}
|
|
5676
|
+
//#endregion
|
|
5677
|
+
//#region src/pipes/interfaces/data-integration-authorize-url-response.interface.d.ts
|
|
5678
|
+
interface DataIntegrationAuthorizeUrlResponse {
|
|
5679
|
+
/** The OAuth authorization URL to redirect the user to. */
|
|
5680
|
+
url: string;
|
|
5681
|
+
}
|
|
5682
|
+
interface DataIntegrationAuthorizeUrlResponseWire {
|
|
5683
|
+
url: string;
|
|
5684
|
+
}
|
|
5685
|
+
//#endregion
|
|
5686
|
+
//#region src/pipes/interfaces/data-integration-credentials-response-credential.interface.d.ts
|
|
5687
|
+
/** The credential object containing the vended secret. */
|
|
5688
|
+
interface DataIntegrationCredentialsResponseCredential {
|
|
5689
|
+
/** Distinguishes the credential object. */
|
|
5690
|
+
object: 'credential';
|
|
5691
|
+
/** The authentication method for this credential. Additional values may be added in the future; handle unknown values gracefully. */
|
|
5692
|
+
authMethod: 'oauth';
|
|
5693
|
+
/** The OAuth access token. */
|
|
5694
|
+
value: string;
|
|
5695
|
+
/** The ISO-8601 formatted timestamp indicating when the credential expires. */
|
|
5696
|
+
expiresAt: string | null;
|
|
5697
|
+
/** The scopes granted to the access token. */
|
|
5698
|
+
scopes: string[];
|
|
5699
|
+
/** If the integration has requested scopes that aren't present on the access token, they're listed here. */
|
|
5700
|
+
missingScopes: string[];
|
|
5701
|
+
}
|
|
5702
|
+
interface DataIntegrationCredentialsResponseCredentialResponse {
|
|
5703
|
+
object: 'credential';
|
|
5704
|
+
auth_method: 'oauth';
|
|
5705
|
+
value: string;
|
|
5706
|
+
expires_at: string | null;
|
|
5707
|
+
scopes: string[];
|
|
5708
|
+
missing_scopes: string[];
|
|
5709
|
+
}
|
|
5710
|
+
//#endregion
|
|
5711
|
+
//#region src/pipes/interfaces/data-integration-credentials-response-error.interface.d.ts
|
|
5712
|
+
declare const DataIntegrationCredentialsResponseError: {
|
|
5713
|
+
readonly NotInstalled: "not_installed";
|
|
5714
|
+
readonly NeedsReauthorization: "needs_reauthorization";
|
|
5715
|
+
};
|
|
5716
|
+
type DataIntegrationCredentialsResponseError = (typeof DataIntegrationCredentialsResponseError)[keyof typeof DataIntegrationCredentialsResponseError];
|
|
5717
|
+
//#endregion
|
|
5718
|
+
//#region src/pipes/interfaces/data-integration-credentials-response.interface.d.ts
|
|
5719
|
+
interface DataIntegrationCredentialsResponse {
|
|
5720
|
+
/** Indicates credentials are available. */
|
|
5721
|
+
active?: true;
|
|
5722
|
+
/** The credential object containing the vended secret. */
|
|
5723
|
+
credential?: DataIntegrationCredentialsResponseCredential;
|
|
5724
|
+
/**
|
|
5725
|
+
* The reason credentials are unavailable. Additional values may be added in the future; handle unknown values gracefully.
|
|
5726
|
+
* - `"not_installed"`: The user does not have the integration installed.
|
|
5727
|
+
* - `"needs_reauthorization"`: The user needs to reauthorize the integration.
|
|
5728
|
+
*/
|
|
5729
|
+
error?: DataIntegrationCredentialsResponseError;
|
|
5730
|
+
}
|
|
5731
|
+
//#endregion
|
|
5732
|
+
//#region src/pipes/interfaces/data-integration-access-token-response-access-token.interface.d.ts
|
|
5733
|
+
/** The [access token](https://workos.com/docs/reference/pipes/access-token) object, present when `active` is `true`. */
|
|
5734
|
+
interface DataIntegrationAccessTokenResponseAccessToken {
|
|
5735
|
+
/** Distinguishes the access token object. */
|
|
5736
|
+
object: 'access_token';
|
|
5737
|
+
/** The OAuth access token for the connected integration. */
|
|
5738
|
+
accessToken: string;
|
|
5739
|
+
/** The ISO-8601 formatted timestamp indicating when the access token expires. */
|
|
5740
|
+
expiresAt: Date | null;
|
|
5741
|
+
/** The scopes granted to the access token. */
|
|
5742
|
+
scopes: string[];
|
|
5743
|
+
/** If the integration has requested scopes that aren't present on the access token, they're listed here. */
|
|
5744
|
+
missingScopes: string[];
|
|
5745
|
+
}
|
|
5746
|
+
interface DataIntegrationAccessTokenResponseAccessTokenResponse {
|
|
5747
|
+
object: 'access_token';
|
|
5748
|
+
access_token: string;
|
|
5749
|
+
expires_at: string | null;
|
|
5750
|
+
scopes: string[];
|
|
5751
|
+
missing_scopes: string[];
|
|
5752
|
+
}
|
|
5753
|
+
//#endregion
|
|
5754
|
+
//#region src/pipes/interfaces/data-integration-access-token-response.interface.d.ts
|
|
5755
|
+
type DataIntegrationAccessTokenResponse = {
|
|
5756
|
+
active: true;
|
|
5757
|
+
accessToken: DataIntegrationAccessTokenResponseAccessToken;
|
|
5758
|
+
} | {
|
|
4757
5759
|
active: false;
|
|
4758
|
-
error: '
|
|
5760
|
+
error: 'needs_reauthorization' | 'not_installed';
|
|
5761
|
+
};
|
|
5762
|
+
type DataIntegrationAccessTokenResponseWire = {
|
|
5763
|
+
active: true;
|
|
5764
|
+
access_token: DataIntegrationAccessTokenResponseAccessTokenResponse;
|
|
5765
|
+
} | {
|
|
5766
|
+
active: false;
|
|
5767
|
+
error: 'needs_reauthorization' | 'not_installed';
|
|
5768
|
+
};
|
|
5769
|
+
//#endregion
|
|
5770
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data-connected-account-auth-method.interface.d.ts
|
|
5771
|
+
declare const DataIntegrationsListResponseDataConnectedAccountAuthMethod: {
|
|
5772
|
+
readonly OAuth: "oauth";
|
|
5773
|
+
readonly ApiKey: "api_key";
|
|
5774
|
+
};
|
|
5775
|
+
type DataIntegrationsListResponseDataConnectedAccountAuthMethod = (typeof DataIntegrationsListResponseDataConnectedAccountAuthMethod)[keyof typeof DataIntegrationsListResponseDataConnectedAccountAuthMethod];
|
|
5776
|
+
//#endregion
|
|
5777
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data-connected-account-state.interface.d.ts
|
|
5778
|
+
declare const DataIntegrationsListResponseDataConnectedAccountState: {
|
|
5779
|
+
readonly Connected: "connected";
|
|
5780
|
+
readonly NeedsReauthorization: "needs_reauthorization";
|
|
5781
|
+
readonly Disconnected: "disconnected";
|
|
5782
|
+
};
|
|
5783
|
+
type DataIntegrationsListResponseDataConnectedAccountState = (typeof DataIntegrationsListResponseDataConnectedAccountState)[keyof typeof DataIntegrationsListResponseDataConnectedAccountState];
|
|
5784
|
+
//#endregion
|
|
5785
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data-connected-account.interface.d.ts
|
|
5786
|
+
interface DataIntegrationsListResponseDataConnectedAccount {
|
|
5787
|
+
/** Distinguishes the connected account object. */
|
|
5788
|
+
object: 'connected_account';
|
|
5789
|
+
/** The unique identifier of the connected account. */
|
|
5790
|
+
id: string;
|
|
5791
|
+
/** The [User](https://workos.com/docs/reference/authkit/user) identifier associated with this connection. */
|
|
5792
|
+
userId: string | null;
|
|
5793
|
+
/** The [Organization](https://workos.com/docs/reference/organization) identifier associated with this connection, or `null` if not scoped to an organization. */
|
|
5794
|
+
organizationId: string | null;
|
|
5795
|
+
/** The OAuth scopes granted for this connection. */
|
|
5796
|
+
scopes: string[];
|
|
5797
|
+
/** The authentication method used for this connection (`oauth` or `api_key`). Defaults to `oauth` if absent. */
|
|
5798
|
+
authMethod?: DataIntegrationsListResponseDataConnectedAccountAuthMethod;
|
|
5799
|
+
/** The last four characters of the API key, or `null` for OAuth connections. */
|
|
5800
|
+
apiKeyLast4?: string | null;
|
|
5801
|
+
/**
|
|
5802
|
+
* The state of the connected account:
|
|
5803
|
+
* - `connected`: The connection is active and tokens are valid.
|
|
5804
|
+
* - `needs_reauthorization`: The user needs to reauthorize the connection, typically because required scopes have changed.
|
|
5805
|
+
* - `disconnected`: The connection has been disconnected.
|
|
5806
|
+
*/
|
|
5807
|
+
state: DataIntegrationsListResponseDataConnectedAccountState;
|
|
5808
|
+
/** The timestamp when the connection was created. */
|
|
5809
|
+
createdAt: string;
|
|
5810
|
+
/** The timestamp when the connection was last updated. */
|
|
5811
|
+
updatedAt: string;
|
|
5812
|
+
/**
|
|
5813
|
+
* Use `user_id` instead.
|
|
5814
|
+
* @deprecated
|
|
5815
|
+
*/
|
|
5816
|
+
userlandUserId: string | null;
|
|
5817
|
+
}
|
|
5818
|
+
interface DataIntegrationsListResponseDataConnectedAccountResponse {
|
|
5819
|
+
object: 'connected_account';
|
|
5820
|
+
id: string;
|
|
5821
|
+
user_id: string | null;
|
|
5822
|
+
organization_id: string | null;
|
|
5823
|
+
scopes: string[];
|
|
5824
|
+
auth_method?: DataIntegrationsListResponseDataConnectedAccountAuthMethod;
|
|
5825
|
+
api_key_last_4?: string | null;
|
|
5826
|
+
state: DataIntegrationsListResponseDataConnectedAccountState;
|
|
5827
|
+
created_at: string;
|
|
5828
|
+
updated_at: string;
|
|
5829
|
+
userland_user_id: string | null;
|
|
5830
|
+
}
|
|
5831
|
+
//#endregion
|
|
5832
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data-auth-methods.interface.d.ts
|
|
5833
|
+
declare const DataIntegrationsListResponseDataAuthMethods: {
|
|
5834
|
+
readonly OAuth: "oauth";
|
|
5835
|
+
readonly ApiKey: "api_key";
|
|
5836
|
+
};
|
|
5837
|
+
type DataIntegrationsListResponseDataAuthMethods = (typeof DataIntegrationsListResponseDataAuthMethods)[keyof typeof DataIntegrationsListResponseDataAuthMethods];
|
|
5838
|
+
//#endregion
|
|
5839
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data-ownership.interface.d.ts
|
|
5840
|
+
declare const DataIntegrationsListResponseDataOwnership: {
|
|
5841
|
+
readonly UserlandUser: "userland_user";
|
|
5842
|
+
readonly Organization: "organization";
|
|
5843
|
+
};
|
|
5844
|
+
type DataIntegrationsListResponseDataOwnership = (typeof DataIntegrationsListResponseDataOwnership)[keyof typeof DataIntegrationsListResponseDataOwnership];
|
|
5845
|
+
//#endregion
|
|
5846
|
+
//#region src/pipes/interfaces/data-integrations-list-response-data.interface.d.ts
|
|
5847
|
+
interface DataIntegrationsListResponseData {
|
|
5848
|
+
/** Distinguishes the data provider object. */
|
|
5849
|
+
object: 'data_provider';
|
|
5850
|
+
/** The unique identifier of the provider. */
|
|
5851
|
+
id: string;
|
|
5852
|
+
/** The display name of the provider (e.g., "GitHub", "Slack"). */
|
|
5853
|
+
name: string;
|
|
5854
|
+
/** A description of the provider explaining how it will be used, if configured. */
|
|
5855
|
+
description: string | null;
|
|
5856
|
+
/** The slug identifier used in API calls (e.g., `github`, `slack`, `notion`). */
|
|
5857
|
+
slug: string;
|
|
5858
|
+
/** The type of integration (e.g., `github`, `slack`). */
|
|
5859
|
+
integrationType: string;
|
|
5860
|
+
/** The type of credentials used by the provider (e.g., `oauth2`). */
|
|
5861
|
+
credentialsType: string;
|
|
5862
|
+
/** The OAuth scopes configured for this provider, or `null` if none are configured. */
|
|
5863
|
+
scopes: string[] | null;
|
|
5864
|
+
/** The authentication methods supported by this provider (`oauth`, `api_key`, or both). Defaults to `["oauth"]` if absent. */
|
|
5865
|
+
authMethods?: DataIntegrationsListResponseDataAuthMethods[];
|
|
5866
|
+
/** Whether the provider is owned by a user or organization. */
|
|
5867
|
+
ownership: DataIntegrationsListResponseDataOwnership;
|
|
5868
|
+
/** The timestamp when the provider was created. */
|
|
5869
|
+
createdAt: string;
|
|
5870
|
+
/** The timestamp when the provider was last updated. */
|
|
5871
|
+
updatedAt: string;
|
|
5872
|
+
/** The user's [connected account](https://workos.com/docs/reference/pipes/connected-account) for this provider, or `null` if the user has not connected. */
|
|
5873
|
+
connectedAccount: DataIntegrationsListResponseDataConnectedAccount | null;
|
|
5874
|
+
}
|
|
5875
|
+
interface DataIntegrationsListResponseDataResponse {
|
|
5876
|
+
object: 'data_provider';
|
|
5877
|
+
id: string;
|
|
5878
|
+
name: string;
|
|
5879
|
+
description: string | null;
|
|
5880
|
+
slug: string;
|
|
5881
|
+
integration_type: string;
|
|
5882
|
+
credentials_type: string;
|
|
5883
|
+
scopes: string[] | null;
|
|
5884
|
+
auth_methods?: DataIntegrationsListResponseDataAuthMethods[];
|
|
5885
|
+
ownership: DataIntegrationsListResponseDataOwnership;
|
|
5886
|
+
created_at: string;
|
|
5887
|
+
updated_at: string;
|
|
5888
|
+
connected_account: DataIntegrationsListResponseDataConnectedAccountResponse | null;
|
|
5889
|
+
}
|
|
5890
|
+
//#endregion
|
|
5891
|
+
//#region src/pipes/interfaces/data-integrations-list-response.interface.d.ts
|
|
5892
|
+
interface DataIntegrationsListResponse {
|
|
5893
|
+
/** Indicates this is a list response. */
|
|
5894
|
+
object: 'list';
|
|
5895
|
+
/** A list of [providers](https://workos.com/docs/reference/pipes/provider), each including a [`connected_account`](https://workos.com/docs/reference/pipes/connected-account) field with the user's connection status. */
|
|
5896
|
+
data: DataIntegrationsListResponseData[];
|
|
5897
|
+
}
|
|
5898
|
+
interface DataIntegrationsListResponseWire {
|
|
5899
|
+
object: 'list';
|
|
5900
|
+
data: DataIntegrationsListResponseDataResponse[];
|
|
4759
5901
|
}
|
|
4760
|
-
type SerializedGetAccessTokenResponse = SerializedGetAccessTokenSuccessResponse | SerializedGetAccessTokenFailureResponse;
|
|
4761
5902
|
//#endregion
|
|
4762
5903
|
//#region src/pipes/pipes.d.ts
|
|
4763
5904
|
declare class Pipes {
|
|
4764
5905
|
private readonly workos;
|
|
4765
5906
|
constructor(workos: WorkOS);
|
|
4766
|
-
|
|
4767
|
-
|
|
4768
|
-
|
|
4769
|
-
|
|
4770
|
-
|
|
4771
|
-
|
|
5907
|
+
/**
|
|
5908
|
+
* List data integrations
|
|
5909
|
+
*
|
|
5910
|
+
* Lists the environment's data integrations configured with `custom` or `organization` credentials, including custom providers.
|
|
5911
|
+
* @param options - Pagination and filter options.
|
|
5912
|
+
* @returns {Promise<AutoPaginatable<DataIntegration, PaginationOptions>>}
|
|
5913
|
+
* @throws {UnauthorizedException} 401
|
|
5914
|
+
*/
|
|
5915
|
+
listDataIntegrations(options?: PaginationOptions): Promise<AutoPaginatable<DataIntegration, PaginationOptions>>;
|
|
5916
|
+
/**
|
|
5917
|
+
* Create a data integration
|
|
5918
|
+
*
|
|
5919
|
+
* Creates a data integration for a provider. Set `credentials.type` to `custom` to use your own OAuth app credentials, or `organization` to have each organization supply its own. For a built-in provider, pass its slug as `provider`. For a custom provider, pass a new slug plus a `custom_provider` definition.
|
|
5920
|
+
* @param options - Object containing provider.
|
|
5921
|
+
* @param options.provider - The provider to create a Data Integration for. For a built-in provider use its slug (e.g. `github`, `slack`). For a custom provider, this is the new provider slug and `custom_provider` must be supplied. A custom provider slug cannot shadow an existing global provider slug.
|
|
5922
|
+
* @example "github"
|
|
5923
|
+
* @param options.description - An optional description of the Data Integration.
|
|
5924
|
+
* @example "Production GitHub app"
|
|
5925
|
+
* @param options.enabled - Whether the Data Integration is enabled. Defaults to `false`.
|
|
5926
|
+
* @example true
|
|
5927
|
+
* @param options.scopes - The OAuth scopes to request for the Data Integration. Defaults to the provider's configured scopes when omitted.
|
|
5928
|
+
* @example ["repo","read:org"]
|
|
5929
|
+
* @param options.credentials - The credentials to configure for the Data Integration. Required for both built-in and custom providers.
|
|
5930
|
+
* @param options.customProvider - The OAuth definition for a custom provider. Supply this to define a custom provider; omit it to create an integration for a built-in provider.
|
|
5931
|
+
* @returns {Promise<DataIntegration>}
|
|
5932
|
+
* @throws {BadRequestException} 400
|
|
5933
|
+
* @throws {UnauthorizedException} 401
|
|
5934
|
+
* @throws {NotFoundException} 404
|
|
5935
|
+
* @throws {UnprocessableEntityException} 422
|
|
5936
|
+
*/
|
|
5937
|
+
createDataIntegration(options: CreateDataIntegrationOptions): Promise<DataIntegration>;
|
|
5938
|
+
/**
|
|
5939
|
+
* Get a data integration
|
|
5940
|
+
*
|
|
5941
|
+
* Retrieves a data integration by its slug.
|
|
5942
|
+
* @param options - The request options.
|
|
5943
|
+
* @param options.slug - The slug identifier of the data integration.
|
|
5944
|
+
* @example "github"
|
|
5945
|
+
* @returns {Promise<DataIntegration>}
|
|
5946
|
+
* @throws {UnauthorizedException} 401
|
|
5947
|
+
* @throws {NotFoundException} 404
|
|
5948
|
+
*/
|
|
5949
|
+
getDataIntegration(options: GetDataIntegrationOptions): Promise<DataIntegration>;
|
|
5950
|
+
/**
|
|
5951
|
+
* Update a data integration
|
|
5952
|
+
*
|
|
5953
|
+
* Updates the description, enabled state, or custom credentials of a data integration. For custom providers, `custom_provider` updates the OAuth definition.
|
|
5954
|
+
* @param options - The request body.
|
|
5955
|
+
* @param options.slug - The slug identifier of the data integration.
|
|
5956
|
+
* @example "github"
|
|
5957
|
+
* @param options.description - An optional description of the Data Integration.
|
|
5958
|
+
* @example "Production GitHub app"
|
|
5959
|
+
* @param options.enabled - Whether the Data Integration is enabled.
|
|
5960
|
+
* @example true
|
|
5961
|
+
* @param options.scopes - The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes.
|
|
5962
|
+
* @example ["repo","read:org"]
|
|
5963
|
+
* @param options.credentials - New credentials for the Data Integration. When provided, rotates the stored client secret.
|
|
5964
|
+
* @param options.customProvider - Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations.
|
|
5965
|
+
* @returns {Promise<DataIntegration>}
|
|
5966
|
+
* @throws {BadRequestException} 400
|
|
5967
|
+
* @throws {UnauthorizedException} 401
|
|
5968
|
+
* @throws {NotFoundException} 404
|
|
5969
|
+
* @throws {UnprocessableEntityException} 422
|
|
5970
|
+
*/
|
|
5971
|
+
updateDataIntegration(options: UpdateDataIntegrationOptions): Promise<DataIntegration>;
|
|
5972
|
+
/**
|
|
5973
|
+
* Delete a data integration
|
|
5974
|
+
*
|
|
5975
|
+
* Deletes a data integration and all of its connected installations. For a custom provider, also deletes the custom provider definition.
|
|
5976
|
+
* @param options - The request options.
|
|
5977
|
+
* @param options.slug - The slug identifier of the data integration.
|
|
5978
|
+
* @example "github"
|
|
5979
|
+
* @returns {Promise<void>}
|
|
5980
|
+
* @throws {UnauthorizedException} 401
|
|
5981
|
+
* @throws {NotFoundException} 404
|
|
5982
|
+
*/
|
|
5983
|
+
deleteDataIntegration(options: DeleteDataIntegrationOptions): Promise<void>;
|
|
5984
|
+
/**
|
|
5985
|
+
* Upsert an API key for a connected account
|
|
5986
|
+
*
|
|
5987
|
+
* Creates or updates an API-key-based installation for the specified integration and user. If an installation already exists, the stored API key is rotated to the new value.
|
|
5988
|
+
* @param options - Object containing userId, secret.
|
|
5989
|
+
* @param options.slug - The identifier of the integration.
|
|
5990
|
+
* @example "github"
|
|
5991
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
5992
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5993
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
|
|
5994
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
5995
|
+
* @param options.secret - The API key secret to store for this integration.
|
|
5996
|
+
* @example "sk-1234567890abcdef"
|
|
5997
|
+
* @returns {Promise<ConnectedAccount>}
|
|
5998
|
+
* @throws {BadRequestException} 400
|
|
5999
|
+
* @throws {UnauthorizedException} 401
|
|
6000
|
+
* @throws {AuthorizationException} 403
|
|
6001
|
+
* @throws {NotFoundException} 404
|
|
6002
|
+
* @throws {UnprocessableEntityException} 422
|
|
6003
|
+
*/
|
|
6004
|
+
updateDataIntegrationApiKey(options: UpdateDataIntegrationApiKeyOptions): Promise<ConnectedAccount>;
|
|
6005
|
+
/**
|
|
6006
|
+
* Get authorization URL
|
|
6007
|
+
*
|
|
6008
|
+
* Generates an OAuth authorization URL to initiate the connection flow for a user. Redirect the user to the returned URL to begin the OAuth flow with the third-party provider.
|
|
6009
|
+
* @param options - Object containing userId.
|
|
6010
|
+
* @param options.slug - The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
6011
|
+
* @example "github"
|
|
6012
|
+
* @param options.userId - The ID of the user to authorize.
|
|
6013
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6014
|
+
* @param options.organizationId - An organization ID to scope the authorization to a specific organization.
|
|
6015
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6016
|
+
* @param options.returnTo - The URL to redirect the user to after authorization.
|
|
6017
|
+
* @example "https://example.com/callback"
|
|
6018
|
+
* @returns {Promise<DataIntegrationAuthorizeUrlResponse>}
|
|
6019
|
+
* @throws {BadRequestException} 400
|
|
6020
|
+
* @throws {UnauthorizedException} 401
|
|
6021
|
+
* @throws {AuthorizationException} 403
|
|
6022
|
+
* @throws {NotFoundException} 404
|
|
6023
|
+
*/
|
|
6024
|
+
authorizeDataIntegration(options: AuthorizeDataIntegrationOptions): Promise<DataIntegrationAuthorizeUrlResponse>;
|
|
6025
|
+
/**
|
|
6026
|
+
* Vend credentials for a connected account
|
|
6027
|
+
*
|
|
6028
|
+
* Returns credentials for a user's connected account. Branches on the installation's `auth_method`: OAuth installations return an access token (refreshed if needed); API-key installations return the stored secret.
|
|
6029
|
+
* @param options - Object containing userId.
|
|
6030
|
+
* @param options.slug - The identifier of the integration.
|
|
6031
|
+
* @example "github"
|
|
6032
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6033
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6034
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
|
|
6035
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6036
|
+
* @returns {Promise<DataIntegrationCredentialsResponse>}
|
|
6037
|
+
* @throws {BadRequestException} 400
|
|
6038
|
+
* @throws {UnauthorizedException} 401
|
|
6039
|
+
* @throws {NotFoundException} 404
|
|
6040
|
+
*/
|
|
6041
|
+
createDataIntegrationCredential(options: CreateDataIntegrationCredentialOptions): Promise<DataIntegrationCredentialsResponse>;
|
|
6042
|
+
/**
|
|
6043
|
+
* Get an access token for a connected account
|
|
6044
|
+
*
|
|
6045
|
+
* Fetches a valid OAuth access token for a user's connected account. WorkOS automatically handles token refresh, ensuring you always receive a valid, non-expired token.
|
|
6046
|
+
* @param options - Object containing userId.
|
|
6047
|
+
* @param options.provider - The identifier of the integration.
|
|
6048
|
+
* @example "github"
|
|
6049
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6050
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6051
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to scope the connection to a specific organization.
|
|
6052
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6053
|
+
* @returns {Promise<DataIntegrationAccessTokenResponse>}
|
|
6054
|
+
* @throws {BadRequestException} 400
|
|
6055
|
+
* @throws {UnauthorizedException} 401
|
|
6056
|
+
* @throws {NotFoundException} 404
|
|
6057
|
+
* @throws {UnprocessableEntityException} 422
|
|
6058
|
+
*/
|
|
6059
|
+
getAccessToken(options: GetAccessTokenOptions): Promise<DataIntegrationAccessTokenResponse>;
|
|
6060
|
+
/**
|
|
6061
|
+
* Get a connected account
|
|
6062
|
+
*
|
|
6063
|
+
* Retrieves a user's [connected account](https://workos.com/docs/reference/pipes/connected-account) for a specific provider.
|
|
6064
|
+
* @param options - Additional query options.
|
|
6065
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6066
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6067
|
+
* @param options.slug - The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
6068
|
+
* @example "github"
|
|
6069
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
|
|
6070
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6071
|
+
* @returns {Promise<ConnectedAccount>}
|
|
6072
|
+
* @throws {UnauthorizedException} 401
|
|
6073
|
+
* @throws {NotFoundException} 404
|
|
6074
|
+
*/
|
|
6075
|
+
getUserConnectedAccount(options: GetUserConnectedAccountOptions): Promise<ConnectedAccount>;
|
|
6076
|
+
/**
|
|
6077
|
+
* Import a connected account
|
|
6078
|
+
*
|
|
6079
|
+
* Imports a [connected account](https://workos.com/docs/reference/pipes/connected-account) for a user by providing OAuth tokens directly. Use this to migrate existing connections or set up connections without going through the OAuth flow.
|
|
6080
|
+
* @param options - The request body.
|
|
6081
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6082
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6083
|
+
* @param options.slug - The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
6084
|
+
* @example "github"
|
|
6085
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
|
|
6086
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6087
|
+
* @param options.accessToken - The OAuth access token for the connected account.
|
|
6088
|
+
* @example "gho_16C7e42F292c6912E7710c838347Ae178B4a"
|
|
6089
|
+
* @param options.refreshToken - The OAuth refresh token for the connected account.
|
|
6090
|
+
* @example "ghr_xxxxxxxxxxxxxxxxxxxx"
|
|
6091
|
+
* @param options.expiresAt - The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
|
|
6092
|
+
* @example "2025-12-31T23:59:59.000Z"
|
|
6093
|
+
* @param options.scopes - The OAuth scopes granted for this connection.
|
|
6094
|
+
* @example ["repo","user:email"]
|
|
6095
|
+
* @param options.state - Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
|
|
6096
|
+
* @example "connected"
|
|
6097
|
+
* @returns {Promise<ConnectedAccount>}
|
|
6098
|
+
* @throws {UnauthorizedException} 401
|
|
6099
|
+
* @throws {NotFoundException} 404
|
|
6100
|
+
* @throws {ConflictException} 409
|
|
6101
|
+
* @throws {UnprocessableEntityException} 422
|
|
6102
|
+
*/
|
|
6103
|
+
createUserConnectedAccount(options: CreateUserConnectedAccountOptions): Promise<ConnectedAccount>;
|
|
6104
|
+
/**
|
|
6105
|
+
* Update a connected account
|
|
6106
|
+
*
|
|
6107
|
+
* Updates a user's [connected account](https://workos.com/docs/reference/pipes/connected-account) tokens, scopes, or state for a specific provider.
|
|
6108
|
+
* @param options - The request body.
|
|
6109
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6110
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6111
|
+
* @param options.slug - The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
6112
|
+
* @example "github"
|
|
6113
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
|
|
6114
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6115
|
+
* @param options.accessToken - The OAuth access token for the connected account.
|
|
6116
|
+
* @example "gho_16C7e42F292c6912E7710c838347Ae178B4a"
|
|
6117
|
+
* @param options.refreshToken - The OAuth refresh token for the connected account.
|
|
6118
|
+
* @example "ghr_xxxxxxxxxxxxxxxxxxxx"
|
|
6119
|
+
* @param options.expiresAt - The ISO-8601 timestamp when the access token expires. Required when `access_token` is provided for tokens that expire.
|
|
6120
|
+
* @example "2025-12-31T23:59:59.000Z"
|
|
6121
|
+
* @param options.scopes - The OAuth scopes granted for this connection.
|
|
6122
|
+
* @example ["repo","user:email"]
|
|
6123
|
+
* @param options.state - Explicitly set the state of the connected account. When omitted, the state is derived from the token combination provided.
|
|
6124
|
+
* @example "connected"
|
|
6125
|
+
* @returns {Promise<ConnectedAccount>}
|
|
6126
|
+
* @throws {UnauthorizedException} 401
|
|
6127
|
+
* @throws {NotFoundException} 404
|
|
6128
|
+
*/
|
|
6129
|
+
updateUserConnectedAccount(options: UpdateUserConnectedAccountOptions): Promise<ConnectedAccount>;
|
|
6130
|
+
/**
|
|
6131
|
+
* Delete a connected account
|
|
6132
|
+
*
|
|
6133
|
+
* Disconnects WorkOS's account for the user, including removing any stored access and refresh tokens. The user will need to reauthorize if they want to reconnect. This does not revoke access on the provider side.
|
|
6134
|
+
* @param options - Additional query options.
|
|
6135
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier.
|
|
6136
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6137
|
+
* @param options.slug - The slug identifier of the provider (e.g., `github`, `slack`, `notion`).
|
|
6138
|
+
* @example "github"
|
|
6139
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter if the connection is scoped to an organization.
|
|
6140
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6141
|
+
* @returns {Promise<void>}
|
|
6142
|
+
* @throws {UnauthorizedException} 401
|
|
6143
|
+
* @throws {NotFoundException} 404
|
|
6144
|
+
*/
|
|
6145
|
+
deleteUserConnectedAccount(options: DeleteUserConnectedAccountOptions): Promise<void>;
|
|
6146
|
+
/**
|
|
6147
|
+
* List providers for a user
|
|
6148
|
+
*
|
|
6149
|
+
* Retrieves a list of available providers and the user's connection status for each. Returns all providers configured for your environment, along with the user's [connected account](https://workos.com/docs/reference/pipes/connected-account) information where applicable.
|
|
6150
|
+
* @param options - Additional query options.
|
|
6151
|
+
* @param options.userId - A [User](https://workos.com/docs/reference/authkit/user) identifier to list providers and connected accounts for.
|
|
6152
|
+
* @example "user_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6153
|
+
* @param options.organizationId - An [Organization](https://workos.com/docs/reference/organization) identifier. Optional parameter to filter connections for a specific organization.
|
|
6154
|
+
* @example "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6155
|
+
* @returns {Promise<DataIntegrationsListResponse>}
|
|
6156
|
+
* @throws {UnauthorizedException} 401
|
|
6157
|
+
* @throws {NotFoundException} 404
|
|
6158
|
+
*/
|
|
6159
|
+
listUserDataProviders(options: ListUserDataProvidersOptions): Promise<DataIntegrationsListResponse>;
|
|
4772
6160
|
}
|
|
4773
6161
|
//#endregion
|
|
4774
6162
|
//#region src/radar/interfaces/radar-standalone-assess-request-auth-method.interface.d.ts
|
|
@@ -5004,14 +6392,7 @@ declare class AdminPortal {
|
|
|
5004
6392
|
* @throws {NotFoundException} 404
|
|
5005
6393
|
* @throws {UnprocessableEntityException} 422
|
|
5006
6394
|
*/
|
|
5007
|
-
generateLink({
|
|
5008
|
-
intent,
|
|
5009
|
-
organization,
|
|
5010
|
-
returnUrl,
|
|
5011
|
-
successUrl,
|
|
5012
|
-
intentOptions,
|
|
5013
|
-
adminEmails
|
|
5014
|
-
}: {
|
|
6395
|
+
generateLink({ intent, organization, returnUrl, successUrl, intentOptions, adminEmails }: {
|
|
5015
6396
|
intent?: GenerateLinkIntent;
|
|
5016
6397
|
organization: string;
|
|
5017
6398
|
returnUrl?: string;
|
|
@@ -5109,11 +6490,7 @@ declare class SSO {
|
|
|
5109
6490
|
*
|
|
5110
6491
|
* @throws Error if neither codeVerifier nor API key is available
|
|
5111
6492
|
*/
|
|
5112
|
-
getProfileAndToken<CustomAttributesType extends UnknownRecord = UnknownRecord>({
|
|
5113
|
-
code,
|
|
5114
|
-
clientId,
|
|
5115
|
-
codeVerifier
|
|
5116
|
-
}: GetProfileAndTokenOptions): Promise<ProfileAndToken<CustomAttributesType>>;
|
|
6493
|
+
getProfileAndToken<CustomAttributesType extends UnknownRecord = UnknownRecord>({ code, clientId, codeVerifier }: GetProfileAndTokenOptions): Promise<ProfileAndToken<CustomAttributesType>>;
|
|
5117
6494
|
/**
|
|
5118
6495
|
* Get a User Profile
|
|
5119
6496
|
*
|
|
@@ -5122,9 +6499,7 @@ declare class SSO {
|
|
|
5122
6499
|
* @throws {UnauthorizedException} 401
|
|
5123
6500
|
* @throws {NotFoundException} 404
|
|
5124
6501
|
*/
|
|
5125
|
-
getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({
|
|
5126
|
-
accessToken
|
|
5127
|
-
}: GetProfileOptions): Promise<Profile<CustomAttributesType>>;
|
|
6502
|
+
getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({ accessToken }: GetProfileOptions): Promise<Profile<CustomAttributesType>>;
|
|
5128
6503
|
}
|
|
5129
6504
|
//#endregion
|
|
5130
6505
|
//#region src/multi-factor-auth/interfaces/challenge-factor-options.d.ts
|
|
@@ -5167,53 +6542,6 @@ type EnrollFactorOptions = {
|
|
|
5167
6542
|
type: 'generic_otp';
|
|
5168
6543
|
};
|
|
5169
6544
|
//#endregion
|
|
5170
|
-
//#region src/multi-factor-auth/interfaces/sms.interface.d.ts
|
|
5171
|
-
interface Sms {
|
|
5172
|
-
phoneNumber: string;
|
|
5173
|
-
}
|
|
5174
|
-
interface SmsResponse {
|
|
5175
|
-
phone_number: string;
|
|
5176
|
-
}
|
|
5177
|
-
//#endregion
|
|
5178
|
-
//#region src/multi-factor-auth/interfaces/factor.interface.d.ts
|
|
5179
|
-
type FactorType = 'sms' | 'totp' | 'generic_otp';
|
|
5180
|
-
interface Factor {
|
|
5181
|
-
object: 'authentication_factor';
|
|
5182
|
-
id: string;
|
|
5183
|
-
createdAt: string;
|
|
5184
|
-
updatedAt: string;
|
|
5185
|
-
type: FactorType;
|
|
5186
|
-
sms?: Sms;
|
|
5187
|
-
totp?: Totp;
|
|
5188
|
-
}
|
|
5189
|
-
interface FactorWithSecrets {
|
|
5190
|
-
object: 'authentication_factor';
|
|
5191
|
-
id: string;
|
|
5192
|
-
createdAt: string;
|
|
5193
|
-
updatedAt: string;
|
|
5194
|
-
type: FactorType;
|
|
5195
|
-
sms?: Sms;
|
|
5196
|
-
totp?: TotpWithSecrets;
|
|
5197
|
-
}
|
|
5198
|
-
interface FactorResponse {
|
|
5199
|
-
object: 'authentication_factor';
|
|
5200
|
-
id: string;
|
|
5201
|
-
created_at: string;
|
|
5202
|
-
updated_at: string;
|
|
5203
|
-
type: FactorType;
|
|
5204
|
-
sms?: SmsResponse;
|
|
5205
|
-
totp?: TotpResponse;
|
|
5206
|
-
}
|
|
5207
|
-
interface FactorWithSecretsResponse {
|
|
5208
|
-
object: 'authentication_factor';
|
|
5209
|
-
id: string;
|
|
5210
|
-
created_at: string;
|
|
5211
|
-
updated_at: string;
|
|
5212
|
-
type: FactorType;
|
|
5213
|
-
sms?: SmsResponse;
|
|
5214
|
-
totp?: TotpWithSecretsResponse;
|
|
5215
|
-
}
|
|
5216
|
-
//#endregion
|
|
5217
6545
|
//#region src/multi-factor-auth/interfaces/verify-challenge-options.d.ts
|
|
5218
6546
|
interface VerifyChallengeOptions {
|
|
5219
6547
|
authenticationChallengeId: string;
|
|
@@ -5775,13 +7103,16 @@ type CryptoKey = Extract<Awaited<ReturnType<typeof crypto.subtle.generateKey>>,
|
|
|
5775
7103
|
*/
|
|
5776
7104
|
declare const customFetch: unique symbol;
|
|
5777
7105
|
/** See {@link customFetch}. */
|
|
5778
|
-
type FetchImplementation = (
|
|
5779
|
-
|
|
5780
|
-
url: string,
|
|
5781
|
-
|
|
7106
|
+
type FetchImplementation = (
|
|
7107
|
+
/** URL the request is being made sent to {@link !fetch} as the `resource` argument */
|
|
7108
|
+
url: string,
|
|
7109
|
+
/** Options otherwise sent to {@link !fetch} as the `options` argument */
|
|
5782
7110
|
options: {
|
|
5783
|
-
/** HTTP Headers */
|
|
5784
|
-
|
|
7111
|
+
/** HTTP Headers */
|
|
7112
|
+
headers: Headers;
|
|
7113
|
+
/** The {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods request method} */
|
|
7114
|
+
method: 'GET';
|
|
7115
|
+
/** See {@link !Request.redirect} */
|
|
5785
7116
|
redirect: 'manual';
|
|
5786
7117
|
signal: AbortSignal;
|
|
5787
7118
|
}) => Promise<Response>;
|
|
@@ -5896,11 +7227,16 @@ type JWKSCacheInput = ExportedJWKSCache | Record<string, never>;
|
|
|
5896
7227
|
* @param options Options for the remote JSON Web Key Set.
|
|
5897
7228
|
*/
|
|
5898
7229
|
declare function createRemoteJWKSet(url: URL, options?: RemoteJWKSetOptions): {
|
|
5899
|
-
(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<CryptoKey>;
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
|
|
5903
|
-
|
|
7230
|
+
(protectedHeader?: JWSHeaderParameters, token?: FlattenedJWSInput): Promise<CryptoKey>;
|
|
7231
|
+
/** @ignore */
|
|
7232
|
+
coolingDown: boolean;
|
|
7233
|
+
/** @ignore */
|
|
7234
|
+
fresh: boolean;
|
|
7235
|
+
/** @ignore */
|
|
7236
|
+
reloading: boolean;
|
|
7237
|
+
/** @ignore */
|
|
7238
|
+
reload: () => Promise<void>;
|
|
7239
|
+
/** @ignore */
|
|
5904
7240
|
jwks: () => JSONWebKeySet | undefined;
|
|
5905
7241
|
};
|
|
5906
7242
|
//#endregion
|
|
@@ -5941,9 +7277,7 @@ declare class CookieSession {
|
|
|
5941
7277
|
*
|
|
5942
7278
|
* @returns The URL to redirect the user to for logging out.
|
|
5943
7279
|
*/
|
|
5944
|
-
getLogoutUrl({
|
|
5945
|
-
returnTo
|
|
5946
|
-
}?: {
|
|
7280
|
+
getLogoutUrl({ returnTo }?: {
|
|
5947
7281
|
returnTo?: string;
|
|
5948
7282
|
}): Promise<string>;
|
|
5949
7283
|
private isValidJwt;
|
|
@@ -6061,17 +7395,11 @@ declare class UserManagement {
|
|
|
6061
7395
|
authenticateWithRadarSmsChallenge(payload: AuthenticateWithRadarSmsChallengeOptions): Promise<AuthenticationResponse>;
|
|
6062
7396
|
/** Authenticate with Radar email challenge. */
|
|
6063
7397
|
authenticateWithRadarEmailChallenge(payload: AuthenticateWithRadarEmailChallengeOptions): Promise<AuthenticationResponse>;
|
|
6064
|
-
authenticateWithSessionCookie({
|
|
6065
|
-
sessionData,
|
|
6066
|
-
cookiePassword
|
|
6067
|
-
}: AuthenticateWithSessionCookieOptions): Promise<AuthenticateWithSessionCookieSuccessResponse | AuthenticateWithSessionCookieFailedResponse>;
|
|
7398
|
+
authenticateWithSessionCookie({ sessionData, cookiePassword }: AuthenticateWithSessionCookieOptions): Promise<AuthenticateWithSessionCookieSuccessResponse | AuthenticateWithSessionCookieFailedResponse>;
|
|
6068
7399
|
private isValidJwt;
|
|
6069
7400
|
private prepareAuthenticationResponse;
|
|
6070
7401
|
private sealSessionDataFromAuthenticationResponse;
|
|
6071
|
-
getSessionFromCookie({
|
|
6072
|
-
sessionData,
|
|
6073
|
-
cookiePassword
|
|
6074
|
-
}: SessionHandlerOptions): Promise<SessionCookieData | undefined>;
|
|
7402
|
+
getSessionFromCookie({ sessionData, cookiePassword }: SessionHandlerOptions): Promise<SessionCookieData | undefined>;
|
|
6075
7403
|
/**
|
|
6076
7404
|
* Get an email verification code
|
|
6077
7405
|
*
|
|
@@ -6089,9 +7417,7 @@ declare class UserManagement {
|
|
|
6089
7417
|
* @throws {NotFoundException} 404
|
|
6090
7418
|
* @throws {RateLimitExceededException} 429
|
|
6091
7419
|
*/
|
|
6092
|
-
sendVerificationEmail({
|
|
6093
|
-
userId
|
|
6094
|
-
}: SendVerificationEmailOptions): Promise<{
|
|
7420
|
+
sendVerificationEmail({ userId }: SendVerificationEmailOptions): Promise<{
|
|
6095
7421
|
user: User;
|
|
6096
7422
|
}>;
|
|
6097
7423
|
/**
|
|
@@ -6123,10 +7449,7 @@ declare class UserManagement {
|
|
|
6123
7449
|
* @throws {NotFoundException} 404
|
|
6124
7450
|
* @throws {UnprocessableEntityException} 422
|
|
6125
7451
|
*/
|
|
6126
|
-
verifyEmail({
|
|
6127
|
-
code,
|
|
6128
|
-
userId
|
|
6129
|
-
}: VerifyEmailOptions): Promise<{
|
|
7452
|
+
verifyEmail({ code, userId }: VerifyEmailOptions): Promise<{
|
|
6130
7453
|
user: User;
|
|
6131
7454
|
}>;
|
|
6132
7455
|
/**
|
|
@@ -6182,6 +7505,28 @@ declare class UserManagement {
|
|
|
6182
7505
|
* @throws {NotFoundException} 404
|
|
6183
7506
|
*/
|
|
6184
7507
|
deleteUser(userId: string): Promise<void>;
|
|
7508
|
+
/**
|
|
7509
|
+
* List API keys for a user
|
|
7510
|
+
*
|
|
7511
|
+
* Get a list of API keys owned by a specific user.
|
|
7512
|
+
* @param userId - Unique identifier of the user.
|
|
7513
|
+
* @param options - Pagination and filter options.
|
|
7514
|
+
* @returns {Promise<AutoPaginatable<UserApiKey, SerializedListUserApiKeysOptions>>}
|
|
7515
|
+
* @throws {NotFoundException} 404
|
|
7516
|
+
*/
|
|
7517
|
+
listUserApiKeys(userId: string, options?: ListUserApiKeysOptions): Promise<AutoPaginatable<UserApiKey, SerializedListUserApiKeysOptions>>;
|
|
7518
|
+
/**
|
|
7519
|
+
* Create an API key for a user
|
|
7520
|
+
*
|
|
7521
|
+
* Create a new API key owned by a user. The user must have an active membership in the specified organization.
|
|
7522
|
+
* @param userId - Unique identifier of the user.
|
|
7523
|
+
* @param options - Object containing the API key properties.
|
|
7524
|
+
* @returns {Promise<UserApiKeyWithValue>}
|
|
7525
|
+
* @throws {BadRequestException} 400
|
|
7526
|
+
* @throws {NotFoundException} 404
|
|
7527
|
+
* @throws {UnprocessableEntityException} 422
|
|
7528
|
+
*/
|
|
7529
|
+
createUserApiKey(userId: string, options: CreateUserApiKeyOptions, requestOptions?: CreateUserApiKeyRequestOptions): Promise<UserApiKeyWithValue>;
|
|
6185
7530
|
/**
|
|
6186
7531
|
* Get user identities
|
|
6187
7532
|
*
|
|
@@ -7872,6 +9217,7 @@ declare class WorkOS {
|
|
|
7872
9217
|
readonly pkce: PKCE;
|
|
7873
9218
|
private readonly hasApiKey;
|
|
7874
9219
|
readonly actions: Actions;
|
|
9220
|
+
readonly agents: Agents;
|
|
7875
9221
|
readonly apiKeys: ApiKeys;
|
|
7876
9222
|
readonly auditLogs: AuditLogs;
|
|
7877
9223
|
readonly authorization: Authorization;
|
|
@@ -7935,7 +9281,7 @@ declare class WorkOS {
|
|
|
7935
9281
|
patch<Result = any, Entity = any>(path: string, entity: Entity, options?: PatchOptions): Promise<{
|
|
7936
9282
|
data: Result;
|
|
7937
9283
|
}>;
|
|
7938
|
-
delete(path: string, query?:
|
|
9284
|
+
delete(path: string, query?: Record<string, string | number | boolean | undefined>): Promise<void>;
|
|
7939
9285
|
deleteWithBody<Entity = any>(path: string, entity: Entity): Promise<void>;
|
|
7940
9286
|
emitWarning(warning: string): void;
|
|
7941
9287
|
private handleHttpError;
|
|
@@ -8242,12 +9588,7 @@ declare class Webhooks {
|
|
|
8242
9588
|
deleteWebhookEndpoint(options: DeleteWebhookEndpointOptions): Promise<void>;
|
|
8243
9589
|
private _signatureProvider?;
|
|
8244
9590
|
private get signatureProvider();
|
|
8245
|
-
get verifyHeader(): ({
|
|
8246
|
-
payload,
|
|
8247
|
-
sigHeader,
|
|
8248
|
-
secret,
|
|
8249
|
-
tolerance
|
|
8250
|
-
}: {
|
|
9591
|
+
get verifyHeader(): ({ payload, sigHeader, secret, tolerance }: {
|
|
8251
9592
|
payload: WebhookPayload;
|
|
8252
9593
|
sigHeader: string;
|
|
8253
9594
|
secret: string;
|
|
@@ -8255,12 +9596,7 @@ declare class Webhooks {
|
|
|
8255
9596
|
}) => Promise<boolean>;
|
|
8256
9597
|
get computeSignature(): (timestamp: any, payload: WebhookPayload, secret: string) => Promise<string>;
|
|
8257
9598
|
get getTimestampAndSignatureHash(): (sigHeader: string) => [string, string];
|
|
8258
|
-
constructEvent({
|
|
8259
|
-
payload,
|
|
8260
|
-
sigHeader,
|
|
8261
|
-
secret,
|
|
8262
|
-
tolerance
|
|
8263
|
-
}: {
|
|
9599
|
+
constructEvent({ payload, sigHeader, secret, tolerance }: {
|
|
8264
9600
|
payload: WebhookPayload;
|
|
8265
9601
|
sigHeader: string;
|
|
8266
9602
|
secret: string;
|
|
@@ -8336,12 +9672,7 @@ declare class BadRequestException extends Error implements RequestException {
|
|
|
8336
9672
|
readonly code?: string;
|
|
8337
9673
|
readonly errors?: unknown[];
|
|
8338
9674
|
readonly requestID: string;
|
|
8339
|
-
constructor({
|
|
8340
|
-
code,
|
|
8341
|
-
errors,
|
|
8342
|
-
message,
|
|
8343
|
-
requestID
|
|
8344
|
-
}: {
|
|
9675
|
+
constructor({ code, errors, message, requestID }: {
|
|
8345
9676
|
code?: string;
|
|
8346
9677
|
errors?: unknown[];
|
|
8347
9678
|
message?: string;
|
|
@@ -8355,12 +9686,7 @@ declare class ConflictException extends Error implements RequestException {
|
|
|
8355
9686
|
readonly name = "ConflictException";
|
|
8356
9687
|
readonly requestID: string;
|
|
8357
9688
|
readonly code?: string;
|
|
8358
|
-
constructor({
|
|
8359
|
-
error,
|
|
8360
|
-
message,
|
|
8361
|
-
requestID,
|
|
8362
|
-
code
|
|
8363
|
-
}: {
|
|
9689
|
+
constructor({ error, message, requestID, code }: {
|
|
8364
9690
|
error?: string;
|
|
8365
9691
|
message?: string;
|
|
8366
9692
|
requestID: string;
|
|
@@ -8382,12 +9708,7 @@ declare class NotFoundException extends Error implements RequestException {
|
|
|
8382
9708
|
readonly message: string;
|
|
8383
9709
|
readonly code?: string;
|
|
8384
9710
|
readonly requestID: string;
|
|
8385
|
-
constructor({
|
|
8386
|
-
code,
|
|
8387
|
-
message,
|
|
8388
|
-
path,
|
|
8389
|
-
requestID
|
|
8390
|
-
}: {
|
|
9711
|
+
constructor({ code, message, path, requestID }: {
|
|
8391
9712
|
code?: string;
|
|
8392
9713
|
message?: string;
|
|
8393
9714
|
path: string;
|
|
@@ -8417,7 +9738,6 @@ declare class RateLimitExceededException extends GenericServerException {
|
|
|
8417
9738
|
/**
|
|
8418
9739
|
* The number of seconds to wait before retrying the request.
|
|
8419
9740
|
*/
|
|
8420
|
-
|
|
8421
9741
|
retryAfter: number | null);
|
|
8422
9742
|
}
|
|
8423
9743
|
//#endregion
|
|
@@ -8443,12 +9763,7 @@ declare class UnprocessableEntityException extends Error implements RequestExcep
|
|
|
8443
9763
|
readonly message: string;
|
|
8444
9764
|
readonly code?: string;
|
|
8445
9765
|
readonly requestID: string;
|
|
8446
|
-
constructor({
|
|
8447
|
-
code,
|
|
8448
|
-
errors,
|
|
8449
|
-
message,
|
|
8450
|
-
requestID
|
|
8451
|
-
}: {
|
|
9766
|
+
constructor({ code, errors, message, requestID }: {
|
|
8452
9767
|
code?: string;
|
|
8453
9768
|
errors?: UnprocessableEntityError[];
|
|
8454
9769
|
message?: string;
|
|
@@ -8594,5 +9909,5 @@ interface ConfidentialClientOptions extends WorkOSOptions {
|
|
|
8594
9909
|
declare function createWorkOS(options: PublicClientOptions): PublicWorkOS;
|
|
8595
9910
|
declare function createWorkOS(options: ConfidentialClientOptions): WorkOS;
|
|
8596
9911
|
//#endregion
|
|
8597
|
-
export { ReadObjectMetadataResponse as $, PermissionUpdatedEventResponse as $a, SerializedCreateMagicAuthOptions as $c, ListAuthorizationResourcesOptions as $d, ResponseHeaderValue as $f, GroupMemberAddedEventResponse as $i, AuthenticateUserWithEmailVerificationCredentials as $l, AutoPaginatable as $n, RuntimeClientStats as $o, AuthenticationPasswordFailedEventResponse as $r, ResetPasswordOptions as $s, RadarStandaloneAssessRequestAction as $t, RemoveGroupRoleAssignmentsOptions as $u, ApiKeyRequiredException as A, OrganizationMembershipCreated as Aa, OrganizationMembershipStatus as Ac, SerializedListRoleAssignmentsOptions as Ad, EnvironmentRole as Af, DsyncUserDeletedEvent as Ai, UserResponse as Al, ExternalAuthCompleteResponse as An, VaultDekReadEventResponse as Ao, GetOptions as Ar, SerializedCreateOrganizationDomainOptions as As, SerializedAuditLogExportOptions as At, DirectoryUserResponse as Au, ObjectSummaryResponse as B, OrganizationRoleUpdatedEvent as Ba, EnrollAuthFactorOptions as Bc, ListResourcesForMembershipOptions as Bd, DirectoryGroupResponse as Bf, FlagCreatedEvent as Bi, SerializedAuthenticateWithPasswordOptions as Bl, CreateM2MApplicationResponse as Bn, SerializedUpdateGroupOptions as Bo, AuthenticationMagicAuthSucceededEvent as Br, Session as Bs, EnrollFactorOptions as Bt, RoleList as Bu, BadRequestException as C, OrganizationDomainDeletedEventResponse as Ca, SerializedListOrganizationMembershipsOptions as Cc, AssignRoleOptionsWithResourceId as Cd, OrganizationRole as Cf, DsyncGroupUpdatedEventResponse as Ci, SessionCookieData as Cl, ConnectApplicationM2M as Cn, VaultDataReadEvent as Co, WorkOSOptions as Cr, OrganizationDomainVerificationFailed as Cs, AuditLogSchema as Ct, ConnectionDomain as Cu, isAuthenticationErrorData as D, OrganizationDomainVerificationFailedEventResponse as Da, BaseOrganizationMembershipResponse as Dc, ListRoleAssignmentsForResourceOptions as Dd, UpdateEnvironmentRoleOptions as Df, DsyncGroupUserRemovedEventResponse as Di, CreateUserResponse as Dl, ConnectApplicationResponse as Dn, VaultDekDecryptedEvent as Do, PatchOptions as Dr, OrganizationDomainState as Ds, AuditLogExport as Dt, SSOPKCEAuthorizationURLResult as Du, AuthenticationException as E, OrganizationDomainVerificationFailedEvent as Ea, BaseOrganizationMembership as Ec, ListRoleAssignmentsForResourceByExternalIdOptions as Ed, SerializedUpdateEnvironmentRoleOptions as Ef, DsyncGroupUserRemovedEvent as Ei, AuthenticationResponseResponse as El, ConnectApplicationOAuthResponse as En, VaultDataUpdatedEventResponse as Eo, PostOptions as Er, OrganizationDomainResponse as Es, AuditLogTargetSchema as Et, SSOAuthorizationURLOptions as Eu, UpdateWebhookEndpointEvents as F, OrganizationMembershipUpdatedResponse as Fa, Invitation as Fc, RoleAssignmentRole as Fd, ListDirectoryGroupsOptions as Ff, EmailVerificationCreatedEventResponse as Fi, AuthenticateUserWithRefreshTokenCredentials as Fl, DeleteApplicationOptions as Fn, VaultNamesListedEvent as Fo, ApiKeyRevokedEventResponse as Fr, SerializedUpdateUserOptions as Fs, FactorResponse as Ft, OrganizationRoleEventResponse as Fu, ObjectMetadata as G, PasswordResetCreatedEventResponse as Ga, EmailVerificationResponse as Gc, AuthorizationCheckOptionsWithResourceExternalId as Gd, DirectoryType as Gf, FlagRuleUpdatedEventResponse as Gi, AuthenticateWithRadarSmsChallengeOptions as Gl, ListApplicationsOptions as Gn, Group as Go, AuthenticationOAuthFailedEventResponse as Gr, SendRadarSmsChallengeResponse as Gs, RadarListEntryAlreadyPresentResponseWire as Gt, GroupRoleAssignmentEntry as Gu, ObjectVersionResponse as H, OrganizationUpdatedEvent as Ha, EmailVerification as Hc, ListResourcesForMembershipOptionsWithParentId as Hd, DirectoryResponse as Hf, FlagDeletedEvent as Hi, AuthenticateWithOrganizationSelectionOptions as Hl, CreateOAuthApplicationResponse as Hn, RemoveGroupOrganizationMembershipOptions as Ho, AuthenticationMfaSucceededEvent as Hr, SessionStatus as Hs, ChallengeResponse as Ht, ListEffectivePermissionsByExternalIdOptions as Hu, UpdateWebhookEndpointStatus as I, OrganizationRoleCreatedEvent as Ia, InvitationEvent as Ic, RoleAssignmentSource as Id, ListDirectoriesOptions as If, Event as Ii, AuthenticateWithRefreshTokenOptions as Il, UpdateApplicationOptions as In, VaultNamesListedEventResponse as Io, AuthenticationEmailVerificationSucceededEvent as Ir, UpdateUserOptions as Is, FactorWithSecrets as It, OrganizationRoleResponse as Iu, ActorResponse as J, PermissionCreatedEvent as Ja, CreatePasswordResetOptions as Jc, SerializedAuthorizationCheckOptions as Jd, HttpClient as Jf, GroupCreatedEvent as Ji, AuthenticateWithRadarEmailChallengeOptions as Jl, UserConsentOptionResponse as Jn, DeleteGroupOptions as Jo, AuthenticationPasskeyFailedEvent as Jr, SendInvitationOptions as Js, RadarStandaloneResponseBlocklistType as Jt, GroupRoleAssignmentEntryWithResourceId as Ju, ObjectMetadataResponse as K, PasswordResetSucceededEvent as Ka, CreateUserOptions as Kc, AuthorizationCheckOptionsWithResourceId as Kd, EventDirectory as Kf, FlagUpdatedEvent as Ki, SerializedAuthenticateWithRadarSmsChallengeOptions as Kl, CompleteOAuth2Options as Kn, GroupResponse as Ko, AuthenticationOAuthSucceededEvent as Kr, SendRadarSmsChallengeResponseResponse as Ks, RadarStandaloneResponse as Kt, GroupRoleAssignmentEntryForOrganization as Ku, CreateWebhookEndpointEvents as L, OrganizationRoleCreatedEventResponse as La, InvitationEventResponse as Lc, RoleAssignmentSourceResponse as Ld, SerializedListDirectoriesOptions as Lf, EventBase as Li, SerializedAuthenticateWithRefreshTokenOptions as Ll, GetApplicationOptions as Ln, DataKey as Lo, AuthenticationEmailVerificationSucceededEventResponse as Lr, SerializedUpdateOrganizationMembershipOptions as Ls, FactorWithSecretsResponse as Lt, Role as Lu, WebhookEndpoint as M, OrganizationMembershipDeleted as Ma, SerializedListInvitationsOptions as Mc, RoleAssignmentResource as Md, EnvironmentRoleListResponse as Mf, DsyncUserUpdatedEvent as Mi, ImpersonatorResponse as Ml, DeleteClientSecretOptions as Mn, VaultKekCreatedEventResponse as Mo, ApiKeyCreatedEvent as Mr, VerifyEmailOptions as Ms, VerifyResponseResponse as Mt, DirectoryUserWithGroupsResponse as Mu, WebhookEndpointResponse as N, OrganizationMembershipDeletedResponse as Na, ListGroupsForOrganizationMembershipOptions as Nc, RoleAssignmentResourceResponse as Nd, EnvironmentRoleResponse as Nf, DsyncUserUpdatedEventResponse as Ni, AuthenticateWithRefreshTokenPublicClientOptions as Nl, CreateApplicationClientSecretOptions as Nn, VaultMetadataReadEvent as No, ApiKeyCreatedEventResponse as Nr, SerializedUpdateUserPasswordOptions as Ns, VerifyChallengeOptions as Nt, ListOrganizationRolesResponse as Nu, GenericServerException as O, OrganizationDomainVerifiedEvent as Oa, OrganizationMembership as Oc, SerializedListRoleAssignmentsForResourceOptions as Od, CreateEnvironmentRoleOptions as Of, DsyncUserCreatedEvent as Oi, CreateUserResponseResponse as Ol, ConnectApplicationRedirectUri as On, VaultDekDecryptedEventResponse as Oo, List as Or, OrganizationDomainVerificationStrategy as Os, AuditLogExportResponse as Ot, DefaultCustomAttributes as Ou, WebhookEndpointStatus as P, OrganizationMembershipUpdated as Pa, ListAuthFactorsOptions as Pc, RoleAssignmentResponse as Pd, ListDirectoryUsersOptions as Pf, EmailVerificationCreatedEvent as Pi, SerializedAuthenticateWithRefreshTokenPublicClientOptions as Pl, ListApplicationClientSecretsOptions as Pn, VaultMetadataReadEventResponse as Po, ApiKeyRevokedEvent as Pr, UpdateUserPasswordOptions as Ps, Factor as Pt, OrganizationRoleEvent as Pu, UpdateObjectOptions as Q, PermissionUpdatedEvent as Qa, CreateMagicAuthOptions as Qc, GetAuthorizationResourceByExternalIdOptions as Qd, RequestOptions as Qf, GroupMemberAddedEvent as Qi, SerializedAuthenticateWithMagicAuthOptions as Ql, UserObjectResponse as Qn, SerializedAddGroupOrganizationMembershipOptions as Qo, AuthenticationPasswordFailedEvent as Qr, serializeRevokeSessionOptions as Qs, RadarListType as Qt, BaseRemoveGroupRoleAssignmentsOptions as Qu, WorkOS as R, OrganizationRoleDeletedEvent as Ra, InvitationResponse as Rc, ListMembershipsForResourceByExternalIdOptions as Rd, PaginationOptions as Rf, EventName as Ri, AuthenticateUserWithPasswordCredentials as Rl, CreateApplicationOptions as Rn, DataKeyPair as Ro, AuthenticationMagicAuthFailedEvent as Rr, UpdateOrganizationMembershipOptions as Rs, Sms as Rt, RoleEvent as Ru, ConflictException as S, OrganizationDomainDeletedEvent as Sa, ListOrganizationMembershipsOptions as Sc, AssignRoleOptionsWithResourceExternalId as Sd, SerializedCreateOrganizationRoleOptions as Sf, DsyncGroupUpdatedEvent as Si, AuthenticateWithSessionCookieSuccessResponse as Sl, ConnectApplication as Sn, VaultDataDeletedEventResponse as So, WorkOSResponseError as Sr, SerializedApiKey as Ss, AuditLogActorSchema as St, Connection as Su, AuthenticationErrorData as T, OrganizationDomainUpdatedEventResponse as Ta, AuthorizationOrganizationMembershipResponse as Tc, SerializedAssignRoleOptions as Td, SetEnvironmentRolePermissionsOptions as Tf, DsyncGroupUserAddedEventResponse as Ti, AuthenticationResponse as Tl, ConnectApplicationOAuth as Tn, VaultDataUpdatedEvent as To, PutOptions as Tr, OrganizationDomain as Ts, AuditLogSchemaResponse as Tt, ConnectionType as Tu, VaultObject as U, OrganizationUpdatedResponse as Ua, EmailVerificationEvent as Uc, SerializedListResourcesForMembershipOptions as Ud, DirectoryState as Uf, FlagDeletedEventResponse as Ui, SerializedAuthenticateWithOrganizationSelectionOptions as Ul, RedirectUriInput as Un, ListGroupsOptions as Uo, AuthenticationMfaSucceededEventResponse as Ur, SendVerificationEmailOptions as Us, ChallengeFactorOptions as Ut, ListEffectivePermissionsOptions as Uu, ObjectVersion as V, OrganizationRoleUpdatedEventResponse as Va, SerializedEnrollUserInMfaFactorOptions as Vc, ListResourcesForMembershipOptionsWithParentExternalId as Vd, Directory as Vf, FlagCreatedEventResponse as Vi, AuthenticateUserWithOrganizationSelectionCredentials as Vl, CreateOAuthApplication as Vn, UpdateGroupOptions as Vo, AuthenticationMagicAuthSucceededEventResponse as Vr, SessionResponse as Vs, Challenge as Vt, RoleResponse as Vu, VaultObjectResponse as W, PasswordResetCreatedEvent as Wa, EmailVerificationEventResponse as Wc, AuthorizationCheckOptions as Wd, DirectoryStateResponse as Wf, FlagRuleUpdatedEvent as Wi, AuthenticateUserWithRadarSmsChallengeCredentials as Wl, RedirectUriInputResponse as Wn, ListGroupOrganizationMembershipsOptions as Wo, AuthenticationOAuthFailedEvent as Wr, SendRadarSmsChallengeOptions as Ws, RadarListEntryAlreadyPresentResponse as Wt, BaseGroupRoleAssignmentEntry as Wu, CreateDataKeyResponseWire as X, PermissionDeletedEvent as Xa, CreateOrganizationMembershipOptions as Xc, DeleteAuthorizationResourceByExternalIdOptions as Xd, HttpClientResponseInterface as Xf, GroupDeletedEvent as Xi, AuthenticateUserWithMagicAuthCredentials as Xl, UserConsentOptionChoiceResponse as Xn, SerializedCreateGroupOptions as Xo, AuthenticationPasskeySucceededEvent as Xr, RevokeSessionOptions as Xs, RadarStandaloneResponseVerdict as Xt, SerializedGroupRoleAssignmentEntry as Xu, CreateDataKeyResponse as Y, PermissionCreatedEventResponse as Ya, SerializedCreatePasswordResetOptions as Yc, DeleteAuthorizationResourceOptions as Yd, HttpClientInterface as Yf, GroupCreatedEventResponse as Yi, SerializedAuthenticateWithRadarEmailChallengeOptions as Yl, UserConsentOptionChoice as Yn, CreateGroupOptions as Yo, AuthenticationPasskeyFailedEventResponse as Yr, SerializedSendInvitationOptions as Ys, RadarStandaloneResponseControl as Yt, ReplaceGroupRoleAssignmentsOptions as Yu, UpdateObjectEntity as Z, PermissionDeletedEventResponse as Za, SerializedCreateOrganizationMembershipOptions as Zc, UpdateAuthorizationResourceByExternalIdOptions as Zd, RequestHeaders as Zf, GroupDeletedEventResponse as Zi, AuthenticateWithMagicAuthOptions as Zl, UserObject as Zn, AddGroupOrganizationMembershipOptions as Zo, AuthenticationPasskeySucceededEventResponse as Zr, SerializedRevokeSessionOptions as Zs, RadarListAction as Zt, SerializedReplaceGroupRoleAssignmentsOptions as Zu, SignatureVerificationException as _, OrganizationCreatedResponse as _a, ListUsersOptions as _c, RemoveRoleOptions as _d, AddOrganizationRolePermissionOptions as _f, DsyncDeletedEventResponse as _i, AuthenticateWithTotpOptions as _l, SerializedListEventOptions as _n, VaultByokKeyVerificationCompletedEvent as _o, CreateOrganizationOptions as _r, SerializedCreatedApiKey as _s, AuditLogActor as _t, OauthTokensResponse as _u, PublicWorkOS as a, GroupUpdatedEventResponse as aa, PasswordReset as ac, BaseCreateGroupRoleAssignmentOptions as ad, CreateOptionsWithParentResourceId as af, AuthenticationSSOFailedEventResponse as ai, AuthenticationFactorResponse as al, SerializedGetAccessTokenFailureResponse as an, RoleUpdatedEventResponse as ao, UserRegistrationActionResponseData as ar, FlagPollEntry as as, DecryptDataKeyResponse as at, AuthenticateWithCodeOptions as au, NotFoundException as b, OrganizationDomainCreatedEvent as ba, ListSessionsOptions as bc, SerializedRemoveRoleOptions as bd, UpdateOrganizationRoleOptions as bf, DsyncGroupDeletedEvent as bi, AuthenticateWithSessionCookieFailureReason as bl, ApplicationCredentialsListItem as bn, VaultDataCreatedEventResponse as bo, DomainData as br, SerializedCreateOrganizationApiKeyOptions as bs, CreateAuditLogEventRequestOptions as bt, GetProfileAndTokenOptions as bu, PortalLinkResponseWire as c, InvitationCreatedEvent as ca, PasswordResetResponse as cc, CreateGroupRoleAssignmentOptionsWithResourceExternalId as cd, UpdateAuthorizationResourceOptions as cf, ConnectionActivatedEvent as ci, Totp as cl, SerializedGetAccessTokenSuccessResponse as cn, SessionRevokedEvent as co, UserData as cr, FeatureFlag as cs, WidgetSessionTokenResponseWire as ct, AuthenticateWithSessionOptions as cu, IntentOptions as d, InvitationResentEventResponse as da, MagicAuth as dc, GetGroupRoleAssignmentOptions as dd, UpdatePermissionOptions as df, ConnectionDeactivatedEventResponse as di, TotpWithSecretsResponse as dl, SendSessionResponse as dn, UserCreatedEvent as do, SerializedUpdateOrganizationOptions as dr, AddFlagTargetOptions as ds, FeatureFlagsRuntimeClient as dt, WithResolvedClientId as du, GroupMemberEventData as ea, SerializedResetPasswordOptions as ec, RemoveGroupRoleAssignmentsOptionsForOrganization as ed, SerializedListAuthorizationResourcesOptions as ef, AuthenticationPasswordSucceededEvent as ei, PKCEAuthorizationURLResult as el, RadarStandaloneAssessRequestAuthMethod as en, RoleCreatedEvent as eo, ResponseHeaders as ep, PKCE as er, RuntimeClientLogger as es, ReadObjectOptions as et, AuthenticateWithEmailVerificationOptions as eu, IntentOptionsResponse as f, InvitationRevokedEvent as fa, MagicAuthEvent as fc, ListGroupRoleAssignmentsOptions as fd, CreatePermissionOptions as ff, ConnectionDeletedEvent as fi, AuthenticationEvent as fl, CreatePasswordlessSessionOptions as fn, UserCreatedEventResponse as fo, UpdateOrganizationOptions as fr, SerializedValidateApiKeyResponse as fs, CookieSession as ft, ProfileAndToken as fu, UnauthorizedException as g, OrganizationCreatedEvent as ga, Locale as gc, BaseRemoveRoleOptions as gd, RemoveOrganizationRolePermissionOptions as gf, DsyncDeletedEvent as gi, AuthenticateUserWithTotpCredentials as gl, ListEventOptions as gn, UserUpdatedEventResponse as go, ListOrganizationFeatureFlagsOptions as gr, CreatedApiKey as gs, SerializedCreateAuditLogSchemaOptions as gt, OauthTokens as gu, UnprocessableEntityException as h, MagicAuthCreatedEventResponse as ha, LogoutURLOptions as hc, RemoveRoleAssignmentOptions as hd, PermissionResponse as hf, DsyncActivatedEventResponse as hi, AuthenticationEventSsoResponse as hl, PasswordlessSessionResponse as hn, UserUpdatedEvent as ho, ListOrganizationsOptions as hr, ListOrganizationApiKeysOptions as hs, CreateAuditLogSchemaResponse as ht, ProfileResponse as hu, PublicUserManagement as i, GroupUpdatedEvent as ia, RefreshSessionResponse as ic, RemoveGroupRoleAssignmentOptions as id, CreateOptionsWithParentExternalId as if, AuthenticationSSOFailedEvent as ii, AuthenticationFactor as il, GetAccessTokenSuccessResponse as in, RoleUpdatedEvent as io, ResponsePayload as ir, FlagChange as is, DecryptDataKeyOptions as it, AuthenticateUserWithCodeCredentials as iu, Webhooks as j, OrganizationMembershipCreatedResponse as ja, ListInvitationsOptions as jc, RoleAssignment as jd, EnvironmentRoleList as jf, DsyncUserDeletedEventResponse as ji, Impersonator as jl, ExternalAuthCompleteResponseWire as jn, VaultKekCreatedEvent as jo, GenerateLinkIntent as jr, SerializedVerifyEmailOptions as js, VerifyResponse as jt, DirectoryUserWithGroups as ju, WorkOSErrorData as k, OrganizationDomainVerifiedEventResponse as ka, OrganizationMembershipResponse as kc, ListRoleAssignmentsOptions as kd, SerializedCreateEnvironmentRoleOptions as kf, DsyncUserCreatedEventResponse as ki, User as kl, ConnectApplicationRedirectUriResponse as kn, VaultDekReadEvent as ko, ListResponse as kr, CreateOrganizationDomainOptions as ks, AuditLogExportOptions as kt, DirectoryUser as ku, GenerateLink as l, InvitationCreatedEventResponse as la, CreateMagicAuthResponse as lc, CreateGroupRoleAssignmentOptionsWithResourceId as ld, ListPermissionsOptions as lf, ConnectionActivatedEventResponse as li, TotpResponse as ll, AccessToken as ln, SessionRevokedEventResponse as lo, UserDataPayload as lr, FeatureFlagResponse as ls, CreateTokenOptions as lt, SerializedAuthenticatePublicClientBase as lu, SSOIntentOptionsResponse as m, MagicAuthCreatedEvent as ma, MagicAuthResponse as mc, GroupRoleAssignmentResponse as md, Permission as mf, DsyncActivatedEvent as mi, AuthenticationEventSso as ml, PasswordlessSession as mn, UserDeletedEventResponse as mo, OrganizationResponse as mr, ValidateApiKeyResponse as ms, CreateAuditLogSchemaRequestOptions as mt, Profile as mu, PublicClientOptions as n, GroupMemberRemovedEvent as na, SerializedResendInvitationOptions as nc, RemoveGroupRoleAssignmentsOptionsWithResourceId as nd, AuthorizationResourceResponse as nf, AuthenticationRadarRiskDetectedEvent as ni, AuthenticationRadarRiskDetectedEventData as nl, GetAccessTokenOptions as nn, RoleDeletedEvent as no, Actions as nr, RemoveFlagTargetOptions as ns, CreateObjectEntity as nt, AuthenticateWithCodeAndVerifierOptions as nu, createWorkOS as o, InvitationAcceptedEvent as oa, PasswordResetEvent as oc, CreateGroupRoleAssignmentOptions as od, SerializedCreateAuthorizationResourceOptions as of, AuthenticationSSOSucceededEvent as oi, AuthenticationFactorWithSecrets as ol, SerializedGetAccessTokenOptions as on, SessionCreatedEvent as oo, ActionContext as or, FlagPollResponse as os, CreateDataKeyOptions as ot, SerializedAuthenticateWithCodeOptions as ou, SSOIntentOptions as p, InvitationRevokedEventResponse as pa, MagicAuthEventResponse as pc, GroupRoleAssignment as pd, SerializedCreatePermissionOptions as pf, ConnectionDeletedEventResponse as pi, AuthenticationEventResponse as pl, SerializedCreatePasswordlessSessionOptions as pn, UserDeletedEvent as po, Organization as pr, ValidateApiKeyOptions as ps, CreateAuditLogSchemaOptions as pt, ProfileAndTokenResponse as pu, Actor as q, PasswordResetSucceededEventResponse as qa, SerializedCreateUserOptions as qc, AuthorizationCheckResult as qd, EventDirectoryResponse as qf, FlagUpdatedEventResponse as qi, AuthenticateUserWithRadarEmailChallengeCredentials as ql, UserConsentOption as qn, GetGroupOptions as qo, AuthenticationOAuthSucceededEventResponse as qr, SerializedSendRadarSmsChallengeOptions as qs, RadarStandaloneResponseWire as qt, GroupRoleAssignmentEntryWithResourceExternalId as qu, PublicSSO as r, GroupMemberRemovedEventResponse as ra, RefreshSessionFailureReason as rc, SerializedRemoveGroupRoleAssignmentsOptions as rd, CreateAuthorizationResourceOptions as rf, AuthenticationRadarRiskDetectedEventResponse as ri, AuthenticationRadarRiskDetectedEventResponseData as rl, GetAccessTokenResponse as rn, RoleDeletedEventResponse as ro, AuthenticationActionResponseData as rr, ListFeatureFlagsOptions as rs, CreateObjectOptions as rt, SerializedAuthenticateWithCodeAndVerifierOptions as ru, PortalLinkResponse as s, InvitationAcceptedEventResponse as sa, PasswordResetEventResponse as sc, CreateGroupRoleAssignmentOptionsForOrganization as sd, SerializedUpdateAuthorizationResourceOptions as sf, AuthenticationSSOSucceededEventResponse as si, AuthenticationFactorWithSecretsResponse as sl, SerializedGetAccessTokenResponse as sn, SessionCreatedEventResponse as so, ActionPayload as sr, FlagTarget as ss, WidgetSessionTokenResponse as st, AuthenticateWithOptionsBase as su, ConfidentialClientOptions as t, GroupMemberEventResponseData as ta, ResendInvitationOptions as tc, RemoveGroupRoleAssignmentsOptionsWithResourceExternalId as td, AuthorizationResource as tf, AuthenticationPasswordSucceededEventResponse as ti, UserManagementAuthorizationURLOptions as tl, GetAccessTokenFailureResponse as tn, RoleCreatedEventResponse as to, CryptoProvider as tp, PKCEPair as tr, RuntimeClientOptions as ts, ReadObjectResponse as tt, SerializedAuthenticateWithEmailVerificationOptions as tu, GenerateLinkResponse as u, InvitationResentEvent as ua, CreateMagicAuthResponseResponse as uc, SerializedCreateGroupRoleAssignmentOptions as ud, SerializedUpdatePermissionOptions as uf, ConnectionDeactivatedEvent as ui, TotpWithSecrets as ul, SerializedAccessToken as un, UnknownEvent as uo, UserRegistrationActionPayload as ur, EvaluationContext as us, WidgetSessionTokenScopes as ut, SerializedAuthenticateWithOptionsBase as uu, RateLimitExceededException as v, OrganizationDeletedEvent as va, SerializedListUsersOptions as vc, RemoveRoleOptionsWithResourceExternalId as vd, SetOrganizationRolePermissionsOptions as vf, DsyncGroupCreatedEvent as vi, SerializedAuthenticateWithTotpOptions as vl, NewConnectApplicationSecret as vn, VaultByokKeyVerificationCompletedEventResponse as vo, CreateOrganizationRequestOptions as vr, CreateOrganizationApiKeyOptions as vs, AuditLogTarget as vt, ListConnectionsOptions as vu, AuthenticationErrorCode as w, OrganizationDomainUpdatedEvent as wa, AuthorizationOrganizationMembership as wc, BaseAssignRoleOptions as wd, AddEnvironmentRolePermissionOptions as wf, DsyncGroupUserAddedEvent as wi, UserManagementAccessToken as wl, ConnectApplicationM2MResponse as wn, VaultDataReadEventResponse as wo, UnprocessableEntityError as wr, OrganizationDomainVerificationFailedResponse as ws, AuditLogSchemaMetadata as wt, ConnectionResponse as wu, NoApiKeyProvidedException as x, OrganizationDomainCreatedEventResponse as xa, SerializedListSessionsOptions as xc, AssignRoleOptions as xd, CreateOrganizationRoleOptions as xf, DsyncGroupDeletedEventResponse as xi, AuthenticateWithSessionCookieOptions as xl, ApplicationCredentialsListItemResponse as xn, VaultDataDeletedEvent as xo, DomainDataState as xr, ApiKey as xs, SerializedCreateAuditLogEventOptions as xt, GetProfileOptions as xu, OauthException as y, OrganizationDeletedResponse as ya, ListUserFeatureFlagsOptions as yc, RemoveRoleOptionsWithResourceId as yd, SerializedUpdateOrganizationRoleOptions as yf, DsyncGroupCreatedEventResponse as yi, AuthenticateWithSessionCookieFailedResponse as yl, NewConnectApplicationSecretResponse as yn, VaultDataCreatedEvent as yo, SerializedCreateOrganizationOptions as yr, CreateOrganizationApiKeyRequestOptions as ys, CreateAuditLogEventOptions as yt, SerializedListConnectionsOptions as yu, ObjectSummary as z, OrganizationRoleDeletedEventResponse as za, Identity as zc, ListMembershipsForResourceOptions as zd, DirectoryGroup as zf, EventResponse as zi, AuthenticateWithPasswordOptions as zl, CreateM2MApplication as zn, KeyContext as zo, AuthenticationMagicAuthFailedEventResponse as zr, AuthMethod as zs, SmsResponse as zt, RoleEventResponse as zu };
|
|
8598
|
-
//# sourceMappingURL=factory-
|
|
9912
|
+
export { ReadObjectMetadataResponse as $, FlagDeletedEventResponse as $a, AuthMethod as $c, ConnectionResponse as $d, BaseAssignRoleOptions as $f, AuthenticationMfaSucceededEventResponse as $i, Invitation as $l, PasswordlessSessionResponse as $n, OrganizationUpdatedResponse as $o, AddEnvironmentRolePermissionOptions as $p, SerializedLinkClaimAttemptToExternalUserOptions as $r, ListGroupsOptions as $s, DataIntegrationsListResponseDataOwnership as $t, UserManagementAccessToken as $u, ApiKeyRequiredException as A, DsyncGroupDeletedEvent as Aa, SerializedCreateOrganizationApiKeyOptions as Ac, SerializedAuthenticateWithEmailVerificationOptions as Ad, RemoveGroupRoleAssignmentsOptionsWithResourceExternalId as Af, DomainData as Ai, MagicAuthResponse as Al, CryptoProvider as Am, ConnectedAccountState as An, OrganizationDomainCreatedEvent as Ao, AuthorizationResource as Ap, CompleteOAuth2Options as Ar, VaultDataCreatedEventResponse as As, SerializedAuditLogExportOptions as At, Factor as Au, ObjectSummaryResponse as B, DsyncUserDeletedEvent as Ba, SerializedCreateOrganizationDomainOptions as Bc, WithResolvedClientId as Bd, GetGroupRoleAssignmentOptions as Bf, GetOptions as Bi, ListOrganizationMembershipsOptions as Bl, UpdateCustomProviderDefinitionAuthenticateVia as Bn, OrganizationMembershipCreated as Bo, UpdatePermissionOptions as Bp, AgentCredentialValidation as Br, VaultDekReadEventResponse as Bs, RadarStandaloneResponse as Bt, SmsResponse as Bu, BadRequestException as C, ConnectionDeletedEventResponse as Ca, ValidateApiKeyOptions as Cc, AuthenticateWithRadarEmailChallengeOptions as Cd, GroupRoleAssignmentEntryWithResourceId as Cf, Organization as Ci, PasswordResetEventResponse as Cl, HttpClient as Cm, DataIntegrationCredential as Cn, InvitationRevokedEventResponse as Co, SerializedAuthorizationCheckOptions as Cp, CreateM2MApplication as Cr, UserDeletedEvent as Cs, AuditLogSchema as Ct, AuthenticationRadarRiskDetectedEventData as Cu, isAuthenticationErrorData as D, DsyncDeletedEventResponse as Da, SerializedCreatedApiKey as Dc, SerializedAuthenticateWithMagicAuthOptions as Dd, BaseRemoveGroupRoleAssignmentsOptions as Df, CreateOrganizationOptions as Di, MagicAuth as Dl, RequestOptions as Dm, DeleteUserConnectedAccountOptions as Dn, OrganizationCreatedResponse as Do, GetAuthorizationResourceByExternalIdOptions as Dp, RedirectUriInput as Dr, VaultByokKeyVerificationCompletedEvent as Ds, AuditLogExport as Dt, AuthenticationFactorType as Du, AuthenticationException as E, DsyncDeletedEvent as Ea, CreatedApiKey as Ec, AuthenticateWithMagicAuthOptions as Ed, SerializedReplaceGroupRoleAssignmentsOptions as Ef, ListOrganizationFeatureFlagsOptions as Ei, CreateMagicAuthResponseResponse as El, RequestHeaders as Em, ListUserDataProvidersOptions as En, OrganizationCreatedEvent as Eo, UpdateAuthorizationResourceByExternalIdOptions as Ep, CreateOAuthApplicationResponse as Er, UserUpdatedEventResponse as Es, AuditLogTargetSchema as Et, AuthenticationFactorResponse as Eu, UpdateWebhookEndpointEvents as F, DsyncGroupUserAddedEventResponse as Fa, OrganizationDomain as Fc, SerializedAuthenticateWithCodeOptions as Fd, CreateGroupRoleAssignmentOptions as Ff, PutOptions as Fi, ListUserApiKeysOptions as Fl, UpdateDataIntegrationApiKeyOptions as Fn, OrganizationDomainUpdatedEventResponse as Fo, SerializedCreateAuthorizationResourceOptions as Fp, UserObject as Fr, VaultDataUpdatedEvent as Fs, Challenge as Ft, Totp as Fu, ObjectMetadata as G, EmailVerificationCreatedEventResponse as Ga, SerializedUserApiKey as Gc, OauthTokens as Gd, BaseRemoveRoleOptions as Gf, ApiKeyRevokedEventResponse as Gi, BaseOrganizationMembershipResponse as Gl, CustomProviderDefinitionAuthenticateVia as Gn, OrganizationMembershipUpdatedResponse as Go, RemoveOrganizationRolePermissionOptions as Gp, ValidAgentCredential as Gr, VaultNamesListedEvent as Gs, RadarListAction as Gt, AuthenticateUserWithTotpCredentials as Gu, ObjectVersionResponse as H, DsyncUserUpdatedEvent as Ha, VerifyEmailOptions as Hc, ProfileAndTokenResponse as Hd, GroupRoleAssignment as Hf, ApiKeyCreatedEvent as Hi, AuthorizationOrganizationMembership as Hl, CreateDataIntegrationOptions as Hn, OrganizationMembershipDeleted as Ho, SerializedCreatePermissionOptions as Hp, SerializedAgentAccessTokenClaims as Hr, VaultKekCreatedEventResponse as Hs, RadarStandaloneResponseBlocklistType as Ht, AuthenticationEventResponse as Hu, UpdateWebhookEndpointStatus as I, DsyncGroupUserRemovedEvent as Ia, OrganizationDomainResponse as Ic, AuthenticateWithOptionsBase as Id, CreateGroupRoleAssignmentOptionsForOrganization as If, PostOptions as Ii, SerializedListUserApiKeysOptions as Il, DeleteDataIntegrationOptions as In, OrganizationDomainVerificationFailedEvent as Io, SerializedUpdateAuthorizationResourceOptions as Ip, UserObjectResponse as Ir, VaultDataUpdatedEventResponse as Is, ChallengeResponse as It, TotpResponse as Iu, ActorResponse as J, EventName as Ja, UpdateUserPasswordOptions as Jc, SerializedListConnectionsOptions as Jd, RemoveRoleOptionsWithResourceId as Jf, AuthenticationMagicAuthFailedEvent as Ji, OrganizationMembershipStatus as Jl, DataIntegrationCredentialsType as Jn, OrganizationRoleDeletedEvent as Jo, SerializedUpdateOrganizationRoleOptions as Jp, ValidateAgentCredentialOptions as Jr, DataKeyPair as Js, RadarStandaloneAssessRequestAuthMethod as Jt, AuthenticateWithSessionCookieFailedResponse as Ju, ObjectMetadataResponse as K, Event as Ka, UserApiKey as Kc, OauthTokensResponse as Kd, RemoveRoleOptions as Kf, AuthenticationEmailVerificationSucceededEvent as Ki, OrganizationMembership as Kl, DataIntegrationCredentialsDto as Kn, OrganizationRoleCreatedEvent as Ko, AddOrganizationRolePermissionOptions as Kp, ValidateAgentAccessTokenOptions as Kr, VaultNamesListedEventResponse as Ks, RadarListType as Kt, AuthenticateWithTotpOptions as Ku, CreateWebhookEndpointEvents as L, DsyncGroupUserRemovedEventResponse as La, OrganizationDomainState as Lc, AuthenticateWithSessionOptions as Ld, CreateGroupRoleAssignmentOptionsWithResourceExternalId as Lf, PatchOptions as Li, ListUserFeatureFlagsOptions as Ll, UpdateDataIntegrationOptions as Ln, OrganizationDomainVerificationFailedEventResponse as Lo, UpdateAuthorizationResourceOptions as Lp, AutoPaginatable as Lr, VaultDekDecryptedEvent as Ls, ChallengeFactorOptions as Lt, TotpWithSecrets as Lu, WebhookEndpoint as M, DsyncGroupUpdatedEvent as Ma, SerializedApiKey as Mc, SerializedAuthenticateWithCodeAndVerifierOptions as Md, SerializedRemoveGroupRoleAssignmentsOptions as Mf, WorkOSResponseError as Mi, Locale as Ml, GetAccessTokenOptions as Mn, OrganizationDomainDeletedEvent as Mo, CreateAuthorizationResourceOptions as Mp, UserConsentOptionResponse as Mr, VaultDataDeletedEventResponse as Ms, VerifyResponseResponse as Mt, FactorType as Mu, WebhookEndpointResponse as N, DsyncGroupUpdatedEventResponse as Na, OrganizationDomainVerificationFailed as Nc, AuthenticateUserWithCodeCredentials as Nd, RemoveGroupRoleAssignmentOptions as Nf, WorkOSOptions as Ni, ListUsersOptions as Nl, CreateDataIntegrationCredentialOptions as Nn, OrganizationDomainDeletedEventResponse as No, CreateOptionsWithParentExternalId as Np, UserConsentOptionChoice as Nr, VaultDataReadEvent as Ns, VerifyChallengeOptions as Nt, FactorWithSecrets as Nu, GenericServerException as O, DsyncGroupCreatedEvent as Oa, CreateOrganizationApiKeyOptions as Oc, AuthenticateUserWithEmailVerificationCredentials as Od, RemoveGroupRoleAssignmentsOptions as Of, CreateOrganizationRequestOptions as Oi, MagicAuthEvent as Ol, ResponseHeaderValue as Om, UpdateUserConnectedAccountOptions as On, OrganizationDeletedEvent as Oo, ListAuthorizationResourcesOptions as Op, RedirectUriInputResponse as Or, VaultByokKeyVerificationCompletedEventResponse as Os, AuditLogExportResponse as Ot, AuthenticationFactorWithSecrets as Ou, WebhookEndpointStatus as P, DsyncGroupUserAddedEvent as Pa, OrganizationDomainVerificationFailedResponse as Pc, AuthenticateWithCodeOptions as Pd, BaseCreateGroupRoleAssignmentOptions as Pf, UnprocessableEntityError as Pi, SerializedListUsersOptions as Pl, AuthorizeDataIntegrationOptions as Pn, OrganizationDomainUpdatedEvent as Po, CreateOptionsWithParentResourceId as Pp, UserConsentOptionChoiceResponse as Pr, VaultDataReadEventResponse as Ps, EnrollFactorOptions as Pt, FactorWithSecretsResponse as Pu, UpdateObjectOptions as Q, FlagDeletedEvent as Qa, UpdateOrganizationMembershipOptions as Qc, ConnectionDomain as Qd, AssignRoleOptionsWithResourceId as Qf, AuthenticationMfaSucceededEvent as Qi, ListAuthFactorsOptions as Ql, PasswordlessSession as Qn, OrganizationUpdatedEvent as Qo, OrganizationRole as Qp, SerializedClaimAttemptResponse as Qr, RemoveGroupOrganizationMembershipOptions as Qs, DataIntegrationsListResponseDataResponse as Qt, SessionCookieData as Qu, WorkOS as R, DsyncUserCreatedEvent as Ra, OrganizationDomainVerificationStrategy as Rc, SerializedAuthenticatePublicClientBase as Rd, CreateGroupRoleAssignmentOptionsWithResourceId as Rf, List as Ri, ListSessionsOptions as Rl, UpdateCustomProviderDefinition as Rn, OrganizationDomainVerifiedEvent as Ro, ListPermissionsOptions as Rp, AgentAccessTokenClaims as Rr, VaultDekDecryptedEventResponse as Rs, RadarListEntryAlreadyPresentResponse as Rt, TotpWithSecretsResponse as Ru, ConflictException as S, ConnectionDeletedEvent as Sa, SerializedValidateApiKeyResponse as Sc, AuthenticateUserWithRadarEmailChallengeCredentials as Sd, GroupRoleAssignmentEntryWithResourceExternalId as Sf, UpdateOrganizationOptions as Si, PasswordResetEvent as Sl, EventDirectoryResponse as Sm, DataIntegrationCustomProviderAuthenticateVia as Sn, InvitationRevokedEvent as So, AuthorizationCheckResult as Sp, CreateApplicationOptions as Sr, UserCreatedEventResponse as Ss, AuditLogActorSchema as St, UserManagementAuthorizationURLOptions as Su, AuthenticationErrorData as T, DsyncActivatedEventResponse as Ta, ListOrganizationApiKeysOptions as Tc, AuthenticateUserWithMagicAuthCredentials as Td, SerializedGroupRoleAssignmentEntry as Tf, ListOrganizationsOptions as Ti, CreateMagicAuthResponse as Tl, HttpClientResponseInterface as Tm, DataIntegrationCredentialType as Tn, MagicAuthCreatedEventResponse as To, DeleteAuthorizationResourceByExternalIdOptions as Tp, CreateOAuthApplication as Tr, UserUpdatedEvent as Ts, AuditLogSchemaResponse as Tt, AuthenticationFactor as Tu, VaultObject as U, DsyncUserUpdatedEventResponse as Ua, SerializedUserApiKeyWithValue as Uc, Profile as Ud, GroupRoleAssignmentResponse as Uf, ApiKeyCreatedEventResponse as Ui, AuthorizationOrganizationMembershipResponse as Ul, CustomProviderDefinition as Un, OrganizationMembershipDeletedResponse as Uo, Permission as Up, SerializedAgentCredentialValidation as Ur, VaultMetadataReadEvent as Us, RadarStandaloneResponseControl as Ut, AuthenticationEventSso as Uu, ObjectVersion as V, DsyncUserDeletedEventResponse as Va, SerializedVerifyEmailOptions as Vc, ProfileAndToken as Vd, ListGroupRoleAssignmentsOptions as Vf, GenerateLinkIntent as Vi, SerializedListOrganizationMembershipsOptions as Vl, GetDataIntegrationOptions as Vn, OrganizationMembershipCreatedResponse as Vo, CreatePermissionOptions as Vp, InvalidAgentCredential as Vr, VaultKekCreatedEvent as Vs, RadarStandaloneResponseWire as Vt, AuthenticationEvent as Vu, VaultObjectResponse as W, EmailVerificationCreatedEvent as Wa, UserApiKeyWithValue as Wc, ProfileResponse as Wd, RemoveRoleAssignmentOptions as Wf, ApiKeyRevokedEvent as Wi, BaseOrganizationMembership as Wl, CustomProviderDefinitionResponse as Wn, OrganizationMembershipUpdated as Wo, PermissionResponse as Wp, SerializedValidateAgentCredentialOptions as Wr, VaultMetadataReadEventResponse as Ws, RadarStandaloneResponseVerdict as Wt, AuthenticationEventSsoResponse as Wu, CreateDataKeyResponseWire as X, FlagCreatedEvent as Xa, UpdateUserOptions as Xc, GetProfileOptions as Xd, AssignRoleOptions as Xf, AuthenticationMagicAuthSucceededEvent as Xi, SerializedListInvitationsOptions as Xl, CreatePasswordlessSessionOptions as Xn, OrganizationRoleUpdatedEvent as Xo, CreateOrganizationRoleOptions as Xp, ClaimAttemptResponse as Xr, SerializedUpdateGroupOptions as Xs, DataIntegrationsListResponseWire as Xt, AuthenticateWithSessionCookieOptions as Xu, CreateDataKeyResponse as Y, EventResponse as Ya, SerializedUpdateUserOptions as Yc, GetProfileAndTokenOptions as Yd, SerializedRemoveRoleOptions as Yf, AuthenticationMagicAuthFailedEventResponse as Yi, ListInvitationsOptions as Yl, SendSessionResponse as Yn, OrganizationRoleDeletedEventResponse as Yo, UpdateOrganizationRoleOptions as Yp, ClaimAttemptOrganization as Yr, KeyContext as Ys, DataIntegrationsListResponse as Yt, AuthenticateWithSessionCookieFailureReason as Yu, UpdateObjectEntity as Z, FlagCreatedEventResponse as Za, SerializedUpdateOrganizationMembershipOptions as Zc, Connection as Zd, AssignRoleOptionsWithResourceExternalId as Zf, AuthenticationMagicAuthSucceededEventResponse as Zi, ListGroupsForOrganizationMembershipOptions as Zl, SerializedCreatePasswordlessSessionOptions as Zn, OrganizationRoleUpdatedEventResponse as Zo, SerializedCreateOrganizationRoleOptions as Zp, LinkClaimAttemptToExternalUserOptions as Zr, UpdateGroupOptions as Zs, DataIntegrationsListResponseData as Zt, AuthenticateWithSessionCookieSuccessResponse as Zu, SignatureVerificationException as _, AuthenticationSSOSucceededEventResponse as _a, FlagTarget as _c, AuthenticateWithOrganizationSelectionOptions as _d, ListEffectivePermissionsByExternalIdOptions as _f, ActionPayload as _i, RefreshSessionFailureReason as _l, DirectoryResponse as _m, DataIntegration as _n, InvitationAcceptedEventResponse as _o, ListResourcesForMembershipOptionsWithParentId as _p, CreateApplicationClientSecretOptions as _r, SessionCreatedEventResponse as _s, AuditLogActor as _t, CreateOrganizationMembershipOptions as _u, PublicWorkOS as a, AuthenticationPasskeyFailedEventResponse as aa, CreateGroupOptions as ac, UserResponse as ad, DirectoryUserResponse as af, AgentRegistrationStatus as ai, SendRadarSmsChallengeResponse as al, EnvironmentRole as am, DataIntegrationAccessTokenResponse as an, GroupCreatedEventResponse as ao, SerializedListRoleAssignmentsOptions as ap, ApplicationCredentialsListItemResponse as ar, PermissionCreatedEventResponse as as, DecryptDataKeyResponse as at, SerializedEnrollUserInMfaFactorOptions as au, NotFoundException as b, ConnectionDeactivatedEvent as ba, EvaluationContext as bc, AuthenticateWithRadarSmsChallengeOptions as bd, GroupRoleAssignmentEntry as bf, UserRegistrationActionPayload as bi, TerminalRefreshSessionFailureReason as bl, DirectoryType as bm, DataIntegrationCustomProvider as bn, InvitationResentEvent as bo, AuthorizationCheckOptionsWithResourceExternalId as bp, UpdateApplicationOptions as br, UnknownEvent as bs, CreateAuditLogEventRequestOptions as bt, SerializedCreateMagicAuthOptions as bu, PortalLinkResponseWire as c, AuthenticationPasswordFailedEvent as ca, SerializedAddGroupOrganizationMembershipOptions as cc, AuthenticateWithRefreshTokenPublicClientOptions as cd, ListOrganizationRolesResponse as cf, SerializedAgentRegistrationClaim as ci, SendInvitationOptions as cl, EnvironmentRoleResponse as cm, DataIntegrationAccessTokenResponseAccessTokenResponse as cn, GroupMemberAddedEvent as co, RoleAssignmentResourceResponse as cp, ConnectApplicationM2MResponse as cr, PermissionUpdatedEvent as cs, WidgetSessionTokenResponseWire as ct, EmailVerificationEventResponse as cu, IntentOptions as d, AuthenticationPasswordSucceededEventResponse as da, RuntimeClientOptions as dc, AuthenticateWithRefreshTokenOptions as dd, OrganizationRoleResponse as df, PKCEPair as di, SerializedRevokeSessionOptions as dl, ListDirectoriesOptions as dm, DataIntegrationCredentialsResponseCredentialResponse as dn, GroupMemberEventResponseData as do, RoleAssignmentSource as dp, ConnectApplicationResponse as dr, RoleCreatedEventResponse as ds, FeatureFlagsRuntimeClient as dt, SerializedCreateUserOptions as du, AuthenticationOAuthFailedEvent as ea, ListGroupOrganizationMembershipsOptions as ec, AuthenticationResponse as ed, ConnectionType as ef, AgentIdentity as ei, Session as el, SetEnvironmentRolePermissionsOptions as em, DataIntegrationsListResponseDataAuthMethods as en, FlagRuleUpdatedEvent as eo, SerializedAssignRoleOptions as ep, ListEventOptions as er, PasswordResetCreatedEvent as es, ReadObjectOptions as et, InvitationEvent as eu, IntentOptionsResponse as f, AuthenticationRadarRiskDetectedEvent as fa, RemoveFlagTargetOptions as fc, SerializedAuthenticateWithRefreshTokenOptions as fd, Role as ff, Actions as fi, serializeRevokeSessionOptions as fl, SerializedListDirectoriesOptions as fm, DataIntegrationAuthorizeUrlResponse as fn, GroupMemberRemovedEvent as fo, RoleAssignmentSourceResponse as fp, ConnectApplicationRedirectUri as fr, RoleDeletedEvent as fs, CookieSession as ft, CreateUserApiKeyOptions as fu, UnauthorizedException as g, AuthenticationSSOSucceededEvent as ga, FlagPollResponse as gc, AuthenticateUserWithOrganizationSelectionCredentials as gd, RoleResponse as gf, ActionContext as gi, SerializedResendInvitationOptions as gl, Directory as gm, ConnectedAccountAuthMethod as gn, InvitationAcceptedEvent as go, ListResourcesForMembershipOptionsWithParentExternalId as gp, DeleteClientSecretOptions as gr, SessionCreatedEvent as gs, SerializedCreateAuditLogSchemaOptions as gt, SerializedCreatePasswordResetOptions as gu, UnprocessableEntityException as h, AuthenticationSSOFailedEventResponse as ha, FlagPollEntry as hc, SerializedAuthenticateWithPasswordOptions as hd, RoleList as hf, UserRegistrationActionResponseData as hi, ResendInvitationOptions as hl, DirectoryGroupResponse as hm, ConnectedAccountResponse as hn, GroupUpdatedEventResponse as ho, ListResourcesForMembershipOptions as hp, ExternalAuthCompleteResponseWire as hr, RoleUpdatedEventResponse as hs, CreateAuditLogSchemaResponse as ht, CreatePasswordResetOptions as hu, PublicUserManagement as i, AuthenticationPasskeyFailedEvent as ia, DeleteGroupOptions as ic, User as id, DirectoryUser as if, AgentRegistrationKind as ii, SendRadarSmsChallengeOptions as il, SerializedCreateEnvironmentRoleOptions as im, DataIntegrationsListResponseDataConnectedAccountAuthMethod as in, GroupCreatedEvent as io, ListRoleAssignmentsOptions as ip, ApplicationCredentialsListItem as ir, PermissionCreatedEvent as is, DecryptDataKeyOptions as it, EnrollAuthFactorOptions as iu, Webhooks as j, DsyncGroupDeletedEventResponse as ja, ApiKey as jc, AuthenticateWithCodeAndVerifierOptions as jd, RemoveGroupRoleAssignmentsOptionsWithResourceId as jf, DomainDataState as ji, LogoutURLOptions as jl, GetUserConnectedAccountOptions as jn, OrganizationDomainCreatedEventResponse as jo, AuthorizationResourceResponse as jp, UserConsentOption as jr, VaultDataDeletedEvent as js, VerifyResponse as jt, FactorResponse as ju, WorkOSErrorData as k, DsyncGroupCreatedEventResponse as ka, CreateOrganizationApiKeyRequestOptions as kc, AuthenticateWithEmailVerificationOptions as kd, RemoveGroupRoleAssignmentsOptionsForOrganization as kf, SerializedCreateOrganizationOptions as ki, MagicAuthEventResponse as kl, ResponseHeaders as km, CreateUserConnectedAccountOptions as kn, OrganizationDeletedResponse as ko, SerializedListAuthorizationResourcesOptions as kp, ListApplicationsOptions as kr, VaultDataCreatedEvent as ks, AuditLogExportOptions as kt, AuthenticationFactorWithSecretsResponse as ku, GenerateLink as l, AuthenticationPasswordFailedEventResponse as la, RuntimeClientStats as lc, SerializedAuthenticateWithRefreshTokenPublicClientOptions as ld, OrganizationRoleEvent as lf, SerializedAgentRegistrationClaimCompletion as li, SerializedSendInvitationOptions as ll, ListDirectoryUsersOptions as lm, DataIntegrationCredentialsResponseError as ln, GroupMemberAddedEventResponse as lo, RoleAssignmentResponse as lp, ConnectApplicationOAuth as lr, PermissionUpdatedEventResponse as ls, CreateTokenOptions as lt, EmailVerificationResponse as lu, SSOIntentOptionsResponse as m, AuthenticationSSOFailedEvent as ma, FlagChange as mc, AuthenticateWithPasswordOptions as md, RoleEventResponse as mf, ResponsePayload as mi, SerializedResetPasswordOptions as ml, DirectoryGroup as mm, ConnectedAccount as mn, GroupUpdatedEvent as mo, ListMembershipsForResourceOptions as mp, ExternalAuthCompleteResponse as mr, RoleUpdatedEvent as ms, CreateAuditLogSchemaRequestOptions as mt, SerializedCreateUserApiKeyOptions as mu, PublicClientOptions as n, AuthenticationOAuthSucceededEvent as na, GroupResponse as nc, CreateUserResponse as nd, SSOPKCEAuthorizationURLResult as nf, AgentRegistrationClaim as ni, SessionStatus as nl, UpdateEnvironmentRoleOptions as nm, DataIntegrationsListResponseDataConnectedAccountResponse as nn, FlagUpdatedEvent as no, ListRoleAssignmentsForResourceOptions as np, NewConnectApplicationSecret as nr, PasswordResetSucceededEvent as ns, CreateObjectEntity as nt, InvitationResponse as nu, createWorkOS as o, AuthenticationPasskeySucceededEvent as oa, SerializedCreateGroupOptions as oc, Impersonator as od, DirectoryUserWithGroups as of, SerializedAgentIdentity as oi, SendRadarSmsChallengeResponseResponse as ol, EnvironmentRoleList as om, DataIntegrationAccessTokenResponseWire as on, GroupDeletedEvent as oo, RoleAssignment as op, ConnectApplication as or, PermissionDeletedEvent as os, CreateDataKeyOptions as ot, EmailVerification as ou, SSOIntentOptions as p, AuthenticationRadarRiskDetectedEventResponse as pa, ListFeatureFlagsOptions as pc, AuthenticateUserWithPasswordCredentials as pd, RoleEvent as pf, AuthenticationActionResponseData as pi, ResetPasswordOptions as pl, PaginationOptions as pm, DataIntegrationAuthorizeUrlResponseWire as pn, GroupMemberRemovedEventResponse as po, ListMembershipsForResourceByExternalIdOptions as pp, ConnectApplicationRedirectUriResponse as pr, RoleDeletedEventResponse as ps, CreateAuditLogSchemaOptions as pt, CreateUserApiKeyRequestOptions as pu, Actor as q, EventBase as qa, SerializedUpdateUserPasswordOptions as qc, ListConnectionsOptions as qd, RemoveRoleOptionsWithResourceExternalId as qf, AuthenticationEmailVerificationSucceededEventResponse as qi, OrganizationMembershipResponse as ql, DataIntegrationCredentialsDtoResponse as qn, OrganizationRoleCreatedEventResponse as qo, SetOrganizationRolePermissionsOptions as qp, ValidateAgentApiKeyOptions as qr, DataKey as qs, RadarStandaloneAssessRequestAction as qt, SerializedAuthenticateWithTotpOptions as qu, PublicSSO as r, AuthenticationOAuthSucceededEventResponse as ra, GetGroupOptions as rc, CreateUserResponseResponse as rd, DefaultCustomAttributes as rf, AgentRegistrationClaimCompletion as ri, SendVerificationEmailOptions as rl, CreateEnvironmentRoleOptions as rm, DataIntegrationsListResponseDataConnectedAccountState as rn, FlagUpdatedEventResponse as ro, SerializedListRoleAssignmentsForResourceOptions as rp, NewConnectApplicationSecretResponse as rr, PasswordResetSucceededEventResponse as rs, CreateObjectOptions as rt, Identity as ru, PortalLinkResponse as s, AuthenticationPasskeySucceededEventResponse as sa, AddGroupOrganizationMembershipOptions as sc, ImpersonatorResponse as sd, DirectoryUserWithGroupsResponse as sf, SerializedAgentRegistration as si, SerializedSendRadarSmsChallengeOptions as sl, EnvironmentRoleListResponse as sm, DataIntegrationAccessTokenResponseAccessToken as sn, GroupDeletedEventResponse as so, RoleAssignmentResource as sp, ConnectApplicationM2M as sr, PermissionDeletedEventResponse as ss, WidgetSessionTokenResponse as st, EmailVerificationEvent as su, ConfidentialClientOptions as t, AuthenticationOAuthFailedEventResponse as ta, Group as tc, AuthenticationResponseResponse as td, SSOAuthorizationURLOptions as tf, AgentRegistration as ti, SessionResponse as tl, SerializedUpdateEnvironmentRoleOptions as tm, DataIntegrationsListResponseDataConnectedAccount as tn, FlagRuleUpdatedEventResponse as to, ListRoleAssignmentsForResourceByExternalIdOptions as tp, SerializedListEventOptions as tr, PasswordResetCreatedEventResponse as ts, ReadObjectResponse as tt, InvitationEventResponse as tu, GenerateLinkResponse as u, AuthenticationPasswordSucceededEvent as ua, RuntimeClientLogger as uc, AuthenticateUserWithRefreshTokenCredentials as ud, OrganizationRoleEventResponse as uf, PKCE as ui, RevokeSessionOptions as ul, ListDirectoryGroupsOptions as um, DataIntegrationCredentialsResponseCredential as un, GroupMemberEventData as uo, RoleAssignmentRole as up, ConnectApplicationOAuthResponse as ur, RoleCreatedEvent as us, WidgetSessionTokenScopes as ut, CreateUserOptions as uu, RateLimitExceededException as v, ConnectionActivatedEvent as va, FeatureFlag as vc, SerializedAuthenticateWithOrganizationSelectionOptions as vd, ListEffectivePermissionsOptions as vf, UserData as vi, RefreshSessionResponse as vl, DirectoryState as vm, DataIntegrationResponse as vn, InvitationCreatedEvent as vo, SerializedListResourcesForMembershipOptions as vp, ListApplicationClientSecretsOptions as vr, SessionRevokedEvent as vs, AuditLogTarget as vt, SerializedCreateOrganizationMembershipOptions as vu, AuthenticationErrorCode as w, DsyncActivatedEvent as wa, ValidateApiKeyResponse as wc, SerializedAuthenticateWithRadarEmailChallengeOptions as wd, ReplaceGroupRoleAssignmentsOptions as wf, OrganizationResponse as wi, PasswordResetResponse as wl, HttpClientInterface as wm, DataIntegrationCredentialResponse as wn, MagicAuthCreatedEvent as wo, DeleteAuthorizationResourceOptions as wp, CreateM2MApplicationResponse as wr, UserDeletedEventResponse as ws, AuditLogSchemaMetadata as wt, AuthenticationRadarRiskDetectedEventResponseData as wu, NoApiKeyProvidedException as x, ConnectionDeactivatedEventResponse as xa, AddFlagTargetOptions as xc, SerializedAuthenticateWithRadarSmsChallengeOptions as xd, GroupRoleAssignmentEntryForOrganization as xf, SerializedUpdateOrganizationOptions as xi, PasswordReset as xl, EventDirectory as xm, DataIntegrationCustomProviderResponse as xn, InvitationResentEventResponse as xo, AuthorizationCheckOptionsWithResourceId as xp, GetApplicationOptions as xr, UserCreatedEvent as xs, SerializedCreateAuditLogEventOptions as xt, PKCEAuthorizationURLResult as xu, OauthException as y, ConnectionActivatedEventResponse as ya, FeatureFlagResponse as yc, AuthenticateUserWithRadarSmsChallengeCredentials as yd, BaseGroupRoleAssignmentEntry as yf, UserDataPayload as yi, RetryableRefreshSessionFailureReason as yl, DirectoryStateResponse as ym, DataIntegrationState as yn, InvitationCreatedEventResponse as yo, AuthorizationCheckOptions as yp, DeleteApplicationOptions as yr, SessionRevokedEventResponse as ys, CreateAuditLogEventOptions as yt, CreateMagicAuthOptions as yu, ObjectSummary as z, DsyncUserCreatedEventResponse as za, CreateOrganizationDomainOptions as zc, SerializedAuthenticateWithOptionsBase as zd, SerializedCreateGroupRoleAssignmentOptions as zf, ListResponse as zi, SerializedListSessionsOptions as zl, UpdateCustomProviderDefinitionResponse as zn, OrganizationDomainVerifiedEventResponse as zo, SerializedUpdatePermissionOptions as zp, AgentCredentialType as zr, VaultDekReadEvent as zs, RadarListEntryAlreadyPresentResponseWire as zt, Sms as zu };
|
|
9913
|
+
//# sourceMappingURL=factory-DmBBe791.d.mts.map
|