From ad3d4bd10a9e0e11f8c76afa25faacb22bf24057 Mon Sep 17 00:00:00 2001
From: Kevin Strong-Holte <42565453+kstrongholte@users.noreply.github.com>
Date: Fri, 11 Aug 2023 12:05:25 -0700
Subject: [PATCH] Added details about the `organization` parameter (#10285)
* Added context for `organization` parameter
* Clarified wording
* Clarified wording for "Organization" parameter table entry
---
articles/api/authentication/_change-password.md | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/articles/api/authentication/_change-password.md b/articles/api/authentication/_change-password.md
index cdcb2fe15e..4f99e81283 100644
--- a/articles/api/authentication/_change-password.md
+++ b/articles/api/authentication/_change-password.md
@@ -7,6 +7,7 @@ Content-Type: application/json
"client_id": "${account.clientId}",
"email": "EMAIL",
"connection": "CONNECTION",
+ "organization": "ORGANIZATION_ID"
}
```
@@ -14,7 +15,7 @@ Content-Type: application/json
curl --request POST \
--url https://${account.namespace}/dbconnections/change_password \
--header 'content-type: application/json' \
- --data '{"client_id": "${account.clientId}","email": "EMAIL", "connection": "CONNECTION"}'
+ --data '{"client_id": "${account.clientId}","email": "EMAIL", "connection": "CONNECTION", "organization": "ORGANIZATION_ID"}'
```
```javascript
@@ -28,7 +29,8 @@ curl --request POST \
webAuth.changePassword({
connection: 'CONNECTION',
- email: 'EMAIL'
+ email: 'EMAIL',
+ organization: 'ORGANIZATION_ID'
}, function (err, resp) {
if(err){
console.log(err.message);
@@ -52,9 +54,11 @@ curl --request POST \
"We've just sent you an email to reset your password."
```
-Given a user's `email` address and a `connection`, Auth0 will send a change password email.
+Send a change password email to the user's provided email address and `connection`.
-This endpoint only works for database connections.
+Optionally, you may provide an Organization ID to support Organization-specific variables in [customized email templates](https://auth0.com/docs/customize/email/email-templates#common-variables) and to include the `organization_id` and `organization_name` parameters in the **Redirect To** URL.
+
+Note: This endpoint only works for database connections.
### Request Parameters
@@ -63,6 +67,7 @@ This endpoint only works for database connections.
| `client_id` | The `client_id` of your client. We strongly recommend including a Client ID so that the email template knows from which client the request was triggered. |
| `email`
Required | The user's email address. |
| `connection`
Required | The name of the database connection configured to your client. |
+| `organization` | The `organization_id` of the Organization associated with the user. |
### Remarks