Skip to content

docs: update core events, entities, SDK and CLI reference #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anttiviljami merged 1 commit into from
Nov 11, 2026
+121,913 −23,399
Merged

docs: update core events, entities, SDK and CLI reference #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 184 additions & 5 deletions docs/cli/commands/access-token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,11 @@ epilot access-token listAccessTokens
- [`getAccessTokenJwks`](#getaccesstokenjwks) — Get jwks public key set to verify access tokens generated by this API
- [`getAccessTokenOIDC`](#getaccesstokenoidc) — OpenID Connect configuration for Access Token API as identity provider
- [`getPublicTokenJwks`](#getpublictokenjwks) — Get jwks public key set to verify public tokens generated by this API
- [`getPortalPreviewTokenJwks`](#getportalpreviewtokenjwks) — Get jwks public key set to verify portal preview tokens generated by this API
- [`getPublicTokenOIDC`](#getpublictokenoidc) — OpenID Connect configuration for Access Token API a a public identity provider
- [`getPortalPreviewTokenOIDC`](#getportalpreviewtokenoidc) — OpenID Connect configuration for Access Token API a a portal preview identity provider
- [`getContactIdentificationTokenJwks`](#getcontactidentificationtokenjwks) — Get jwks public key set to verify contact identification tokens generated by this API
- [`getContactIdentificationTokenOIDC`](#getcontactidentificationtokenoidc) — OpenID Connect configuration for Access Token API as a contact identification identity provider

### `listAccessTokens`

Expand All @@ -61,7 +65,7 @@ Lists all Access Tokens for current user (by default excludes system generated t

| Name | In | Type | Required | Description |
| ---- | -- | ---- | -------- | ----------- |
| `token_type` | query | "api" \| "journey" \| "portal" \| "assume" \| "app"[] | No | Filter by token types |
| `token_type` | query | "api" \| "journey" \| "portal" \| "assume" \| "app" \| "portal_preview" \| "contact_identification"[] | No | Filter by token types |

**Sample Call**

Expand All @@ -87,8 +91,14 @@ epilot access-token listAccessTokens --jsonata '$'
"token_type": "api",
"journey_id": "string",
"portal_id": "string",
"portal_user_id": "string",
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
"allowed_operations": ["getContact", "getContracts"],
"assignments": ["123:owner"],
"last_used": "2026-02-24"
"read_only": true,
"anonymize": true,
"last_used": "2026-02-24",
"expires_at": "2026-03-01T12:00:00.000Z"
}
]
```
Expand All @@ -107,9 +117,22 @@ epilot access-token listAccessTokens --jsonata '$'

**Sample Call**

```bash
epilot access-token createAccessToken
```

With request body:

```bash
epilot access-token createAccessToken \
-d '{"name":"Postman Access Token","token_type":"api","assignments":["123:owner"],"expires_in":3600}'
-d '{
"name": "Postman Access Token",
"token_type": "api",
"assignments": ["123:owner"],
"expires_in": 3600,
"read_only": true,
"anonymize": true
}'
```

Using stdin pipe:
Expand All @@ -136,8 +159,14 @@ epilot access-token createAccessToken --jsonata '$'
"token_type": "api",
"journey_id": "string",
"portal_id": "string",
"portal_user_id": "string",
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
"allowed_operations": ["getContact", "getContracts"],
"assignments": ["123:owner"],
"last_used": "2026-02-24"
"read_only": true,
"anonymize": true,
"last_used": "2026-02-24",
"expires_at": "2026-03-01T12:00:00.000Z"
}
```

Expand Down Expand Up @@ -187,8 +216,14 @@ epilot access-token revokeAccessToken -p id=api_5ZugdRXasLfWBypHi93Fk --jsonata
"token_type": "api",
"journey_id": "string",
"portal_id": "string",
"portal_user_id": "string",
"contact_id": "5da0a718-c822-403d-9f5d-20d4584e0528",
"allowed_operations": ["getContact", "getContracts"],
"assignments": ["123:owner"],
"last_used": "2026-02-24"
"read_only": true,
"anonymize": true,
"last_used": "2026-02-24",
"expires_at": "2026-03-01T12:00:00.000Z"
}
```

Expand Down Expand Up @@ -308,6 +343,46 @@ epilot access-token getPublicTokenJwks --jsonata 'keys'

---

### `getPortalPreviewTokenJwks`

Get jwks public key set to verify portal preview tokens generated by this API

`GET /v1/access-tokens/portal-preview/.well-known/jwks.json`

**Sample Call**

```bash
epilot access-token getPortalPreviewTokenJwks
```

With JSONata filter:

```bash
epilot access-token getPortalPreviewTokenJwks --jsonata 'keys'
```

<details>
<summary>Sample Response</summary>

```json
{
"keys": [
{
"alg": "RS256",
"e": "AQAB",
"kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",
"kty": "RSA",
"n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",
"use": "sig"
}
]
}
```

</details>

---

### `getPublicTokenOIDC`

OpenID Connect configuration for Access Token API a a public identity provider
Expand Down Expand Up @@ -339,3 +414,107 @@ epilot access-token getPublicTokenOIDC --jsonata 'issuer'
</details>

---

### `getPortalPreviewTokenOIDC`

OpenID Connect configuration for Access Token API a a portal preview identity provider

`GET /v1/access-tokens/portal-preview/.well-known/openid-configuration`

**Sample Call**

```bash
epilot access-token getPortalPreviewTokenOIDC
```

With JSONata filter:

```bash
epilot access-token getPortalPreviewTokenOIDC --jsonata 'issuer'
```

<details>
<summary>Sample Response</summary>

```json
{
"issuer": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview",
"jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"
}
```

</details>

---

### `getContactIdentificationTokenJwks`

Get jwks public key set to verify contact identification tokens generated by this API

`GET /v1/access-tokens/contact-identification/.well-known/jwks.json`

**Sample Call**

```bash
epilot access-token getContactIdentificationTokenJwks
```

With JSONata filter:

```bash
epilot access-token getContactIdentificationTokenJwks --jsonata 'keys'
```

<details>
<summary>Sample Response</summary>

```json
{
"keys": [
{
"alg": "RS256",
"e": "AQAB",
"kid": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=",
"kty": "RSA",
"n": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ",
"use": "sig"
}
]
}
```

</details>

---

### `getContactIdentificationTokenOIDC`

OpenID Connect configuration for Access Token API as a contact identification identity provider

`GET /v1/access-tokens/contact-identification/.well-known/openid-configuration`

**Sample Call**

```bash
epilot access-token getContactIdentificationTokenOIDC
```

With JSONata filter:

```bash
epilot access-token getContactIdentificationTokenOIDC --jsonata 'issuer'
```

<details>
<summary>Sample Response</summary>

```json
{
"issuer": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification",
"jwks_uri": "https://access-token.sls.epilot.io/v1/access-tokens/contact-identification/.well-known/jwks.json"
}
```

</details>

---
Loading
Loading