Skip to content

Commit 024d05e

Browse files
pranav-oktaclaude
andcommitted
docs: add and fix brand/template resource documentation
- Add missing docs for okta_brands_templates_email_customization resource - Add missing example for okta_brands_templates_email_customization - Fix okta_template_sms: correct template/type to Optional, replace nested block translations with Map of String - Fix okta_email_template_settings: correct recipients to Optional 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 40da2a3 commit 024d05e

4 files changed

Lines changed: 74 additions & 25 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
page_title: "Resource: okta_brands_templates_email_customization"
3+
description: |-
4+
These endpoints allow you to programmatically manage email customizations.
5+
---
6+
7+
# Resource: okta_brands_templates_email_customization
8+
9+
These endpoints allow you to programmatically manage email customizations.
10+
11+
## Example Usage
12+
13+
```terraform
14+
resource "okta_brands_templates_email_customization" "example" {
15+
brand_id = "<brand_id>"
16+
template_name = "ForgotPassword"
17+
language = "en"
18+
subject = "Forgot Password"
19+
body = "<html><body>Reset your password here: $${resetPasswordLink}</body></html>"
20+
is_default = true
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `body` (String) The HTML body of the email.
30+
- `brand_id` (String) The ID of the brand
31+
- `language` (String) The language specified as an [IETF BCP 47 language tag](https://datatracker.ietf.org/doc/html/rfc5646).
32+
- `subject` (String) The email subject.
33+
- `template_name` (String) The name of the email template
34+
35+
### Optional
36+
37+
- `is_default` (Boolean) Whether this is the default customization for the email template.
38+
39+
### Read-Only
40+
41+
- `created` (String) The UTC time at which this email customization was created.
42+
- `id` (String) The unique identifier for the resource.
43+
- `last_updated` (String) The UTC time at which this email customization was last updated.
44+
45+
## Import
46+
47+
Import is supported using the following syntax:
48+
49+
```shell
50+
terraform import okta_brands_templates_email_customization.example <brand_id>/<template_name>/<id>
51+
```

docs/resources/email_template_settings.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,12 @@ resource "okta_email_template_settings" "example" {
2424
### Required
2525

2626
- `brand_id` (String) The ID of the brand.
27-
- `recipients` (String) The recipients the emails of this template will be sent to - Valid values: `ALL_USERS`, `ADMINS_ONLY`, `NO_USERS`
2827
- `template_name` (String) Email template name - Example values: `AccountLockout`,`ADForgotPassword`,`ADForgotPasswordDenied`,`ADSelfServiceUnlock`,`ADUserActivation`,`AuthenticatorEnrolled`,`AuthenticatorReset`,`ChangeEmailConfirmation`,`EmailChallenge`,`EmailChangeConfirmation`,`EmailFactorVerification`,`ForgotPassword`,`ForgotPasswordDenied`,`IGAReviewerEndNotification`,`IGAReviewerNotification`,`IGAReviewerPendingNotification`,`IGAReviewerReassigned`,`LDAPForgotPassword`,`LDAPForgotPasswordDenied`,`LDAPSelfServiceUnlock`,`LDAPUserActivation`,`MyAccountChangeConfirmation`,`NewSignOnNotification`,`OktaVerifyActivation`,`PasswordChanged`,`PasswordResetByAdmin`,`PendingEmailChange`,`RegistrationActivation`,`RegistrationEmailVerification`,`SelfServiceUnlock`,`SelfServiceUnlockOnUnlockedAccount`,`UserActivation`
2928

29+
### Optional
30+
31+
- `recipients` (String) The recipients the emails of this template will be sent to - Valid values: `ALL_USERS`, `ADMINS_ONLY`, `NO_USERS`
32+
3033
### Read-Only
3134

3235
- `id` (String) The ID of the resource. This is a compound ID of the brand ID and the template name.

docs/resources/template_sms.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,46 +14,33 @@ Creates an Okta SMS Template. This resource allows you to create and configure a
1414
resource "okta_template_sms" "example" {
1515
type = "SMS_VERIFY_CODE"
1616
template = "Your $${org.name} code is: $${code}"
17-
translations {
18-
language = "en"
19-
template = "Your $${org.name} code is: $${code}"
20-
}
21-
22-
translations {
23-
language = "es"
24-
template = "Tu código de $${org.name} es: $${code}."
17+
translations = {
18+
en = "Your $${org.name} code is: $${code}"
19+
es = "Tu código de $${org.name} es: $${code}."
2520
}
2621
}
2722
```
2823

2924
<!-- schema generated by tfplugindocs -->
3025
## Schema
3126

32-
### Required
33-
34-
- `template` (String) SMS default template
35-
- `type` (String) SMS template type
36-
3727
### Optional
3828

39-
- `translations` (Block Set) Set of translations for a particular template. (see [below for nested schema](#nestedblock--translations))
29+
- `name` (String) Human-readable name of the Template
30+
- `template` (String) Text of the Template, including any macros
31+
- `translations` (Map of String) Template translations are optionally provided when you want to localize the SMS messages. Keys are IETF BCP 47 language tags, values are the translated template text.
32+
- `type` (String) Type of the Template
4033

4134
### Read-Only
4235

43-
- `id` (String) The ID of this resource.
44-
45-
<a id="nestedblock--translations"></a>
46-
### Nested Schema for `translations`
47-
48-
Required:
49-
50-
- `language` (String) The language to map the template to.
51-
- `template` (String) The SMS message.
36+
- `created` (String) Created
37+
- `id` (String) The unique identifier for the resource.
38+
- `last_updated` (String) LastUpdated
5239

5340
## Import
5441

5542
Import is supported using the following syntax:
5643

5744
```shell
58-
terraform import okta_template_sms.example <template_type>
45+
terraform import okta_template_sms.example <id>
5946
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
resource "okta_brands_templates_email_customization" "example" {
2+
brand_id = "<brand_id>"
3+
template_name = "ForgotPassword"
4+
language = "en"
5+
subject = "Forgot Password"
6+
body = "<html><body>Reset your password here: $${resetPasswordLink}</body></html>"
7+
is_default = true
8+
}

0 commit comments

Comments
 (0)