Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions examples/asyncio/audit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 4 additions & 3 deletions examples/asyncio/authn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
9 changes: 4 additions & 5 deletions examples/asyncio/authz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
8 changes: 6 additions & 2 deletions examples/asyncio/embargo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
6 changes: 3 additions & 3 deletions examples/asyncio/file_scan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
6 changes: 3 additions & 3 deletions examples/asyncio/intel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions examples/asyncio/redact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions examples/asyncio/sanitize/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
5 changes: 3 additions & 2 deletions examples/asyncio/share/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions examples/asyncio/vault/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/audit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions examples/authn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 4 additions & 5 deletions examples/authz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
8 changes: 6 additions & 2 deletions examples/embargo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
7 changes: 4 additions & 3 deletions examples/file_scan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
7 changes: 4 additions & 3 deletions examples/intel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
4 changes: 2 additions & 2 deletions examples/redact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading