diff --git a/docs/resource-specific-documentation.md b/docs/resource-specific-documentation.md new file mode 100644 index 000000000..eea677d5e --- /dev/null +++ b/docs/resource-specific-documentation.md @@ -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: + : #two character language code + : # prompt ID + : # prompt screen 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' +```