From 2eebb3cc0b5a3d4c6424604faa96c7bab2ef00fe Mon Sep 17 00:00:00 2001 From: Patrick Cowland <44225864+patrickcping@users.noreply.github.com> Date: Mon, 18 Nov 2024 11:46:14 +0000 Subject: [PATCH] Update connector reference guide (November 2024) (#385) * Update connector reference guide (November 2024) * changelog --- .changelog/385.txt | 3 + docs/guides/connector-reference.md | 66 +++++++++++++++++-- examples/connectors/akamaiConnector.tf | 12 ++++ .../connectors/connectorMicrosoftIntune.tf | 6 -- examples/connectors/mailchainConnector.tf | 18 +++++ templates/guides/connector-reference.md.tmpl | 28 +++++++- 6 files changed, 119 insertions(+), 14 deletions(-) create mode 100644 .changelog/385.txt create mode 100644 examples/connectors/akamaiConnector.tf create mode 100644 examples/connectors/mailchainConnector.tf diff --git a/.changelog/385.txt b/.changelog/385.txt new file mode 100644 index 00000000..2a08f15f --- /dev/null +++ b/.changelog/385.txt @@ -0,0 +1,3 @@ +```release-note:note +Update Connector Reference Guide (November 2024). +``` \ No newline at end of file diff --git a/docs/guides/connector-reference.md b/docs/guides/connector-reference.md index 69952980..6961170b 100644 --- a/docs/guides/connector-reference.md +++ b/docs/guides/connector-reference.md @@ -275,6 +275,32 @@ resource "davinci_connection" "adobemarketoConnector" { ``` +## Akamai MFA + +Connector ID (`connector_id` in the resource): `akamaiConnector` + +Properties (used in the `property` block in the resource as the `name` parameter): + +* `customAuth` (json): Console display name: "Custom Parameters". + + +Example: +```terraform +resource "davinci_connection" "akamaiConnector" { + environment_id = var.pingone_environment_id + + connector_id = "akamaiConnector" + name = "My awesome akamaiConnector" + + property { + name = "customAuth" + type = "json" + value = var.akamaiconnector_property_custom_auth + } +} +``` + + ## Allthenticate Connector ID (`connector_id` in the resource): `connectorAllthenticate` @@ -4488,7 +4514,6 @@ Properties (used in the `property` block in the resource as the `name` parameter * `clientId` (string): Client ID. Console display name: "Client ID". * `clientSecret` (string): Client Secret. Console display name: "Client Secret". -* `domainName` (string): Domain Name. Console display name: "Domain Name". * `grantType` (string): Grant Type. Console display name: "Grant Type". * `scope` (string): Scope. Console display name: "Scope". * `tenant` (string): Tenant. Console display name: "Tenant". @@ -4514,12 +4539,6 @@ resource "davinci_connection" "connectorMicrosoftIntune" { value = var.connectormicrosoftintune_property_client_secret } - property { - name = "domainName" - type = "string" - value = var.connectormicrosoftintune_property_domain_name - } - property { name = "grantType" type = "string" @@ -8517,6 +8536,39 @@ resource "davinci_connection" "connector443id" { ``` +## Vidos + +Connector ID (`connector_id` in the resource): `mailchainConnector` + +Properties (used in the `property` block in the resource as the `name` parameter): + +* `apiKey` (string): Enter your Vidos API Key obtained from the Vidos Dashboard with appropriate resolver or verifier permissions (visit https://dashboard.vidos.id/iam/api-keys). Console display name: "Vidos API Key". +* `version` (string): The verification API specification version. Console display name: "Verifier Version". + + +Example: +```terraform +resource "davinci_connection" "mailchainConnector" { + environment_id = var.pingone_environment_id + + connector_id = "mailchainConnector" + name = "My awesome mailchainConnector" + + property { + name = "apiKey" + type = "string" + value = var.mailchainconnector_property_api_key + } + + property { + name = "version" + type = "string" + value = var.mailchainconnector_property_version + } +} +``` + + ## Webhook Connector ID (`connector_id` in the resource): `webhookConnector` diff --git a/examples/connectors/akamaiConnector.tf b/examples/connectors/akamaiConnector.tf new file mode 100644 index 00000000..787f90ad --- /dev/null +++ b/examples/connectors/akamaiConnector.tf @@ -0,0 +1,12 @@ +resource "davinci_connection" "akamaiConnector" { + environment_id = var.pingone_environment_id + + connector_id = "akamaiConnector" + name = "My awesome akamaiConnector" + + property { + name = "customAuth" + type = "json" + value = var.akamaiconnector_property_custom_auth + } +} diff --git a/examples/connectors/connectorMicrosoftIntune.tf b/examples/connectors/connectorMicrosoftIntune.tf index db6ec734..12a7b55c 100644 --- a/examples/connectors/connectorMicrosoftIntune.tf +++ b/examples/connectors/connectorMicrosoftIntune.tf @@ -16,12 +16,6 @@ resource "davinci_connection" "connectorMicrosoftIntune" { value = var.connectormicrosoftintune_property_client_secret } - property { - name = "domainName" - type = "string" - value = var.connectormicrosoftintune_property_domain_name - } - property { name = "grantType" type = "string" diff --git a/examples/connectors/mailchainConnector.tf b/examples/connectors/mailchainConnector.tf new file mode 100644 index 00000000..e7277fc3 --- /dev/null +++ b/examples/connectors/mailchainConnector.tf @@ -0,0 +1,18 @@ +resource "davinci_connection" "mailchainConnector" { + environment_id = var.pingone_environment_id + + connector_id = "mailchainConnector" + name = "My awesome mailchainConnector" + + property { + name = "apiKey" + type = "string" + value = var.mailchainconnector_property_api_key + } + + property { + name = "version" + type = "string" + value = var.mailchainconnector_property_version + } +} diff --git a/templates/guides/connector-reference.md.tmpl b/templates/guides/connector-reference.md.tmpl index a77b110c..001f303f 100644 --- a/templates/guides/connector-reference.md.tmpl +++ b/templates/guides/connector-reference.md.tmpl @@ -123,6 +123,19 @@ Example: {{ tffile (printf "%s" "examples/connectors/adobemarketoConnector.tf") }} +## Akamai MFA + +Connector ID (`connector_id` in the resource): `akamaiConnector` + +Properties (used in the `property` block in the resource as the `name` parameter): + +* `customAuth` (json): Console display name: "Custom Parameters". + + +Example: +{{ tffile (printf "%s" "examples/connectors/akamaiConnector.tf") }} + + ## Allthenticate Connector ID (`connector_id` in the resource): `connectorAllthenticate` @@ -1634,7 +1647,6 @@ Properties (used in the `property` block in the resource as the `name` parameter * `clientId` (string): Client ID. Console display name: "Client ID". * `clientSecret` (string): Client Secret. Console display name: "Client Secret". -* `domainName` (string): Domain Name. Console display name: "Domain Name". * `grantType` (string): Grant Type. Console display name: "Grant Type". * `scope` (string): Scope. Console display name: "Scope". * `tenant` (string): Tenant. Console display name: "Tenant". @@ -2965,6 +2977,20 @@ Example: {{ tffile (printf "%s" "examples/connectors/connector443id.tf") }} +## Vidos + +Connector ID (`connector_id` in the resource): `mailchainConnector` + +Properties (used in the `property` block in the resource as the `name` parameter): + +* `apiKey` (string): Enter your Vidos API Key obtained from the Vidos Dashboard with appropriate resolver or verifier permissions (visit https://dashboard.vidos.id/iam/api-keys). Console display name: "Vidos API Key". +* `version` (string): The verification API specification version. Console display name: "Verifier Version". + + +Example: +{{ tffile (printf "%s" "examples/connectors/mailchainConnector.tf") }} + + ## Webhook Connector ID (`connector_id` in the resource): `webhookConnector`