-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new auth0_branding_theme resource docs
- Loading branch information
Showing
3 changed files
with
347 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,261 @@ | ||
--- | ||
page_title: "Resource: auth0_branding_theme" | ||
description: |- | ||
This resource allows you to manage branding themes for your universal login page within your Auth0 tenant. | ||
--- | ||
|
||
# Resource: auth0_branding_theme | ||
|
||
This resource allows you to manage branding themes for your universal login page within your Auth0 tenant. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "auth0_branding_theme" "my_theme" { | ||
borders { | ||
button_border_radius = 1 | ||
button_border_weight = 1 | ||
buttons_style = "pill" | ||
input_border_radius = 3 | ||
input_border_weight = 1 | ||
inputs_style = "pill" | ||
show_widget_shadow = false | ||
widget_border_weight = 1 | ||
widget_corner_radius = 3 | ||
} | ||
colors { | ||
body_text = "#FF00CC" | ||
error = "#FF00CC" | ||
header = "#FF00CC" | ||
icons = "#FF00CC" | ||
input_background = "#FF00CC" | ||
input_border = "#FF00CC" | ||
input_filled_text = "#FF00CC" | ||
input_labels_placeholders = "#FF00CC" | ||
links_focused_components = "#FF00CC" | ||
primary_button = "#FF00CC" | ||
primary_button_label = "#FF00CC" | ||
secondary_button_border = "#FF00CC" | ||
secondary_button_label = "#FF00CC" | ||
success = "#FF00CC" | ||
widget_background = "#FF00CC" | ||
widget_border = "#FF00CC" | ||
} | ||
fonts { | ||
font_url = "https://google.com/font.woff" | ||
links_style = "normal" | ||
reference_text_size = 12 | ||
body_text { | ||
bold = false | ||
size = 100 | ||
} | ||
buttons_text { | ||
bold = false | ||
size = 100 | ||
} | ||
input_labels { | ||
bold = false | ||
size = 100 | ||
} | ||
links { | ||
bold = false | ||
size = 100 | ||
} | ||
title { | ||
bold = false | ||
size = 100 | ||
} | ||
subtitle { | ||
bold = false | ||
size = 100 | ||
} | ||
} | ||
page_background { | ||
background_color = "#000000" | ||
background_image_url = "https://google.com/background.png" | ||
page_layout = "center" | ||
} | ||
widget { | ||
header_text_alignment = "center" | ||
logo_height = 55 | ||
logo_position = "center" | ||
logo_url = "https://google.com/logo.png" | ||
social_buttons_layout = "top" | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `borders` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--borders)) | ||
- `colors` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--colors)) | ||
- `fonts` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--fonts)) | ||
- `page_background` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--page_background)) | ||
- `widget` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--widget)) | ||
|
||
### Optional | ||
|
||
- `display_name` (String) The display name for the branding theme. | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. | ||
|
||
<a id="nestedblock--borders"></a> | ||
### Nested Schema for `borders` | ||
|
||
Required: | ||
|
||
- `button_border_radius` (Number) Button border radius. | ||
- `button_border_weight` (Number) Button border weight. | ||
- `buttons_style` (String) Buttons style. | ||
- `input_border_radius` (Number) Input border radius. | ||
- `input_border_weight` (Number) Input border weight. | ||
- `inputs_style` (String) Inputs style. | ||
- `show_widget_shadow` (Boolean) Show widget shadow. | ||
- `widget_border_weight` (Number) Widget border weight. | ||
- `widget_corner_radius` (Number) Widget corner radius. | ||
|
||
|
||
<a id="nestedblock--colors"></a> | ||
### Nested Schema for `colors` | ||
|
||
Required: | ||
|
||
- `body_text` (String) Body text. | ||
- `error` (String) Error. | ||
- `header` (String) Header. | ||
- `icons` (String) Icons. | ||
- `input_background` (String) Input background. | ||
- `input_border` (String) Input border. | ||
- `input_filled_text` (String) Input filled text. | ||
- `input_labels_placeholders` (String) Input labels & placeholders. | ||
- `links_focused_components` (String) Links & focused components. | ||
- `primary_button` (String) Primary button | ||
- `primary_button_label` (String) Primary button label. | ||
- `secondary_button_border` (String) Secondary button border. | ||
- `secondary_button_label` (String) Secondary button label. | ||
- `success` (String) Success. | ||
- `widget_background` (String) Widget background. | ||
- `widget_border` (String) Widget border. | ||
|
||
Optional: | ||
|
||
- `base_focus_color` (String) Base focus color. | ||
- `base_hover_color` (String) Base hover color. | ||
|
||
|
||
<a id="nestedblock--fonts"></a> | ||
### Nested Schema for `fonts` | ||
|
||
Required: | ||
|
||
- `body_text` (Block List, Min: 1, Max: 1) Body text. (see [below for nested schema](#nestedblock--fonts--body_text)) | ||
- `buttons_text` (Block List, Min: 1, Max: 1) Buttons text. (see [below for nested schema](#nestedblock--fonts--buttons_text)) | ||
- `font_url` (String) Font URL. | ||
- `input_labels` (Block List, Min: 1, Max: 1) Input labels. (see [below for nested schema](#nestedblock--fonts--input_labels)) | ||
- `links` (Block List, Min: 1, Max: 1) Links. (see [below for nested schema](#nestedblock--fonts--links)) | ||
- `links_style` (String) Links style. | ||
- `reference_text_size` (Number) Reference text size. | ||
- `subtitle` (Block List, Min: 1, Max: 1) Subtitle. (see [below for nested schema](#nestedblock--fonts--subtitle)) | ||
- `title` (Block List, Min: 1, Max: 1) Title. (see [below for nested schema](#nestedblock--fonts--title)) | ||
|
||
<a id="nestedblock--fonts--body_text"></a> | ||
### Nested Schema for `fonts.body_text` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Body text bold. | ||
- `size` (Number) Body text size. | ||
|
||
|
||
<a id="nestedblock--fonts--buttons_text"></a> | ||
### Nested Schema for `fonts.buttons_text` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Buttons text bold. | ||
- `size` (Number) Buttons text size. | ||
|
||
|
||
<a id="nestedblock--fonts--input_labels"></a> | ||
### Nested Schema for `fonts.input_labels` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Input labels bold. | ||
- `size` (Number) Input labels size. | ||
|
||
|
||
<a id="nestedblock--fonts--links"></a> | ||
### Nested Schema for `fonts.links` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Links bold. | ||
- `size` (Number) Links size. | ||
|
||
|
||
<a id="nestedblock--fonts--subtitle"></a> | ||
### Nested Schema for `fonts.subtitle` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Subtitle bold. | ||
- `size` (Number) Subtitle size. | ||
|
||
|
||
<a id="nestedblock--fonts--title"></a> | ||
### Nested Schema for `fonts.title` | ||
|
||
Required: | ||
|
||
- `bold` (Boolean) Title bold. | ||
- `size` (Number) Title size. | ||
|
||
|
||
|
||
<a id="nestedblock--page_background"></a> | ||
### Nested Schema for `page_background` | ||
|
||
Required: | ||
|
||
- `background_color` (String) Background color. | ||
- `background_image_url` (String) Background image url. | ||
- `page_layout` (String) Page layout. | ||
|
||
|
||
<a id="nestedblock--widget"></a> | ||
### Nested Schema for `widget` | ||
|
||
Required: | ||
|
||
- `header_text_alignment` (String) Header text alignment. | ||
- `logo_height` (Number) Logo height. | ||
- `logo_position` (String) Logo position. | ||
- `logo_url` (String) Logo url. | ||
- `social_buttons_layout` (String) Social buttons layout. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
# Branding Themes can be imported using their ID. | ||
# | ||
# Example: | ||
terraform import auth0_branding_theme.my_theme XXXXXXXXXXXXXXXXXXXX | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Branding Themes can be imported using their ID. | ||
# | ||
# Example: | ||
terraform import auth0_branding_theme.my_theme XXXXXXXXXXXXXXXXXXXX |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
resource "auth0_branding_theme" "my_theme" { | ||
borders { | ||
button_border_radius = 1 | ||
button_border_weight = 1 | ||
buttons_style = "pill" | ||
input_border_radius = 3 | ||
input_border_weight = 1 | ||
inputs_style = "pill" | ||
show_widget_shadow = false | ||
widget_border_weight = 1 | ||
widget_corner_radius = 3 | ||
} | ||
|
||
colors { | ||
body_text = "#FF00CC" | ||
error = "#FF00CC" | ||
header = "#FF00CC" | ||
icons = "#FF00CC" | ||
input_background = "#FF00CC" | ||
input_border = "#FF00CC" | ||
input_filled_text = "#FF00CC" | ||
input_labels_placeholders = "#FF00CC" | ||
links_focused_components = "#FF00CC" | ||
primary_button = "#FF00CC" | ||
primary_button_label = "#FF00CC" | ||
secondary_button_border = "#FF00CC" | ||
secondary_button_label = "#FF00CC" | ||
success = "#FF00CC" | ||
widget_background = "#FF00CC" | ||
widget_border = "#FF00CC" | ||
} | ||
|
||
fonts { | ||
font_url = "https://google.com/font.woff" | ||
links_style = "normal" | ||
reference_text_size = 12 | ||
|
||
body_text { | ||
bold = false | ||
size = 100 | ||
} | ||
|
||
buttons_text { | ||
bold = false | ||
size = 100 | ||
} | ||
|
||
input_labels { | ||
bold = false | ||
size = 100 | ||
} | ||
|
||
links { | ||
bold = false | ||
size = 100 | ||
} | ||
|
||
title { | ||
bold = false | ||
size = 100 | ||
} | ||
|
||
subtitle { | ||
bold = false | ||
size = 100 | ||
} | ||
} | ||
|
||
page_background { | ||
background_color = "#000000" | ||
background_image_url = "https://google.com/background.png" | ||
page_layout = "center" | ||
} | ||
|
||
widget { | ||
header_text_alignment = "center" | ||
logo_height = 55 | ||
logo_position = "center" | ||
logo_url = "https://google.com/logo.png" | ||
social_buttons_layout = "top" | ||
} | ||
} |