diff --git a/examples/asyncio/audit/README.md b/examples/asyncio/audit/README.md index 1f209ec1..324e7e09 100644 --- a/examples/asyncio/audit/README.md +++ b/examples/asyncio/audit/README.md @@ -4,14 +4,13 @@ This is a quick example about how you use Pangea Python SDK, set up and run it. ## Set up -On this example root directory (./examples/audit) run +On this example root directory (`./examples/asyncio/audit`) run ``` poetry install ``` -Set up environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_AUDIT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on Pangea User Console (token should have access to Audit service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. - +Set up environment variables ([Instructions](https://pangea.cloud/docs/audit/#set-your-environment-variables)) `PANGEA_AUDIT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on Pangea User Console (token should have access to the Secure Audit Log service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run diff --git a/examples/asyncio/authn/README.md b/examples/asyncio/authn/README.md index 84b65779..ac5964db 100644 --- a/examples/asyncio/authn/README.md +++ b/examples/asyncio/authn/README.md @@ -4,17 +4,18 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/authn), run the following command: +In the example root directory (`./examples/asyncio/authn`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_AUTHN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to AuthN service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/authn#set-your-environment-variables)) `PANGEA_AUTHN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to AuthN service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` -poetry run python authn_examples/encrypt.py +poetry run python authn_examples/invite_actions.py ``` diff --git a/examples/asyncio/authz/README.md b/examples/asyncio/authz/README.md index 5b92643e..3e249062 100644 --- a/examples/asyncio/authz/README.md +++ b/examples/asyncio/authz/README.md @@ -11,11 +11,10 @@ In the example root directory (`./examples/asyncio/authz`), run the following co $ poetry install ``` -Set up the environment variables ([Instructions][set-environment-variables]) +Set up the environment variables ([Instructions][set-your-environment-variables]) `PANGEA_AUTHZ_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to the AuthZ service, see -["Configure a Pangea service"][configure-a-pangea-service]) and with your Pangea -domain. +[the Tokens page][tokens]) and with your Pangea domain. ## Run @@ -25,5 +24,5 @@ To run the example: $ poetry run python authz_examples/example.py ``` -[configure-a-pangea-service]: https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service -[set-environment-variables]: https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables +[set-your-environment-variables]: https://pangea.cloud/docs/authz/#set-your-environment-variables +[tokens]: https://pangea.cloud/docs/admin-guide/tokens diff --git a/examples/asyncio/embargo/README.md b/examples/asyncio/embargo/README.md index ed326f4d..9d900df0 100644 --- a/examples/asyncio/embargo/README.md +++ b/examples/asyncio/embargo/README.md @@ -4,17 +4,21 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/embargo), run the following command: +In the example root directory (`./examples/asyncio/embargo`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_EMBARGO_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Embargo service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables `PANGEA_EMBARGO_TOKEN` and `PANGEA_DOMAIN` with +your project token configured on the Pangea User Console (token should have +access to Embargo service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) +and with your Pangea domain. ## Run To run examples: + ``` poetry run python embargo_examples/ip_check.py ``` diff --git a/examples/asyncio/file_scan/README.md b/examples/asyncio/file_scan/README.md index 43f40cf9..9f5b1814 100644 --- a/examples/asyncio/file_scan/README.md +++ b/examples/asyncio/file_scan/README.md @@ -4,17 +4,17 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/file_scan), run the following command: +In the example root directory (`./examples/asyncio/file_scan`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_FILE_SCAN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to File Scan service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/file-scan/getting-started/#set-environment-variables)) `PANGEA_FILE_SCAN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to File Scan service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: ``` -poetry run python file_scan_examples/file_scan_async.py +poetry run python file_scan_examples/file_scan_async_crowdstrike.py ``` diff --git a/examples/asyncio/intel/README.md b/examples/asyncio/intel/README.md index c201e4f8..2cbf5b44 100644 --- a/examples/asyncio/intel/README.md +++ b/examples/asyncio/intel/README.md @@ -4,17 +4,17 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/intel), run the following command: +In the example root directory (`./examples/asyncio/intel`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_INTEL_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Intel services [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/domain-intel/getting-started/#set-environment-variables)) `PANGEA_INTEL_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Intel services [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: ``` -poetry run python intel_examples/domain/domain.py +poetry run python intel_examples/domain/domain_reputation.py ``` diff --git a/examples/asyncio/redact/README.md b/examples/asyncio/redact/README.md index 978e6ddd..0fa9a2fd 100644 --- a/examples/asyncio/redact/README.md +++ b/examples/asyncio/redact/README.md @@ -4,13 +4,13 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/redact), run the following command: +In the example root directory (`./examples/asyncio/redact`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_REDACT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Redact service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/redact#set-your-environment-variables)) `PANGEA_REDACT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Redact service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. You'll need to set up and enable some rulesets in the Redact service config. diff --git a/examples/asyncio/sanitize/README.md b/examples/asyncio/sanitize/README.md index d94b02d3..2cb41613 100644 --- a/examples/asyncio/sanitize/README.md +++ b/examples/asyncio/sanitize/README.md @@ -4,18 +4,18 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (`./examples/sanitize`), run the following command: +In the example root directory (`./examples/asyncio/sanitize`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_SANITIZE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Sanitize and Secure Share services [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. - +Set up the environment variables ([Instructions](https://pangea.cloud/docs/sanitize/#set-your-environment-variables)) `PANGEA_SANITIZE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Sanitize and Secure Share services [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` poetry run python sanitize_examples/sanitize_and_share.py ``` diff --git a/examples/asyncio/share/README.md b/examples/asyncio/share/README.md index 20bc0654..6fa96aa4 100644 --- a/examples/asyncio/share/README.md +++ b/examples/asyncio/share/README.md @@ -4,17 +4,18 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/share), run the following command: +In the example root directory (`./examples/asyncio/share`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_SHARE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Share service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/share/#set-your-environment-variables)) `PANGEA_SHARE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Share service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` poetry run python share_examples/folder_create_and_delete.py ``` diff --git a/examples/asyncio/vault/README.md b/examples/asyncio/vault/README.md index 7f554c5c..5ec4001d 100644 --- a/examples/asyncio/vault/README.md +++ b/examples/asyncio/vault/README.md @@ -4,13 +4,13 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/vault), run the following command: +In the example root directory (`./examples/asyncio/vault`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_VAULT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Vault service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/vault/#set-your-environment-variables)) `PANGEA_VAULT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Vault service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run diff --git a/examples/audit/README.md b/examples/audit/README.md index 4cad64f6..40efc4e5 100644 --- a/examples/audit/README.md +++ b/examples/audit/README.md @@ -4,13 +4,13 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/audit), run the following command: +In the example root directory (`./examples/audit`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_AUDIT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Audit service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up environment variables ([Instructions](https://pangea.cloud/docs/audit/#set-your-environment-variables)) `PANGEA_AUDIT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on Pangea User Console (token should have access to the Secure Audit Log service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run diff --git a/examples/authn/README.md b/examples/authn/README.md index 1ddb8342..64b45e34 100644 --- a/examples/authn/README.md +++ b/examples/authn/README.md @@ -4,13 +4,13 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/authn), run the following command: +In the example root directory (`./examples/authn`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_AUTHN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to AuthN service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/authn#set-your-environment-variables)) `PANGEA_AUTHN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to AuthN service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run diff --git a/examples/authz/README.md b/examples/authz/README.md index c4cd36e9..7ed054de 100644 --- a/examples/authz/README.md +++ b/examples/authz/README.md @@ -11,11 +11,10 @@ In the example root directory (`./examples/authz`), run the following command: $ poetry install ``` -Set up the environment variables ([Instructions][set-environment-variables]) +Set up the environment variables ([Instructions][set-your-environment-variables]) `PANGEA_AUTHZ_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to the AuthZ service, see -["Configure a Pangea service"][configure-a-pangea-service]) and with your Pangea -domain. +[the Tokens page][tokens]) and with your Pangea domain. ## Run @@ -25,5 +24,5 @@ To run the example: $ poetry run python authz_examples/example.py ``` -[configure-a-pangea-service]: https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service -[set-environment-variables]: https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables +[set-your-environment-variables]: https://pangea.cloud/docs/authz/#set-your-environment-variables +[tokens]: https://pangea.cloud/docs/admin-guide/tokens diff --git a/examples/embargo/README.md b/examples/embargo/README.md index ed326f4d..c158010d 100644 --- a/examples/embargo/README.md +++ b/examples/embargo/README.md @@ -4,17 +4,21 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/embargo), run the following command: +In the example root directory (`./examples/embargo`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_EMBARGO_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Embargo service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables `PANGEA_EMBARGO_TOKEN` and `PANGEA_DOMAIN` with +your project token configured on the Pangea User Console (token should have +access to Embargo service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) +and with your Pangea domain. ## Run To run examples: + ``` poetry run python embargo_examples/ip_check.py ``` diff --git a/examples/file_scan/README.md b/examples/file_scan/README.md index 43f40cf9..f51a47d8 100644 --- a/examples/file_scan/README.md +++ b/examples/file_scan/README.md @@ -4,17 +4,18 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/file_scan), run the following command: +In the example root directory (`./examples/file_scan`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_FILE_SCAN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to File Scan service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/file-scan/getting-started/#set-environment-variables)) `PANGEA_FILE_SCAN_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to File Scan service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` -poetry run python file_scan_examples/file_scan_async.py +poetry run python file_scan_examples/file_scan_sync_crowdstrike.py ``` diff --git a/examples/intel/README.md b/examples/intel/README.md index c201e4f8..aa91ddff 100644 --- a/examples/intel/README.md +++ b/examples/intel/README.md @@ -4,17 +4,18 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/intel), run the following command: +In the example root directory (`./examples/intel`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_INTEL_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Intel services [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/domain-intel/getting-started/#set-environment-variables)) `PANGEA_INTEL_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Intel services [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` -poetry run python intel_examples/domain/domain.py +poetry run python intel_examples/domain/domain_reputation.py ``` diff --git a/examples/redact/README.md b/examples/redact/README.md index 933f8ea4..d11fc525 100644 --- a/examples/redact/README.md +++ b/examples/redact/README.md @@ -4,13 +4,13 @@ This is a quick example of how to set up and use the Pangea Python SDK. ## Set up -In the example root directory (./examples/redact), run the following command: +In the example root directory (`./examples/redact`), run the following command: ``` poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_REDACT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Redact service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/redact#set-your-environment-variables)) `PANGEA_REDACT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Redact service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. You'll need to set up and enable some rulesets in Redact service config. diff --git a/examples/sanitize/README.md b/examples/sanitize/README.md index d94b02d3..0f084f2d 100644 --- a/examples/sanitize/README.md +++ b/examples/sanitize/README.md @@ -10,12 +10,12 @@ In the example root directory (`./examples/sanitize`), run the following command poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_SANITIZE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Sanitize and Secure Share services [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. - +Set up the environment variables ([Instructions](https://pangea.cloud/docs/sanitize/#set-your-environment-variables)) `PANGEA_SANITIZE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Sanitize and Secure Share services [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` poetry run python sanitize_examples/sanitize_and_share.py ``` diff --git a/examples/share/README.md b/examples/share/README.md index 20bc0654..c8e3178e 100644 --- a/examples/share/README.md +++ b/examples/share/README.md @@ -10,11 +10,12 @@ In the example root directory (./examples/share), run the following command: poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_SHARE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Share service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. +Set up the environment variables ([Instructions](https://pangea.cloud/docs/share/#set-your-environment-variables)) `PANGEA_SHARE_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Share service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. ## Run To run examples: + ``` poetry run python share_examples/folder_create_and_delete.py ``` diff --git a/examples/vault/README.md b/examples/vault/README.md index c5e85279..b4d23f8e 100644 --- a/examples/vault/README.md +++ b/examples/vault/README.md @@ -10,7 +10,7 @@ In the example root directory (`./examples/vault`), run the following command: $ poetry install ``` -Set up the environment variables ([Instructions](https://pangea.cloud/docs/getting-started/integrate/#set-environment-variables)) `PANGEA_VAULT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Vault service [Instructions](https://pangea.cloud/docs/getting-started/configure-services/#configure-a-pangea-service)) and with your Pangea domain. Some examples require +Set up the environment variables ([Instructions](https://pangea.cloud/docs/vault/#set-your-environment-variables)) `PANGEA_VAULT_TOKEN` and `PANGEA_DOMAIN` with your project token configured on the Pangea User Console (token should have access to Vault service [Instructions](https://pangea.cloud/docs/admin-guide/tokens)) and with your Pangea domain. Some examples require an additional variable `PANGEA_AUDIT_TOKEN_VAULT_ID` that is the Vault ID of a Secure Audit Log token.