@epilot/sdk 2.20.14 → 2.20.16
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/definitions/access-token-runtime.json +1 -1
- package/definitions/access-token.json +193 -3
- package/dist/access-token-ADVHFJ63.js +7 -0
- package/dist/access-token-CQMYWZIG.cjs +7 -0
- package/dist/{access-token-runtime-B6Z7JLUS.cjs → access-token-runtime-3HQN34OF.cjs} +2 -2
- package/dist/{access-token-runtime-2PSLN2U3.js → access-token-runtime-MEKGPOGL.js} +1 -1
- package/dist/{access-token.d-BhRUc8I-.d.cts → access-token.d-Yy-yrft_.d.cts} +213 -3
- package/dist/{access-token.d-BhRUc8I-.d.ts → access-token.d-Yy-yrft_.d.ts} +213 -3
- 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.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.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- 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.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 +6 -6
- package/dist/apis/snapshot.js +1 -1
- 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.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- 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/{chunk-FONJD6VA.js → chunk-2LP3UTEA.js} +2 -2
- package/dist/{chunk-ELW4V3ID.cjs → chunk-BV7UB72B.cjs} +2 -2
- package/dist/{chunk-OHHHS4HH.js → chunk-TW4SUGOF.js} +1 -1
- package/dist/{chunk-S5HBBTKM.cjs → chunk-ZMBA3WV4.cjs} +1 -1
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/access-token.md +120 -5
- package/package.json +1 -1
- package/dist/access-token-7Y2MDFZH.cjs +0 -7
- package/dist/access-token-NWN7UBUP.js +0 -7
|
@@ -5,7 +5,7 @@ var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
|
5
5
|
// src/definitions/access-token-runtime.json
|
|
6
6
|
var require_access_token_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
7
|
"src/definitions/access-token-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://access-token.sls.epilot.io", o: [["createAccessToken", "post", "/v1/access-tokens", null, 1], ["listAccessTokens", "get", "/v1/access-tokens", [["token_type", "q"]]], ["revokeAccessToken", "delete", "/v1/access-tokens/{id}", [["id", "p", true]]], ["getAccessTokenJwks", "get", "/v1/access-tokens/.well-known/jwks.json"], ["getAccessTokenOIDC", "get", "/v1/access-tokens/.well-known/openid-configuration"], ["getPublicTokenJwks", "get", "/v1/access-tokens/public/.well-known/jwks.json"], ["getPortalPreviewTokenJwks", "get", "/v1/access-tokens/portal-preview/.well-known/jwks.json"], ["getPublicTokenOIDC", "get", "/v1/access-tokens/public/.well-known/openid-configuration"], ["getPortalPreviewTokenOIDC", "get", "/v1/access-tokens/portal-preview/.well-known/openid-configuration"]], v: "3.0.3" };
|
|
8
|
+
module.exports = { s: "https://access-token.sls.epilot.io", o: [["createAccessToken", "post", "/v1/access-tokens", null, 1], ["listAccessTokens", "get", "/v1/access-tokens", [["token_type", "q"]]], ["revokeAccessToken", "delete", "/v1/access-tokens/{id}", [["id", "p", true]]], ["getAccessTokenJwks", "get", "/v1/access-tokens/.well-known/jwks.json"], ["getAccessTokenOIDC", "get", "/v1/access-tokens/.well-known/openid-configuration"], ["getPublicTokenJwks", "get", "/v1/access-tokens/public/.well-known/jwks.json"], ["getPortalPreviewTokenJwks", "get", "/v1/access-tokens/portal-preview/.well-known/jwks.json"], ["getPublicTokenOIDC", "get", "/v1/access-tokens/public/.well-known/openid-configuration"], ["getPortalPreviewTokenOIDC", "get", "/v1/access-tokens/portal-preview/.well-known/openid-configuration"], ["getContactIdentificationTokenJwks", "get", "/v1/access-tokens/contact-identification/.well-known/jwks.json"], ["getContactIdentificationTokenOIDC", "get", "/v1/access-tokens/contact-identification/.well-known/openid-configuration"]], v: "3.0.3" };
|
|
9
9
|
}
|
|
10
10
|
});
|
|
11
11
|
|
package/dist/index.cjs
CHANGED
|
@@ -132,7 +132,7 @@ var _chunkVMCF5R6Rcjs = require('./chunk-VMCF5R6R.cjs');
|
|
|
132
132
|
var _chunkZL6KDJFTcjs = require('./chunk-ZL6KDJFT.cjs');
|
|
133
133
|
|
|
134
134
|
|
|
135
|
-
var
|
|
135
|
+
var _chunkZMBA3WV4cjs = require('./chunk-ZMBA3WV4.cjs');
|
|
136
136
|
|
|
137
137
|
|
|
138
138
|
var _chunkLKRBFBFNcjs = require('./chunk-LKRBFBFN.cjs');
|
|
@@ -158,7 +158,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
|
|
|
158
158
|
|
|
159
159
|
|
|
160
160
|
|
|
161
|
-
var
|
|
161
|
+
var _chunkBV7UB72Bcjs = require('./chunk-BV7UB72B.cjs');
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
|
|
|
225
225
|
}
|
|
226
226
|
if (!entry.instance) {
|
|
227
227
|
const definition = entry.loader();
|
|
228
|
-
entry.instance =
|
|
228
|
+
entry.instance = _chunkBV7UB72Bcjs.createApiClient.call(void 0, {
|
|
229
229
|
definition,
|
|
230
230
|
token: state.token,
|
|
231
231
|
headers: state.globalHeaders,
|
|
@@ -258,12 +258,12 @@ var resetAllClients = (registry) => {
|
|
|
258
258
|
};
|
|
259
259
|
|
|
260
260
|
// src/apis/_registry.ts
|
|
261
|
-
var expandDef = (mod) =>
|
|
261
|
+
var expandDef = (mod) => _chunkBV7UB72Bcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
262
262
|
var registerBuiltinApis = (registry) => {
|
|
263
263
|
registerApi({
|
|
264
264
|
registry,
|
|
265
265
|
name: "accessToken",
|
|
266
|
-
loader: () => expandDef(
|
|
266
|
+
loader: () => expandDef(_chunkZMBA3WV4cjs.require_access_token_runtime.call(void 0, ))
|
|
267
267
|
});
|
|
268
268
|
registerApi({
|
|
269
269
|
registry,
|
|
@@ -601,9 +601,9 @@ var createSDK = () => {
|
|
|
601
601
|
const available = [...registry.keys()].join(", ");
|
|
602
602
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
603
603
|
}
|
|
604
|
-
return
|
|
604
|
+
return _chunkBV7UB72Bcjs.createApiHandle.call(void 0, {
|
|
605
605
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
606
|
-
createClient: () =>
|
|
606
|
+
createClient: () => _chunkBV7UB72Bcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
607
607
|
apiName: name
|
|
608
608
|
});
|
|
609
609
|
};
|
|
@@ -651,9 +651,9 @@ var createSDK = () => {
|
|
|
651
651
|
return interceptorUse;
|
|
652
652
|
}
|
|
653
653
|
case "help":
|
|
654
|
-
return (apiName) =>
|
|
654
|
+
return (apiName) => _chunkBV7UB72Bcjs.help.call(void 0, apiName);
|
|
655
655
|
case "openapi":
|
|
656
|
-
return (apiName) =>
|
|
656
|
+
return (apiName) => _chunkBV7UB72Bcjs.openapi.call(void 0, apiName);
|
|
657
657
|
case "then":
|
|
658
658
|
case "catch":
|
|
659
659
|
case "finally":
|
|
@@ -683,4 +683,4 @@ var epilot = createSDK();
|
|
|
683
683
|
|
|
684
684
|
|
|
685
685
|
|
|
686
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
686
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkBV7UB72Bcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkBV7UB72Bcjs.help; exports.openapi = _chunkBV7UB72Bcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -3,7 +3,7 @@ import { Document } from 'openapi-client-axios';
|
|
|
3
3
|
import { AxiosInstance, InternalAxiosRequestConfig, AxiosResponse } from 'axios';
|
|
4
4
|
import { T as TokenArg, H as HeadersConfig, A as ApiHandle } from './types-ChU9Acbv.cjs';
|
|
5
5
|
export { I as Interceptor, O as OverridesConfig, a as authorize } from './types-ChU9Acbv.cjs';
|
|
6
|
-
import { C as Client } from './access-token.d-
|
|
6
|
+
import { C as Client } from './access-token.d-Yy-yrft_.cjs';
|
|
7
7
|
import { C as Client$1 } from './address.d-CwAPOVxa.cjs';
|
|
8
8
|
import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
|
|
9
9
|
import { C as Client$3 } from './ai-agents.d-B3TkP4mo.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import { Document } from 'openapi-client-axios';
|
|
|
3
3
|
import { AxiosInstance, InternalAxiosRequestConfig, AxiosResponse } from 'axios';
|
|
4
4
|
import { T as TokenArg, H as HeadersConfig, A as ApiHandle } from './types-ChU9Acbv.js';
|
|
5
5
|
export { I as Interceptor, O as OverridesConfig, a as authorize } from './types-ChU9Acbv.js';
|
|
6
|
-
import { C as Client } from './access-token.d-
|
|
6
|
+
import { C as Client } from './access-token.d-Yy-yrft_.js';
|
|
7
7
|
import { C as Client$1 } from './address.d-CwAPOVxa.js';
|
|
8
8
|
import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
|
|
9
9
|
import { C as Client$3 } from './ai-agents.d-B3TkP4mo.js';
|
package/dist/index.js
CHANGED
|
@@ -132,7 +132,7 @@ import {
|
|
|
132
132
|
} from "./chunk-5ED7FB3Q.js";
|
|
133
133
|
import {
|
|
134
134
|
require_access_token_runtime
|
|
135
|
-
} from "./chunk-
|
|
135
|
+
} from "./chunk-TW4SUGOF.js";
|
|
136
136
|
import {
|
|
137
137
|
require_address_suggestions_runtime
|
|
138
138
|
} from "./chunk-4ZGZDE6D.js";
|
|
@@ -158,7 +158,7 @@ import {
|
|
|
158
158
|
expand,
|
|
159
159
|
help,
|
|
160
160
|
openapi
|
|
161
|
-
} from "./chunk-
|
|
161
|
+
} from "./chunk-2LP3UTEA.js";
|
|
162
162
|
import {
|
|
163
163
|
__require
|
|
164
164
|
} from "./chunk-YPSWSI3M.js";
|
package/docs/access-token.md
CHANGED
|
@@ -36,6 +36,8 @@ const { data } = await accessTokenClient.createAccessToken(...)
|
|
|
36
36
|
- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks)
|
|
37
37
|
- [`getPublicTokenOIDC`](#getpublictokenoidc)
|
|
38
38
|
- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc)
|
|
39
|
+
- [`getContactIdentificationTokenJwks`](#getcontactidentificationtokenjwks)
|
|
40
|
+
- [`getContactIdentificationTokenOIDC`](#getcontactidentificationtokenoidc)
|
|
39
41
|
|
|
40
42
|
**Schemas**
|
|
41
43
|
- [`AccessToken`](#accesstoken)
|
|
@@ -45,6 +47,8 @@ const { data } = await accessTokenClient.createAccessToken(...)
|
|
|
45
47
|
- [`AccessTokenJourneyId`](#accesstokenjourneyid)
|
|
46
48
|
- [`PortalId`](#portalid)
|
|
47
49
|
- [`PortalUserId`](#portaluserid)
|
|
50
|
+
- [`ContactId`](#contactid)
|
|
51
|
+
- [`AllowedOperations`](#allowedoperations)
|
|
48
52
|
- [`TokenParameters`](#tokenparameters)
|
|
49
53
|
- [`ExpiresIn`](#expiresin)
|
|
50
54
|
- [`ReadOnly`](#readonly)
|
|
@@ -55,6 +59,7 @@ const { data } = await accessTokenClient.createAccessToken(...)
|
|
|
55
59
|
- [`AssumeTokenParameters`](#assumetokenparameters)
|
|
56
60
|
- [`AppTokenParameters`](#apptokenparameters)
|
|
57
61
|
- [`PortalPreviewTokenParameters`](#portalpreviewtokenparameters)
|
|
62
|
+
- [`ContactIdentificationTokenParameters`](#contactidentificationtokenparameters)
|
|
58
63
|
- [`AccessTokenItem`](#accesstokenitem)
|
|
59
64
|
- [`RoleId`](#roleid)
|
|
60
65
|
- [`Assignments`](#assignments)
|
|
@@ -92,10 +97,13 @@ const { data } = await client.createAccessToken(
|
|
|
92
97
|
"journey_id": "string",
|
|
93
98
|
"portal_id": "string",
|
|
94
99
|
"portal_user_id": "string",
|
|
100
|
+
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
101
|
+
"allowed_operations": ["getContact", "getContracts"],
|
|
95
102
|
"assignments": ["123:owner"],
|
|
96
103
|
"read_only": true,
|
|
97
104
|
"anonymize": true,
|
|
98
|
-
"last_used": "2026-02-24"
|
|
105
|
+
"last_used": "2026-02-24",
|
|
106
|
+
"expires_at": "2026-03-01T12:00:00.000Z"
|
|
99
107
|
}
|
|
100
108
|
```
|
|
101
109
|
|
|
@@ -128,10 +136,13 @@ const { data } = await client.listAccessTokens({
|
|
|
128
136
|
"journey_id": "string",
|
|
129
137
|
"portal_id": "string",
|
|
130
138
|
"portal_user_id": "string",
|
|
139
|
+
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
140
|
+
"allowed_operations": ["getContact", "getContracts"],
|
|
131
141
|
"assignments": ["123:owner"],
|
|
132
142
|
"read_only": true,
|
|
133
143
|
"anonymize": true,
|
|
134
|
-
"last_used": "2026-02-24"
|
|
144
|
+
"last_used": "2026-02-24",
|
|
145
|
+
"expires_at": "2026-03-01T12:00:00.000Z"
|
|
135
146
|
}
|
|
136
147
|
]
|
|
137
148
|
```
|
|
@@ -164,10 +175,13 @@ const { data } = await client.revokeAccessToken({
|
|
|
164
175
|
"journey_id": "string",
|
|
165
176
|
"portal_id": "string",
|
|
166
177
|
"portal_user_id": "string",
|
|
178
|
+
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
|
|
179
|
+
"allowed_operations": ["getContact", "getContracts"],
|
|
167
180
|
"assignments": ["123:owner"],
|
|
168
181
|
"read_only": true,
|
|
169
182
|
"anonymize": true,
|
|
170
|
-
"last_used": "2026-02-24"
|
|
183
|
+
"last_used": "2026-02-24",
|
|
184
|
+
"expires_at": "2026-03-01T12:00:00.000Z"
|
|
171
185
|
}
|
|
172
186
|
```
|
|
173
187
|
|
|
@@ -343,6 +357,62 @@ const { data } = await client.getPortalPreviewTokenOIDC()
|
|
|
343
357
|
|
|
344
358
|
---
|
|
345
359
|
|
|
360
|
+
### `getContactIdentificationTokenJwks`
|
|
361
|
+
|
|
362
|
+
Get jwks public key set to verify contact identification tokens generated by this API
|
|
363
|
+
|
|
364
|
+
`GET /v1/access-tokens/contact-identification/.well-known/jwks.json`
|
|
365
|
+
|
|
366
|
+
```ts
|
|
367
|
+
const { data } = await client.getContactIdentificationTokenJwks()
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
<details>
|
|
371
|
+
<summary>Response</summary>
|
|
372
|
+
|
|
373
|
+
```json
|
|
374
|
+
{
|
|
375
|
+
"keys": [
|
|
376
|
+
{
|
|
377
|
+
"alg": "RS256",
|
|
378
|
+
"e": "AQAB",
|
|
379
|
+
"kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",
|
|
380
|
+
"kty": "RSA",
|
|
381
|
+
"n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",
|
|
382
|
+
"use": "sig"
|
|
383
|
+
}
|
|
384
|
+
]
|
|
385
|
+
}
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
</details>
|
|
389
|
+
|
|
390
|
+
---
|
|
391
|
+
|
|
392
|
+
### `getContactIdentificationTokenOIDC`
|
|
393
|
+
|
|
394
|
+
OpenID Connect configuration for Access Token API as a contact identification identity provider
|
|
395
|
+
|
|
396
|
+
`GET /v1/access-tokens/contact-identification/.well-known/openid-configuration`
|
|
397
|
+
|
|
398
|
+
```ts
|
|
399
|
+
const { data } = await client.getContactIdentificationTokenOIDC()
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
<details>
|
|
403
|
+
<summary>Response</summary>
|
|
404
|
+
|
|
405
|
+
```json
|
|
406
|
+
{
|
|
407
|
+
"issuer": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification",
|
|
408
|
+
"jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification/.well-known/jwks.json"
|
|
409
|
+
}
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
</details>
|
|
413
|
+
|
|
414
|
+
---
|
|
415
|
+
|
|
346
416
|
## Schemas
|
|
347
417
|
|
|
348
418
|
### `AccessToken`
|
|
@@ -372,7 +442,7 @@ type AccessTokenName = string
|
|
|
372
442
|
Access token type
|
|
373
443
|
|
|
374
444
|
```ts
|
|
375
|
-
type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"
|
|
445
|
+
type AccessTokenType = "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"
|
|
376
446
|
```
|
|
377
447
|
|
|
378
448
|
### `AccessTokenJourneyId`
|
|
@@ -399,6 +469,22 @@ Portal User ID for access token type "portal_preview"
|
|
|
399
469
|
type PortalUserId = string
|
|
400
470
|
```
|
|
401
471
|
|
|
472
|
+
### `ContactId`
|
|
473
|
+
|
|
474
|
+
Contact entity ID for access token type "contact_identification"
|
|
475
|
+
|
|
476
|
+
```ts
|
|
477
|
+
type ContactId = string
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
### `AllowedOperations`
|
|
481
|
+
|
|
482
|
+
openapi operationIds the token may call. Enforced by the API that consumes the token, which must additionally deny any operation not on this list. Baked into the token at issue time so widening the consumer's own allowlist later cannot retroactively widen a token that is already in circulation.
|
|
483
|
+
|
|
484
|
+
```ts
|
|
485
|
+
type AllowedOperations = string[]
|
|
486
|
+
```
|
|
487
|
+
|
|
402
488
|
### `TokenParameters`
|
|
403
489
|
|
|
404
490
|
```ts
|
|
@@ -437,6 +523,15 @@ type TokenParameters = {
|
|
|
437
523
|
token_type?: "portal_preview"
|
|
438
524
|
portal_id: string
|
|
439
525
|
portal_user_id: string
|
|
526
|
+
} | {
|
|
527
|
+
name: string
|
|
528
|
+
token_type?: "contact_identification"
|
|
529
|
+
portal_id: string
|
|
530
|
+
contact_id: string
|
|
531
|
+
surface_id: string
|
|
532
|
+
allowed_operations: string[]
|
|
533
|
+
expires_in: number
|
|
534
|
+
email?: string
|
|
440
535
|
}
|
|
441
536
|
```
|
|
442
537
|
|
|
@@ -533,6 +628,23 @@ type PortalPreviewTokenParameters = {
|
|
|
533
628
|
}
|
|
534
629
|
```
|
|
535
630
|
|
|
631
|
+
### `ContactIdentificationTokenParameters`
|
|
632
|
+
|
|
633
|
+
A token that acts as one contact, issued after that contact was identified by a portal's registration identifiers rather than by logging in. Distinct from portal_preview, which impersonates an existing portal user for a 360 operator: this kind belongs to no user, is minted for an unauthenticated cal
|
|
634
|
+
|
|
635
|
+
```ts
|
|
636
|
+
type ContactIdentificationTokenParameters = {
|
|
637
|
+
name: string
|
|
638
|
+
token_type?: "contact_identification"
|
|
639
|
+
portal_id: string
|
|
640
|
+
contact_id: string
|
|
641
|
+
surface_id: string
|
|
642
|
+
allowed_operations: string[]
|
|
643
|
+
expires_in: number
|
|
644
|
+
email?: string
|
|
645
|
+
}
|
|
646
|
+
```
|
|
647
|
+
|
|
536
648
|
### `AccessTokenItem`
|
|
537
649
|
|
|
538
650
|
```ts
|
|
@@ -540,14 +652,17 @@ type AccessTokenItem = {
|
|
|
540
652
|
id: string
|
|
541
653
|
created_at: string // date-time
|
|
542
654
|
name: string
|
|
543
|
-
token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview"
|
|
655
|
+
token_type?: "api" | "journey" | "portal" | "assume" | "app" | "portal_preview" | "contact_identification"
|
|
544
656
|
journey_id?: string
|
|
545
657
|
portal_id?: string
|
|
546
658
|
portal_user_id?: string
|
|
659
|
+
contact_id?: string
|
|
660
|
+
allowed_operations?: string[]
|
|
547
661
|
assignments?: string[]
|
|
548
662
|
read_only?: boolean
|
|
549
663
|
anonymize?: boolean
|
|
550
664
|
last_used?: string // date
|
|
665
|
+
expires_at?: string // date-time
|
|
551
666
|
}
|
|
552
667
|
```
|
|
553
668
|
|
package/package.json
CHANGED
|
@@ -1,7 +0,0 @@
|
|
|
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- [`Anonymize`](#anonymize)\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 anonymize: 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 "anonymize": 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 "anonymize": 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 "anonymize": 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 anonymize?: 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 anonymize?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: 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### `Anonymize`\n\nForces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.\n\n```ts\ntype Anonymize = 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 anonymize?: 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 anonymize?: 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 anonymize?: 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 anonymize?: 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,7 +0,0 @@
|
|
|
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- [`Anonymize`](#anonymize)\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 anonymize: 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 "anonymize": 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 "anonymize": 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 "anonymize": 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 anonymize?: 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 anonymize?: boolean\n} | {\n name: string\n token_type?: "app"\n assignments?: string[]\n expires_in?: number | string\n read_only?: boolean\n anonymize?: 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### `Anonymize`\n\nForces PII anonymization on all entity data returned to this token. Cannot be disabled by the token bearer. See entity-api anonymized responses.\n\n```ts\ntype Anonymize = 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 anonymize?: 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 anonymize?: 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 anonymize?: 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 anonymize?: 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
|
-
};
|