@jupiterone/integration-sdk-cli 12.7.1 → 12.8.3

package/src/bocchi/docs/template/authentication.md

@@ -0,0 +1,100 @@
+# Authentication
+
+Defines the authentication method to use for the API. The template currently
+supports two options for Authentication.
+
+## Option 1 - Endpoint:
+
+Use this method if you need to hit an endpoint to get authentication headers.
+
+|                     |                     |
+| ------------------- | ------------------- |
+| Property            | `authentication`    |
+| Type                | `Object`            |
+| Required            | `true`              |
+| Available templates | `config` `response` |
+
+```ts
+{
+  strategy: 'endpoint',
+  params: {
+      path: String,
+      method: 'GET' | 'POST',
+      body?: Object,
+      headers?: Object
+  }
+  authHeaders: Object
+}
+```
+
+Note: `authHeaders` represents the authentication headers that will be present
+on all API requests the client makes, aside from the initial
+`verifyAuthentication` request. The `authHeaders` object should contain at least
+the `Authorization` property, which is typically a bearer token or API key.
+
+Example:
+
+```json
+{
+  "strategy": "endpoint",
+  "params": {
+    "path": "/auth",
+    "method": "POST",
+    "headers": {
+      "user-agent": "JupiterOne",
+      "tenant": "%config.tenant%"
+    },
+    "body": {
+      "exampleBody": "%config.exampleConfigValue%"
+    }
+  },
+  "authHeaders": {
+    "user-agent": "JupiterOne",
+    "tenant": "%config.tenant%",
+    "Authorization": "bearer %response.auth.token%"
+  }
+}
+```
+
+Using this authentication schema will result in a verifyAuthentication()
+function in the generated client that is ready-to-use; that is, the function
+requires no manual updates, and when your integration runs, it will hit the
+provided endpoint to verify authentication.
+
+## Option 2 - Config Fields:
+
+Use this method if the authentication headers will be provided in the instance
+config.
+
+|                     |                  |
+| ------------------- | ---------------- |
+| Property            | `authentication` |
+| Type                | `Object`         |
+| Required            | `true`           |
+| Available templates | `config`         |
+
+```ts
+{
+  strategy: 'configField',
+  authHeaders: Object
+}
+```
+
+Example:
+
+```json
+{
+  "strategy": "configField",
+  "authHeaders": {
+    "x-api-user": "%config.email%",
+    "x-api-token": "%config.token%"
+  }
+}
+```
+
+Using this authentication schema will result in an incomplete
+verifyAuthentication() function in the generated client. This is because the
+graph-project generator does not know what endpoint to use for verifying
+authentication. <b>You will need to manually update the generated
+verifyAuthentication() function and choose what endpoint should be used for
+verifying authentication.</b>

package/src/bocchi/docs/template/examples/example.json

@@ -0,0 +1,127 @@
+{
+  "instanceConfigFields": {
+    "email": {
+      "type": "string"
+    },
+    "token": {
+      "type": "string",
+      "mask": true
+    },
+    "tenant": {
+      "type": "string"
+    }
+  },
+  "authentication": {
+    "strategy": "endpoint",
+    "params": {
+      "path": "/auth",
+      "method": "POST",
+      "headers": {
+        "user-agent": "JupiterOne",
+        "tenant": "%config.tenant%"
+      },
+      "body": {
+        "exampleBody": "%config.exampleConfigValue%"
+      }
+    },
+    "authHeaders": {
+      "user-agent": "JupiterOne",
+      "tenant": "%config.tenant%",
+      "Authorization": "bearer %response.auth.token%"
+    }
+  },
+  "baseUrl": "https://example.com",
+  "steps": [
+    {
+      "id": "fetch-organizations",
+      "name": "Fetch Organizations",
+      "entity": {
+        "name": "Organization",
+        "_type": "example_organization",
+        "_class": ["Organization"],
+        "_keyPath": "name",
+        "staticFields": {
+          "a": false,
+          "b": true
+        },
+        "fieldMappings": {
+          "name": "title",
+          "displayName": "title",
+          "description": "advisory.description",
+          "ruleId": "advisory.ruleId",
+          "severity": "advisory.severity",
+          "ecosystem": "advisory.ecosystem",
+          "urls": "advisory.references.urls",
+          "exposureType": "exposureType",
+          "repositoryId": "repositoryId",
+          "subdirectory": "subdirectory",
+          "createdOn": "openedAt"
+        }
+      },
+      "request": {
+        "urlTemplate": "/organizations"
+      },
+      "response": {
+        "dataPath": "data",
+        "responseType": "LIST"
+      },
+      "directRelationships": [
+        {
+          "targetKey": "directory",
+          "targetType": "example_directory",
+          "_class": "HAS",
+          "direction": "FORWARD"
+        }
+      ]
+    },
+    {
+      "id": "fetch-directory",
+      "name": "Fetch Directory",
+      "entity": {
+        "name": "Directory",
+        "_type": "example_directory",
+        "_class": ["Directory"],
+        "_keyPath": "id"
+      },
+      "fieldMappings": {
+        "name": "title",
+        "orgId": "organizationId"
+      },
+      "parentAssociation": {
+        "parentEntityType": "example_organization",
+        "relationshipClass": "HAS"
+      },
+      "request": {
+        "urlTemplate": "/organizations/%parent._key%/directory"
+      },
+      "response": {
+        "dataPath": "data",
+        "responseType": "SINGLETON"
+      },
+      "dependsOn": ["fetch-organizations"]
+    },
+    {
+      "id": "fetch-users",
+      "name": "Fetch Users",
+      "entity": {
+        "name": "User",
+        "_type": "example_user",
+        "_class": ["User"],
+        "_keyPath": "email"
+      },
+      "parentAssociation": {
+        "parentEntityType": "example_directory",
+        "relationshipClass": "HAS"
+      },
+      "request": {
+        "urlTemplate": "/organizations/%parent._key%/directory/%parent.orgId%/users?nextPage=%nextToken%"
+      },
+      "response": {
+        "dataPath": "data",
+        "nextTokenPath": "next",
+        "responseType": "LIST"
+      },
+      "dependsOn": ["fetch-directory"]
+    }
+  ]
+}

