@atlasauth/backend 0.5.0 → 0.6.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 +187 -0
- package/dist/client/activity.d.ts +104 -0
- package/dist/client/activity.js +29 -0
- package/dist/client/activity.js.map +1 -0
- package/dist/client/audit-events.d.ts +103 -0
- package/dist/client/audit-events.js +43 -0
- package/dist/client/audit-events.js.map +1 -0
- package/dist/client/billing-plans.d.ts +43 -0
- package/dist/client/billing-plans.js +26 -0
- package/dist/client/billing-plans.js.map +1 -1
- package/dist/client/connectors.d.ts +174 -0
- package/dist/client/connectors.js +54 -0
- package/dist/client/connectors.js.map +1 -0
- package/dist/client/data-subject-requests.d.ts +21 -0
- package/dist/client/data-subject-requests.js +15 -0
- package/dist/client/data-subject-requests.js.map +1 -1
- package/dist/client/design.d.ts +295 -0
- package/dist/client/design.js +76 -0
- package/dist/client/design.js.map +1 -0
- package/dist/client/diagnostics.d.ts +53 -0
- package/dist/client/diagnostics.js +24 -0
- package/dist/client/diagnostics.js.map +1 -0
- package/dist/client/email-addresses.d.ts +22 -0
- package/dist/client/email-addresses.js +17 -0
- package/dist/client/email-addresses.js.map +1 -0
- package/dist/client/entitlement-overrides.d.ts +50 -0
- package/dist/client/entitlement-overrides.js +20 -0
- package/dist/client/entitlement-overrides.js.map +1 -0
- package/dist/client/error.d.ts +28 -0
- package/dist/client/error.js +27 -1
- package/dist/client/error.js.map +1 -1
- package/dist/client/index.d.ts +458 -16
- package/dist/client/index.js +76 -2
- package/dist/client/index.js.map +1 -1
- package/dist/client/instance.d.ts +54 -0
- package/dist/client/instance.js +18 -0
- package/dist/client/instance.js.map +1 -1
- package/dist/client/invitations.d.ts +14 -0
- package/dist/client/invitations.js +9 -0
- package/dist/client/invitations.js.map +1 -1
- package/dist/client/legacy-auth.d.ts +45 -0
- package/dist/client/legacy-auth.js +18 -0
- package/dist/client/legacy-auth.js.map +1 -0
- package/dist/client/mcp.d.ts +86 -0
- package/dist/client/mcp.js +47 -0
- package/dist/client/mcp.js.map +1 -0
- package/dist/client/notifications.d.ts +92 -0
- package/dist/client/notifications.js +55 -0
- package/dist/client/notifications.js.map +1 -0
- package/dist/client/oauth-clients.d.ts +46 -2
- package/dist/client/oauth-clients.js +4 -0
- package/dist/client/oauth-clients.js.map +1 -1
- package/dist/client/oauth-providers.d.ts +67 -7
- package/dist/client/oauth-providers.js +7 -2
- package/dist/client/oauth-providers.js.map +1 -1
- package/dist/client/openfga.d.ts +137 -0
- package/dist/client/openfga.js +72 -0
- package/dist/client/openfga.js.map +1 -0
- package/dist/client/org-ldap-connections.d.ts +75 -0
- package/dist/client/org-ldap-connections.js +36 -0
- package/dist/client/org-ldap-connections.js.map +1 -0
- package/dist/client/organization-settings-schema.d.ts +24 -0
- package/dist/client/organization-settings-schema.js +30 -0
- package/dist/client/organization-settings-schema.js.map +1 -0
- package/dist/client/organizations.d.ts +205 -4
- package/dist/client/organizations.js +109 -0
- package/dist/client/organizations.js.map +1 -1
- package/dist/client/pca.d.ts +59 -0
- package/dist/client/pca.js +40 -0
- package/dist/client/pca.js.map +1 -0
- package/dist/client/platform.d.ts +328 -0
- package/dist/client/platform.js +187 -0
- package/dist/client/platform.js.map +1 -0
- package/dist/client/redirect-urls.d.ts +23 -0
- package/dist/client/redirect-urls.js +22 -0
- package/dist/client/redirect-urls.js.map +1 -0
- package/dist/client/request.d.ts +45 -0
- package/dist/client/request.js +35 -2
- package/dist/client/request.js.map +1 -1
- package/dist/client/session-exchange-apps.d.ts +43 -0
- package/dist/client/session-exchange-apps.js +25 -0
- package/dist/client/session-exchange-apps.js.map +1 -0
- package/dist/client/sessions.d.ts +12 -0
- package/dist/client/sessions.js +10 -0
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/sign-in-tokens.d.ts +13 -1
- package/dist/client/sign-in-tokens.js +11 -0
- package/dist/client/sign-in-tokens.js.map +1 -1
- package/dist/client/test-mode.d.ts +44 -0
- package/dist/client/test-mode.js +26 -0
- package/dist/client/test-mode.js.map +1 -0
- package/dist/client/tickets.d.ts +49 -0
- package/dist/client/tickets.js +19 -0
- package/dist/client/tickets.js.map +1 -0
- package/dist/client/users.d.ts +346 -0
- package/dist/client/users.js +228 -0
- package/dist/client/users.js.map +1 -1
- package/dist/client/waitlist.d.ts +21 -0
- package/dist/client/waitlist.js +16 -0
- package/dist/client/waitlist.js.map +1 -1
- package/dist/client/webhooks.d.ts +60 -6
- package/dist/client/webhooks.js +36 -2
- package/dist/client/webhooks.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +9 -1
- package/dist/index.js.map +1 -1
- package/dist/logout-token.d.ts +97 -0
- package/dist/logout-token.js +182 -0
- package/dist/logout-token.js.map +1 -0
- package/dist/verify.d.ts +7 -0
- package/dist/verify.js +13 -0
- package/dist/verify.js.map +1 -1
- package/package.json +1 -1
package/dist/client/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { type AtlasClientConfig } from './request';
|
|
1
|
+
import { type AtlasClientConfig, type AtlasRequestSettings } from './request';
|
|
2
|
+
import type { RequestFn } from './request';
|
|
2
3
|
/**
|
|
3
4
|
* The typed management client for the Atlas Backend API — the secret-key
|
|
4
5
|
* surface, the peer of `@clerk/backend`'s `createClerkClient`.
|
|
@@ -8,7 +9,8 @@ import { type AtlasClientConfig } from './request';
|
|
|
8
9
|
* mapping and the wire types live, so this file stays a table of contents you
|
|
9
10
|
* can read top to bottom to see the whole surface.
|
|
10
11
|
*/
|
|
11
|
-
export declare function createAtlasClient(config: AtlasClientConfig):
|
|
12
|
+
export declare function createAtlasClient(config: AtlasClientConfig): AtlasClient;
|
|
13
|
+
declare function buildNamespaces(request: RequestFn): {
|
|
12
14
|
users: {
|
|
13
15
|
list(params?: import("./users").ListUsersParams): Promise<import("./types").CursorPage<import("./users").User>>;
|
|
14
16
|
get(id: string): Promise<import("./users").User>;
|
|
@@ -85,6 +87,75 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
85
87
|
deleted: true;
|
|
86
88
|
tokens_revoked: number;
|
|
87
89
|
}>;
|
|
90
|
+
byEmails(body: import("./users").UsersByEmailsBody): Promise<import("./types").ListPage<import("./users").UserEmailMatch>>;
|
|
91
|
+
resolved(id: string): Promise<import("./users").ResolvedUser>;
|
|
92
|
+
state(id: string): Promise<import("./users").UserState>;
|
|
93
|
+
signInHistory(id: string, params?: import("./types").CursorParams): Promise<import("./types").CursorPage<import("./users").SignInEvent>>;
|
|
94
|
+
listOrganizationMemberships(id: string, params?: import("./types").CursorParams): Promise<import("./types").CursorPage<import("./users").UserOrganizationMembership>>;
|
|
95
|
+
setPassword(id: string, body: import("./users").SetUserPasswordBody): Promise<import("./users").User>;
|
|
96
|
+
deleteProfileImage(id: string): Promise<import("./users").User>;
|
|
97
|
+
deletePasskey(id: string, passkeyId: string): Promise<{
|
|
98
|
+
object: "passkey";
|
|
99
|
+
id: string;
|
|
100
|
+
deleted: true;
|
|
101
|
+
}>;
|
|
102
|
+
importIdentity(id: string, body: import("./users").ImportIdentityBody): Promise<import("./users").Identity>;
|
|
103
|
+
removeIdentityByProvider(id: string, provider: string): Promise<{
|
|
104
|
+
object: string;
|
|
105
|
+
id: string;
|
|
106
|
+
provider: string;
|
|
107
|
+
removed: boolean;
|
|
108
|
+
}>;
|
|
109
|
+
acknowledgeErasure(id: string, body: import("./users").UserErasureAckBody, idempotencyKey?: string): Promise<import("./users").UserErasureAck>;
|
|
110
|
+
erasureExport(id: string): Promise<import("./users").UserErasureExport>;
|
|
111
|
+
deletion: {
|
|
112
|
+
schedule(id: string, body?: {
|
|
113
|
+
grace_seconds?: number;
|
|
114
|
+
}, idempotencyKey?: string): Promise<import("./users").User>;
|
|
115
|
+
cancel(id: string, idempotencyKey?: string): Promise<import("./users").User>;
|
|
116
|
+
finalize(id: string, idempotencyKey?: string): Promise<{
|
|
117
|
+
object: "user";
|
|
118
|
+
id: string;
|
|
119
|
+
deleted: true;
|
|
120
|
+
}>;
|
|
121
|
+
};
|
|
122
|
+
directives: {
|
|
123
|
+
impose(id: string, body: import("./users").ImposeUserDirectiveBody, idempotencyKey?: string): Promise<import("./users").UserDirective>;
|
|
124
|
+
lift(id: string): Promise<{
|
|
125
|
+
object: "directive";
|
|
126
|
+
user_id: string;
|
|
127
|
+
lifted: true;
|
|
128
|
+
}>;
|
|
129
|
+
};
|
|
130
|
+
consents: {
|
|
131
|
+
list(id: string): Promise<{
|
|
132
|
+
object: string;
|
|
133
|
+
data: import("./users").UserConsent[];
|
|
134
|
+
}>;
|
|
135
|
+
record(id: string, body: import("./users").RecordUserConsentBody, idempotencyKey?: string): Promise<import("./users").UserConsent>;
|
|
136
|
+
};
|
|
137
|
+
approvalRequests: {
|
|
138
|
+
create(id: string, body: import("./users").CreateUserApprovalRequestBody): Promise<import("./users").UserApprovalRequestCreated>;
|
|
139
|
+
get(id: string, approvalId: string): Promise<import("./users").UserApprovalRequest>;
|
|
140
|
+
};
|
|
141
|
+
notificationPreferences: {
|
|
142
|
+
get(id: string): Promise<import("./users").UserNotificationPreferences>;
|
|
143
|
+
update(id: string, body: import("./users").UpdateUserNotificationPreferencesBody): Promise<import("./users").UserNotificationPreferences>;
|
|
144
|
+
};
|
|
145
|
+
phoneNumbers: {
|
|
146
|
+
add(id: string, body: {
|
|
147
|
+
phone_number: string;
|
|
148
|
+
}): Promise<import("./users").UserPhoneNumber>;
|
|
149
|
+
verify(id: string, phoneId: string): Promise<import("./users").UserPhoneNumber>;
|
|
150
|
+
delete(id: string, phoneId: string): Promise<{
|
|
151
|
+
object: "phone_number";
|
|
152
|
+
id: string;
|
|
153
|
+
deleted: true;
|
|
154
|
+
}>;
|
|
155
|
+
};
|
|
156
|
+
progression: {
|
|
157
|
+
addEvent(id: string, body: import("./users").UserProgressionEventBody): Promise<import("./users").UserProgressionEvent>;
|
|
158
|
+
};
|
|
88
159
|
};
|
|
89
160
|
sessions: {
|
|
90
161
|
create(params: import("./sessions").CreateSessionParams): Promise<import("./sessions").MintedSession>;
|
|
@@ -95,6 +166,7 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
95
166
|
id: string;
|
|
96
167
|
status: "revoked";
|
|
97
168
|
}>;
|
|
169
|
+
getToken(id: string, template: string): Promise<import("./sessions").SessionTemplateToken>;
|
|
98
170
|
};
|
|
99
171
|
organizations: {
|
|
100
172
|
list(params?: import("./types").CursorParams): Promise<import("./types").CursorPage<import("./organizations").Organization>>;
|
|
@@ -173,6 +245,49 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
173
245
|
deleted: true;
|
|
174
246
|
}>;
|
|
175
247
|
};
|
|
248
|
+
settings: {
|
|
249
|
+
get(orgId: string): Promise<import("./organizations").OrganizationSettings>;
|
|
250
|
+
replace(orgId: string, values: Record<string, unknown>, idempotencyKey?: string): Promise<import("./organizations").OrganizationSettings>;
|
|
251
|
+
update(orgId: string, values: Record<string, unknown>, idempotencyKey?: string): Promise<import("./organizations").OrganizationSettings>;
|
|
252
|
+
};
|
|
253
|
+
auditStreams: {
|
|
254
|
+
list(orgId: string): Promise<import("./types").ListPage<import("./organizations").OrganizationAuditStream>>;
|
|
255
|
+
create(orgId: string, body: import("./organizations").CreateOrganizationAuditStreamBody, idempotencyKey?: string): Promise<import("./organizations").OrganizationAuditStream>;
|
|
256
|
+
delete(orgId: string, streamId: string): Promise<{
|
|
257
|
+
object: "org_audit_stream";
|
|
258
|
+
id: string;
|
|
259
|
+
deleted: true;
|
|
260
|
+
}>;
|
|
261
|
+
};
|
|
262
|
+
branding: {
|
|
263
|
+
get(orgId: string): Promise<import("./organizations").OrganizationBranding>;
|
|
264
|
+
update(orgId: string, body: import("./organizations").UpdateOrganizationBrandingBody): Promise<import("./organizations").OrganizationBranding>;
|
|
265
|
+
};
|
|
266
|
+
endUsers: {
|
|
267
|
+
list(orgId: string, params?: import("./organizations").ListOrganizationEndUsersParams): Promise<import("./types").CursorPage<import("./organizations").OrganizationEndUser> & {
|
|
268
|
+
object: "list";
|
|
269
|
+
}>;
|
|
270
|
+
add(orgId: string, body: import("./organizations").AddOrganizationEndUserBody, idempotencyKey?: string): Promise<import("./organizations").OrganizationEndUser>;
|
|
271
|
+
update(orgId: string, userId: string, body: {
|
|
272
|
+
status: import("./organizations").OrganizationEndUserStatus;
|
|
273
|
+
}): Promise<import("./organizations").OrganizationEndUser>;
|
|
274
|
+
remove(orgId: string, userId: string): Promise<{
|
|
275
|
+
object: "organization_end_user";
|
|
276
|
+
id: string;
|
|
277
|
+
deleted: true;
|
|
278
|
+
}>;
|
|
279
|
+
};
|
|
280
|
+
readerDomain: {
|
|
281
|
+
list(orgId: string): Promise<import("./types").ListPage<import("./organizations").OrganizationReaderDomain>>;
|
|
282
|
+
create(orgId: string, body: {
|
|
283
|
+
host: string;
|
|
284
|
+
}, idempotencyKey?: string): Promise<import("./organizations").OrganizationReaderDomainCreated>;
|
|
285
|
+
delete(orgId: string): Promise<{
|
|
286
|
+
object: "custom_domain";
|
|
287
|
+
id: string;
|
|
288
|
+
deleted: true;
|
|
289
|
+
}>;
|
|
290
|
+
};
|
|
176
291
|
groupRoles: {
|
|
177
292
|
grant(orgId: string, groupId: string, roleId: string): Promise<{
|
|
178
293
|
object: "group_role_grant";
|
|
@@ -215,6 +330,9 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
215
330
|
}>;
|
|
216
331
|
};
|
|
217
332
|
oauthClients: {
|
|
333
|
+
import(body: {
|
|
334
|
+
clients: import("./oauth-clients").ImportOAuthClientEntry[];
|
|
335
|
+
}, idempotencyKey?: string): Promise<import("./types").ListPage<import("./oauth-clients").ImportedOAuthClient>>;
|
|
218
336
|
list(): Promise<import("./types").ListPage<import("./oauth-clients").OAuthClient>>;
|
|
219
337
|
get(id: string): Promise<import("./oauth-clients").OAuthClient>;
|
|
220
338
|
create(body: import("./oauth-clients").CreateOAuthClientBody, idempotencyKey?: string): Promise<import("./oauth-clients").OAuthClientWithSecret>;
|
|
@@ -290,6 +408,15 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
290
408
|
}>;
|
|
291
409
|
};
|
|
292
410
|
waitlist: {
|
|
411
|
+
create(body: {
|
|
412
|
+
email_address: string;
|
|
413
|
+
}, idempotencyKey?: string): Promise<import("./waitlist").WaitlistEntry>;
|
|
414
|
+
bulkCreate(emailAddresses: string[], idempotencyKey?: string): Promise<import("./waitlist").BulkWaitlistResult>;
|
|
415
|
+
delete(id: string): Promise<{
|
|
416
|
+
object: "waitlist_entry";
|
|
417
|
+
id: string;
|
|
418
|
+
deleted: true;
|
|
419
|
+
}>;
|
|
293
420
|
list(params?: import("./waitlist").ListWaitlistParams): Promise<import("./waitlist").ListWaitlistResponse>;
|
|
294
421
|
decide(id: string, body: {
|
|
295
422
|
status: "approved" | "denied";
|
|
@@ -335,16 +462,19 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
335
462
|
}>;
|
|
336
463
|
};
|
|
337
464
|
invitations: {
|
|
465
|
+
bulkCreate(invitations: import("./invitations").CreateInvitationBody[], idempotencyKey?: string): Promise<import("./invitations").BulkInvitationsResult>;
|
|
338
466
|
list(params?: import("./types").CursorParams): Promise<import("./types").CursorPage<import("./invitations").Invitation>>;
|
|
339
467
|
create(body: import("./invitations").CreateInvitationBody, idempotencyKey?: string): Promise<import("./invitations").Invitation>;
|
|
340
468
|
revoke(id: string): Promise<import("./invitations").Invitation>;
|
|
341
469
|
};
|
|
342
470
|
webhooks: {
|
|
343
471
|
endpoints: {
|
|
344
|
-
list(): Promise<
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
472
|
+
list(): Promise<import("./webhooks").WebhookEndpointList>;
|
|
473
|
+
update(id: string, body: import("./webhooks").UpdateWebhookEndpointBody): Promise<import("./webhooks").WebhookEndpoint>;
|
|
474
|
+
revealSecret(id: string): Promise<import("./webhooks").WebhookSigningSecret>;
|
|
475
|
+
rotateSecret(id: string): Promise<import("./webhooks").WebhookSigningSecret>;
|
|
476
|
+
test(id: string): Promise<import("./webhooks").WebhookDeliveryQueued>;
|
|
477
|
+
redeliver(id: string, deliveryId: string): Promise<import("./webhooks").WebhookDeliveryQueued>;
|
|
348
478
|
create(body: import("./webhooks").CreateWebhookEndpointBody, idempotencyKey?: string): Promise<import("./webhooks").WebhookEndpointWithSecret>;
|
|
349
479
|
delete(id: string): Promise<{
|
|
350
480
|
object: "webhook_endpoint";
|
|
@@ -352,13 +482,20 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
352
482
|
deleted: true;
|
|
353
483
|
}>;
|
|
354
484
|
};
|
|
355
|
-
deliveries(id: string): Promise<{
|
|
485
|
+
deliveries(id: string, params?: import("./webhooks").ListWebhookDeliveriesParams): Promise<{
|
|
356
486
|
data: import("./webhooks").WebhookDelivery[];
|
|
357
|
-
has_more:
|
|
487
|
+
has_more: boolean;
|
|
488
|
+
next_cursor?: string | null;
|
|
358
489
|
}>;
|
|
490
|
+
redeliver(endpointId: string, deliveryId: string): Promise<import("./webhooks").WebhookDeliveryQueued>;
|
|
359
491
|
};
|
|
360
492
|
signInTokens: {
|
|
361
493
|
create(body: import("./sign-in-tokens").CreateSignInTokenBody, idempotencyKey?: string): Promise<import("./sign-in-tokens").SignInToken>;
|
|
494
|
+
revoke(id: string): Promise<{
|
|
495
|
+
object: "sign_in_token";
|
|
496
|
+
id: string;
|
|
497
|
+
revoked: true;
|
|
498
|
+
}>;
|
|
362
499
|
};
|
|
363
500
|
auditLogs: {
|
|
364
501
|
list(params?: import("./audit-logs").ListAuditLogsParams): Promise<import("./types").CursorPage<import("./audit-logs").AuditLog>>;
|
|
@@ -419,13 +556,9 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
419
556
|
verifyM2mToken(token: string): Promise<import("./machines").M2mTokenVerification>;
|
|
420
557
|
};
|
|
421
558
|
oauthProviders: {
|
|
422
|
-
list(): Promise<import("./types").ListPage<import("./oauth-providers").OAuthProvider>>;
|
|
559
|
+
list(params?: import("./oauth-providers").ListOAuthProvidersParams): Promise<import("./types").ListPage<import("./oauth-providers").OAuthProvider>>;
|
|
423
560
|
get(provider: string): Promise<import("./oauth-providers").OAuthProvider>;
|
|
424
|
-
upsert(provider: string, body: import("./oauth-providers").UpsertOAuthProviderBody, idempotencyKey?: string): Promise<
|
|
425
|
-
object: "oauth_provider";
|
|
426
|
-
provider: string;
|
|
427
|
-
configured: true;
|
|
428
|
-
}>;
|
|
561
|
+
upsert(provider: string, body: import("./oauth-providers").UpsertOAuthProviderBody, idempotencyKey?: string): Promise<import("./oauth-providers").OAuthProviderUpsertResult>;
|
|
429
562
|
delete(provider: string): Promise<{
|
|
430
563
|
object: "oauth_provider";
|
|
431
564
|
provider: string;
|
|
@@ -678,6 +811,9 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
678
811
|
deleted: true;
|
|
679
812
|
}>;
|
|
680
813
|
listSubscriptions(params?: import("./billing-plans").ListSubscriptionsParams): Promise<import("./types").ListPage<import("./billing-plans").BillingSubscription>>;
|
|
814
|
+
importSubscription(body: import("./billing-plans").ImportBillingSubscriptionBody, idempotencyKey?: string): Promise<import("./billing-plans").BillingSubscription>;
|
|
815
|
+
reportUsage(body: import("./billing-plans").ReportBillingUsageBody): Promise<import("./billing-plans").BillingUsageReport>;
|
|
816
|
+
syncSeats(subjectType: "user" | "org", subjectId: string): Promise<import("./billing-plans").BillingSeatSync>;
|
|
681
817
|
};
|
|
682
818
|
messaging: {
|
|
683
819
|
get(): Promise<import("./messaging").MessagingProviders>;
|
|
@@ -706,6 +842,8 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
706
842
|
getJobErrors(id: string): Promise<import("./types").ListPage<import("./import-export").JobError>>;
|
|
707
843
|
};
|
|
708
844
|
dataSubjectRequests: {
|
|
845
|
+
create(body: import("./data-subject-requests").CreateDataSubjectRequestBody, idempotencyKey?: string): Promise<import("./data-subject-requests").DataSubjectRequest>;
|
|
846
|
+
cancel(id: string): Promise<import("./data-subject-requests").DataSubjectRequest>;
|
|
709
847
|
list(params?: import("./data-subject-requests").ListDataSubjectRequestsParams): Promise<import("./types").CursorPage<import("./data-subject-requests").DataSubjectRequest>>;
|
|
710
848
|
get(id: string): Promise<import("./data-subject-requests").DataSubjectRequest>;
|
|
711
849
|
fulfill(id: string, idempotencyKey?: string): Promise<import("./data-subject-requests").DataSubjectRequest>;
|
|
@@ -738,6 +876,12 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
738
876
|
instance: {
|
|
739
877
|
get(): Promise<import("./instance").Instance>;
|
|
740
878
|
update(body: import("./instance").UpdateInstanceBody): Promise<import("./instance").InstanceUpdateResult>;
|
|
879
|
+
preflight(): Promise<import("./instance").PreflightReport>;
|
|
880
|
+
cookieConsent: {
|
|
881
|
+
get(): Promise<import("./instance").CookieConsent>;
|
|
882
|
+
set(body: import("./instance").SetCookieConsentBody): Promise<import("./instance").CookieConsent>;
|
|
883
|
+
delete(): Promise<import("./instance").CookieConsent>;
|
|
884
|
+
};
|
|
741
885
|
};
|
|
742
886
|
instanceSecurity: {
|
|
743
887
|
get(): Promise<import("./instance-security").InstanceSecurity>;
|
|
@@ -783,11 +927,290 @@ export declare function createAtlasClient(config: AtlasClientConfig): {
|
|
|
783
927
|
captcha: {
|
|
784
928
|
verify(token: string, options?: import("./captcha").VerifyCaptchaOptions): Promise<import("./captcha").CaptchaVerification>;
|
|
785
929
|
};
|
|
930
|
+
design: {
|
|
931
|
+
get(): Promise<import("./design").DesignSettings>;
|
|
932
|
+
replace(design: import("./design").AtlasDesign): Promise<import("./design").DesignSettings>;
|
|
933
|
+
update(design: import("./design").AtlasDesignPatch): Promise<import("./design").DesignSettings>;
|
|
934
|
+
preview(design: import("./design").AtlasDesign): Promise<import("./design").DesignPreview>;
|
|
935
|
+
organizations: {
|
|
936
|
+
get(organizationId: string): Promise<import("./design").DesignSettings>;
|
|
937
|
+
replace(organizationId: string, design: import("./design").AtlasDesign): Promise<import("./design").DesignSettings>;
|
|
938
|
+
update(organizationId: string, design: import("./design").AtlasDesignPatch): Promise<import("./design").DesignSettings>;
|
|
939
|
+
};
|
|
940
|
+
assets: {
|
|
941
|
+
upload(data: import("./design").DesignAssetData, options?: import("./design").UploadDesignAssetOptions): Promise<import("./design").DesignAsset>;
|
|
942
|
+
list(): Promise<import("./types").ListPage<import("./design").DesignAsset>>;
|
|
943
|
+
delete(assetId: string): Promise<import("./design").DeletedDesignAsset>;
|
|
944
|
+
};
|
|
945
|
+
catalog(): Promise<import("./design").DesignCatalog>;
|
|
946
|
+
};
|
|
947
|
+
entitlementOverrides: {
|
|
948
|
+
create(body: import("./entitlement-overrides").CreateEntitlementOverrideBody, idempotencyKey?: string): Promise<import("./entitlement-overrides").EntitlementOverride>;
|
|
949
|
+
list(params?: import("./entitlement-overrides").ListEntitlementOverridesParams): Promise<import("./types").ListPage<import("./entitlement-overrides").EntitlementOverride>>;
|
|
950
|
+
delete(id: string): Promise<{
|
|
951
|
+
object: "entitlement_override";
|
|
952
|
+
id: string;
|
|
953
|
+
deleted: true;
|
|
954
|
+
}>;
|
|
955
|
+
};
|
|
956
|
+
orgLdapConnections: {
|
|
957
|
+
list(params?: {
|
|
958
|
+
organization_id?: string;
|
|
959
|
+
}): Promise<import("./types").ListPage<import("./org-ldap-connections").OrgLdapConnection>>;
|
|
960
|
+
create(body: import("./org-ldap-connections").CreateOrgLdapConnectionBody, idempotencyKey?: string): Promise<import("./org-ldap-connections").OrgLdapConnection>;
|
|
961
|
+
get(id: string): Promise<import("./org-ldap-connections").OrgLdapConnection>;
|
|
962
|
+
update(id: string, body: import("./org-ldap-connections").UpdateOrgLdapConnectionBody, idempotencyKey?: string): Promise<import("./org-ldap-connections").OrgLdapConnection>;
|
|
963
|
+
delete(id: string): Promise<{
|
|
964
|
+
object: "org_ldap_connection";
|
|
965
|
+
id: string;
|
|
966
|
+
deleted: true;
|
|
967
|
+
}>;
|
|
968
|
+
test(id: string, body?: {
|
|
969
|
+
bind_password?: string;
|
|
970
|
+
}): Promise<import("./org-ldap-connections").OrgLdapConnectionTest>;
|
|
971
|
+
};
|
|
972
|
+
organizationSettingsSchema: {
|
|
973
|
+
get(): Promise<import("./organization-settings-schema").OrganizationSettingsSchema>;
|
|
974
|
+
create(schema: Record<string, unknown>, idempotencyKey?: string): Promise<import("./organization-settings-schema").OrganizationSettingsSchema>;
|
|
975
|
+
replace(schema: Record<string, unknown>, idempotencyKey?: string): Promise<import("./organization-settings-schema").OrganizationSettingsSchema>;
|
|
976
|
+
};
|
|
977
|
+
emailAddresses: {
|
|
978
|
+
verify(id: string): Promise<import("./email-addresses").EmailAddressRecord>;
|
|
979
|
+
setPrimary(id: string): Promise<import("./email-addresses").EmailAddressRecord>;
|
|
980
|
+
};
|
|
981
|
+
openfga: {
|
|
982
|
+
stores: {
|
|
983
|
+
list(): Promise<{
|
|
984
|
+
stores: import("./openfga").OpenFgaStore[];
|
|
985
|
+
}>;
|
|
986
|
+
create(body: {
|
|
987
|
+
name: string;
|
|
988
|
+
}, idempotencyKey?: string): Promise<import("./openfga").OpenFgaStore>;
|
|
989
|
+
get(store: string): Promise<import("./openfga").OpenFgaStore>;
|
|
990
|
+
};
|
|
991
|
+
authorizationModels: {
|
|
992
|
+
list(store: string): Promise<{
|
|
993
|
+
authorization_models: import("./openfga").OpenFgaAuthorizationModel[];
|
|
994
|
+
}>;
|
|
995
|
+
write(store: string, body: import("./openfga").WriteOpenFgaModelBody): Promise<{
|
|
996
|
+
authorization_model_id: string;
|
|
997
|
+
}>;
|
|
998
|
+
get(store: string, modelId: string): Promise<{
|
|
999
|
+
authorization_model: import("./openfga").OpenFgaAuthorizationModel;
|
|
1000
|
+
}>;
|
|
1001
|
+
};
|
|
1002
|
+
check(store: string, body: import("./openfga").OpenFgaCheckBody): Promise<{
|
|
1003
|
+
allowed: boolean;
|
|
1004
|
+
}>;
|
|
1005
|
+
batchCheck(store: string, body: import("./openfga").OpenFgaBatchCheckBody): Promise<{
|
|
1006
|
+
result: Record<string, {
|
|
1007
|
+
allowed: boolean;
|
|
1008
|
+
}>;
|
|
1009
|
+
}>;
|
|
1010
|
+
expand(store: string, body: import("./openfga").OpenFgaExpandBody): Promise<{
|
|
1011
|
+
tree: {
|
|
1012
|
+
root: Record<string, unknown>;
|
|
1013
|
+
};
|
|
1014
|
+
}>;
|
|
1015
|
+
listObjects(store: string, body: import("./openfga").OpenFgaListObjectsBody): Promise<{
|
|
1016
|
+
objects: string[];
|
|
1017
|
+
}>;
|
|
1018
|
+
read(store: string, body?: import("./openfga").OpenFgaReadBody): Promise<{
|
|
1019
|
+
tuples: import("./openfga").OpenFgaTuple[];
|
|
1020
|
+
continuation_token: string;
|
|
1021
|
+
}>;
|
|
1022
|
+
write(store: string, body: import("./openfga").OpenFgaWriteBody): Promise<Record<string, never>>;
|
|
1023
|
+
};
|
|
1024
|
+
connectors: {
|
|
1025
|
+
list(): Promise<{
|
|
1026
|
+
object: "list";
|
|
1027
|
+
data: import("./connectors").CommunityConnector[];
|
|
1028
|
+
has_more: false;
|
|
1029
|
+
}>;
|
|
1030
|
+
create(body: import("./connectors").CreateCommunityConnectorBody, idempotencyKey?: string): Promise<import("./connectors").CommunityConnector>;
|
|
1031
|
+
get(id: string): Promise<import("./connectors").CommunityConnector>;
|
|
1032
|
+
update(id: string, body: import("./connectors").UpdateCommunityConnectorBody): Promise<import("./connectors").CommunityConnector>;
|
|
1033
|
+
delete(id: string): Promise<{
|
|
1034
|
+
object: "connector";
|
|
1035
|
+
id: string;
|
|
1036
|
+
deleted: true;
|
|
1037
|
+
}>;
|
|
1038
|
+
publish(id: string): Promise<import("./connectors").CommunityConnector>;
|
|
1039
|
+
unlist(id: string): Promise<import("./connectors").CommunityConnector>;
|
|
1040
|
+
setSharedCredentials(id: string, body: import("./connectors").ConnectorSharedCredentialsBody): Promise<import("./connectors").CommunityConnector>;
|
|
1041
|
+
install(slug: string, body: import("./connectors").InstallConnectorBody): Promise<import("./connectors").ConnectorInstall>;
|
|
1042
|
+
review(slug: string, body: {
|
|
1043
|
+
rating: number;
|
|
1044
|
+
body?: string;
|
|
1045
|
+
}): Promise<import("./connectors").ConnectorReview>;
|
|
1046
|
+
directory(params?: import("./connectors").ConnectorDirectoryParams): Promise<{
|
|
1047
|
+
object: "list";
|
|
1048
|
+
data: import("./connectors").ConnectorDirectoryEntry[];
|
|
1049
|
+
}>;
|
|
1050
|
+
};
|
|
1051
|
+
notifications: {
|
|
1052
|
+
send(body: import("./notifications").SendNotificationBody, idempotencyKey?: string): Promise<import("./notifications").SentNotification>;
|
|
1053
|
+
categories: {
|
|
1054
|
+
list(): Promise<{
|
|
1055
|
+
object: "list";
|
|
1056
|
+
data: import("./notifications").NotificationCategory[];
|
|
1057
|
+
}>;
|
|
1058
|
+
create(body: {
|
|
1059
|
+
key: string;
|
|
1060
|
+
label: string;
|
|
1061
|
+
}): Promise<import("./notifications").NotificationCategory>;
|
|
1062
|
+
update(key: string, body: {
|
|
1063
|
+
label: string;
|
|
1064
|
+
}): Promise<import("./notifications").NotificationCategory>;
|
|
1065
|
+
delete(key: string): Promise<{
|
|
1066
|
+
object: "notification_category";
|
|
1067
|
+
key: string;
|
|
1068
|
+
deleted: boolean;
|
|
1069
|
+
}>;
|
|
1070
|
+
};
|
|
1071
|
+
templates: {
|
|
1072
|
+
list(): Promise<{
|
|
1073
|
+
object: "list";
|
|
1074
|
+
data: import("./notifications").NotificationTemplate[];
|
|
1075
|
+
}>;
|
|
1076
|
+
create(body: import("./notifications").CreateNotificationTemplateBody): Promise<import("./notifications").NotificationTemplate>;
|
|
1077
|
+
get(name: string): Promise<import("./notifications").NotificationTemplate>;
|
|
1078
|
+
update(name: string, body: import("./notifications").UpdateNotificationTemplateBody): Promise<import("./notifications").NotificationTemplate>;
|
|
1079
|
+
delete(name: string): Promise<{
|
|
1080
|
+
object: "notification_template";
|
|
1081
|
+
name: string;
|
|
1082
|
+
deleted: boolean;
|
|
1083
|
+
}>;
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
auditEvents: {
|
|
1087
|
+
create(body: import("./audit-events").CreateCustomAuditEventBody, idempotencyKey?: string): Promise<import("./audit-events").CustomAuditEvent>;
|
|
1088
|
+
createBatch(events: import("./audit-events").CreateCustomAuditEventBody[], idempotencyKey?: string): Promise<{
|
|
1089
|
+
object: "list";
|
|
1090
|
+
data: import("./audit-events").CustomAuditEvent[];
|
|
1091
|
+
}>;
|
|
1092
|
+
list(params?: import("./audit-events").ListCustomAuditEventsParams): Promise<import("./types").CursorPage<import("./audit-events").CustomAuditEvent>>;
|
|
1093
|
+
export(params?: import("./audit-events").ExportCustomAuditEventsParams): Promise<string>;
|
|
1094
|
+
deleteAll(params?: {
|
|
1095
|
+
organization_id?: string;
|
|
1096
|
+
action?: string;
|
|
1097
|
+
}): Promise<{
|
|
1098
|
+
object: "audit_events.bulk_delete";
|
|
1099
|
+
deleted: number;
|
|
1100
|
+
}>;
|
|
1101
|
+
};
|
|
1102
|
+
events: {
|
|
1103
|
+
list(params?: import("./activity").ListActivityEventsParams): Promise<import("./activity").ActivityEventsPage>;
|
|
1104
|
+
};
|
|
1105
|
+
usage: {
|
|
1106
|
+
get(params?: {
|
|
1107
|
+
days?: number;
|
|
1108
|
+
}): Promise<import("./activity").UsageReport>;
|
|
1109
|
+
};
|
|
1110
|
+
configChangelog: {
|
|
1111
|
+
list(params?: import("./activity").ListConfigChangelogParams): Promise<{
|
|
1112
|
+
object: "config_changelog";
|
|
1113
|
+
data: import("./activity").ConfigChangelogEntry[];
|
|
1114
|
+
has_more: boolean;
|
|
1115
|
+
next_cursor: string | null;
|
|
1116
|
+
}>;
|
|
1117
|
+
};
|
|
1118
|
+
pca: {
|
|
1119
|
+
attestors: {
|
|
1120
|
+
get(): Promise<import("./pca").PcaAdminAttestors>;
|
|
1121
|
+
set(trustedAttestorKeys: string[]): Promise<import("./pca").PcaAdminAttestors>;
|
|
1122
|
+
};
|
|
1123
|
+
freeze(body?: {
|
|
1124
|
+
reason?: string;
|
|
1125
|
+
}): Promise<import("./pca").PcaAdminFreeze>;
|
|
1126
|
+
unfreeze(): Promise<import("./pca").PcaAdminFreeze>;
|
|
1127
|
+
revoke(body: {
|
|
1128
|
+
grant_ref: string;
|
|
1129
|
+
cap_id: string;
|
|
1130
|
+
}): Promise<import("./pca").PcaAdminRevocation>;
|
|
1131
|
+
denyStepUp(id: string, body?: {
|
|
1132
|
+
reason?: string;
|
|
1133
|
+
}): Promise<import("./pca").PcaAdminStepUp>;
|
|
1134
|
+
};
|
|
1135
|
+
mcp: {
|
|
1136
|
+
describe(): Promise<import("./mcp").McpServerDescriptor>;
|
|
1137
|
+
rpc: <R = Record<string, unknown>>(method: string, params?: unknown, id?: string | number) => Promise<import("./mcp").McpJsonRpcResponse<R>>;
|
|
1138
|
+
listTools(): Promise<import("./mcp").McpJsonRpcResponse<{
|
|
1139
|
+
tools: Array<Record<string, unknown>>;
|
|
1140
|
+
}>>;
|
|
1141
|
+
callTool(name: string, args?: Record<string, unknown>): Promise<import("./mcp").McpJsonRpcResponse<import("./mcp").McpToolCallResult>>;
|
|
1142
|
+
};
|
|
1143
|
+
mcpConnector: {
|
|
1144
|
+
get(): Promise<import("./mcp").McpConnector>;
|
|
1145
|
+
update(body: import("./mcp").UpdateMcpConnectorBody, idempotencyKey?: string): Promise<import("./mcp").McpConnector>;
|
|
1146
|
+
disable(): Promise<import("./mcp").McpConnector>;
|
|
1147
|
+
};
|
|
1148
|
+
legacyAuthConnection: {
|
|
1149
|
+
get(): Promise<import("./legacy-auth").LegacyAuthConnection>;
|
|
1150
|
+
set(body: import("./legacy-auth").PutLegacyAuthConnectionBody, idempotencyKey?: string): Promise<import("./legacy-auth").LegacyAuthConnection>;
|
|
1151
|
+
delete(): Promise<{
|
|
1152
|
+
object: "legacy_auth_connection";
|
|
1153
|
+
deleted: boolean;
|
|
1154
|
+
}>;
|
|
1155
|
+
};
|
|
1156
|
+
redirectUrls: {
|
|
1157
|
+
list(): Promise<import("./types").ListPage<import("./redirect-urls").RedirectUrl> & {
|
|
1158
|
+
next_cursor?: string | null;
|
|
1159
|
+
}>;
|
|
1160
|
+
create(url: string, idempotencyKey?: string): Promise<import("./redirect-urls").RedirectUrl>;
|
|
1161
|
+
get(id: string): Promise<import("./redirect-urls").RedirectUrl>;
|
|
1162
|
+
delete(id: string): Promise<{
|
|
1163
|
+
object: "redirect_url";
|
|
1164
|
+
id: string;
|
|
1165
|
+
deleted: true;
|
|
1166
|
+
}>;
|
|
1167
|
+
};
|
|
1168
|
+
sessionExchangeApps: {
|
|
1169
|
+
list(): Promise<import("./types").ListPage<import("./session-exchange-apps").SessionExchangeApp> & {
|
|
1170
|
+
next_cursor?: string | null;
|
|
1171
|
+
}>;
|
|
1172
|
+
create(body: import("./session-exchange-apps").CreateSessionExchangeAppBody, idempotencyKey?: string): Promise<import("./session-exchange-apps").SessionExchangeApp>;
|
|
1173
|
+
get(id: string): Promise<import("./session-exchange-apps").SessionExchangeApp>;
|
|
1174
|
+
update(id: string, body: import("./session-exchange-apps").UpdateSessionExchangeAppBody): Promise<import("./session-exchange-apps").SessionExchangeApp>;
|
|
1175
|
+
delete(id: string): Promise<{
|
|
1176
|
+
object: "session_exchange_app";
|
|
1177
|
+
id: string;
|
|
1178
|
+
deleted: true;
|
|
1179
|
+
}>;
|
|
1180
|
+
};
|
|
1181
|
+
tickets: {
|
|
1182
|
+
create(body: import("./tickets").CreateTicketBody, idempotencyKey?: string): Promise<import("./tickets").CapabilityTicket>;
|
|
1183
|
+
redeem<P = unknown>(body: import("./tickets").RedeemTicketBody): Promise<import("./tickets").TicketRedemption<P>>;
|
|
1184
|
+
};
|
|
1185
|
+
testMode: {
|
|
1186
|
+
testInstance(body?: {
|
|
1187
|
+
rotate_secret?: boolean;
|
|
1188
|
+
}): Promise<import("./test-mode").TestInstance>;
|
|
1189
|
+
purgeTestUsers(body?: {
|
|
1190
|
+
limit?: number;
|
|
1191
|
+
}): Promise<import("./test-mode").TestUsersPurgeResult>;
|
|
1192
|
+
createTestingToken(): Promise<import("./test-mode").TestingToken>;
|
|
1193
|
+
};
|
|
1194
|
+
diagnostics: {
|
|
1195
|
+
loginReadiness(params: import("./diagnostics").LoginReadinessParams): Promise<import("./diagnostics").LoginReadiness>;
|
|
1196
|
+
requestInspector(params: import("./diagnostics").RequestInspectorParams): Promise<import("./diagnostics").RequestInspection>;
|
|
1197
|
+
};
|
|
786
1198
|
};
|
|
1199
|
+
/** Every resource namespace of the management client. */
|
|
1200
|
+
export type AtlasClientNamespaces = ReturnType<typeof buildNamespaces>;
|
|
787
1201
|
/** The fully typed client instance `createAtlasClient` returns. */
|
|
788
|
-
export
|
|
789
|
-
|
|
1202
|
+
export interface AtlasClient extends AtlasClientNamespaces {
|
|
1203
|
+
/**
|
|
1204
|
+
* A copy of this client with some settings changed — e.g.
|
|
1205
|
+
* `atlas.withOptions({ strict: true }).users.update(...)` for one strict call.
|
|
1206
|
+
*/
|
|
1207
|
+
withOptions(overrides: AtlasRequestSettings): AtlasClient;
|
|
1208
|
+
}
|
|
1209
|
+
export type { AtlasClientConfig, AtlasRequestSettings, UnknownFieldsEvent, RawBody, } from './request';
|
|
790
1210
|
export { DEFAULT_API_URL } from './request';
|
|
1211
|
+
export { AtlasErrorCodes, type AtlasErrorCode } from './error';
|
|
1212
|
+
export { createAtlasPlatformClient } from './platform';
|
|
1213
|
+
export type { AtlasPlatformClient, AtlasPlatformClientConfig } from './platform';
|
|
791
1214
|
export { AtlasApiError, type AtlasErrorItem } from './error';
|
|
792
1215
|
export { paginate, collect } from './paginate';
|
|
793
1216
|
export * from './types';
|
|
@@ -836,3 +1259,22 @@ export * from './instance';
|
|
|
836
1259
|
export * from './instance-security';
|
|
837
1260
|
export * from './tokens';
|
|
838
1261
|
export * from './captcha';
|
|
1262
|
+
export * from './design';
|
|
1263
|
+
export * from './entitlement-overrides';
|
|
1264
|
+
export * from './org-ldap-connections';
|
|
1265
|
+
export * from './organization-settings-schema';
|
|
1266
|
+
export * from './email-addresses';
|
|
1267
|
+
export * from './openfga';
|
|
1268
|
+
export * from './connectors';
|
|
1269
|
+
export * from './notifications';
|
|
1270
|
+
export * from './audit-events';
|
|
1271
|
+
export * from './activity';
|
|
1272
|
+
export * from './pca';
|
|
1273
|
+
export * from './mcp';
|
|
1274
|
+
export * from './legacy-auth';
|
|
1275
|
+
export * from './redirect-urls';
|
|
1276
|
+
export * from './session-exchange-apps';
|
|
1277
|
+
export * from './tickets';
|
|
1278
|
+
export * from './test-mode';
|
|
1279
|
+
export * from './diagnostics';
|
|
1280
|
+
export * from './platform';
|