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

Added details about the organization parameter #10285

Merged
merged 4 commits into from
Aug 11, 2023
Merged
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
13 changes: 9 additions & 4 deletions articles/api/authentication/_change-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ Content-Type: application/json
"client_id": "${account.clientId}",
"email": "EMAIL",
"connection": "CONNECTION",
"organization": "ORGANIZATION_ID"
}
```

```shell
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
Expand All @@ -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);
Expand All @@ -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`.

kegashe marked this conversation as resolved.
Show resolved Hide resolved
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.

kegashe marked this conversation as resolved.
Show resolved Hide resolved
Note: This endpoint only works for database connections.

### Request Parameters

Expand All @@ -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` <br/><span class="label label-danger">Required</span> | The user's email address. |
| `connection` <br/><span class="label label-danger">Required</span> | The name of the database connection configured to your client. |
| `organization` | The `organization_id` of the Organization associated with the user. |


### Remarks
Expand Down
Loading