Skip to content

Commit

Permalink
Adding prompts section
Browse files Browse the repository at this point in the history
  • Loading branch information
willvedd committed Aug 29, 2022
1 parent 8d84395 commit 68a82bb
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/resource-specific-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Resource-specific Documentation

In general, the Deploy CLI resource configuration files closely match the payload schemas of the [Management API](https://auth0.com/docs/api/management/v2).

However, there are some notable nuances to be aware of:

## Client Grants

The c

## Prompts

Multilingual custom text prompts follow a particular hierarchy. Under the root-level `prompts` resource property is a proprietary `customText` property that is an invention to bundle custom text translations with other prompts settings. Underneath `customText` is the two-character language code. Thirdly is the prompt ID, followed by the screen ID, followed by text ID.

**Hierarchy**

```yaml
prompts:
customText:
<LANGUAGE>: #two character language code
<PROMPT_ID>: # prompt ID
<SCREEN_ID>: # prompt screen ID
<TEXT_ID>: 'Some text'
```
**Example**
```yaml
prompts:
identifier_first: true
universal_login_experience: classic
customText:
en:
login:
login:
description: Login description in english
buttonText: Button text
mfa:
mfa-detect-browser-capabilities:
pickAuthenticatorText: 'Try another method'
reloadButtonText: 'Reload'
noJSErrorTitle: 'JavaScript Required'
mfa-login-options:
pageTitle: 'Log in to ${clientName}'
authenticatorNamesSMS: 'SMS'
```

0 comments on commit 68a82bb

Please sign in to comment.