package/src/bocchi/docs/template/examples/signalSciences.json

@@ -0,0 +1,128 @@
+{
+  "instanceConfigFields": {
+    "email": {
+      "type": "string"
+    },
+    "token": {
+      "type": "string",
+      "mask": true
+    }
+  },
+  "authentication": {
+    "strategy": "configField",
+    "authHeaders": {
+      "x-api-user": "%config.email%",
+      "x-api-token": "%config.token%"
+    }
+  },
+  "baseUrl": "https://dashboard.signalsciences.net/api/v0",
+  "steps": [
+    {
+      "id": "fetch-organizations",
+      "name": "Fetch Organizations",
+      "entity": {
+        "name": "Organization",
+        "_type": "signal_sciences_organization",
+        "_class": ["Organization"],
+        "_keyPath": "name",
+        "fieldMappings": {
+          "name": "name",
+          "displayName": "displayName",
+          "smallIconURI": "smallIconURI",
+          "createdAt": "created",
+          "siteLimit": "siteLimit",
+          "authType": "authType",
+          "sessionMaxAgeDashboard": "sessionMaxAgeDashboard"
+        },
+        "staticFields": {
+          "external": false
+        }
+      },
+      "request": {
+        "urlTemplate": "/corps"
+      },
+      "response": {
+        "dataPath": "data",
+        "responseType": "LIST"
+      }
+    },
+    {
+      "id": "fetch-users",
+      "name": "Fetch Users",
+      "entity": {
+        "name": "User",
+        "_type": "signal_sciences_user",
+        "_class": ["User"],
+        "_keyPath": "email",
+        "fieldMappings": {
+          "name": "name",
+          "displayName": "name",
+          "email": "email",
+          "role": "role",
+          "status": "status",
+          "mfaEnabled": "mfaEnabled",
+          "authStatus": "authStatus",
+          "createdAt": "created"
+        }
+      },
+      "parentAssociation": {
+        "parentEntityType": "signal_sciences_organization",
+        "relationshipClass": "HAS"
+      },
+      "mappedRelationships": [
+        {
+          "_class": "IS",
+          "direction": "REVERSE",
+          "mappings": [
+            {
+              "targetValue": "google_user",
+              "targetProperty": "_type"
+            },
+            {
+              "sourceProperty": "email",
+              "targetProperty": "email"
+            }
+          ]
+        }
+      ],
+      "request": {
+        "urlTemplate": "/corps/%parent._key%/users"
+      },
+      "response": {
+        "dataPath": "data",
+        "responseType": "LIST"
+      },
+      "dependsOn": ["fetch-organizations"]
+    },
+    {
+      "id": "fetch-cloudwaf-instances",
+      "name": "Fetch Cloud WAF Instances",
+      "entity": {
+        "name": "Cloud WAF Instance",
+        "_type": "signal_sciences_cloudwaf",
+        "_class": ["Firewall"],
+        "_keyPath": "id",
+        "fieldMappings": {
+          "id": "id",
+          "name": "name",
+          "displayName": "name",
+          "description": "description",
+          "region": "region",
+          "tlsMinVersion": "tlsMinVersion"
+        }
+      },
+      "parentAssociation": {
+        "parentEntityType": "signal_sciences_organization",
+        "relationshipClass": "HAS"
+      },
+      "request": {
+        "urlTemplate": "/corps/%parent._key%/cloudwafInstances"
+      },
+      "response": {
+        "dataPath": "data",
+        "responseType": "LIST"
+      },
+      "dependsOn": ["fetch-organizations"]
+    }
+  ]
+}