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.

Sign up for GitHub

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

Update connector reference guide (November 2024) #385

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Update connector reference guide (November 2024) #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0d2c63
Update connector reference guide (November 2024)
patrickcping Nov 18, 2024
985f385
changelog
patrickcping Nov 18, 2024
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
3 changes: 3 additions & 0 deletions .changelog/385.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:note
Update Connector Reference Guide (November 2024).
```
66 changes: 59 additions & 7 deletions docs/guides/connector-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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".
Expand All @@ -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"
Expand Down Expand Up @@ -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`
Expand Down
12 changes: 12 additions & 0 deletions examples/connectors/akamaiConnector.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
}
}
6 changes: 0 additions & 6 deletions examples/connectors/connectorMicrosoftIntune.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
18 changes: 18 additions & 0 deletions examples/connectors/mailchainConnector.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
}
}
28 changes: 27 additions & 1 deletion templates/guides/connector-reference.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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".
Expand Down Expand Up @@ -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`
Expand Down