Skip to content

Commit

Permalink
Merge pull request #1 from himeshsiriwardana/pr-4826
Browse files Browse the repository at this point in the history
feedback on sms notification docs
  • Loading branch information
RushanNanayakkara authored Nov 12, 2024
2 parents c263359 + e4a8ced commit ba3bf6d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
1 change: 0 additions & 1 deletion en/identity-server/next/docs/references/sms-templates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
{% set product_name = "WSO2 Identity Server" %}
{% set api_path = "notification-templates-rest-api" %}
{% include "../../../../includes/references/sms-templates.md" %}
5 changes: 3 additions & 2 deletions en/identity-server/next/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -866,8 +866,9 @@ nav:
- Conditional authentication:
- Conditional auth - API: references/conditional-auth/api-reference.md
- Authorization policies for apps: references/authorization-policies-for-apps.md
- Email templates: references/email-templates.md
- SMS templates: references/sms-templates.md
- Notification templates:
- Email templates: references/email-templates.md
- SMS templates: references/sms-templates.md
- Actions:
- Pre issue access token action:
- API contract to implement: references/actions/pre-issue-access-token-action/api-contract.md
Expand Down
14 changes: 7 additions & 7 deletions en/includes/references/sms-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ The following is a comprehensive list of SMS templates available in {{ product_n
<tbody>
<tr>
<td>SMSOTP</td>
<td>These SMS are sent when a user attempts to sign in to their account in your {{ product_name }} organization using SMS OTP. The SMS can display the OTP using {{"{{confirmation-code}}"}} literal.</td>
<td>These SMS messages are sent when a user attempts to sign in to an account using SMS OTP. The OTP can be displayed using the {{"{{confirmation-code}}"}} literal.</td>
</tr>
<tr>
<td>passwordReset</td>
<td>These SMS are sent when a user attempts to recover the password of their account using SMS OTP method. The SMS can display the OTP using {{"{{confirmation-code}}"}} literal.</td>
<td>These SMS messages are sent when a user attempts to recover the password using SMS OTP. The OTP can be displayed using the {{"{{confirmation-code}}"}} literal.</td>
</tr>
{% if product_name != "Asgardeo" %}
<tr>
<td>accountconfirmation</td>
<td>These SMS are sent when you create an account in {{ product_name }} while having account confirmation enabled and you have SMS configured as the notification channel. The SMS can display the OTP using {{"{{confirmation-code}}"}} literal.</td>
<td>These SMS messages are sent when a user creates an account in {{ product_name }}, when administrators have enabled account confirmation via SMS. The OTP can be displayed using the {{"{{confirmation-code}}"}} literal.</td>
</tr>
<tr>
<td>verifyMobileOnUpdate</td>
<td>This SMS is sent when a user changes the mobile number associated with the account and verification is enabled for mobile numbers.The SMS can display the OTP using {{"{{confirmation-code}}"}} literal.</td>
<td>This SMS message is sent when a user changes the mobile number associated with the account, when administrators have enabled mobile number verification. The OTP can be displayed using the {{"{{confirmation-code}}"}} literal.</td>
</tr>
<tr>
<td>accountIdRecovery</td>
<td>This SMS is sent when a user requests an account ID recovery. The SMS can display the username using {{"{{user-name}}"}} literal.</td>
<td>This SMS message is sent when a user requests a username recovery. The username can be displayed using the {{"{{user-name}}"}} literal.</td>
</tr>
{% endif %}
</tbody>
Expand Down Expand Up @@ -71,10 +71,10 @@ The following user-related literals are accessible for all SMS templates.
</tr>
<tr>
<td>{{"{{tenant-domain}}"}}</td>
<td>Domain name specific to the organization. For organization (root), this is a human-readable domain name. For organizations, a UUID is used to uniquely identify them.</td>
<td>Domain name specific to the organization. For root organizations, this is the human-readable domain name. For other organizations, it is the UUID.</td>
</tr>
</tbody>
</table>

!!! note
Organizations (root) created before October 2022 will utilize `{{"{{ tenant-domain }}"}}` as the placeholder to represent the organization name. As this placeholder may not provide the organization name in a human-readable format, consider updating it to `{{"{{ organization-name }}"}}` as needed for clarity and ease of understanding.
Root organizations created before October 2022 will utilize `{{"{{ tenant-domain }}"}}` as the placeholder to represent the organization name. As this placeholder may not provide the organization name in a human-readable format, consider updating it to `{{"{{ organization-name }}"}}` as needed for clarity and ease of understanding.

0 comments on commit ba3bf6d

Please sign in to comment.