Skip to content

account-deletion-api.md

Latest commit

 

History

History
194 lines (139 loc) · 5.54 KB

account-deletion-api.md

File metadata and controls

194 lines (139 loc) · 5.54 KB
Raw

Account Deletion API

Frontend integration guide for deleting an OnTime account with optional withdrawal feedback.

Summary

Account deletion hard-deletes the user from OnTime. The request can optionally include feedback. If feedback is provided, the backend stores it separately from the User table so it remains available after the account is deleted.

For Google and Apple social accounts, the backend first tries to revoke the social login token, then deletes the local OnTime account. If provider token revocation fails, the backend logs a warning and still deletes the local OnTime account.

Account deletion also deletes account-scoped settings and preferences, including the analytics preference stored in user_analytics_preference. Future user-linked Product Usage Events stop after deletion; historical analytics may be retained only in aggregate or de-identified form under the approved privacy policy and analytics provider configuration.

For release/privacy evidence by data category, see docs/account-deletion-verification-evidence.md.

Authentication

All endpoints require the current OnTime access token.

Authorization: Bearer {accessToken}
Content-Type: application/json

Request Body

The request body is optional for every deletion endpoint.

{
  "feedbackId": "d784cde3-9ff9-4054-872a-500bbcc2198a",
  "message": "I do not use the app anymore."
}

Fields:

Field Type Required Notes
feedbackId UUID string No Client-generated ID. If omitted, the backend generates one.
message string No If missing, blank, or only whitespace, feedback is not saved and deletion still proceeds.

General Account Deletion

Use this endpoint for normal OnTime account deletion.

DELETE /users/me/delete

Example without feedback:

DELETE /users/me/delete
Authorization: Bearer {accessToken}
Content-Type: application/json

{}

Example with feedback:

DELETE /users/me/delete
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "feedbackId": "d784cde3-9ff9-4054-872a-500bbcc2198a",
  "message": "The notifications were not useful for me."
}

Success response:

{
  "status": "success",
  "code": "200",
  "message": "계정이 성공적으로 삭제되었습니다!",
  "data": null
}

Google Account Deletion

Use this endpoint when the current account is linked through Google login.

DELETE /oauth2/google/me

Example:

DELETE /oauth2/google/me
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "message": "I am switching to another calendar app."
}

Success response:

{
  "status": "success",
  "code": "200",
  "message": "구글 로그인 회원탈퇴 성공",
  "data": null
}

Behavior:

  • Revokes the stored Google OAuth token for OnTime.
  • Deletes the local OnTime account even if Google token revocation fails.
  • Saves optional feedback if message is nonblank.
  • Does not delete the user's actual Google account.

Expected frontend result after successful revoke:

  • If the user signs up or logs in with the same Google account again, Google may show an "OnTime에 다시 로그인하는 중입니다" confirmation screen.
  • The Google account can still be preselected because the user is still signed in to Google on the device/browser.

Important caveat:

  • The Google unlink only works if the backend has a valid Google refresh/access token saved in socialLoginToken.
  • If the client never provided a real Google refresh token, Google revoke may fail. The backend logs the revoke failure and still deletes the local OnTime account.

Apple Account Deletion

Use this endpoint when the current account is linked through Apple login.

DELETE /oauth2/apple/me

Example:

DELETE /oauth2/apple/me
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "feedbackId": "85fc54e0-e6c7-4c7e-9312-7784a52bf120",
  "message": "I want to restart with a fresh account."
}

Success response:

{
  "status": "success",
  "code": "200",
  "message": "애플 로그인 회원탈퇴 성공",
  "data": null
}

Behavior:

  • Revokes the stored Apple OAuth token for OnTime.
  • Deletes the local OnTime account even if Apple token revocation fails.
  • Saves optional feedback if message is nonblank.
  • Does not delete the user's Apple ID.

What Gets Stored For Feedback

When feedback is provided, the backend stores:

Stored Field Notes
feedbackId Client-provided UUID or backend-generated UUID
deletedUserId Previous OnTime user ID
socialType GOOGLE, APPLE, or null for non-social accounts
emailHash SHA-256 hash of the normalized email, not plaintext email
message User feedback text
createdAt Server timestamp

Feedback is not linked by foreign key to the deleted user.

Frontend Recommendations

  • Treat feedback as optional. Do not block deletion if the user skips it.
  • Generate a UUID for feedbackId if convenient, but it is safe to omit.
  • Use /oauth2/google/me for Google-linked accounts if the product requirement is to unlink Google access.
  • Use /oauth2/apple/me for Apple-linked accounts if the product requirement is to unlink Apple access.
  • Use /users/me/delete for normal local deletion.
  • After a successful deletion response, clear local auth state and navigate to the logged-out screen.
  • If social provider revocation fails, the backend still returns success after deleting the local account. Follow up through support or backend logs if provider unlink confirmation is required.