Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.51 KB

index.md

File metadata and controls

48 lines (38 loc) · 1.51 KB
Raw
Error in user YAML: (<unknown>): could not find expected ':' while scanning a simple key at line 5 column 1
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "pfptmeta Provider"
subcategory: ""
description: |-
The pfptmeta provider allows resources to interact with Proofpoint-metanetworks API.
---

pfptmeta Provider

The pfptmeta provider allows resources to interact with Proofpoint-metanetworks API. To use the provider, you must generate an API key in the Proofpoint Admin Console under Administration -> API Keys. There are three ways to configure the provider:

  • Using the api_key, api_secret, org, realm keys, as illustrated in the example below.
  • Using PFPTMETA_API_KEY, PFPTMETA_API_SECRET, PFPTMETA_ORG_SHORTNAME and PFPTMETA_REALM env variables.
  • Using a json file placed under the current user's home directory named ~/.pfptmeta/credentials.json in the following format:
{
  "api_key": "<api-key>",
  "api_secret": "<api-secret>",
  "org_shortname": "<org>",
  "realm": "<realm>"
}

Example Usage

provider "pfptmeta" {
  api_key       = "key-123456"
  api_secret    = "secret123456"
  org_shortname = "org-shortname"
  realm         = "us"
}

Schema

Optional

  • api_key (String) Alternatively, use the PFPTMETA_API_KEY env variable
  • api_secret (String, Sensitive) Alternatively, use the PFPTMETA_API_SECRET env variable
  • org_shortname (String) Alternatively, use the PFPTMETA_ORG_SHORTNAME env variable
  • realm (String) GDPR data location, ENUM: us, eu. defaults to us