Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add captcha_providers resource #275

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 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
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# v0.12.0 (Unreleased)
# v0.13.0 (Unreleased)
PingDavidR marked this conversation as resolved.
Show resolved Hide resolved
### Resources
* **New Resource:** `pingfederate_captcha_providers` ([#275]([https](https://github.com/pingidentity/terraform-provider-pingfederate/pull/275)))
henryrecker-pingidentity marked this conversation as resolved.
Show resolved Hide resolved
*
# v0.12.0 June 27th, 2024
### BREAKING CHANGES
* Removed deprecated `inherited` attribute from various resources and data sources. ([#268]([https](https://github.com/pingidentity/terraform-provider-pingfederate/pull/268)))

### FEATURES
### ENHANCEMENTS
* Added support for PingFederate `12.1.0` and implemented new attributes for the new version. Added support for latest PF patch releases to `11.2`, `11.3`, and `12.0`. ([#268]([https](https://github.com/pingidentity/terraform-provider-pingfederate/pull/268)))

# v0.11.0 May 30th, 2024
Expand Down
168 changes: 168 additions & 0 deletions docs/resources/captcha_provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
---
page_title: "pingfederate_captcha_provider Resource - terraform-provider-pingfederate"
subcategory: ""
description: |-

---

# pingfederate_captcha_provider (Resource)



## Example Usage

```terraform
resource "pingfederate_captcha_providers" "captchaProviderExample" {
providers_id = "myCaptchaProviderId"
name = "My Captcha Provider"
configuration = {
tables = [],
fields = [
{
name = "Site Key"
value = "exampleSiteKey"
},
{
name = "Secret Key"
value = "exampleSecretKey"
}
]
}
// class name of the plugin
// Captcha V2 used here
plugin_descriptor_ref = {
id = "com.pingidentity.captcha.ReCaptchaV2InvisiblePlugin"
}
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `configuration` (Attributes) Plugin instance configuration. (see [below for nested schema](#nestedatt--configuration))
- `name` (String) The plugin instance name. The name can be modified once the instance is created.<br>Note: Ignored when specifying a connection's adapter override.
- `plugin_descriptor_ref` (Attributes) Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created. Note: Ignored when specifying a connection's adapter override. (see [below for nested schema](#nestedatt--plugin_descriptor_ref))
- `provider_id` (String) The ID of the plugin instance. The ID cannot be modified once the instance is created.<br>Note: Ignored when specifying a connection's adapter override.

### Optional

- `parent_ref` (Attributes) The reference to this plugin's parent instance. The parent reference is only accepted if the plugin type supports parent instances. Note: This parent reference is required if this plugin instance is used as an overriding plugin (e.g. connection adapter overrides) (see [below for nested schema](#nestedatt--parent_ref))

<a id="nestedatt--configuration"></a>
### Nested Schema for `configuration`

Optional:

- `fields` (Attributes List) List of configuration fields. (see [below for nested schema](#nestedatt--configuration--fields))
- `tables` (Attributes List) List of configuration tables. (see [below for nested schema](#nestedatt--configuration--tables))

Read-Only:

- `fields_all` (Attributes List) List of configuration fields. This attribute will include any values set by default by PingFederate. (see [below for nested schema](#nestedatt--configuration--fields_all))
- `tables_all` (Attributes List) List of configuration tables. This attribute will include any values set by default by PingFederate. (see [below for nested schema](#nestedatt--configuration--tables_all))

<a id="nestedatt--configuration--fields"></a>
### Nested Schema for `configuration.fields`

Required:

- `name` (String) The name of the configuration field.
- `value` (String) The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.


<a id="nestedatt--configuration--tables"></a>
### Nested Schema for `configuration.tables`

Required:

- `name` (String) The name of the table.

Optional:

- `rows` (Attributes List) List of table rows. (see [below for nested schema](#nestedatt--configuration--tables--rows))

<a id="nestedatt--configuration--tables--rows"></a>
### Nested Schema for `configuration.tables.rows`

Optional:

- `default_row` (Boolean) Whether this row is the default.
- `fields` (Attributes List) The configuration fields in the row. (see [below for nested schema](#nestedatt--configuration--tables--rows--fields))

<a id="nestedatt--configuration--tables--rows--fields"></a>
### Nested Schema for `configuration.tables.rows.fields`

Required:

- `name` (String) The name of the configuration field.
- `value` (String) The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.




<a id="nestedatt--configuration--fields_all"></a>
### Nested Schema for `configuration.fields_all`

Required:

- `name` (String) The name of the configuration field.
- `value` (String) The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.


<a id="nestedatt--configuration--tables_all"></a>
### Nested Schema for `configuration.tables_all`

Required:

- `name` (String) The name of the table.

Optional:

- `rows` (Attributes List) List of table rows. (see [below for nested schema](#nestedatt--configuration--tables_all--rows))

<a id="nestedatt--configuration--tables_all--rows"></a>
### Nested Schema for `configuration.tables_all.rows`

Optional:

- `default_row` (Boolean) Whether this row is the default.
- `fields` (Attributes List) The configuration fields in the row. (see [below for nested schema](#nestedatt--configuration--tables_all--rows--fields))

<a id="nestedatt--configuration--tables_all--rows--fields"></a>
### Nested Schema for `configuration.tables_all.rows.fields`

Required:

- `name` (String) The name of the configuration field.
- `value` (String) The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.





<a id="nestedatt--plugin_descriptor_ref"></a>
### Nested Schema for `plugin_descriptor_ref`

Required:

- `id` (String) The ID of the resource.


<a id="nestedatt--parent_ref"></a>
### Nested Schema for `parent_ref`

Required:

- `id` (String) The ID of the resource.

## Import

Import is supported using the following syntax:

~> "myCaptchaProviderId" should be the id of the Captcha provider to be imported

```shell
terraform import pingfederate_captcha_providers.captchaProviderExample myCaptchaProviderId
```
1 change: 1 addition & 0 deletions examples/resources/pingfederate_captcha_provider/import.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
terraform import pingfederate_captcha_providers.captchaProviderExample myCaptchaProviderId
PingDavidR marked this conversation as resolved.
Show resolved Hide resolved
22 changes: 22 additions & 0 deletions examples/resources/pingfederate_captcha_provider/resource.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
resource "pingfederate_captcha_providers" "captchaProviderExample" {
henryrecker-pingidentity marked this conversation as resolved.
Show resolved Hide resolved
providers_id = "myCaptchaProviderId"
PingDavidR marked this conversation as resolved.
Show resolved Hide resolved
name = "My Captcha Provider"
configuration = {
tables = [],
fields = [
{
name = "Site Key"
value = "exampleSiteKey"
},
{
name = "Secret Key"
value = "exampleSecretKey"
}
]
}
// class name of the plugin
// Captcha V2 used here
plugin_descriptor_ref = {
id = "com.pingidentity.captcha.ReCaptchaV2InvisiblePlugin"
}
}
Loading