Cloud Protect onhttps://docs.protegrity.com/cloud-protect/4.1.0/docs/Recent content in Cloud Protect onHugoen<link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/payload_encoding/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/payload_encoding/</guid><description><h2 id="payload-encoding">Payload Encoding</h2> <p>The following encoding formats are supported in the REST API.</p> <p>For every encoding, the resultant protected data is returned in the same encoding. For example, if request is hex-encoded, the response is also hex-encoded.</p> <p>For more information about the encoding formats, refer to the <a href="https://docs.protegrity.com/protectors/10.1/docs/pmr/">Protection Methods Reference</a>.</p> <table><thead><tr><th align="left" id="d1729e55"> <p>Encoding</p> </th><th align="left" id="d1729e58"> <p>Supported by data elements</p> </th><th align="left" id="d1729e61"> <p>Notes</p> </th></tr></thead><tbody><tr><td> <p>utf8</p> </td><td> <p>All except binary data elements.</p> </td><td> <p>Default encoding if encoding is not specified.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_legacy/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_legacy/</guid><description><h2 id="request">Request</h2> <p>Performs a policy operation such as protect, unprotect, or reprotect.</p> <ul> <li> <p><strong>Method</strong></p> <p>POST</p> </li> <li> <p><strong>Parameters</strong></p> <p><strong>dataelementname</strong>: (protect/unprotect) Data element to use for the policy operation.</p> <p><strong>externaliv</strong>: (protect/unprotect) Optional, external initialization vector.</p> <p><strong>newdataelementname</strong>: (reprotect) Data element to use for the output.</p> <p><strong>newexternaliv</strong>: (reprotect) Optional, external initialization vector for the output.</p> <p><strong>olddataelementname</strong>: (reprotect) Data element to use for the input.</p> <p><strong>oldexternaliv</strong>: (reprotect) Optional, external initialization vector for the input.</p> <p><strong>policyusername</strong>: User performing the operation.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_v1/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_v1/</guid><description><h2 id="request">Request</h2> <p>AWS Lambda service limits maximum size of payload to 6 MB. Client applications of Protegrity Cloud API must ensure their payload size is within this limit. This applies to all types of requests described below.</p> <p>Performs a policy operation such as protect, unprotect, or reprotect.</p> <ul> <li> <p><strong>URI</strong></p> <p><code>/v1/protect</code> or <code>/v1/unprotect</code> or <code>/v1/reprotect</code></p> </li> <li> <p><strong>Method</strong></p> <p>POST</p> </li> <li> <p><strong>Parameters</strong></p> <p><strong>data</strong>: Input data to the policy operation.</p> <p><strong>data_element</strong>: Data element to use for the policy operation.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_v4/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/api/specification_v4/</guid><description><h2 id="overview">Overview</h2> <p>The <strong>Protegrity Data Protection API v4</strong> (SecOps v4) lets callers protect, unprotect, and reprotect (unprotect with one data element, then protect with another) sensitive data values according to a configured data security policy.</p> <p>This is the new, canonical JSON API and is the recommended interface for all new integrations. It replaces the older v1 and Legacy REST formats, which are now deprecated.</p> <ul> <li><strong>Base path</strong>: <code>/pty/api/secops/v4</code></li> <li><strong>Content type</strong>: <code>application/json</code> for both request and response</li> <li><strong>Method</strong>: all operations are HTTP <code>POST</code></li> </ul> <div class="alert alert-info" role="alert"> <h4 class="alert-heading">Note</h4> SecOps v4 is served <strong>only</strong> at <code>/pty/api/secops/v4/*</code>. Requests on this path are never handled by the v1 or Legacy formats, even if the body looks like a legacy request. </div> <h2 id="endpoints">Endpoints</h2> <table> <thead> <tr> <th>Method</th> <th>Path</th> <th>Purpose</th> </tr> </thead> <tbody> <tr> <td>POST</td> <td><code>/pty/api/secops/v4/protect</code></td> <td>Protect data values using a data element.</td> </tr> <tr> <td>POST</td> <td><code>/pty/api/secops/v4/unprotect</code></td> <td>Unprotect previously protected values.</td> </tr> <tr> <td>POST</td> <td><code>/pty/api/secops/v4/reprotect</code></td> <td>Unprotect with one data element and protect with another.</td> </tr> </tbody> </table> <h2 id="authentication">Authentication</h2> <p>Authentication uses a JWT bearer token supplied in the <code>Authorization</code> header (the scheme keyword is matched case-insensitively):</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/log_forwarder/esa_audit_store_configuration/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/log_forwarder/esa_audit_store_configuration/</guid><description><h2 id="esa-audit-store-configuration">ESA Audit Store Configuration</h2> <p>ESA server is required as the recipient of audit logs. Verify the information below to ensure ESA is accessible and configured properly.</p> <ol> <li> <p>ESA server running and accessible on TCP port 9200 (Audit Store) or 24284 (td-agent).</p> </li> <li> <p>Audit Store service is configured and running on ESA. Applies when audit logs are output to Audit Store directly or through td-agent. For information related to ESA Audit Store configuration, refer to <em>Audit Store Guide</em>.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/key_esa_difference/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/key_esa_difference/</guid><description><h2 id="key-differences-ppc-vs-esa">Key Differences: PPC vs ESA</h2> <table> <thead> <tr> <th>Feature</th> <th>ESA 10.2</th> <th>PPC (this guide)</th> </tr> </thead> <tbody> <tr> <td>Datastore Key Fingerprint</td> <td>Optional/Recommended</td> <td><strong>Required</strong></td> </tr> <tr> <td>CA Certificate on Agent</td> <td>Optional/Recommended</td> <td><strong>Optional/Recommended</strong></td> </tr> <tr> <td>CA Certificate on Log Forwarder</td> <td>Optional/Recommended</td> <td><strong>Not supported</strong></td> </tr> <tr> <td>Client Certificate Authentication from Log Forwarder</td> <td>Optional/Recommended</td> <td><strong>Not supported</strong></td> </tr> <tr> <td>IP Address</td> <td>ESA IP address</td> <td><strong>PPC address</strong></td> </tr> </tbody> </table></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/log_forwarder_setup/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/log_forwarder_setup/</guid><description><h2 id="log-forwarder-setup-with-ppc">Log Forwarder Setup with PPC</h2> <div class="alert alert-info" role="alert"> <h4 class="alert-heading">Note</h4> When using PPC, certificate authentication and CA validation are <strong>not supported</strong> for the Log Forwarder. Configuration steps related to certificates in <a href="../installation/log-forwarder/">Log Forwarder Installation</a> do <strong>not</strong> apply to PPC. If you attempt to use certificates provided by PPC, the Log Forwarder will not function correctly. </div> <ul> <li>The Log Forwarder will proceed without certificates and will print a warning if <code>PTY_ESA_CA_SERVER_CERT</code> is not provided.</li> <li>No additional certificate or CA configuration is needed for PPC.</li> </ul></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/overview_summary/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/overview_summary/</guid><description><p>This guide describes how to configure the Protegrity Policy Agent and Log Forwarder to connect to a Protegrity Provisioned Cluster (PPC), highlighting the differences from connecting to ESA.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/policy_agent_setup/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/policy_agent_setup/</guid><description><h2 id="policy-agent-setup-with-ppc">Policy Agent Setup with PPC</h2> <div class="alert alert-warning" role="alert"> <h4 class="alert-heading">Important</h4> When connecting to PPC, the Policy Agent <strong>requires</strong> use of a datastore key fingerprint. For connecting to ESA 10.2 with Cloud Protect Policy Agent, the fingerprint is optional but recommended. See <a href="../installation/agent/">Policy Agent Installation</a> for general setup steps. </div> <p>Follow these instructions as a guide for understanding specific inputs for Policy Agent integrating with PPC:</p> <ol> <li> <p><strong>Obtain the Datastore Key Fingerprint</strong></p> <p>To retrieve the fingerprint for your Policy Agent:</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/prerequisites/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/ppc/prerequisites/</guid><description><h2 id="prerequisites">Prerequisites</h2> <ul> <li>Access to PPC and required credentials.</li> <li>Tools: <code>curl</code>, <code>kubectl</code> installed.</li> </ul></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/protector/esa-requirements/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/protector/esa-requirements/</guid><description><h2 id="esa-version-requirements">ESA Version Requirements</h2> <p>The Protector and Log Forwarder functions require a security policy from a compatible ESA version.</p> <p>The table below shows compatibility between different Protector and ESA versions.</p> <div class="alert alert-info" role="alert"> <h4 class="alert-heading">Note</h4> For the latest up-to-date information refer to: <a href="https://my.protegrity.com/product-management/compatibility-matrix/">Protegrity Compatibility Matrix</a> </div> <table> <thead> <tr> <th rowspan="2">Protector Version</th> <th colspan="4">ESA Version</th> </tr> <tr> <th>8.x</th> <th>9.0</th> <th>9.1 &amp; 9.2</th> <th>10.0</th> </tr> </thead> <tbody> <tr> <td>2.x</td> <td>No</td> <td>Yes</td> <td>*</td> <td>No</td> </tr> <tr> <td>3.0.x &amp; 3.1.x</td> <td>No</td> <td>No</td> <td>Yes</td> <td>No</td> </tr> <tr> <td>3.2.x</td> <td>No</td> <td>No</td> <td>Yes</td> <td>*</td> </tr> <tr> <td>4.0.x</td> <td>No</td> <td>No</td> <td>No</td> <td>Yes</td> </tr> </tbody> </table> <table><thead><tr><th colspan="2"> <p>Legend</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/snowflake/understanding-snowflake-objects/external-functions/external-fn-operation/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/snowflake/understanding-snowflake-objects/external-functions/external-fn-operation/</guid><description><h2 id="security-operation-parameters">Security Operation Parameters</h2> <p>The following table describes optional and required security operation parameters.</p> <table><thead><tr><th> <p>Parameter</p> </th><th> <p>Type</p> </th><th> <p>Example</p> </th><th> <p>Description</p> </th></tr></thead><tbody><tr><td> <p>op_type</p> </td><td> <p>String</p> </td><td> <p>&ldquo;op_type&rdquo;:&ldquo;UNPROTECT&rdquo; &ldquo;op_type&rdquo;:&ldquo;PROTECT&rdquo;</p> </td><td> <p>Required operation name, can be either UNPROTECT or PROTECT</p> </td></tr><tr><td> <p>data_element</p> </td><td> <p>String</p> </td><td> <p>&ldquo;data_element&rdquo;:&ldquo;TOK_ALPHA&rdquo;</p> </td><td> <p>Required data element name defined in Protegrity Security Policy</p> </td></tr><tr><td> <p>external_iv</p> </td><td> <p>String</p> </td><td> <p>&ldquo;external_iv&rdquo;:&ldquo;abc-123&rdquo;</p> </td><td> <p>Optional external intialization vector, which allows for different tokenized results for the same input data and data element of the same security policy. Refer to the External Initialization Vector (IV) in the <a href="https://docs.protegrity.com/protectors/10.1/docs/pmr/">Protection Methods Reference</a> for more details.</p></description></item><item><title/><link>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/toc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://docs.protegrity.com/cloud-protect/4.1.0/docs/common/toc/</guid><description><ol id="toc"></ol> <script> // JavaScript to generate the table of contents from H2 headings document.addEventListener("DOMContentLoaded", function () { //get all h2 headings within the 'main' element and generate a toc with links to them //excluding h2 heading 'Feedback' if it exists const toc = document.getElementById("toc"); const headings = document.querySelectorAll("main h2"); headings.forEach(heading => { if (heading.textContent === "Feedback") { return; // Skip the 'Feedback' heading } const li = document.createElement("li"); const a = document.createElement("a"); const id = heading.textContent.toLowerCase().replace(/\s+/g, '-'); heading.id = id; // Set the id for the heading a.href = `#${id}`; a.textContent = heading.textContent; li.appendChild(a); toc.appendChild(li); }); }); </script></description></item></channel></rss>