post https://{application_vanity_domain}/api/v1/change-email/request-email-change
Initiates a request to change a user's email. This will trigger the following operations to be performed:
- A notification email will be sent to the user's current email address indicating that their email is being changed.
- A confirmation email will be sent to their new email address to verify ownership. The user's email won't be changed until they've completed the confirmation process.
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.
| Permission | Boundary | Description |
|---|---|---|
| change-email-workflow:execute | Application | The subject can perform this operation on users associated with the application to which the subject belongs. |
| Tenant | The subject can perform this operation on users associated with the tenant to which the subject belongs. | |
| Tenant Inclusion List | The subject can perform this operation on users associated with tenants specified in the tenant inclusion list. | |
| Tenant Exclusion List | The subject can perform this operation on users associated with tenants that belong to the subject's application but are not included in the tenant exclusion list. | |
| Self | A user subject can perform this operation on their own behalf. |