generated from hashicorp/terraform-provider-scaffolding
-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.md.tmpl
33 lines (25 loc) · 1.04 KB
/
index.md.tmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
---
# 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:
```json
{
"api_key": "<api-key>",
"api_secret": "<api-secret>",
"org_shortname": "<org>",
"realm": "<realm>"
}
```
## Example Usage
{{tffile "examples/provider/provider.tf"}}
{{ .SchemaMarkdown | trimspace }}