@atlasauth/backend 0.17.0 → 0.19.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/CHANGELOG.md +40 -0
- package/dist/backchannel-handlers.d.ts +87 -0
- package/dist/backchannel-handlers.js +137 -0
- package/dist/backchannel-handlers.js.map +1 -0
- package/dist/client/activity.d.ts +13 -2
- package/dist/client/activity.js.map +1 -1
- package/dist/client/audit-logs.d.ts +7 -0
- package/dist/client/audit-logs.js.map +1 -1
- package/dist/client/compliance.d.ts +216 -0
- package/dist/client/compliance.js +77 -0
- package/dist/client/compliance.js.map +1 -0
- package/dist/client/credentials.d.ts +409 -0
- package/dist/client/credentials.js +158 -0
- package/dist/client/credentials.js.map +1 -0
- package/dist/client/data-subject-requests.d.ts +36 -1
- package/dist/client/data-subject-requests.js.map +1 -1
- package/dist/client/design.d.ts +48 -0
- package/dist/client/design.js +9 -0
- package/dist/client/design.js.map +1 -1
- package/dist/client/entitlement-overrides.d.ts +30 -0
- package/dist/client/entitlement-overrides.js +9 -0
- package/dist/client/entitlement-overrides.js.map +1 -1
- package/dist/client/env.d.ts +16 -0
- package/dist/client/env.js +38 -0
- package/dist/client/env.js.map +1 -0
- package/dist/client/error.d.ts +10 -0
- package/dist/client/error.js +4 -0
- package/dist/client/error.js.map +1 -1
- package/dist/client/index.d.ts +382 -7
- package/dist/client/index.js +44 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/instance.d.ts +401 -3
- package/dist/client/instance.js +77 -3
- package/dist/client/instance.js.map +1 -1
- package/dist/client/integrations.d.ts +107 -0
- package/dist/client/integrations.js +25 -0
- package/dist/client/integrations.js.map +1 -0
- package/dist/client/messaging.d.ts +18 -4
- package/dist/client/messaging.js +6 -2
- package/dist/client/messaging.js.map +1 -1
- package/dist/client/oauth-clients.d.ts +11 -3
- package/dist/client/oauth-clients.js +4 -2
- package/dist/client/oauth-clients.js.map +1 -1
- package/dist/client/operator.d.ts +100 -0
- package/dist/client/operator.js +132 -0
- package/dist/client/operator.js.map +1 -0
- package/dist/client/platform.d.ts +233 -9
- package/dist/client/platform.js +74 -6
- package/dist/client/platform.js.map +1 -1
- package/dist/client/policies.d.ts +316 -0
- package/dist/client/policies.js +103 -0
- package/dist/client/policies.js.map +1 -0
- package/dist/client/privacy.d.ts +127 -0
- package/dist/client/privacy.js +44 -0
- package/dist/client/privacy.js.map +1 -0
- package/dist/client/referrals.d.ts +53 -6
- package/dist/client/referrals.js +9 -0
- package/dist/client/referrals.js.map +1 -1
- package/dist/client/request.d.ts +38 -1
- package/dist/client/request.js +6 -2
- package/dist/client/request.js.map +1 -1
- package/dist/client/sealed-box.d.ts +7 -0
- package/dist/client/sealed-box.js +62 -0
- package/dist/client/sealed-box.js.map +1 -0
- package/dist/client/sessions.d.ts +16 -5
- package/dist/client/sessions.js +7 -10
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/status.d.ts +200 -0
- package/dist/client/status.js +54 -0
- package/dist/client/status.js.map +1 -0
- package/dist/client/users.d.ts +15 -0
- package/dist/client/webhooks.d.ts +244 -11
- package/dist/client/webhooks.js +52 -3
- package/dist/client/webhooks.js.map +1 -1
- package/dist/index.d.ts +9 -6
- package/dist/index.js +20 -4
- package/dist/index.js.map +1 -1
- package/dist/oidc.d.ts +65 -1
- package/dist/oidc.js +46 -0
- package/dist/oidc.js.map +1 -1
- package/dist/policy-source.d.ts +104 -0
- package/dist/policy-source.js +99 -0
- package/dist/policy-source.js.map +1 -0
- package/dist/referral-test-calls.d.ts +26 -13
- package/dist/referral-test-calls.js +40 -14
- package/dist/referral-test-calls.js.map +1 -1
- package/dist/testing.d.ts +41 -6
- package/dist/testing.js +34 -2
- package/dist/testing.js.map +1 -1
- package/dist/webhooks.d.ts +8 -0
- package/dist/webhooks.js +13 -4
- package/dist/webhooks.js.map +1 -1
- package/package.json +6 -3
package/dist/client/index.js
CHANGED
|
@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
exports.collect = exports.paginate = exports.AtlasApiError = exports.createAtlasPlatformClient = exports.AtlasErrorCodes = exports.DEFAULT_API_URL = void 0;
|
|
17
|
+
exports.collect = exports.paginate = exports.AtlasApiError = exports.createAtlasPlatformClient = exports.AtlasErrorCodes = exports.createAtlasClientFromEnv = exports.atlasConfigFromEnv = exports.apiBaseFromEnv = exports.API_BASE_ENV_NAMES = exports.DEFAULT_API_URL = void 0;
|
|
18
18
|
exports.createAtlasClient = createAtlasClient;
|
|
19
19
|
const request_1 = require("./request");
|
|
20
20
|
const users_1 = require("./users");
|
|
@@ -48,6 +48,7 @@ const bot_signals_1 = require("./bot-signals");
|
|
|
48
48
|
const network_acls_1 = require("./network-acls");
|
|
49
49
|
const managed_waf_1 = require("./managed-waf");
|
|
50
50
|
const log_streams_1 = require("./log-streams");
|
|
51
|
+
const compliance_1 = require("./compliance");
|
|
51
52
|
const branding_1 = require("./branding");
|
|
52
53
|
const email_templates_1 = require("./email-templates");
|
|
53
54
|
const sms_templates_1 = require("./sms-templates");
|
|
@@ -59,11 +60,15 @@ const messaging_1 = require("./messaging");
|
|
|
59
60
|
const import_export_1 = require("./import-export");
|
|
60
61
|
const better_auth_imports_1 = require("./better-auth-imports");
|
|
61
62
|
const data_subject_requests_1 = require("./data-subject-requests");
|
|
63
|
+
const privacy_1 = require("./privacy");
|
|
62
64
|
const radius_clients_1 = require("./radius-clients");
|
|
63
65
|
const lti_platforms_1 = require("./lti-platforms");
|
|
64
66
|
const instance_1 = require("./instance");
|
|
67
|
+
const integrations_1 = require("./integrations");
|
|
65
68
|
const instance_security_1 = require("./instance-security");
|
|
66
69
|
const referrals_1 = require("./referrals");
|
|
70
|
+
const policies_1 = require("./policies");
|
|
71
|
+
const status_1 = require("./status");
|
|
67
72
|
const user_hooks_1 = require("./user-hooks");
|
|
68
73
|
const tokens_1 = require("./tokens");
|
|
69
74
|
const captcha_1 = require("./captcha");
|
|
@@ -77,6 +82,7 @@ const connectors_1 = require("./connectors");
|
|
|
77
82
|
const custom_oauth_providers_1 = require("./custom-oauth-providers");
|
|
78
83
|
const notifications_1 = require("./notifications");
|
|
79
84
|
const audit_events_1 = require("./audit-events");
|
|
85
|
+
const credentials_1 = require("./credentials");
|
|
80
86
|
const activity_1 = require("./activity");
|
|
81
87
|
const logout_notify_endpoints_1 = require("./logout-notify-endpoints");
|
|
82
88
|
const pca_1 = require("./pca");
|
|
@@ -142,6 +148,13 @@ function buildNamespaces(request) {
|
|
|
142
148
|
networkAcls: (0, network_acls_1.networkAclsResource)(request),
|
|
143
149
|
managedWaf: (0, managed_waf_1.managedWafResource)(request),
|
|
144
150
|
logStreams: (0, log_streams_1.logStreamsResource)(request),
|
|
151
|
+
// Instance audit export: CloudEvents to a webhook or an S3-compatible bucket.
|
|
152
|
+
auditExports: (0, compliance_1.auditExportsResource)(request),
|
|
153
|
+
// Behaviour changes that affect this instance, and security advisories.
|
|
154
|
+
notices: (0, compliance_1.noticesResource)(request),
|
|
155
|
+
securityAdvisories: (0, compliance_1.securityAdvisoriesResource)(request),
|
|
156
|
+
// Who processes this instance's end-user data, in which role.
|
|
157
|
+
subProcessors: (0, compliance_1.subProcessorsResource)(request),
|
|
145
158
|
branding: (0, branding_1.brandingResource)(request),
|
|
146
159
|
emailTemplates: (0, email_templates_1.emailTemplatesResource)(request),
|
|
147
160
|
smsTemplates: (0, sms_templates_1.smsTemplatesResource)(request),
|
|
@@ -155,12 +168,21 @@ function buildNamespaces(request) {
|
|
|
155
168
|
// Migrate from Better Auth: sealed-bundle upload, dry run and resumable apply.
|
|
156
169
|
betterAuthImports: (0, better_auth_imports_1.betterAuthImportsResource)(request),
|
|
157
170
|
dataSubjectRequests: (0, data_subject_requests_1.dataSubjectRequestsResource)(request),
|
|
171
|
+
/** The data-rights executor protocol and the instance's orchestrator. */
|
|
172
|
+
privacy: (0, privacy_1.privacyResource)(request),
|
|
158
173
|
radiusClients: (0, radius_clients_1.radiusClientsResource)(request),
|
|
159
174
|
ltiPlatforms: (0, lti_platforms_1.ltiPlatformsResource)(request),
|
|
160
175
|
instance: (0, instance_1.instanceResource)(request),
|
|
176
|
+
// Identity integrations, the integration-facing side: verify-error reports, sidebar cards, public metadata.
|
|
177
|
+
integrations: (0, integrations_1.integrationsResource)(request),
|
|
161
178
|
instanceSecurity: (0, instance_security_1.instanceSecurityResource)(request),
|
|
162
179
|
// Referral attribution: the instance's referral platform connection and call log.
|
|
163
180
|
referrals: (0, referrals_1.referralsResource)(request),
|
|
181
|
+
// Policy acceptance: policies, versions, acceptances, settings, and the external policy source.
|
|
182
|
+
policies: (0, policies_1.policiesResource)(request),
|
|
183
|
+
policySource: (0, policies_1.policySourceResource)(request),
|
|
184
|
+
// Atlas service status: the incident subscription, incidents that concern you, upstream status pages.
|
|
185
|
+
status: (0, status_1.statusResource)(request),
|
|
164
186
|
// The before_user_create hook (sets external_id before the user exists).
|
|
165
187
|
userHooks: (0, user_hooks_1.userHooksResource)(request),
|
|
166
188
|
tokens: (0, tokens_1.tokensResource)(request),
|
|
@@ -170,6 +192,7 @@ function buildNamespaces(request) {
|
|
|
170
192
|
// Sign-in page design: instance + per-organization overrides, images, catalog.
|
|
171
193
|
design: (0, design_1.designResource)(request),
|
|
172
194
|
entitlementOverrides: (0, entitlement_overrides_1.entitlementOverridesResource)(request),
|
|
195
|
+
entitlements: (0, entitlement_overrides_1.entitlementsResource)(request),
|
|
173
196
|
orgLdapConnections: (0, org_ldap_connections_1.orgLdapConnectionsResource)(request),
|
|
174
197
|
organizationSettingsSchema: (0, organization_settings_schema_1.organizationSettingsSchemaResource)(request),
|
|
175
198
|
emailAddresses: (0, email_addresses_1.emailAddressesResource)(request),
|
|
@@ -180,6 +203,14 @@ function buildNamespaces(request) {
|
|
|
180
203
|
notifications: (0, notifications_1.notificationsResource)(request),
|
|
181
204
|
// The tenant's own custom audit events (distinct from Atlas's auditLogs).
|
|
182
205
|
auditEvents: (0, audit_events_1.auditEventsResource)(request),
|
|
206
|
+
// The key this client uses, the instance's secret keys, and every credential on it.
|
|
207
|
+
whoami: (0, credentials_1.whoamiResource)(request),
|
|
208
|
+
secretKeys: (0, credentials_1.secretKeysResource)(request),
|
|
209
|
+
keys: (0, credentials_1.keysResource)(request),
|
|
210
|
+
// Partner links: products allowed to call this instance, and links partners granted Atlas.
|
|
211
|
+
partnerLinks: (0, credentials_1.partnerLinksResource)(request),
|
|
212
|
+
// Sign in with Atlas grants of apps this instance manages (DSAR erasure).
|
|
213
|
+
atlasIdGrants: (0, credentials_1.atlasIdGrantsResource)(request),
|
|
183
214
|
events: (0, activity_1.eventsResource)(request),
|
|
184
215
|
usage: (0, activity_1.usageResource)(request),
|
|
185
216
|
configChangelog: (0, activity_1.configChangelogResource)(request),
|
|
@@ -199,6 +230,11 @@ function buildNamespaces(request) {
|
|
|
199
230
|
}
|
|
200
231
|
var request_2 = require("./request");
|
|
201
232
|
Object.defineProperty(exports, "DEFAULT_API_URL", { enumerable: true, get: function () { return request_2.DEFAULT_API_URL; } });
|
|
233
|
+
var env_1 = require("./env");
|
|
234
|
+
Object.defineProperty(exports, "API_BASE_ENV_NAMES", { enumerable: true, get: function () { return env_1.API_BASE_ENV_NAMES; } });
|
|
235
|
+
Object.defineProperty(exports, "apiBaseFromEnv", { enumerable: true, get: function () { return env_1.apiBaseFromEnv; } });
|
|
236
|
+
Object.defineProperty(exports, "atlasConfigFromEnv", { enumerable: true, get: function () { return env_1.atlasConfigFromEnv; } });
|
|
237
|
+
Object.defineProperty(exports, "createAtlasClientFromEnv", { enumerable: true, get: function () { return env_1.createAtlasClientFromEnv; } });
|
|
202
238
|
var error_1 = require("./error");
|
|
203
239
|
Object.defineProperty(exports, "AtlasErrorCodes", { enumerable: true, get: function () { return error_1.AtlasErrorCodes; } });
|
|
204
240
|
var platform_1 = require("./platform");
|
|
@@ -210,6 +246,7 @@ Object.defineProperty(exports, "paginate", { enumerable: true, get: function ()
|
|
|
210
246
|
Object.defineProperty(exports, "collect", { enumerable: true, get: function () { return paginate_1.collect; } });
|
|
211
247
|
// Resource types — exported so callers can annotate their own code.
|
|
212
248
|
__exportStar(require("./types"), exports);
|
|
249
|
+
__exportStar(require("./compliance"), exports);
|
|
213
250
|
__exportStar(require("./users"), exports);
|
|
214
251
|
__exportStar(require("./sessions"), exports);
|
|
215
252
|
__exportStar(require("./organizations"), exports);
|
|
@@ -252,11 +289,15 @@ __exportStar(require("./messaging"), exports);
|
|
|
252
289
|
__exportStar(require("./import-export"), exports);
|
|
253
290
|
__exportStar(require("./better-auth-imports"), exports);
|
|
254
291
|
__exportStar(require("./data-subject-requests"), exports);
|
|
292
|
+
__exportStar(require("./privacy"), exports);
|
|
255
293
|
__exportStar(require("./radius-clients"), exports);
|
|
256
294
|
__exportStar(require("./lti-platforms"), exports);
|
|
257
295
|
__exportStar(require("./instance"), exports);
|
|
296
|
+
__exportStar(require("./integrations"), exports);
|
|
258
297
|
__exportStar(require("./instance-security"), exports);
|
|
259
298
|
__exportStar(require("./referrals"), exports);
|
|
299
|
+
__exportStar(require("./policies"), exports);
|
|
300
|
+
__exportStar(require("./status"), exports);
|
|
260
301
|
__exportStar(require("./user-hooks"), exports);
|
|
261
302
|
__exportStar(require("./tokens"), exports);
|
|
262
303
|
__exportStar(require("./captcha"), exports);
|
|
@@ -281,4 +322,6 @@ __exportStar(require("./test-mode"), exports);
|
|
|
281
322
|
__exportStar(require("./diagnostics"), exports);
|
|
282
323
|
__exportStar(require("./logout-notify-endpoints"), exports);
|
|
283
324
|
__exportStar(require("./platform"), exports);
|
|
325
|
+
__exportStar(require("./credentials"), exports);
|
|
326
|
+
__exportStar(require("./operator"), exports);
|
|
284
327
|
//# sourceMappingURL=index.js.map
|
package/dist/client/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA8FA,8CAQC;AAtGD,uCAA6F;AAC7F,mCAAwC;AACxC,yCAA8C;AAC9C,mDAAwD;AACxD,mCAA6D;AAC7D,mDAAuD;AACvD,yDAA6D;AAC7D,uDAA2D;AAC3D,+CAAmD;AACnD,uCAA4C;AAC5C,yCAA8C;AAC9C,iDAAsE;AACtE,2DAA+D;AAC/D,iDAAqD;AACrD,+CAAoD;AACpD,yCAA8C;AAC9C,qDAAwD;AACxD,6CAAiD;AACjD,mDAAuD;AACvD,yCAA6C;AAC7C,2CAA+C;AAC/C,yCAA8C;AAC9C,uDAA2D;AAC3D,qDAAyD;AACzD,2DAA+D;AAC/D,+BAAoC;AACpC,6CAAuD;AACvD,qDAAwD;AACxD,+CAAmD;AACnD,iDAAqD;AACrD,+CAAmD;AACnD,+CAAmD;AACnD,6CAAwH;AACxH,yCAA8C;AAC9C,uDAA2D;AAC3D,mDAAuD;AACvD,mDAAwD;AACxD,uCAA4C;AAC5C,qDAAkF;AAClF,mDAAkD;AAClD,2CAAgD;AAChD,mDAAuD;AACvD,+DAAkE;AAClE,mEAAsE;AACtE,uCAA4C;AAC5C,qDAAyD;AACzD,mDAAuD;AACvD,yCAA8C;AAC9C,iDAAsD;AACtD,2DAA+D;AAC/D,2CAAgD;AAChD,yCAAoE;AACpE,qCAA0C;AAC1C,6CAAiD;AACjD,qCAA0C;AAC1C,uCAA4C;AAC5C,qCAA0C;AAC1C,mEAA6F;AAC7F,iEAAoE;AACpE,iFAAoF;AACpF,uDAA2D;AAC3D,uCAA4C;AAC5C,6CAAkD;AAClD,qEAAwE;AACxE,mDAAwD;AACxD,iDAAqD;AACrD,+CAMuB;AACvB,yCAAoF;AACpF,uEAA0E;AAC1E,+BAAoC;AACpC,+BAA0D;AAC1D,+CAA6D;AAC7D,mDAAuD;AACvD,mEAAsE;AACtE,uCAA4C;AAC5C,2CAA+C;AAC/C,+CAAoD;AAGpD;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAAC,MAAyB;IACzD,MAAM,OAAO,GAAG,IAAA,uBAAa,EAAC,MAAM,CAAC,CAAC;IACtC,OAAO;QACL,GAAG,eAAe,CAAC,OAAO,CAAC;QAC3B,WAAW,CAAC,SAA+B;YACzC,OAAO,iBAAiB,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;QACxD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,OAAkB;IACzC,OAAO;QACL,KAAK,EAAE,IAAA,qBAAa,EAAC,OAAO,CAAC;QAC7B,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,aAAa,EAAE,IAAA,qCAAqB,EAAC,OAAO,CAAC;QAC7C,KAAK,EAAE,IAAA,qBAAa,EAAC,OAAO,CAAC;QAC7B,WAAW,EAAE,IAAA,2BAAmB,EAAC,OAAO,CAAC;QACzC,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,eAAe,EAAE,IAAA,0CAAuB,EAAC,OAAO,CAAC;QACjD,cAAc,EAAE,IAAA,wCAAsB,EAAC,OAAO,CAAC;QAC/C,UAAU,EAAE,IAAA,gCAAkB,EAAC,OAAO,CAAC;QACvC,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,SAAS,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;QACrC,SAAS,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;QACrC,gBAAgB,EAAE,IAAA,4CAAwB,EAAC,OAAO,CAAC;QACnD,WAAW,EAAE,IAAA,kCAAmB,EAAC,OAAO,CAAC;QACzC,WAAW,EAAE,IAAA,iCAAmB,EAAC,OAAO,CAAC;QACzC,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,YAAY,EAAE,IAAA,qCAAoB,EAAC,OAAO,CAAC;QAC3C,SAAS,EAAE,IAAA,8BAAiB,EAAC,OAAO,CAAC;QACrC,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,OAAO,EAAE,IAAA,0BAAe,EAAC,OAAO,CAAC;QACjC,wDAAwD;QACxD,QAAQ,EAAE,IAAA,4BAAgB,EAAC,OAAO,CAAC;QACnC,8EAA8E;QAC9E,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,cAAc,EAAE,IAAA,wCAAsB,EAAC,OAAO,CAAC;QAC/C,aAAa,EAAE,IAAA,sCAAqB,EAAC,OAAO,CAAC;QAC7C,gBAAgB,EAAE,IAAA,4CAAwB,EAAC,OAAO,CAAC;QACnD,GAAG,EAAE,IAAA,iBAAW,EAAC,OAAO,CAAC;QACzB,eAAe,EAAE,IAAA,oCAAuB,EAAC,OAAO,CAAC;QACjD,YAAY,EAAE,IAAA,qCAAoB,EAAC,OAAO,CAAC;QAC3C,UAAU,EAAE,IAAA,gCAAkB,EAAC,OAAO,CAAC;QACvC,WAAW,EAAE,IAAA,kCAAmB,EAAC,OAAO,CAAC;QACzC,UAAU,EAAE,IAAA,gCAAkB,EAAC,OAAO,CAAC;QACvC,UAAU,EAAE,IAAA,gCAAkB,EAAC,OAAO,CAAC;QACvC,8EAA8E;QAC9E,YAAY,EAAE,IAAA,iCAAoB,EAAC,OAAO,CAAC;QAC3C,wEAAwE;QACxE,OAAO,EAAE,IAAA,4BAAe,EAAC,OAAO,CAAC;QACjC,kBAAkB,EAAE,IAAA,uCAA0B,EAAC,OAAO,CAAC;QACvD,8DAA8D;QAC9D,aAAa,EAAE,IAAA,kCAAqB,EAAC,OAAO,CAAC;QAC7C,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,cAAc,EAAE,IAAA,wCAAsB,EAAC,OAAO,CAAC;QAC/C,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,aAAa,EAAE,IAAA,qCAAqB,EAAC,OAAO,CAAC;QAC7C,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,aAAa,EAAE,IAAA,sCAAqB,EAAC,OAAO,CAAC;QAC7C,eAAe,EAAE,IAAA,wCAAuB,EAAC,OAAO,CAAC;QACjD,OAAO,EAAE,IAAA,+BAAe,EAAC,OAAO,CAAC;QACjC,SAAS,EAAE,IAAA,6BAAiB,EAAC,OAAO,CAAC;QACrC,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,+EAA+E;QAC/E,iBAAiB,EAAE,IAAA,+CAAyB,EAAC,OAAO,CAAC;QACrD,mBAAmB,EAAE,IAAA,mDAA2B,EAAC,OAAO,CAAC;QACzD,yEAAyE;QACzE,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,aAAa,EAAE,IAAA,sCAAqB,EAAC,OAAO,CAAC;QAC7C,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,4GAA4G;QAC5G,YAAY,EAAE,IAAA,mCAAoB,EAAC,OAAO,CAAC;QAC3C,gBAAgB,EAAE,IAAA,4CAAwB,EAAC,OAAO,CAAC;QACnD,kFAAkF;QAClF,SAAS,EAAE,IAAA,6BAAiB,EAAC,OAAO,CAAC;QACrC,gGAAgG;QAChG,QAAQ,EAAE,IAAA,2BAAgB,EAAC,OAAO,CAAC;QACnC,YAAY,EAAE,IAAA,+BAAoB,EAAC,OAAO,CAAC;QAC3C,sGAAsG;QACtG,MAAM,EAAE,IAAA,uBAAc,EAAC,OAAO,CAAC;QAC/B,yEAAyE;QACzE,SAAS,EAAE,IAAA,8BAAiB,EAAC,OAAO,CAAC;QACrC,MAAM,EAAE,IAAA,uBAAc,EAAC,OAAO,CAAC;QAC/B,0EAA0E;QAC1E,6EAA6E;QAC7E,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,+EAA+E;QAC/E,MAAM,EAAE,IAAA,uBAAc,EAAC,OAAO,CAAC;QAC/B,oBAAoB,EAAE,IAAA,oDAA4B,EAAC,OAAO,CAAC;QAC3D,YAAY,EAAE,IAAA,4CAAoB,EAAC,OAAO,CAAC;QAC3C,kBAAkB,EAAE,IAAA,iDAA0B,EAAC,OAAO,CAAC;QACvD,0BAA0B,EAAE,IAAA,iEAAkC,EAAC,OAAO,CAAC;QACvE,cAAc,EAAE,IAAA,wCAAsB,EAAC,OAAO,CAAC;QAC/C,gDAAgD;QAChD,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,UAAU,EAAE,IAAA,+BAAkB,EAAC,OAAO,CAAC;QACvC,oBAAoB,EAAE,IAAA,qDAA4B,EAAC,OAAO,CAAC;QAC3D,aAAa,EAAE,IAAA,qCAAqB,EAAC,OAAO,CAAC;QAC7C,0EAA0E;QAC1E,WAAW,EAAE,IAAA,kCAAmB,EAAC,OAAO,CAAC;QACzC,oFAAoF;QACpF,MAAM,EAAE,IAAA,4BAAc,EAAC,OAAO,CAAC;QAC/B,UAAU,EAAE,IAAA,gCAAkB,EAAC,OAAO,CAAC;QACvC,IAAI,EAAE,IAAA,0BAAY,EAAC,OAAO,CAAC;QAC3B,2FAA2F;QAC3F,YAAY,EAAE,IAAA,kCAAoB,EAAC,OAAO,CAAC;QAC3C,0EAA0E;QAC1E,aAAa,EAAE,IAAA,mCAAqB,EAAC,OAAO,CAAC;QAC7C,MAAM,EAAE,IAAA,yBAAc,EAAC,OAAO,CAAC;QAC/B,KAAK,EAAE,IAAA,wBAAa,EAAC,OAAO,CAAC;QAC7B,eAAe,EAAE,IAAA,kCAAuB,EAAC,OAAO,CAAC;QACjD,GAAG,EAAE,IAAA,iBAAW,EAAC,OAAO,CAAC;QACzB,GAAG,EAAE,IAAA,iBAAW,EAAC,OAAO,CAAC;QACzB,YAAY,EAAE,IAAA,0BAAoB,EAAC,OAAO,CAAC;QAC3C,oBAAoB,EAAE,IAAA,0CAA4B,EAAC,OAAO,CAAC;QAC3D,YAAY,EAAE,IAAA,oCAAoB,EAAC,OAAO,CAAC;QAC3C,mBAAmB,EAAE,IAAA,mDAA2B,EAAC,OAAO,CAAC;QACzD,OAAO,EAAE,IAAA,yBAAe,EAAC,OAAO,CAAC;QACjC,sFAAsF;QACtF,QAAQ,EAAE,IAAA,4BAAgB,EAAC,OAAO,CAAC;QACnC,WAAW,EAAE,IAAA,iCAAmB,EAAC,OAAO,CAAC;QACzC,wEAAwE;QACxE,qBAAqB,EAAE,IAAA,uDAA6B,EAAC,OAAO,CAAC;KAC9D,CAAC;AACJ,CAAC;AAsBD,qCAA4C;AAAnC,0GAAA,eAAe,OAAA;AACxB,6BAAyG;AAAhG,yGAAA,kBAAkB,OAAA;AAAE,qGAAA,cAAc,OAAA;AAAE,yGAAA,kBAAkB,OAAA;AAAE,+GAAA,wBAAwB,OAAA;AACzF,iCAA+D;AAAtD,wGAAA,eAAe,OAAA;AACxB,uCAAuD;AAA9C,qHAAA,yBAAyB,OAAA;AAElC,iCAA6D;AAApD,sGAAA,aAAa,OAAA;AACtB,uCAA+C;AAAtC,oGAAA,QAAQ,OAAA;AAAE,mGAAA,OAAO,OAAA;AAE1B,oEAAoE;AACpE,0CAAwB;AACxB,+CAA6B;AAC7B,0CAAwB;AACxB,6CAA2B;AAC3B,kDAAgC;AAChC,0CAAwB;AACxB,8CAA4B;AAC5B,kDAAgC;AAChC,qDAAmC;AACnC,oDAAkC;AAClC,gDAA8B;AAC9B,4CAA0B;AAC1B,6CAA2B;AAC3B,iDAA+B;AAC/B,sDAAoC;AACpC,iDAA+B;AAC/B,gDAA8B;AAC9B,6CAA2B;AAC3B,mDAAiC;AACjC,+CAA6B;AAC7B,kDAAgC;AAChC,6CAA2B;AAC3B,6CAA2B;AAC3B,oDAAkC;AAClC,mDAAiC;AACjC,sDAAoC;AACpC,wCAAsB;AACtB,+CAA6B;AAC7B,mDAAiC;AACjC,gDAA8B;AAC9B,iDAA+B;AAC/B,gDAA8B;AAC9B,gDAA8B;AAC9B,6CAA2B;AAC3B,oDAAkC;AAClC,kDAAgC;AAChC,kDAAgC;AAChC,4CAA0B;AAC1B,mDAAiC;AACjC,kDAAgC;AAChC,8CAA4B;AAC5B,kDAAgC;AAChC,wDAAsC;AACtC,0DAAwC;AACxC,4CAA0B;AAC1B,mDAAiC;AACjC,kDAAgC;AAChC,6CAA2B;AAC3B,iDAA+B;AAC/B,sDAAoC;AACpC,8CAA4B;AAC5B,6CAA2B;AAC3B,2CAAyB;AACzB,+CAA6B;AAC7B,2CAAyB;AACzB,4CAA0B;AAC1B,2CAAyB;AACzB,0DAAwC;AACxC,yDAAuC;AACvC,iEAA+C;AAC/C,oDAAkC;AAClC,4CAA0B;AAC1B,+CAA6B;AAC7B,2DAAyC;AACzC,kDAAgC;AAChC,iDAA+B;AAC/B,6CAA2B;AAC3B,wCAAsB;AACtB,wCAAsB;AACtB,gDAA8B;AAC9B,kDAAgC;AAChC,0DAAwC;AACxC,4CAA0B;AAC1B,8CAA4B;AAC5B,gDAA8B;AAC9B,4DAA0C;AAC1C,6CAA2B;AAC3B,gDAA8B;AAC9B,6CAA2B"}
|
|
@@ -67,6 +67,77 @@ export interface PreflightFinding {
|
|
|
67
67
|
fix: string;
|
|
68
68
|
/** Ids of what the finding is about (provider, client_id, domain, …). */
|
|
69
69
|
subject?: Record<string, string>;
|
|
70
|
+
/** `security_posture` on the findings about settings weaker than the defaults new instances get. */
|
|
71
|
+
group?: 'security_posture';
|
|
72
|
+
/** Only with `include_suppressed: true`: the finding does not apply to how the instance integrates. */
|
|
73
|
+
suppressed?: true;
|
|
74
|
+
suppressed_reason?: string;
|
|
75
|
+
}
|
|
76
|
+
/** A finding that does not apply to how the instance integrates, and why. */
|
|
77
|
+
export interface PreflightSuppressedFinding {
|
|
78
|
+
code: string;
|
|
79
|
+
severity: 'error' | 'warning' | 'info';
|
|
80
|
+
subject: Record<string, string> | null;
|
|
81
|
+
reason: string;
|
|
82
|
+
}
|
|
83
|
+
/** How one allowed https origin signs in, as preflight judged it. */
|
|
84
|
+
export interface PreflightOriginIntegration {
|
|
85
|
+
origin: string;
|
|
86
|
+
integration: 'redirect' | 'embedded';
|
|
87
|
+
source: 'declared' | 'embedded_traffic' | 'redirect_clients' | 'default';
|
|
88
|
+
/** False only for the default (nothing says how the origin signs in). */
|
|
89
|
+
confident: boolean;
|
|
90
|
+
reason: string;
|
|
91
|
+
}
|
|
92
|
+
export interface PreflightParams {
|
|
93
|
+
/** Only findings at least this severe (`ok` still covers every finding). */
|
|
94
|
+
min_severity?: 'error' | 'warning' | 'info';
|
|
95
|
+
/** Also list the suppressed findings in `findings`, marked `suppressed: true`. */
|
|
96
|
+
include_suppressed?: boolean;
|
|
97
|
+
}
|
|
98
|
+
/** One unknown body field your writes sent, aggregated over the report window. */
|
|
99
|
+
export interface UnknownFieldReportRow {
|
|
100
|
+
method: string;
|
|
101
|
+
/** The route template, e.g. `/v1/users/{id}`. */
|
|
102
|
+
path: string;
|
|
103
|
+
/** The field path, nested as `parent.child`. */
|
|
104
|
+
field: string;
|
|
105
|
+
count: number;
|
|
106
|
+
/** Lenient requests: the field was ignored and named in Atlas-Unknown-Fields. */
|
|
107
|
+
ignored_count: number;
|
|
108
|
+
/** Strict requests: refused with 422 UNKNOWN_FIELD. */
|
|
109
|
+
rejected_count: number;
|
|
110
|
+
/** Epoch ms. */
|
|
111
|
+
last_seen_at: number;
|
|
112
|
+
/** The secret key that sent it (null without a key). */
|
|
113
|
+
api_key_id: string | null;
|
|
114
|
+
}
|
|
115
|
+
export interface UnknownFieldsReport {
|
|
116
|
+
object: 'unknown_fields_report';
|
|
117
|
+
days: number;
|
|
118
|
+
retention_days: number;
|
|
119
|
+
strict_request_bodies: boolean;
|
|
120
|
+
/** True when nothing in the window would be refused by strict request bodies. */
|
|
121
|
+
safe_to_enable_strict: boolean;
|
|
122
|
+
data: UnknownFieldReportRow[];
|
|
123
|
+
}
|
|
124
|
+
/** One operation in an OpenAPI diff. */
|
|
125
|
+
export interface OpenApiDiffItem {
|
|
126
|
+
method: string;
|
|
127
|
+
path: string;
|
|
128
|
+
operation_id: string | null;
|
|
129
|
+
summary: string | null;
|
|
130
|
+
/** YYYY-MM-DD of the change. */
|
|
131
|
+
at: string;
|
|
132
|
+
}
|
|
133
|
+
export interface OpenApiDiff {
|
|
134
|
+
object: 'openapi_diff';
|
|
135
|
+
since: string;
|
|
136
|
+
/** The API build the diff was computed on (`<date>+<sha>`). */
|
|
137
|
+
version: string;
|
|
138
|
+
added: OpenApiDiffItem[];
|
|
139
|
+
deprecated: OpenApiDiffItem[];
|
|
140
|
+
removed: OpenApiDiffItem[];
|
|
70
141
|
}
|
|
71
142
|
/** An advisory published for an Atlas browser SDK version. */
|
|
72
143
|
export interface SdkAdvisory {
|
|
@@ -92,14 +163,104 @@ export interface SdkVersionSeen {
|
|
|
92
163
|
/** The advisories that apply to this version. */
|
|
93
164
|
advisories: SdkAdvisory[];
|
|
94
165
|
}
|
|
166
|
+
/** One row of the integration-health report. */
|
|
167
|
+
export interface IntegrationHealthCheck {
|
|
168
|
+
/** A preflight code verbatim, or `<source>.<check>`. */
|
|
169
|
+
id: string;
|
|
170
|
+
/** false = failing; null = not known or not configured. */
|
|
171
|
+
ok: boolean | null;
|
|
172
|
+
detail: string;
|
|
173
|
+
fix: string | null;
|
|
174
|
+
docs: string | null;
|
|
175
|
+
/** For a check that calls your server: the hop that failed. */
|
|
176
|
+
hop?: 'dns' | 'tls' | 'http' | 'challenge' | 'auth';
|
|
177
|
+
status?: number;
|
|
178
|
+
elapsedMs?: number;
|
|
179
|
+
source: string;
|
|
180
|
+
severity?: 'error' | 'warning' | 'info';
|
|
181
|
+
subject?: Record<string, string>;
|
|
182
|
+
observedAt?: number | null;
|
|
183
|
+
}
|
|
184
|
+
export interface IntegrationHealthReport {
|
|
185
|
+
object: 'integration_health';
|
|
186
|
+
ok: boolean;
|
|
187
|
+
summary: {
|
|
188
|
+
failing: number;
|
|
189
|
+
passing: number;
|
|
190
|
+
unknown: number;
|
|
191
|
+
};
|
|
192
|
+
checks: IntegrationHealthCheck[];
|
|
193
|
+
/** ISO 8601. */
|
|
194
|
+
generatedAt: string;
|
|
195
|
+
/** The same instant, epoch ms. */
|
|
196
|
+
generated_at: number;
|
|
197
|
+
}
|
|
198
|
+
/** The embed manifest (embed-v1) for one instance: CSP sources per surface, storage, SRI and the merged policy. */
|
|
199
|
+
export interface EmbedManifest {
|
|
200
|
+
schema: string;
|
|
201
|
+
product: string;
|
|
202
|
+
updated: string;
|
|
203
|
+
openapi?: string;
|
|
204
|
+
llms?: string;
|
|
205
|
+
status?: string;
|
|
206
|
+
docs?: string;
|
|
207
|
+
checkers?: {
|
|
208
|
+
userAgent: string;
|
|
209
|
+
userAgents?: string[];
|
|
210
|
+
egress: string[];
|
|
211
|
+
};
|
|
212
|
+
surfaces: Record<string, {
|
|
213
|
+
tenant?: boolean;
|
|
214
|
+
servedBy?: 'customer' | 'atlas';
|
|
215
|
+
csp?: Record<string, string[]>;
|
|
216
|
+
requires?: Record<string, string[]>;
|
|
217
|
+
trustedTypes?: string[];
|
|
218
|
+
consentCategory?: string;
|
|
219
|
+
storage?: Array<{
|
|
220
|
+
name: string;
|
|
221
|
+
type: string;
|
|
222
|
+
category: string;
|
|
223
|
+
lifetime: string;
|
|
224
|
+
purpose: {
|
|
225
|
+
en: string;
|
|
226
|
+
} & Record<string, string>;
|
|
227
|
+
}>;
|
|
228
|
+
sri?: Record<string, string>;
|
|
229
|
+
notes?: string[];
|
|
230
|
+
}>;
|
|
231
|
+
changes: Array<{
|
|
232
|
+
effective: string;
|
|
233
|
+
surface: string;
|
|
234
|
+
add: Record<string, string[]>;
|
|
235
|
+
remove: Record<string, string[]>;
|
|
236
|
+
note?: string;
|
|
237
|
+
}>;
|
|
238
|
+
tenant?: {
|
|
239
|
+
instance: string;
|
|
240
|
+
environment: string;
|
|
241
|
+
frontendApiHosts: string[];
|
|
242
|
+
shape: 'redirect' | 'panel' | 'button' | null;
|
|
243
|
+
origin: string | null;
|
|
244
|
+
originAllowed: boolean | null;
|
|
245
|
+
/** The merged sources for your pages, as one Content-Security-Policy value. */
|
|
246
|
+
policy: string;
|
|
247
|
+
sources: Record<string, string[]>;
|
|
248
|
+
};
|
|
249
|
+
}
|
|
95
250
|
export interface PreflightReport {
|
|
96
251
|
object: 'preflight';
|
|
97
252
|
/** True when there are no error-severity findings. */
|
|
98
253
|
ok: boolean;
|
|
99
254
|
/** When the check ran (epoch ms). */
|
|
100
255
|
checked_at: number;
|
|
101
|
-
/** Ordered error, then warning, then info
|
|
256
|
+
/** Ordered error, then warning, then info; only those at or above `min_severity`. */
|
|
102
257
|
findings: PreflightFinding[];
|
|
258
|
+
/** The `min_severity` the findings were filtered by (`info` = everything). */
|
|
259
|
+
min_severity?: 'error' | 'warning' | 'info';
|
|
260
|
+
/** Findings that do not apply to how the instance integrates (not counted in `ok`). */
|
|
261
|
+
suppressed?: PreflightSuppressedFinding[];
|
|
262
|
+
/** How each allowed https origin signs in. */
|
|
263
|
+
integrations?: PreflightOriginIntegration[];
|
|
103
264
|
/** Atlas browser SDK versions seen in the last 7 days (newest first), with their advisories. */
|
|
104
265
|
sdk_versions_seen?: SdkVersionSeen[];
|
|
105
266
|
}
|
|
@@ -296,21 +457,258 @@ export interface SetForumulateIntegrationBody {
|
|
|
296
457
|
/** The token `aud`. Default `forumulate:<org_id>`. */
|
|
297
458
|
audience?: string | null;
|
|
298
459
|
}
|
|
460
|
+
/** Receiver health, in the webhook health vocabulary. */
|
|
461
|
+
export interface IntegrationReceiverHealth {
|
|
462
|
+
url: string;
|
|
463
|
+
endpoint_id: string | null;
|
|
464
|
+
state: 'healthy' | 'failing' | 'disabled' | 'unknown';
|
|
465
|
+
failing_since: number | null;
|
|
466
|
+
disabled_at: number | null;
|
|
467
|
+
last_success_at: number | null;
|
|
468
|
+
last_failure: {
|
|
469
|
+
at: number;
|
|
470
|
+
status: number | null;
|
|
471
|
+
error: string | null;
|
|
472
|
+
} | null;
|
|
473
|
+
consecutive_failures: number;
|
|
474
|
+
success_rate_24h: number | null;
|
|
475
|
+
events?: string[];
|
|
476
|
+
}
|
|
477
|
+
/**
|
|
478
|
+
* An identity integration: any service that verifies a user with a JWT — a
|
|
479
|
+
* preset (`chatly`, `forumulate`, `cookiemunch`, `referalli`) or a custom one.
|
|
480
|
+
* `enabled: false, connected: false` when it was never connected.
|
|
481
|
+
*/
|
|
482
|
+
export interface Integration {
|
|
483
|
+
object: string;
|
|
484
|
+
id: string;
|
|
485
|
+
/** The same value as `id`. */
|
|
486
|
+
product: string;
|
|
487
|
+
preset: 'chatly' | 'forumulate' | 'cookiemunch' | 'referalli' | null;
|
|
488
|
+
name?: string;
|
|
489
|
+
role?: 'support_chat' | 'docs_community' | 'consent' | 'referrals' | 'other';
|
|
490
|
+
enabled: boolean;
|
|
491
|
+
connected: boolean;
|
|
492
|
+
audience?: string;
|
|
493
|
+
audience_format?: string | null;
|
|
494
|
+
principal_claim?: 'audience_hint' | null;
|
|
495
|
+
ext_claim?: 'external_id' | null;
|
|
496
|
+
ttl_seconds?: number;
|
|
497
|
+
issuer?: string;
|
|
498
|
+
jwks_url?: string;
|
|
499
|
+
token_schema?: string;
|
|
500
|
+
events_url?: string | null;
|
|
501
|
+
events_url_default?: boolean;
|
|
502
|
+
events?: string[];
|
|
503
|
+
backchannel_logout_url?: string | null;
|
|
504
|
+
backchannel_logout_url_default?: boolean;
|
|
505
|
+
/** Where the receiver comes from: set here, the first-party OAuth client's backchannel_logout_uri, or the preset's path. */
|
|
506
|
+
backchannel_logout_source?: 'integration' | 'oauth_client' | 'preset' | null;
|
|
507
|
+
/** With source `oauth_client`: that client's client_id (also the `aud` of its logout tokens). */
|
|
508
|
+
backchannel_logout_client_id?: string | null;
|
|
509
|
+
/** The first-party OAuth client the service signs users in with, as set (null = not set). */
|
|
510
|
+
oauth_client_id?: string | null;
|
|
511
|
+
verify_error_report_url?: string | null;
|
|
512
|
+
cmp?: {
|
|
513
|
+
script_url: string;
|
|
514
|
+
script_id: string | null;
|
|
515
|
+
site_id: string | null;
|
|
516
|
+
blocking_mode: string | null;
|
|
517
|
+
extra_origins: string[];
|
|
518
|
+
settings_preset: 'cookiemunch' | 'cookiebot' | 'onetrust' | 'custom' | null;
|
|
519
|
+
} | null;
|
|
520
|
+
atlas_id_users?: boolean;
|
|
521
|
+
atlas_id_issuer?: {
|
|
522
|
+
issuer: string;
|
|
523
|
+
jwks_url: string;
|
|
524
|
+
} | null;
|
|
525
|
+
enabled_at?: number | null;
|
|
526
|
+
updated_at?: number | null;
|
|
527
|
+
/** Present on a `?dry_run=true` answer. */
|
|
528
|
+
dry_run?: boolean;
|
|
529
|
+
health?: {
|
|
530
|
+
last_minted_at: number | null;
|
|
531
|
+
mints_24h: number;
|
|
532
|
+
verify_errors_24h: number;
|
|
533
|
+
last_verify_error: {
|
|
534
|
+
error: string;
|
|
535
|
+
audience: string | null;
|
|
536
|
+
at: number;
|
|
537
|
+
reported_at: number;
|
|
538
|
+
} | null;
|
|
539
|
+
events: IntegrationReceiverHealth | null;
|
|
540
|
+
backchannel_logout: IntegrationReceiverHealth | null;
|
|
541
|
+
};
|
|
542
|
+
/** Preset fields (chatly: channel/template/identity_verification; forumulate: org_id/spaces/reader_auth_provider; cookiemunch: site_id; referalli: org_id). */
|
|
543
|
+
[presetField: string]: unknown;
|
|
544
|
+
}
|
|
545
|
+
export interface SetIntegrationBody {
|
|
546
|
+
enabled?: boolean;
|
|
547
|
+
/** `<preset>:<id>` for a preset; any value for a custom integration. */
|
|
548
|
+
audience?: string;
|
|
549
|
+
/** Custom integrations: the display name (required), role and audience format. */
|
|
550
|
+
name?: string;
|
|
551
|
+
role?: 'support_chat' | 'docs_community' | 'consent' | 'referrals' | 'other';
|
|
552
|
+
audience_format?: string | null;
|
|
553
|
+
principal_claim?: 'audience_hint' | null;
|
|
554
|
+
ext_claim?: 'external_id' | null;
|
|
555
|
+
/** 10-120. Default 120. */
|
|
556
|
+
ttl_seconds?: number;
|
|
557
|
+
/** Omitted = the preset default; null = none. */
|
|
558
|
+
events_url?: string | null;
|
|
559
|
+
/**
|
|
560
|
+
* Omitted = the backchannel_logout_uri of the service's first-party OAuth
|
|
561
|
+
* client when it has one, else the preset default; null = none.
|
|
562
|
+
*/
|
|
563
|
+
backchannel_logout_url?: string | null;
|
|
564
|
+
verify_error_report_url?: string | null;
|
|
565
|
+
/**
|
|
566
|
+
* The client_id of the first-party OAuth client the service signs users in
|
|
567
|
+
* with. Omitted = the first-party client tagged `metadata.product = <id>`;
|
|
568
|
+
* null = none.
|
|
569
|
+
*/
|
|
570
|
+
oauth_client_id?: string | null;
|
|
571
|
+
cmp?: {
|
|
572
|
+
script_url: string;
|
|
573
|
+
script_id?: string | null;
|
|
574
|
+
site_id?: string | null;
|
|
575
|
+
blocking_mode?: string | null;
|
|
576
|
+
extra_origins?: string[];
|
|
577
|
+
settings_preset?: 'cookiemunch' | 'cookiebot' | 'onetrust' | 'custom' | null;
|
|
578
|
+
} | null;
|
|
579
|
+
atlas_id_users?: boolean;
|
|
580
|
+
/** chatly: the channel (same as `audience: 'chatly:<channel>'`). */
|
|
581
|
+
channel?: string;
|
|
582
|
+
/** forumulate: the org and spaces. */
|
|
583
|
+
org_id?: string;
|
|
584
|
+
spaces?: Array<string | {
|
|
585
|
+
id: string;
|
|
586
|
+
redeem_url?: string | null;
|
|
587
|
+
}>;
|
|
588
|
+
}
|
|
589
|
+
export interface IntegrationDelivery {
|
|
590
|
+
object: 'integration_delivery';
|
|
591
|
+
kind: 'event' | 'backchannel_logout';
|
|
592
|
+
integration: string;
|
|
593
|
+
id: string;
|
|
594
|
+
url: string;
|
|
595
|
+
event_id?: string;
|
|
596
|
+
event_type?: string | null;
|
|
597
|
+
sid?: string | null;
|
|
598
|
+
trace_id: string | null;
|
|
599
|
+
status: 'pending' | 'success' | 'failed';
|
|
600
|
+
attempt_number: number;
|
|
601
|
+
http_status: number | null;
|
|
602
|
+
error: string | null;
|
|
603
|
+
created_at: number;
|
|
604
|
+
[field: string]: unknown;
|
|
605
|
+
}
|
|
606
|
+
/** An integration token (the claims follow /schemas/integration-token-v1.json). */
|
|
607
|
+
export interface IntegrationTokenResponse {
|
|
608
|
+
object: 'integration_token';
|
|
609
|
+
integration: string;
|
|
610
|
+
product: string;
|
|
611
|
+
jwt: string;
|
|
612
|
+
expires_in: number;
|
|
613
|
+
audience: string;
|
|
614
|
+
org_id?: string;
|
|
615
|
+
space_id?: string;
|
|
616
|
+
redeem_url?: string;
|
|
617
|
+
issuer?: string;
|
|
618
|
+
jwks_uri?: string;
|
|
619
|
+
}
|
|
299
620
|
export declare function instanceResource(request: RequestFn): {
|
|
300
621
|
get(): Promise<Instance>;
|
|
301
622
|
update(body: UpdateInstanceBody): Promise<InstanceUpdateResult>;
|
|
302
623
|
/** Check your setup in one call: configuration the server can see is broken or risky. */
|
|
303
|
-
preflight(): Promise<PreflightReport>;
|
|
624
|
+
preflight(params?: PreflightParams): Promise<PreflightReport>;
|
|
625
|
+
/**
|
|
626
|
+
* The unknown body fields your writes sent over the last `days` (1-90,
|
|
627
|
+
* default 30): fix every row with an `ignored_count`, then turn
|
|
628
|
+
* `auth_config.strictRequestBodies` on.
|
|
629
|
+
*/
|
|
630
|
+
unknownFieldsReport(params?: {
|
|
631
|
+
days?: number;
|
|
632
|
+
}): Promise<UnknownFieldsReport>;
|
|
633
|
+
/** What changed in the API since a date (YYYY-MM-DD): operations added, deprecated and removed. */
|
|
634
|
+
openapiDiff(params: {
|
|
635
|
+
since: string;
|
|
636
|
+
surface?: string;
|
|
637
|
+
}): Promise<OpenApiDiff>;
|
|
304
638
|
/**
|
|
305
639
|
* Move every URL that points at one origin to another (a domain move), across
|
|
306
640
|
* the instance, its OAuth clients, webhooks, redirect URLs and Sign in with
|
|
307
641
|
* Atlas apps. `dry_run: true` writes nothing.
|
|
308
642
|
*/
|
|
309
643
|
moveOrigin(body: OriginMoveRequest): Promise<OriginMove>;
|
|
644
|
+
/**
|
|
645
|
+
* One report of everything that connects the instance to the outside world
|
|
646
|
+
* (setup checks, webhooks with the failing hop, back-channel logout,
|
|
647
|
+
* referrals, email, consent manager, SDK versions). `only` limits the
|
|
648
|
+
* sources; `probe: false` skips live reachability probes.
|
|
649
|
+
*/
|
|
650
|
+
integrationHealth(params?: {
|
|
651
|
+
only?: string[];
|
|
652
|
+
probe?: boolean;
|
|
653
|
+
}): Promise<IntegrationHealthReport>;
|
|
654
|
+
/** The integration-health check sources this deployment reports. */
|
|
655
|
+
integrationHealthProviders(): Promise<{
|
|
656
|
+
object: "list";
|
|
657
|
+
data: {
|
|
658
|
+
object: "integration_health_provider";
|
|
659
|
+
source: string;
|
|
660
|
+
description: string;
|
|
661
|
+
}[];
|
|
662
|
+
has_more: false;
|
|
663
|
+
}>;
|
|
664
|
+
/**
|
|
665
|
+
* The embed manifest for an instance (public; no key needed): CSP sources per
|
|
666
|
+
* surface with its hosts filled in, and the merged policy in `tenant.policy`.
|
|
667
|
+
*/
|
|
668
|
+
embed(params: {
|
|
669
|
+
instance: string;
|
|
670
|
+
origin?: string;
|
|
671
|
+
shape?: "redirect" | "panel" | "button";
|
|
672
|
+
}): Promise<EmbedManifest>;
|
|
310
673
|
/** The instance's links to other platforms and their health. Read-only. */
|
|
311
674
|
connections(): Promise<InstanceConnections>;
|
|
312
|
-
/**
|
|
675
|
+
/**
|
|
676
|
+
* Identity integrations: presets and custom integrations (generic), plus the
|
|
677
|
+
* earlier per-product helpers (`chatly`, `forumulate`) on the same records.
|
|
678
|
+
*/
|
|
313
679
|
integrations: {
|
|
680
|
+
/** Every integration (the presets, connected or not, and every custom one) with its health. */
|
|
681
|
+
list(): Promise<{
|
|
682
|
+
object: "list";
|
|
683
|
+
data: Integration[];
|
|
684
|
+
has_more: boolean;
|
|
685
|
+
}>;
|
|
686
|
+
get(id: string): Promise<Integration>;
|
|
687
|
+
/** Connect or replace an integration. `{ dryRun: true }` validates and saves nothing. */
|
|
688
|
+
set(id: string, body: SetIntegrationBody, opts?: {
|
|
689
|
+
dryRun?: boolean;
|
|
690
|
+
}): Promise<Integration>;
|
|
691
|
+
remove(id: string): Promise<Integration>;
|
|
692
|
+
/** Event and back-channel logout deliveries, newest first; `trace` finds one operation. */
|
|
693
|
+
deliveries(id: string, query?: {
|
|
694
|
+
limit?: number;
|
|
695
|
+
trace?: string;
|
|
696
|
+
kind?: "event" | "backchannel_logout";
|
|
697
|
+
}): Promise<{
|
|
698
|
+
object: "list";
|
|
699
|
+
data: IntegrationDelivery[];
|
|
700
|
+
has_more: boolean;
|
|
701
|
+
}>;
|
|
702
|
+
/** Reveal the event receiver's signing secret (audited). */
|
|
703
|
+
revealEventsSecret(id: string): Promise<{
|
|
704
|
+
object: "integration_events_secret";
|
|
705
|
+
integration: string;
|
|
706
|
+
endpoint_id: string;
|
|
707
|
+
url: string;
|
|
708
|
+
secret: string;
|
|
709
|
+
}>;
|
|
710
|
+
/** An integration token for a Sign in with Atlas user (their Atlas ID access token). */
|
|
711
|
+
atlasIdToken(id: string, accessToken: string): Promise<IntegrationTokenResponse>;
|
|
314
712
|
chatly: {
|
|
315
713
|
get(): Promise<ChatlyIntegration>;
|
|
316
714
|
set(body: SetChatlyIntegrationBody): Promise<ChatlyIntegration>;
|