EmailChangeService

class EmailChangeService

Methods

confirm_new	Verify the new-email code and complete the email change.
confirm_old	Verify the old-email code and send a code to the new email.
create	Initiate an email change.

confirm_new(json_body, *, token)

Verify the new-email code and complete the email change.

Only valid for sessions in pending_new_confirm status. On success, the user’s email is updated and marked as verified.

Does not require authentication — the token in the URL is the credential. IP-bound to the initiating client.

Parameters:

• json_body (ConfirmNewEmailChangeData) – The body of the request. See ConfirmNewEmailChangeData for information about the possible fields. You can provide this data as a ConfirmNewEmailChangeData or as a dictionary.

• token (str) – The email change session identifier.

Returns:

The new email address.

Return type:

EmailChangeDoneResponse

confirm_old(json_body, *, token)

Verify the old-email code and send a code to the new email.

Only valid for sessions in pending_old_confirm status (Path B: no-password users). On success, transitions to pending_new_confirm and sends a code to the new email. Call email_change.confirm_new next.

Does not require authentication — the token in the URL is the credential. IP-bound to the initiating client.

Parameters:

• json_body (ConfirmOldEmailChangeData) – The body of the request. See ConfirmOldEmailChangeData for information about the possible fields. You can provide this data as a ConfirmOldEmailChangeData or as a dictionary.

• token (str) – The email change session identifier.

Returns:

An empty response on success.

Return type:

EmailChangeConfirmOldResponse

create(json_body)

Initiate an email change.

If the user has a password and provides old_password, the flow skips old-email verification and goes straight to new-email verification (call email_change.confirm_new).

If the user has no password (SSO/LTI), old-email verification is required first (call email_change.confirm_old, then email_change.confirm_new).

Parameters:

• json_body (CreateEmailChangeData) – The body of the request. See CreateEmailChangeData for information about the possible fields. You can provide this data as a CreateEmailChangeData or as a dictionary.

• self (EmailChangeService[AuthenticatedClient])

Returns:

An email change session identifier.

Return type:

EmailChangeResponse