@epilot/sdk 2.9.0 → 2.9.1
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/LICENSE +21 -0
- package/README.md +1 -0
- package/definitions/access-token-runtime.json +1 -1
- package/definitions/access-token.json +155 -1
- package/definitions/automation.json +120 -0
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +571 -1
- package/definitions/journey.json +19 -2
- package/definitions/snapshot-runtime.json +1 -0
- package/definitions/snapshot.json +935 -0
- package/definitions/targeting.json +5 -4
- package/definitions/user-runtime.json +1 -1
- package/definitions/user.json +441 -0
- package/dist/README-NBWAQWQS.js +7 -0
- package/dist/README-XCIDDEAE.cjs +7 -0
- package/dist/{_index-DB2VV4PQ.cjs → _index-D5TTZP5F.cjs} +4 -1
- package/dist/{_index-5FB6F5YY.js → _index-UY46ZN47.js} +3 -0
- package/dist/access-token-GD6REL4U.js +7 -0
- package/dist/access-token-NQ5BLMOW.cjs +7 -0
- package/dist/{access-token-runtime-KCKGT4O7.js → access-token-runtime-2PSLN2U3.js} +1 -1
- package/dist/{access-token-runtime-NZWZJPWV.cjs → access-token-runtime-B6Z7JLUS.cjs} +2 -2
- package/dist/{access-token.d-CnmUTOlq.d.cts → access-token.d-CegaQmrK.d.cts} +165 -5
- package/dist/{access-token.d-CnmUTOlq.d.ts → access-token.d-CegaQmrK.d.ts} +165 -5
- package/dist/{ai-agents.d-OkXfr2bz.d.cts → ai-agents.d-CC5IjXrs.d.cts} +0 -2
- package/dist/{ai-agents.d-OkXfr2bz.d.ts → ai-agents.d-CC5IjXrs.d.ts} +0 -2
- package/dist/apis/access-token.cjs +8 -8
- package/dist/apis/access-token.d.cts +2 -2
- package/dist/apis/access-token.d.ts +2 -2
- package/dist/apis/access-token.js +2 -2
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.d.cts +2 -2
- package/dist/apis/ai-agents.d.ts +2 -2
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +38 -0
- package/dist/apis/snapshot.d.cts +18 -0
- package/dist/apis/snapshot.d.ts +18 -0
- package/dist/apis/snapshot.js +38 -0
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.cts +2 -2
- package/dist/apis/targeting.d.ts +2 -2
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +8 -8
- package/dist/apis/user.d.cts +2 -2
- package/dist/apis/user.d.ts +2 -2
- package/dist/apis/user.js +2 -2
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/automation-S6NFS5KU.cjs +7 -0
- package/dist/automation-W75XZG7B.js +7 -0
- package/dist/{automation.d-Du6-uiz5.d.cts → automation.d-DS_YXDE8.d.cts} +300 -1
- package/dist/{automation.d-Du6-uiz5.d.ts → automation.d-DS_YXDE8.d.ts} +300 -1
- package/dist/blueprint-manifest-WHYSBU66.cjs +7 -0
- package/dist/blueprint-manifest-WZVBTKUL.js +7 -0
- package/dist/{blueprint-manifest-runtime-FRLU3ZSF.js → blueprint-manifest-runtime-2344IUIE.js} +1 -1
- package/dist/{blueprint-manifest-runtime-EIDOROIQ.cjs → blueprint-manifest-runtime-WU5MWPVT.cjs} +2 -2
- package/dist/{blueprint-manifest.d-B8yDxagC.d.cts → blueprint-manifest.d-2-TORV8o.d.cts} +926 -4
- package/dist/{blueprint-manifest.d-B8yDxagC.d.ts → blueprint-manifest.d-2-TORV8o.d.ts} +926 -4
- package/dist/chunk-54QNWEPZ.js +14 -0
- package/dist/{chunk-CULH5PIN.cjs → chunk-6V3NYADA.cjs} +13 -11
- package/dist/chunk-NFIYEMMM.js +14 -0
- package/dist/{chunk-XSE4CFSM.js → chunk-OHHHS4HH.js} +1 -1
- package/dist/chunk-OWXEZ56F.cjs +14 -0
- package/dist/{chunk-RZ4ABDOF.js → chunk-QGP5WMHK.js} +13 -11
- package/dist/{chunk-OXJOO2YF.cjs → chunk-S5HBBTKM.cjs} +1 -1
- package/dist/{chunk-NGHCQ2FA.cjs → chunk-T57MT6J5.cjs} +1 -1
- package/dist/{chunk-4YBWMDFP.js → chunk-UWGWRGGB.js} +1 -1
- package/dist/chunk-YXJ4PBFQ.cjs +14 -0
- package/dist/index.cjs +24 -16
- package/dist/index.d.cts +23 -21
- package/dist/index.d.ts +23 -21
- package/dist/index.js +14 -6
- package/dist/journey-LHVSSVTG.cjs +7 -0
- package/dist/journey-NXL264XW.js +7 -0
- package/dist/{journey.d-BenIUWaO.d.ts → journey.d-B1sOeMHw.d.cts} +16 -3
- package/dist/{journey.d-BenIUWaO.d.cts → journey.d-B1sOeMHw.d.ts} +16 -3
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/dist/snapshot-2HFERXRQ.js +7 -0
- package/dist/snapshot-UHCQAT4R.cjs +7 -0
- package/dist/snapshot-runtime-6DV42FVY.cjs +5 -0
- package/dist/snapshot-runtime-IW57MINC.js +5 -0
- package/dist/snapshot.d-CqefmvuB.d.cts +724 -0
- package/dist/snapshot.d-CqefmvuB.d.ts +724 -0
- package/dist/{targeting-DAFJBPIZ.cjs → targeting-WC62BBZN.cjs} +1 -1
- package/dist/{targeting-TGPCRRI6.js → targeting-X4Y2ODBT.js} +1 -1
- package/dist/{targeting.d-DxHQbn7-.d.cts → targeting.d-0rNF7ErD.d.cts} +11 -4
- package/dist/{targeting.d-DxHQbn7-.d.ts → targeting.d-0rNF7ErD.d.ts} +11 -4
- package/dist/user-3SLAEEVD.cjs +7 -0
- package/dist/user-PRUYBXQV.js +7 -0
- package/dist/{user-runtime-U4HYUWJU.js → user-runtime-6ICV2Y73.js} +1 -1
- package/dist/user-runtime-Y3227ETX.cjs +5 -0
- package/dist/{user.d-D18fe97W.d.cts → user.d-L-C7_K84.d.cts} +421 -1
- package/dist/{user.d-D18fe97W.d.ts → user.d-L-C7_K84.d.ts} +421 -1
- package/docs/access-token.md +111 -3
- package/docs/automation.md +180 -37
- package/docs/blueprint-manifest.md +421 -95
- package/docs/journey.md +28 -8
- package/docs/snapshot.md +607 -0
- package/docs/targeting.md +6 -3
- package/docs/user.md +321 -8
- package/package.json +20 -12
- package/definitions/focus-pocus-runtime.json +0 -1
- package/definitions/focus-pocus.json +0 -757
- package/dist/README-46VYEGGW.js +0 -7
- package/dist/README-IVBISSWB.cjs +0 -7
- package/dist/access-token-6BJDZSFE.cjs +0 -7
- package/dist/access-token-GSQZLDXR.js +0 -7
- package/dist/automation-BMO7ZFTN.cjs +0 -7
- package/dist/automation-MEZTSUR3.js +0 -7
- package/dist/blueprint-manifest-6DEYW5MW.js +0 -7
- package/dist/blueprint-manifest-GCV7H74X.cjs +0 -7
- package/dist/chunk-3XKBB5AE.js +0 -14
- package/dist/chunk-Z5TVWG3I.cjs +0 -14
- package/dist/journey-4DIIPRU4.js +0 -7
- package/dist/journey-ATC3Y5AW.cjs +0 -7
- package/dist/user-7ZN2XO7G.cjs +0 -7
- package/dist/user-ZK7BK6VY.js +0 -7
- package/dist/user-runtime-7O2HLFVQ.cjs +0 -5
|
@@ -43,6 +43,7 @@ var purpose = "purpose";
|
|
|
43
43
|
var query = "query";
|
|
44
44
|
var sandbox = "sandbox";
|
|
45
45
|
var sharing = "sharing";
|
|
46
|
+
var snapshot = "snapshot";
|
|
46
47
|
var submission = "submission";
|
|
47
48
|
var targeting = "targeting";
|
|
48
49
|
var templateVariables = "template-variables";
|
|
@@ -94,6 +95,7 @@ var index_default = {
|
|
|
94
95
|
query,
|
|
95
96
|
sandbox,
|
|
96
97
|
sharing,
|
|
98
|
+
snapshot,
|
|
97
99
|
submission,
|
|
98
100
|
targeting,
|
|
99
101
|
templateVariables,
|
|
@@ -155,4 +157,5 @@ var index_default = {
|
|
|
155
157
|
|
|
156
158
|
|
|
157
159
|
|
|
158
|
-
|
|
160
|
+
|
|
161
|
+
exports.accessToken = accessToken; exports.address = address; exports.addressSuggestions = addressSuggestions; exports.aiAgents = aiAgents; exports.app = app; exports.auditLogs = auditLogs; exports.automation = automation; exports.billing = billing; exports.blueprintManifest = blueprintManifest; exports.calendar = calendar; exports.configurationHub = configurationHub; exports.consent = consent; exports.customerPortal = customerPortal; exports.dashboard = dashboard; exports.dataGovernance = dataGovernance; exports.deduplication = deduplication; exports.default = index_default; exports.design = design; exports.document = document; exports.emailSettings = emailSettings; exports.emailTemplate = emailTemplate; exports.entity = entity; exports.entityMapping = entityMapping; exports.environments = environments; exports.eventCatalog = eventCatalog; exports.file = file; exports.iban = iban; exports.integrationToolkit = integrationToolkit; exports.journey = journey; exports.kanban = kanban; exports.message = message; exports.metering = metering; exports.notes = notes; exports.notification = notification; exports.organization = organization; exports.partnerDirectory = partnerDirectory; exports.permissions = permissions; exports.pricing = pricing; exports.pricingTier = pricingTier; exports.purpose = purpose; exports.query = query; exports.sandbox = sandbox; exports.sharing = sharing; exports.snapshot = snapshot; exports.submission = submission; exports.targeting = targeting; exports.templateVariables = templateVariables; exports.user = user; exports.validationRules = validationRules; exports.webhooks = webhooks; exports.workflow = workflow; exports.workflowDefinition = workflowDefinition;
|
|
@@ -43,6 +43,7 @@ var purpose = "purpose";
|
|
|
43
43
|
var query = "query";
|
|
44
44
|
var sandbox = "sandbox";
|
|
45
45
|
var sharing = "sharing";
|
|
46
|
+
var snapshot = "snapshot";
|
|
46
47
|
var submission = "submission";
|
|
47
48
|
var targeting = "targeting";
|
|
48
49
|
var templateVariables = "template-variables";
|
|
@@ -94,6 +95,7 @@ var index_default = {
|
|
|
94
95
|
query,
|
|
95
96
|
sandbox,
|
|
96
97
|
sharing,
|
|
98
|
+
snapshot,
|
|
97
99
|
submission,
|
|
98
100
|
targeting,
|
|
99
101
|
templateVariables,
|
|
@@ -147,6 +149,7 @@ export {
|
|
|
147
149
|
query,
|
|
148
150
|
sandbox,
|
|
149
151
|
sharing,
|
|
152
|
+
snapshot,
|
|
150
153
|
submission,
|
|
151
154
|
targeting,
|
|
152
155
|
templateVariables,
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/access-token.json
|
|
4
|
+
var access_token_default = '# Access Token API\n\n- **Base URL:** `https://access-token.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/access-token](https://docs.epilot.io/api/access-token)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.accessToken.createAccessToken(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/access-token\'\n\nconst accessTokenClient = getClient()\nauthorize(accessTokenClient, () => \'<token>\')\nconst { data } = await accessTokenClient.createAccessToken(...)\n```\n\n## Operations\n\n**Access Tokens**\n- [`createAccessToken`](#createaccesstoken)\n- [`listAccessTokens`](#listaccesstokens)\n- [`revokeAccessToken`](#revokeaccesstoken)\n\n**Public**\n- [`getAccessTokenJwks`](#getaccesstokenjwks)\n- [`getAccessTokenOIDC`](#getaccesstokenoidc)\n- [`getPublicTokenJwks`](#getpublictokenjwks)\n- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)\n- [`getPublicTokenOIDC`](#getpublictokenoidc)\n- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)\n\n**Schemas**\n- [`AccessToken`](#accesstoken)\n- [`AccessTokenId`](#accesstokenid)\n- [`AccessTokenName`](#accesstokenname)\n- [`AccessTokenType`](#accesstokentype)\n- [`AccessTokenJourneyId`](#accesstokenjourneyid)\n- [`PortalId`](#portalid)\n- [`PortalUserId`](#portaluserid)\n- [`TokenParameters`](#tokenparameters)\n- [`ExpiresIn`](#expiresin)\n- [`ReadOnly`](#readonly)\n- [`AccessTokenParameters`](#accesstokenparameters)\n- [`JourneyTokenParameters`](#journeytokenparameters)\n- [`PortalTokenParameters`](#portaltokenparameters)\n- [`AssumeTokenParameters`](#assumetokenparameters)\n- [`AppTokenParameters`](#apptokenparameters)\n- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)\n- [`AccessTokenItem`](#accesstokenitem)\n- [`RoleId`](#roleid)\n- [`Assignments`](#assignments)\n\n### `createAccessToken`\n\n**Access Token type: `API`** (default if not specified):\n\n`POST /v1/access-tokens`\n\n```ts\nconst { data } = await client.createAccessToken(\n null,\n {\n name: \'Postman Access Token\',\n token_type: \'api\',\n assignments: [\'123:owner\'],\n expires_in: 3600,\n read_only: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n}\n```\n\n</details>\n\n---\n\n### `listAccessTokens`\n\nLists all Access Tokens for current user (by default excludes system generated tokens)\n\n`GET /v1/access-tokens`\n\n```ts\nconst { data } = await client.listAccessTokens({\n token_type: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n }\n]\n```\n\n</details>\n\n---\n\n### `revokeAccessToken`\n\nRevokes an Access Token so it can\'t be used anymore.\n\n`DELETE /v1/access-tokens/{id}`\n\n```ts\nconst { data } = await client.revokeAccessToken({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenJwks`\n\nGet jwks public key set to verify access tokens generated by this API\n\n`GET /v1/access-tokens/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getAccessTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenOIDC`\n\nOpenID Connect configuration for Access Token API as identity provider\n\n`GET /v1/access-tokens/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getAccessTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenJwks`\n\nGet jwks public key set to verify public tokens generated by this API\n\n`GET /v1/access-tokens/public/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPublicTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenJwks`\n\nGet jwks public key set to verify portal preview tokens generated by this API\n\n`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a public identity provider\n\n`GET /v1/access-tokens/public/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPublicTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a portal preview identity provider\n\n`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AccessToken`\n\nA JWT Access Token\n\n```ts\ntype AccessToken = string\n```\n\n### `AccessTokenId`\n\n```ts\ntype AccessTokenId = string\n```\n\n### `AccessTokenName`\n\nHuman readable name for access token\n\n```ts\ntype AccessTokenName = string\n```\n\n### `AccessTokenType`\n\nAccess token type\n\n```ts\ntype AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"\n```\n\n### `AccessTokenJourneyId`\n\nJourney ID for access token type "journey"\n\n```ts\ntype AccessTokenJourneyId = string\n```\n\n### `PortalId`\n\nPortal ID for access token type "portal"\n\n```ts\ntype PortalId = string\n```\n\n### `PortalUserId`\n\nPortal User ID for access token type "portal_preview"\n\n```ts\ntype PortalUserId = string\n```\n\n### `TokenParameters`\n\n```ts\ntype TokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n} | {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n} | {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `ExpiresIn`\n\n```ts\ntype ExpiresIn = number | string\n```\n\n### `ReadOnly`\n\nWhen true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.\n\n```ts\ntype ReadOnly = boolean\n```\n\n### `AccessTokenParameters`\n\n```ts\ntype AccessTokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n}\n```\n\n### `JourneyTokenParameters`\n\n```ts\ntype JourneyTokenParameters = {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n}\n```\n\n### `PortalTokenParameters`\n\n```ts\ntype PortalTokenParameters = {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n}\n```\n\n### `AssumeTokenParameters`\n\n```ts\ntype AssumeTokenParameters = {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n}\n```\n\n### `AppTokenParameters`\n\n```ts\ntype AppTokenParameters = {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n}\n```\n\n### `PortalPreviewTokenParameters`\n\n```ts\ntype PortalPreviewTokenParameters = {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `AccessTokenItem`\n\n```ts\ntype AccessTokenItem = {\n id: string\n created_at: string // date-time\n name: string\n token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"\n journey_id?: string\n portal_id?: string\n portal_user_id?: string\n assignments?: string[]\n read_only?: boolean\n last_used?: string // date\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
access_token_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/access-token.json
|
|
4
|
+
var access_token_default = '# Access Token API\n\n- **Base URL:** `https://access-token.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/access-token](https://docs.epilot.io/api/access-token)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.accessToken.createAccessToken(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/access-token\'\n\nconst accessTokenClient = getClient()\nauthorize(accessTokenClient, () => \'<token>\')\nconst { data } = await accessTokenClient.createAccessToken(...)\n```\n\n## Operations\n\n**Access Tokens**\n- [`createAccessToken`](#createaccesstoken)\n- [`listAccessTokens`](#listaccesstokens)\n- [`revokeAccessToken`](#revokeaccesstoken)\n\n**Public**\n- [`getAccessTokenJwks`](#getaccesstokenjwks)\n- [`getAccessTokenOIDC`](#getaccesstokenoidc)\n- [`getPublicTokenJwks`](#getpublictokenjwks)\n- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)\n- [`getPublicTokenOIDC`](#getpublictokenoidc)\n- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)\n\n**Schemas**\n- [`AccessToken`](#accesstoken)\n- [`AccessTokenId`](#accesstokenid)\n- [`AccessTokenName`](#accesstokenname)\n- [`AccessTokenType`](#accesstokentype)\n- [`AccessTokenJourneyId`](#accesstokenjourneyid)\n- [`PortalId`](#portalid)\n- [`PortalUserId`](#portaluserid)\n- [`TokenParameters`](#tokenparameters)\n- [`ExpiresIn`](#expiresin)\n- [`ReadOnly`](#readonly)\n- [`AccessTokenParameters`](#accesstokenparameters)\n- [`JourneyTokenParameters`](#journeytokenparameters)\n- [`PortalTokenParameters`](#portaltokenparameters)\n- [`AssumeTokenParameters`](#assumetokenparameters)\n- [`AppTokenParameters`](#apptokenparameters)\n- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)\n- [`AccessTokenItem`](#accesstokenitem)\n- [`RoleId`](#roleid)\n- [`Assignments`](#assignments)\n\n### `createAccessToken`\n\n**Access Token type: `API`** (default if not specified):\n\n`POST /v1/access-tokens`\n\n```ts\nconst { data } = await client.createAccessToken(\n null,\n {\n name: \'Postman Access Token\',\n token_type: \'api\',\n assignments: [\'123:owner\'],\n expires_in: 3600,\n read_only: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n}\n```\n\n</details>\n\n---\n\n### `listAccessTokens`\n\nLists all Access Tokens for current user (by default excludes system generated tokens)\n\n`GET /v1/access-tokens`\n\n```ts\nconst { data } = await client.listAccessTokens({\n token_type: [\'...\'],\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n }\n]\n```\n\n</details>\n\n---\n\n### `revokeAccessToken`\n\nRevokes an Access Token so it can\'t be used anymore.\n\n`DELETE /v1/access-tokens/{id}`\n\n```ts\nconst { data } = await client.revokeAccessToken({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "api_5ZugdRXasLfWBypHi93Fk",\n "created_at": "1970-01-01T00:00:00.000Z",\n "name": "Postman Access Token",\n "token_type": "api",\n "journey_id": "string",\n "portal_id": "string",\n "portal_user_id": "string",\n "assignments": ["123:owner"],\n "read_only": true,\n "last_used": "2026-02-24"\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenJwks`\n\nGet jwks public key set to verify access tokens generated by this API\n\n`GET /v1/access-tokens/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getAccessTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getAccessTokenOIDC`\n\nOpenID Connect configuration for Access Token API as identity provider\n\n`GET /v1/access-tokens/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getAccessTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenJwks`\n\nGet jwks public key set to verify public tokens generated by this API\n\n`GET /v1/access-tokens/public/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPublicTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenJwks`\n\nGet jwks public key set to verify portal preview tokens generated by this API\n\n`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenJwks()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "keys": [\n {\n "alg": "RS256",\n "e": "AQAB",\n "kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",\n "kty": "RSA",\n "n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",\n "use": "sig"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPublicTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a public identity provider\n\n`GET /v1/access-tokens/public/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPublicTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n### `getPortalPreviewTokenOIDC`\n\nOpenID Connect configuration for Access Token API a a portal preview identity provider\n\n`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`\n\n```ts\nconst { data } = await client.getPortalPreviewTokenOIDC()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",\n "jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `AccessToken`\n\nA JWT Access Token\n\n```ts\ntype AccessToken = string\n```\n\n### `AccessTokenId`\n\n```ts\ntype AccessTokenId = string\n```\n\n### `AccessTokenName`\n\nHuman readable name for access token\n\n```ts\ntype AccessTokenName = string\n```\n\n### `AccessTokenType`\n\nAccess token type\n\n```ts\ntype AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"\n```\n\n### `AccessTokenJourneyId`\n\nJourney ID for access token type "journey"\n\n```ts\ntype AccessTokenJourneyId = string\n```\n\n### `PortalId`\n\nPortal ID for access token type "portal"\n\n```ts\ntype PortalId = string\n```\n\n### `PortalUserId`\n\nPortal User ID for access token type "portal_preview"\n\n```ts\ntype PortalUserId = string\n```\n\n### `TokenParameters`\n\n```ts\ntype TokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n} | {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n} | {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n} | {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `ExpiresIn`\n\n```ts\ntype ExpiresIn = number | string\n```\n\n### `ReadOnly`\n\nWhen true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.\n\n```ts\ntype ReadOnly = boolean\n```\n\n### `AccessTokenParameters`\n\n```ts\ntype AccessTokenParameters = {\n name: string\n token_type?: "api"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n}\n```\n\n### `JourneyTokenParameters`\n\n```ts\ntype JourneyTokenParameters = {\n name: string\n token_type?: "journey"\n journey_id: string\n expires_in?: number | string\n}\n```\n\n### `PortalTokenParameters`\n\n```ts\ntype PortalTokenParameters = {\n name: string\n token_type?: "portal"\n portal_id: string\n expires_in?: number | string\n}\n```\n\n### `AssumeTokenParameters`\n\n```ts\ntype AssumeTokenParameters = {\n name: string\n token_type?: "assume"\n assignments?: string[]\n read_only?: boolean\n}\n```\n\n### `AppTokenParameters`\n\n```ts\ntype AppTokenParameters = {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n}\n```\n\n### `PortalPreviewTokenParameters`\n\n```ts\ntype PortalPreviewTokenParameters = {\n name: string\n token_type?: "portal_preview"\n portal_id: string\n portal_user_id: string\n}\n```\n\n### `AccessTokenItem`\n\n```ts\ntype AccessTokenItem = {\n id: string\n created_at: string // date-time\n name: string\n token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"\n journey_id?: string\n portal_id?: string\n portal_user_id?: string\n assignments?: string[]\n read_only?: boolean\n last_used?: string // date\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = access_token_default;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkS5HBBTKMcjs = require('./chunk-S5HBBTKM.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkS5HBBTKMcjs.require_access_token_runtime.call(void 0, );
|
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
2
|
|
|
3
3
|
/* Auto-copied from access-token-client */
|
|
4
|
-
/* eslint-disable */
|
|
5
|
-
|
|
6
4
|
|
|
7
5
|
|
|
8
6
|
declare namespace Components {
|
|
@@ -39,7 +37,14 @@ declare namespace Components {
|
|
|
39
37
|
AccessTokenType;
|
|
40
38
|
journey_id?: /* Journey ID for access token type "journey" */ AccessTokenJourneyId;
|
|
41
39
|
portal_id?: /* Portal ID for access token type "portal" */ PortalId;
|
|
40
|
+
portal_user_id?: /* Portal User ID for access token type "portal_preview" */ PortalUserId;
|
|
42
41
|
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
42
|
+
read_only?: /**
|
|
43
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
44
|
+
* example:
|
|
45
|
+
* true
|
|
46
|
+
*/
|
|
47
|
+
ReadOnly;
|
|
43
48
|
/**
|
|
44
49
|
* Last date the token was used (YYYY-MM-DD format, 1 day accuracy)
|
|
45
50
|
* example:
|
|
@@ -67,13 +72,19 @@ declare namespace Components {
|
|
|
67
72
|
token_type?: "api";
|
|
68
73
|
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
69
74
|
expires_in?: ExpiresIn;
|
|
75
|
+
read_only?: /**
|
|
76
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
77
|
+
* example:
|
|
78
|
+
* true
|
|
79
|
+
*/
|
|
80
|
+
ReadOnly;
|
|
70
81
|
}
|
|
71
82
|
/**
|
|
72
83
|
* Access token type
|
|
73
84
|
* example:
|
|
74
85
|
* api
|
|
75
86
|
*/
|
|
76
|
-
export type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app";
|
|
87
|
+
export type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview";
|
|
77
88
|
export interface AppTokenParameters {
|
|
78
89
|
name: /**
|
|
79
90
|
* Human readable name for access token
|
|
@@ -84,6 +95,12 @@ declare namespace Components {
|
|
|
84
95
|
token_type?: "app";
|
|
85
96
|
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
86
97
|
expires_in?: ExpiresIn;
|
|
98
|
+
read_only?: /**
|
|
99
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
100
|
+
* example:
|
|
101
|
+
* true
|
|
102
|
+
*/
|
|
103
|
+
ReadOnly;
|
|
87
104
|
}
|
|
88
105
|
/**
|
|
89
106
|
* List of role ids attached to an user
|
|
@@ -103,6 +120,12 @@ declare namespace Components {
|
|
|
103
120
|
AccessTokenName;
|
|
104
121
|
token_type?: "assume";
|
|
105
122
|
assignments?: /* List of role ids attached to an user */ Assignments;
|
|
123
|
+
read_only?: /**
|
|
124
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
125
|
+
* example:
|
|
126
|
+
* true
|
|
127
|
+
*/
|
|
128
|
+
ReadOnly;
|
|
106
129
|
}
|
|
107
130
|
export type ExpiresIn = number /* int32 */ | string /* ^[0-9]+ ?(ms|milliseconds?|s|seconds?|m|minutes?|h|hours?|d|days?|w|weeks?|y|years?)?$ */;
|
|
108
131
|
export interface JourneyTokenParameters {
|
|
@@ -120,6 +143,17 @@ declare namespace Components {
|
|
|
120
143
|
* Portal ID for access token type "portal"
|
|
121
144
|
*/
|
|
122
145
|
export type PortalId = string;
|
|
146
|
+
export interface PortalPreviewTokenParameters {
|
|
147
|
+
name: /**
|
|
148
|
+
* Human readable name for access token
|
|
149
|
+
* example:
|
|
150
|
+
* Postman Access Token
|
|
151
|
+
*/
|
|
152
|
+
AccessTokenName;
|
|
153
|
+
token_type?: "portal_preview";
|
|
154
|
+
portal_id: /* Portal ID for access token type "portal" */ PortalId;
|
|
155
|
+
portal_user_id: /* Portal User ID for access token type "portal_preview" */ PortalUserId;
|
|
156
|
+
}
|
|
123
157
|
export interface PortalTokenParameters {
|
|
124
158
|
name: /**
|
|
125
159
|
* Human readable name for access token
|
|
@@ -131,13 +165,23 @@ declare namespace Components {
|
|
|
131
165
|
portal_id: /* Portal ID for access token type "portal" */ PortalId;
|
|
132
166
|
expires_in?: ExpiresIn;
|
|
133
167
|
}
|
|
168
|
+
/**
|
|
169
|
+
* Portal User ID for access token type "portal_preview"
|
|
170
|
+
*/
|
|
171
|
+
export type PortalUserId = string;
|
|
172
|
+
/**
|
|
173
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
174
|
+
* example:
|
|
175
|
+
* true
|
|
176
|
+
*/
|
|
177
|
+
export type ReadOnly = boolean;
|
|
134
178
|
/**
|
|
135
179
|
* Format: <organization_id>:<slug>
|
|
136
180
|
* example:
|
|
137
181
|
* 123:owner
|
|
138
182
|
*/
|
|
139
183
|
export type RoleId = string;
|
|
140
|
-
export type TokenParameters = AccessTokenParameters | JourneyTokenParameters | PortalTokenParameters | AssumeTokenParameters | AppTokenParameters;
|
|
184
|
+
export type TokenParameters = AccessTokenParameters | JourneyTokenParameters | PortalTokenParameters | AssumeTokenParameters | AppTokenParameters | PortalPreviewTokenParameters;
|
|
141
185
|
}
|
|
142
186
|
}
|
|
143
187
|
declare namespace Paths {
|
|
@@ -171,7 +215,14 @@ declare namespace Paths {
|
|
|
171
215
|
Components.Schemas.AccessTokenType;
|
|
172
216
|
journey_id?: /* Journey ID for access token type "journey" */ Components.Schemas.AccessTokenJourneyId;
|
|
173
217
|
portal_id?: /* Portal ID for access token type "portal" */ Components.Schemas.PortalId;
|
|
218
|
+
portal_user_id?: /* Portal User ID for access token type "portal_preview" */ Components.Schemas.PortalUserId;
|
|
174
219
|
assignments?: /* List of role ids attached to an user */ Components.Schemas.Assignments;
|
|
220
|
+
read_only?: /**
|
|
221
|
+
* When true, the issued token may only perform read-only actions. Any action guarded by permissions that is not read-only (i.e. not a view/export/download action) is denied, regardless of the roles the token carries.
|
|
222
|
+
* example:
|
|
223
|
+
* true
|
|
224
|
+
*/
|
|
225
|
+
Components.Schemas.ReadOnly;
|
|
175
226
|
/**
|
|
176
227
|
* Last date the token was used (YYYY-MM-DD format, 1 day accuracy)
|
|
177
228
|
* example:
|
|
@@ -243,6 +294,60 @@ declare namespace Paths {
|
|
|
243
294
|
}
|
|
244
295
|
}
|
|
245
296
|
}
|
|
297
|
+
namespace GetPortalPreviewTokenJwks {
|
|
298
|
+
namespace Responses {
|
|
299
|
+
export interface $200 {
|
|
300
|
+
keys?: {
|
|
301
|
+
/**
|
|
302
|
+
* example:
|
|
303
|
+
* RS256
|
|
304
|
+
*/
|
|
305
|
+
alg?: string;
|
|
306
|
+
/**
|
|
307
|
+
* example:
|
|
308
|
+
* AQAB
|
|
309
|
+
*/
|
|
310
|
+
e?: string;
|
|
311
|
+
/**
|
|
312
|
+
* example:
|
|
313
|
+
* tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=
|
|
314
|
+
*/
|
|
315
|
+
kid?: string;
|
|
316
|
+
/**
|
|
317
|
+
* example:
|
|
318
|
+
* RSA
|
|
319
|
+
*/
|
|
320
|
+
kty?: string;
|
|
321
|
+
/**
|
|
322
|
+
* example:
|
|
323
|
+
* h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ
|
|
324
|
+
*/
|
|
325
|
+
n?: string;
|
|
326
|
+
/**
|
|
327
|
+
* example:
|
|
328
|
+
* sig
|
|
329
|
+
*/
|
|
330
|
+
use?: string;
|
|
331
|
+
}[];
|
|
332
|
+
}
|
|
333
|
+
}
|
|
334
|
+
}
|
|
335
|
+
namespace GetPortalPreviewTokenOIDC {
|
|
336
|
+
namespace Responses {
|
|
337
|
+
export interface $200 {
|
|
338
|
+
/**
|
|
339
|
+
* example:
|
|
340
|
+
* https://access-token.sls.epilot.io/v1/access-tokens/portal-preview
|
|
341
|
+
*/
|
|
342
|
+
issuer?: string; // uri
|
|
343
|
+
/**
|
|
344
|
+
* example:
|
|
345
|
+
* https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json
|
|
346
|
+
*/
|
|
347
|
+
jwks_uri?: string; // uri
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
}
|
|
246
351
|
namespace GetPublicTokenJwks {
|
|
247
352
|
namespace Responses {
|
|
248
353
|
export interface $200 {
|
|
@@ -408,6 +513,16 @@ interface OperationMethods {
|
|
|
408
513
|
data?: any,
|
|
409
514
|
config?: AxiosRequestConfig
|
|
410
515
|
): OperationResponse<Paths.GetPublicTokenJwks.Responses.$200>
|
|
516
|
+
/**
|
|
517
|
+
* getPortalPreviewTokenJwks - getPortalPreviewTokenJwks
|
|
518
|
+
*
|
|
519
|
+
* Get jwks public key set to verify portal preview tokens generated by this API
|
|
520
|
+
*/
|
|
521
|
+
'getPortalPreviewTokenJwks'(
|
|
522
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
523
|
+
data?: any,
|
|
524
|
+
config?: AxiosRequestConfig
|
|
525
|
+
): OperationResponse<Paths.GetPortalPreviewTokenJwks.Responses.$200>
|
|
411
526
|
/**
|
|
412
527
|
* getPublicTokenOIDC - getPublicTokenOIDC
|
|
413
528
|
*
|
|
@@ -422,6 +537,20 @@ interface OperationMethods {
|
|
|
422
537
|
data?: any,
|
|
423
538
|
config?: AxiosRequestConfig
|
|
424
539
|
): OperationResponse<Paths.GetPublicTokenOIDC.Responses.$200>
|
|
540
|
+
/**
|
|
541
|
+
* getPortalPreviewTokenOIDC - getPortalPreviewTokenOIDC
|
|
542
|
+
*
|
|
543
|
+
* OpenID Connect configuration for Access Token API a a portal preview identity provider
|
|
544
|
+
*
|
|
545
|
+
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
546
|
+
* automate the process of verifying JWT tokens.
|
|
547
|
+
*
|
|
548
|
+
*/
|
|
549
|
+
'getPortalPreviewTokenOIDC'(
|
|
550
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
551
|
+
data?: any,
|
|
552
|
+
config?: AxiosRequestConfig
|
|
553
|
+
): OperationResponse<Paths.GetPortalPreviewTokenOIDC.Responses.$200>
|
|
425
554
|
}
|
|
426
555
|
|
|
427
556
|
interface PathsDictionary {
|
|
@@ -511,6 +640,18 @@ interface PathsDictionary {
|
|
|
511
640
|
config?: AxiosRequestConfig
|
|
512
641
|
): OperationResponse<Paths.GetPublicTokenJwks.Responses.$200>
|
|
513
642
|
}
|
|
643
|
+
['/v1/access-tokens/portal-preview/.well-known/jwks.json']: {
|
|
644
|
+
/**
|
|
645
|
+
* getPortalPreviewTokenJwks - getPortalPreviewTokenJwks
|
|
646
|
+
*
|
|
647
|
+
* Get jwks public key set to verify portal preview tokens generated by this API
|
|
648
|
+
*/
|
|
649
|
+
'get'(
|
|
650
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
651
|
+
data?: any,
|
|
652
|
+
config?: AxiosRequestConfig
|
|
653
|
+
): OperationResponse<Paths.GetPortalPreviewTokenJwks.Responses.$200>
|
|
654
|
+
}
|
|
514
655
|
['/v1/access-tokens/public/.well-known/openid-configuration']: {
|
|
515
656
|
/**
|
|
516
657
|
* getPublicTokenOIDC - getPublicTokenOIDC
|
|
@@ -527,6 +668,22 @@ interface PathsDictionary {
|
|
|
527
668
|
config?: AxiosRequestConfig
|
|
528
669
|
): OperationResponse<Paths.GetPublicTokenOIDC.Responses.$200>
|
|
529
670
|
}
|
|
671
|
+
['/v1/access-tokens/portal-preview/.well-known/openid-configuration']: {
|
|
672
|
+
/**
|
|
673
|
+
* getPortalPreviewTokenOIDC - getPortalPreviewTokenOIDC
|
|
674
|
+
*
|
|
675
|
+
* OpenID Connect configuration for Access Token API a a portal preview identity provider
|
|
676
|
+
*
|
|
677
|
+
* Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
|
|
678
|
+
* automate the process of verifying JWT tokens.
|
|
679
|
+
*
|
|
680
|
+
*/
|
|
681
|
+
'get'(
|
|
682
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
683
|
+
data?: any,
|
|
684
|
+
config?: AxiosRequestConfig
|
|
685
|
+
): OperationResponse<Paths.GetPortalPreviewTokenOIDC.Responses.$200>
|
|
686
|
+
}
|
|
530
687
|
}
|
|
531
688
|
|
|
532
689
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -545,8 +702,11 @@ type AssumeTokenParameters = Components.Schemas.AssumeTokenParameters;
|
|
|
545
702
|
type ExpiresIn = Components.Schemas.ExpiresIn;
|
|
546
703
|
type JourneyTokenParameters = Components.Schemas.JourneyTokenParameters;
|
|
547
704
|
type PortalId = Components.Schemas.PortalId;
|
|
705
|
+
type PortalPreviewTokenParameters = Components.Schemas.PortalPreviewTokenParameters;
|
|
548
706
|
type PortalTokenParameters = Components.Schemas.PortalTokenParameters;
|
|
707
|
+
type PortalUserId = Components.Schemas.PortalUserId;
|
|
708
|
+
type ReadOnly = Components.Schemas.ReadOnly;
|
|
549
709
|
type RoleId = Components.Schemas.RoleId;
|
|
550
710
|
type TokenParameters = Components.Schemas.TokenParameters;
|
|
551
711
|
|
|
552
|
-
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type
|
|
712
|
+
export { type AccessToken as A, type Client as C, type ExpiresIn as E, type JourneyTokenParameters as J, type OperationMethods as O, Paths as P, type ReadOnly as R, type TokenParameters as T, Components as a, type PathsDictionary as b, type AccessTokenId as c, type AccessTokenItem as d, type AccessTokenJourneyId as e, type AccessTokenName as f, type AccessTokenParameters as g, type AccessTokenType as h, type AppTokenParameters as i, type Assignments as j, type AssumeTokenParameters as k, type PortalId as l, type PortalPreviewTokenParameters as m, type PortalTokenParameters as n, type PortalUserId as o, type RoleId as p };
|