Skip to content

Commit

Permalink
docs: add smtp config note and generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stebenz committed Aug 21, 2024
1 parent f0f9bf0 commit 6a1012c
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/data-sources/application_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@ data "zitadel_application_api" "default" {
### Read-Only

- `auth_method_type` (String) Auth method type
- `client_id` (String, Sensitive) generated ID for this config
- `id` (String) The ID of this resource.
- `name` (String) Name of the application
1 change: 1 addition & 0 deletions docs/data-sources/application_oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ data "zitadel_application_oidc" "default" {
- `additional_origins` (List of String) Additional origins
- `app_type` (String) App type
- `auth_method_type` (String) Auth method type
- `client_id` (String, Sensitive) Client ID
- `clock_skew` (String) Clockskew
- `dev_mode` (Boolean) Dev mode
- `grant_types` (List of String) Grant types
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/application_oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ resource "zitadel_application_oidc" "default" {

### Required

- `grant_types` (List of String) Grant types, supported values: OIDC_GRANT_TYPE_AUTHORIZATION_CODE, OIDC_GRANT_TYPE_IMPLICIT, OIDC_GRANT_TYPE_REFRESH_TOKEN, OIDC_GRANT_TYPE_DEVICE_CODE
- `grant_types` (List of String) Grant types, supported values: OIDC_GRANT_TYPE_AUTHORIZATION_CODE, OIDC_GRANT_TYPE_IMPLICIT, OIDC_GRANT_TYPE_REFRESH_TOKEN, OIDC_GRANT_TYPE_DEVICE_CODE, OIDC_GRANT_TYPE_TOKEN_EXCHANGE
- `name` (String) Name of the application
- `project_id` (String) ID of the project
- `redirect_uris` (List of String) RedirectURIs
Expand Down
14 changes: 14 additions & 0 deletions docs/resources/default_login_texts.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,7 @@ resource "zitadel_default_login_texts" "default" {
- `initialize_done_text` (Attributes) (see [below for nested schema](#nestedatt--initialize_done_text))
- `initialize_user_text` (Attributes) (see [below for nested schema](#nestedatt--initialize_user_text))
- `linking_user_done_text` (Attributes) (see [below for nested schema](#nestedatt--linking_user_done_text))
- `linking_user_prompt_text` (Attributes) (see [below for nested schema](#nestedatt--linking_user_prompt_text))
- `login_text` (Attributes) (see [below for nested schema](#nestedatt--login_text))
- `logout_text` (Attributes) (see [below for nested schema](#nestedatt--logout_text))
- `mfa_providers_text` (Attributes) (see [below for nested schema](#nestedatt--mfa_providers_text))
Expand Down Expand Up @@ -422,6 +423,7 @@ Optional:

- `help` (String)
- `privacy_policy` (String)
- `support_email` (String)
- `tos` (String)


Expand Down Expand Up @@ -537,6 +539,17 @@ Optional:
- `title` (String)


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

Optional:

- `description` (String)
- `link_button_text` (String)
- `other_button_text` (String)
- `title` (String)


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

Expand Down Expand Up @@ -592,6 +605,7 @@ Optional:

- `cancel_button_text` (String)
- `description` (String)
- `expired_description` (String)
- `new_password_confirm_label` (String)
- `new_password_label` (String)
- `next_button_text` (String)
Expand Down
14 changes: 14 additions & 0 deletions docs/resources/login_texts.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ resource "zitadel_login_texts" "default" {
- `initialize_done_text` (Attributes) (see [below for nested schema](#nestedatt--initialize_done_text))
- `initialize_user_text` (Attributes) (see [below for nested schema](#nestedatt--initialize_user_text))
- `linking_user_done_text` (Attributes) (see [below for nested schema](#nestedatt--linking_user_done_text))
- `linking_user_prompt_text` (Attributes) (see [below for nested schema](#nestedatt--linking_user_prompt_text))
- `login_text` (Attributes) (see [below for nested schema](#nestedatt--login_text))
- `logout_text` (Attributes) (see [below for nested schema](#nestedatt--logout_text))
- `mfa_providers_text` (Attributes) (see [below for nested schema](#nestedatt--mfa_providers_text))
Expand Down Expand Up @@ -424,6 +425,7 @@ Optional:

- `help` (String)
- `privacy_policy` (String)
- `support_email` (String)
- `tos` (String)


Expand Down Expand Up @@ -539,6 +541,17 @@ Optional:
- `title` (String)


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

Optional:

- `description` (String)
- `link_button_text` (String)
- `other_button_text` (String)
- `title` (String)


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

Expand Down Expand Up @@ -594,6 +607,7 @@ Optional:

- `cancel_button_text` (String)
- `description` (String)
- `expired_description` (String)
- `new_password_confirm_label` (String)
- `new_password_label` (String)
- `next_button_text` (String)
Expand Down
12 changes: 10 additions & 2 deletions docs/resources/smtp_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: |-

Resource representing the SMTP configuration of an instance.

---
**NOTE**

Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed.

---

## Example Usage

```terraform
Expand Down Expand Up @@ -36,6 +43,7 @@ resource "zitadel_smtp_config" "default" {

- `password` (String, Sensitive) Password used to communicate with your SMTP server.
- `reply_to_address` (String) Address to reply to.
- `set_active` (Boolean) Set the SMTP configuration active after creating/updating
- `tls` (Boolean) TLS used to communicate with your SMTP server.
- `user` (String) User used to communicate with your SMTP server.

Expand All @@ -46,6 +54,6 @@ resource "zitadel_smtp_config" "default" {
## Import

```bash
# The resource can be imported using the ID format `<[password]>`, e.g.
terraform import zitadel_smtp_config.imported 'p4ssw0rd'
# The resource can be imported using the ID format `<id[:password]>`, e.g.
terraform import zitadel_smtp_config.imported '123456789012345678:p4ssw0rd'
```
7 changes: 7 additions & 0 deletions templates/resources/smtp_config.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ description: |-

{{ .Description | trimspace }}

---
**NOTE**

Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed.

---

## Example Usage

{{ tffile "examples/provider/resources/smtp_config.tf" }}
Expand Down

0 comments on commit 6a1012c

Please sign in to comment.