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.

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

Include new ACUL screens in PROMPT_SCREEN_MAPPINGS List #1035

Merged
merged 2 commits into from
Feb 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 22 additions & 28 deletions docs/resource-specific-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,7 @@ Contents of `promptName_screenName.json`
"prompt": "signup-id",
"screen": "signup-id",
"rendering_mode": "advanced",
"context_configuration": [
"branding.settings",
"branding.themes.default"
],
"context_configuration": ["branding.settings", "branding.themes.default"],
"default_head_tags_disabled": false,
"head_tags": [
{
Expand All @@ -107,9 +104,7 @@ Contents of `promptName_screenName.json`
"src": "URL_TO_YOUR_ASSET",
"async": true,
"defer": true,
"integrity": [
"ASSET_SHA"
]
"integrity": ["ASSET_SHA"]
}
}
]
Expand Down Expand Up @@ -281,7 +276,6 @@ Contents of `password_reset.json`
}
```


## emailTemplates

When managing email templates, the values of `options.body` and `options.body` point to specific HTML files relative to the path of the output folder. Otherwise, the payload closely matches that of the [Management API](https://auth0.com/docs/api/management/v2#!/Email_Templates/post_email_templates).
Expand All @@ -303,33 +297,33 @@ Folder structure when in YAML mode.
```yaml
# Contents of ./tenant.yaml
emailTemplates:
- template: "verify_email"
- template: 'verify_email'
enabled: true
syntax: "liquid"
from: "[email protected]"
subject: "something"
body: "emailTemplates/change_email.html"
syntax: 'liquid'
from: '[email protected]'
subject: 'something'
body: 'emailTemplates/change_email.html'

- template: "welcome_email"
- template: 'welcome_email'
enabled: true
syntax: "liquid"
from: "[email protected]"
subject: "something"
body: "emailTemplates/change_email.html"
syntax: 'liquid'
from: '[email protected]'
subject: 'something'
body: 'emailTemplates/change_email.html'

- template: "password_reset"
- template: 'password_reset'
enabled: true
syntax: "liquid"
from: "[email protected]"
subject: "something"
body: "emailTemplates/change_email.html"
syntax: 'liquid'
from: '[email protected]'
subject: 'something'
body: 'emailTemplates/change_email.html'

- template: "reset_email_by_code"
- template: 'reset_email_by_code'
enabled: true
syntax: "liquid"
from: "[email protected]"
subject: "something"
body: "emailTemplates/change_email.html"
syntax: 'liquid'
from: '[email protected]'
subject: 'something'
body: 'emailTemplates/change_email.html'
```

**Directory Example**
Expand Down
4 changes: 1 addition & 3 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ async function run(params: CliParams): Promise<void> {
log.debug(`Setting proxy to ${proxy}`);

// moving from `global-agent` to undici due to update on SDK 4.x.x
setGlobalDispatcher(
new ProxyAgent(process.env.HTTP_PROXY)
);
setGlobalDispatcher(new ProxyAgent(process.env.HTTP_PROXY));
}

log.debug(`Start command ${command}`);
Expand Down
23 changes: 21 additions & 2 deletions src/tools/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,27 @@ const constants = {
captcha: ['interstitial-captcha'],
login: ['login'],
signup: ['signup'],
'reset-password': ['reset-password-request', 'reset-password-email', 'reset-password', 'reset-password-success', 'reset-password-error'],

'reset-password': [
'reset-password-request',
'reset-password-email',
'reset-password',
'reset-password-success',
'reset-password-error',
],
mfa: [
'mfa-detect-browser-capabilities',
'mfa-enroll-result',
'mfa-begin-enroll-options',
'mfa-login-options',
],
'mfa-email': ['mfa-email-challenge', 'mfa-email-list'],
'mfa-sms': ['mfa-country-codes', 'mfa-sms-challenge', 'mfa-sms-enrollment', 'mfa-sms-list'],
'mfa-push': [
'mfa-push-challenge-push',
'mfa-push-enrollment-qr',
'mfa-push-list',
'mfa-push-welcome',
],
} as PromptScreenMapping,
};

Expand Down