@epilot/cli 0.1.45 → 0.1.47

package/README.md

@@ -29,7 +29,7 @@ npm install -g @epilot/cli
 
 <!-- usage-help -->
 ```
-epilot v0.1.45 — CLI for epilot APIs
+epilot v0.1.47 — CLI for epilot APIs
 
 USAGE
   epilot <api> <operationId> [params...] [flags]
@@ -103,6 +103,7 @@ APIs
   query                Query API
   sandbox              Sandbox API
   sharing              Sharing API
+  snapshot             Snapshot API
   submission           Submission API
   targeting            Targeting API
   template-variables   Template Variables API
@@ -359,6 +360,7 @@ Full documentation with sample calls and responses for all APIs:
 | Query API | `epilot query` | [docs](./docs/query.md) |
 | Sandbox API | `epilot sandbox` | [docs](./docs/sandbox.md) |
 | Sharing API | `epilot sharing` | [docs](./docs/sharing.md) |
+| Snapshot API | `epilot snapshot` | [docs](./docs/snapshot.md) |
 | Submission API | `epilot submission` | [docs](./docs/submission.md) |
 | Targeting API | `epilot targeting` | [docs](./docs/targeting.md) |
 | Template Variables API | `epilot template-variables` | [docs](./docs/template-variables.md) |

package/definitions/access-token.json

@@ -70,6 +70,14 @@
                     ]
                   }
                 },
+                "portal_preview": {
+                  "value": {
+                    "name": "Portal Preview Token for previewing customer portal",
+                    "token_type": "portal_preview",
+                    "portal_id": "portal_abc123",
+                    "portal_user_id": "user_xyz789"
+                  }
+                },
                 "app": {
                   "value": {
                     "name": "App Access Token",
@@ -361,6 +369,63 @@
         }
       }
     },
+    "/v1/access-tokens/portal-preview/.well-known/jwks.json": {
+      "get": {
+        "operationId": "getPortalPreviewTokenJwks",
+        "summary": "getPortalPreviewTokenJwks",
+        "description": "Get jwks public key set to verify portal preview tokens generated by this API",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "responses": {
+          "200": {
+            "description": "Set of jwks",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "keys": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "alg": {
+                            "type": "string",
+                            "example": "RS256"
+                          },
+                          "e": {
+                            "type": "string",
+                            "example": "AQAB"
+                          },
+                          "kid": {
+                            "type": "string",
+                            "example": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw="
+                          },
+                          "kty": {
+                            "type": "string",
+                            "example": "RSA"
+                          },
+                          "n": {
+                            "type": "string",
+                            "example": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ"
+                          },
+                          "use": {
+                            "type": "string",
+                            "example": "sig"
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/access-tokens/public/.well-known/openid-configuration": {
       "get": {
         "operationId": "getPublicTokenOIDC",
@@ -395,6 +460,41 @@
           }
         }
       }
+    },
+    "/v1/access-tokens/portal-preview/.well-known/openid-configuration": {
+      "get": {
+        "operationId": "getPortalPreviewTokenOIDC",
+        "summary": "getPortalPreviewTokenOIDC",
+        "description": "OpenID Connect configuration for Access Token API a a portal preview identity provider\n\nNote: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to\nautomate the process of verifying JWT tokens.\n",
+        "tags": [
+          "Public"
+        ],
+        "security": [],
+        "responses": {
+          "200": {
+            "description": "OpenID Configuration",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "issuer": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview"
+                    },
+                    "jwks_uri": {
+                      "type": "string",
+                      "format": "uri",
+                      "example": "https://access-token.sls.epilot.io/v1/access-tokens/portal-preview/.well-known/jwks.json"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -434,7 +534,8 @@
           "journey",
           "portal",
           "assume",
-          "app"
+          "app",
+          "portal_preview"
         ],
         "description": "Access token type",
         "example": "api"
@@ -447,6 +548,10 @@
         "type": "string",
         "description": "Portal ID for access token type \"portal\""
       },
+      "PortalUserId": {
+        "type": "string",
+        "description": "Portal User ID for access token type \"portal_preview\""
+      },
       "TokenParameters": {
         "anyOf": [
           {
@@ -463,6 +568,9 @@
           },
           {
             "$ref": "#/components/schemas/AppTokenParameters"
+          },
+          {
+            "$ref": "#/components/schemas/PortalPreviewTokenParameters"
           }
         ]
       },
@@ -484,6 +592,11 @@
           }
         ]
       },
+      "ReadOnly": {
+        "type": "boolean",
+        "description": "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.",
+        "example": true
+      },
       "AccessTokenParameters": {
         "type": "object",
         "additionalProperties": false,
@@ -502,6 +615,9 @@
           },
           "expires_in": {
             "$ref": "#/components/schemas/ExpiresIn"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
@@ -573,6 +689,9 @@
           },
           "assignments": {
             "$ref": "#/components/schemas/Assignments"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
@@ -597,12 +716,41 @@
           },
           "expires_in": {
             "$ref": "#/components/schemas/ExpiresIn"
+          },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
           }
         },
         "required": [
           "name"
         ]
       },
+      "PortalPreviewTokenParameters": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "$ref": "#/components/schemas/AccessTokenName"
+          },
+          "token_type": {
+            "type": "string",
+            "enum": [
+              "portal_preview"
+            ]
+          },
+          "portal_id": {
+            "$ref": "#/components/schemas/PortalId"
+          },
+          "portal_user_id": {
+            "$ref": "#/components/schemas/PortalUserId"
+          }
+        },
+        "required": [
+          "name",
+          "portal_id",
+          "portal_user_id"
+        ]
+      },
       "AccessTokenItem": {
         "type": "object",
         "properties": {
@@ -625,9 +773,15 @@
           "portal_id": {
             "$ref": "#/components/schemas/PortalId"
           },
+          "portal_user_id": {
+            "$ref": "#/components/schemas/PortalUserId"
+          },
           "assignments": {
             "$ref": "#/components/schemas/Assignments"
           },
+          "read_only": {
+            "$ref": "#/components/schemas/ReadOnly"
+          },
           "last_used": {
             "type": "string",
             "format": "date",