Skip to content

Commit

Permalink
Added context for organization parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
kegashe committed Aug 9, 2023
1 parent c0820cb commit 036b931
Showing 1 changed file with 9 additions and 4 deletions.
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 with the given email address on the given connection.

This endpoint only works for database connections.
Optionally, you may provide an Organization ID to support Organization-specific variables in customized email templates and redirect URLs.

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 the user is a member of. |


### Remarks
Expand Down

0 comments on commit 036b931

Please sign in to comment.