Skip to content

Commit 4d2fa14

Browse files
authored
Update ACUL samples config and readme with the new schema (#1260)
* Update samples config and readme with the new configs * Update filter field * Update filter field
1 parent 915b264 commit 4d2fa14

3 files changed

Lines changed: 45 additions & 13 deletions

File tree

CUSTOMIZATION_GUIDE.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,37 @@ This document provides essential information on **configuring the rendering mode
1212
- The **default value** is `"standard"`.
1313

1414
### 🔹 2. Default Head Tags
15-
- `default_head_tags_disabled` is a **toggle** to enable/disable **Universal Login's default head tags**.
15+
- `default_head_tags_disabled` is a **toggle** to enable or disable **Universal Login's default head tags**.
1616

1717
### 🔹 3. Context Configuration
18-
- `context_configuration` contains a list of **context values** made available.
19-
- Refer to the [official documentation](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for possible values.
18+
- `context_configuration` specifies a list of **context values** that are made available.
19+
- Refer to the [official documentation](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) for supported values.
2020

2121
### 🔹 4. Head Tags Customization
22-
- `head_tags` is an **array of custom head tags** (e.g., scripts, stylesheets).
22+
- `head_tags` defines an **array of custom head tags** (e.g., scripts, stylesheets).
2323
- **⚠️ At least one** `<script>` tag **must be included**.
2424

25-
### 🔹 5. Updating Rendering Mode
26-
- **Switching to `"standard"` only updates `rendering_mode`**.
27-
- **All other fields remain unchanged**.
28-
29-
### 🔹 6. Partial Updates
25+
### 🔹 5. Filters Configuration
26+
- `filters` defines the conditions under which **advanced rendering mode** with custom UI is applied. By default, the configuration applies tenant-wide.
27+
- `match_type` and at least one of the entity arrays (`clients`, `organizations`, or `domains`) must be specified.
28+
- `match_type` defines the matching logic:
29+
- `"includes_any"`: Uses custom assets if **any match**.
30+
- `"excludes_any"`: Excludes custom assets if **any match**.
31+
- `clients`: Up to 25 client objects, defined by either `id` or `metadata` key/value.
32+
- `organizations`: Up to 25 organization objects, defined by either `id` or `metadata`.
33+
- `domains`: Up to 25 domain objects, defined by either `id` or `metadata`.
34+
35+
### 🔹 6. Page Template Option
36+
- `use_page_template` determines whether to render using the **tenant’s custom page template**.
37+
- When set to `true`, it attempts to use the custom page template (a warning is logged if not defined).
38+
- When set to `false` or omitted, the default template is used.
39+
- The **default is `false`**.
40+
41+
### 🔹 7. Updating Rendering Mode
42+
- Switching to `"standard"` **only updates the `rendering_mode`**.
43+
- All other fields remain unchanged.
44+
45+
### 🔹 8. Partial Updates
3046
- Only **explicitly declared fields** are updated.
3147
- **Unspecified fields remain as they are**.
3248

@@ -66,7 +82,23 @@ This document provides essential information on **configuring the rendering mode
6682
"href": "https://cdn.sass.app/auth-screens/{{client.name}}.css"
6783
}
6884
}
69-
]
85+
],
86+
"filters": {
87+
"match_type": "includes_any",
88+
"clients": [
89+
{ "id": "appId" },
90+
{ "metadata": { "key": "value" } }
91+
],
92+
"organizations": [
93+
{ "id": "orgId" },
94+
{ "metadata": { "key": "value" } }
95+
],
96+
"domains": [
97+
{ "id": "domainId" },
98+
{ "metadata": { "key": "value" } }
99+
]
100+
},
101+
"use_page_template": false
70102
}
71103
```
72104

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ require (
66
github.com/AlecAivazis/survey/v2 v2.3.7
77
github.com/PuerkitoBio/rehttp v1.4.0
88
github.com/atotto/clipboard v0.1.4
9-
github.com/auth0/go-auth0 v1.23.0
9+
github.com/auth0/go-auth0 v1.24.0
1010
github.com/briandowns/spinner v1.23.2
1111
github.com/charmbracelet/glamour v0.10.0
1212
github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ github.com/apparentlymart/go-textseg/v15 v15.0.0 h1:uYvfpb3DyLSCGWnctWKGj857c6ew
2222
github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmmsvpAG721bKi0joRfFdHIWJ4=
2323
github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4=
2424
github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
25-
github.com/auth0/go-auth0 v1.23.0 h1:XefT0lk1tWpj3uRC5YbqlRFNzfyY3argYO/uwmgkIyo=
26-
github.com/auth0/go-auth0 v1.23.0/go.mod h1:g9S/4ImupKFx1gSLqeQO0v1yV91Oo5J5bYobLCAL+J4=
25+
github.com/auth0/go-auth0 v1.24.0 h1:9H3Qv+mAbvv90OLab2pd2ktn7SFdQN86xY9d6niOtd0=
26+
github.com/auth0/go-auth0 v1.24.0/go.mod h1:g9S/4ImupKFx1gSLqeQO0v1yV91Oo5J5bYobLCAL+J4=
2727
github.com/aybabtme/iocontrol v0.0.0-20150809002002-ad15bcfc95a0 h1:0NmehRCgyk5rljDQLKUO+cRJCnduDyn11+zGZIc9Z48=
2828
github.com/aybabtme/iocontrol v0.0.0-20150809002002-ad15bcfc95a0/go.mod h1:6L7zgvqo0idzI7IO8de6ZC051AfXb5ipkIJ7bIA2tGA=
2929
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=

0 commit comments

Comments
 (0)